@capillarytech/creatives-library 8.0.286 → 8.0.287-alpha.0

package/utils/tests/commonUtil.test.js

@@ -20,13 +20,17 @@ describe("validateLiquidTemplateContent", () => {
     somethingWentWrong: { id: "wrong" },
     unsupportedTagsValidationError: { id: "unsupported" }
   };
-  const tagLookupMap = { foo: true };
   const eventContextTags = [{ tagName: "bar" }];
   const onError = jest.fn();
   const onSuccess = jest.fn();
 
   beforeEach(() => {
     jest.clearAllMocks();
+    formatMessage.mockImplementation((msg, vars) =>
+      vars && vars.unsupportedTags != null
+        ? `${msg?.id}:${vars.unsupportedTags}`
+        : (msg?.id ?? "unsupported")
+    );
   });
 
   it("calls onError for empty content", async () => {
@@ -39,11 +43,10 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
     expect(onError).toHaveBeenCalledWith({
-      standardErrors: [undefined],
+      standardErrors: ["empty"],
       liquidErrors: [],
       tabType: undefined
     });
@@ -58,7 +61,6 @@ describe("validateLiquidTemplateContent", () => {
       getLiquidTags,
       formatMessage,
       messages,
-      tagLookupMap,
       eventContextTags
     });
     expect(onError).not.toHaveBeenCalled();
@@ -75,7 +77,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
     expect(onError).toHaveBeenCalledWith({
@@ -86,9 +87,15 @@ describe("validateLiquidTemplateContent", () => {
     expect(onSuccess).not.toHaveBeenCalled();
   });
 
-  it("calls onError for unsupported tags", async () => {
+  it("calls onError when API returns success but response.errors has validation errors (e.g. unsupported tag)", async () => {
     const getLiquidTags = jest.fn((content, cb) =>
-      cb({ askAiraResponse: { errors: [], data: [{ name: "baz" }] }, isError: false })
+      cb({
+        askAiraResponse: {
+          errors: [{ message: "Unsupported tag: custom_tag" }],
+          data: []
+        },
+        isError: false
+      })
     );
     await validateLiquidTemplateContent("foo", {
       getLiquidTags,
@@ -96,18 +103,33 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
     expect(onError).toHaveBeenCalledWith({
       standardErrors: [],
-      liquidErrors: [undefined],
+      liquidErrors: ["Unsupported tag: custom_tag"],
       tabType: undefined
     });
     expect(onSuccess).not.toHaveBeenCalled();
   });
 
-  it("calls onSuccess for valid content", async () => {
+  it("calls onSuccess when API returns no errors and a single extracted tag (extracted tags are not validated)", async () => {
+    const getLiquidTags = jest.fn((content, cb) =>
+      cb({ askAiraResponse: { errors: [], data: [{ name: "foo" }] }, isError: false })
+    );
+    await validateLiquidTemplateContent("foo", {
+      getLiquidTags,
+      formatMessage,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags
+    });
+    expect(onSuccess).toHaveBeenCalledWith("foo", undefined);
+    expect(onError).not.toHaveBeenCalled();
+  });
+
+  it("calls onSuccess for valid content when API returns multiple extracted tags but no errors", async () => {
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [{ name: "foo" }, { name: "bar" }] }, isError: false })
     );
@@ -117,7 +139,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
     expect(onSuccess).toHaveBeenCalledWith("foo", undefined);
@@ -133,7 +154,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -151,7 +171,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -169,7 +188,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -187,7 +205,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -205,7 +222,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -223,7 +239,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -241,7 +256,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -259,7 +273,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       skipTags
     });
@@ -277,7 +290,6 @@ describe("validateLiquidTemplateContent", () => {
     };
     const onError = jest.fn();
     const onSuccess = jest.fn();
-    const tagLookupMap = {};
     const eventContextTags = [];
     await validateLiquidTemplateContent('', {
       getLiquidTags,
@@ -285,7 +297,6 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
     });
     expect(formatMessage).toHaveBeenCalledWith(messages.emailBodyEmptyError);
@@ -297,7 +308,7 @@ describe("validateLiquidTemplateContent", () => {
     expect(onSuccess).not.toHaveBeenCalled();
   });
 
-  it("should skip tags that appear in {% %} syntax (like order.items in for loop)", async () => {
+  it("calls onSuccess when API returns extracted tags from {% for %} template but no errors (extracted tags are not validated)", async () => {
     const content = '{% for item in order.items %} Hello {% endfor %}';
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [{ name: "order.items" }] }, isError: false })
@@ -308,15 +319,13 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
-    // order.items appears in {% %} syntax, so it should be skipped and validation should pass
     expect(onSuccess).toHaveBeenCalledWith(content, undefined);
     expect(onError).not.toHaveBeenCalled();
   });
 
-  it("should skip tags that appear only inside {% %} blocks (like item.name in for loop)", async () => {
+  it("calls onSuccess when API returns extracted tags in {% %} blocks but no errors", async () => {
     const content = '{% for item in order.items %} {{ item.name }} - {{ item.quantity }} {% endfor %}';
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [{ name: "item.name" }, { name: "item.quantity" }] }, isError: false })
@@ -327,15 +336,13 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
-    // item.name and item.quantity appear inside {% for %} block, so they should be skipped
     expect(onSuccess).toHaveBeenCalledWith(content, undefined);
     expect(onError).not.toHaveBeenCalled();
   });
 
-  it("should validate tags that don't appear in content but are extracted by API", async () => {
+  it("calls onSuccess when API returns extracted tags not in content but no errors", async () => {
     const content = 'Some content without the tag';
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [{ name: "extractedTag" }] }, isError: false })
@@ -346,19 +353,13 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
-    // extractedTag doesn't appear in content but was extracted by API, should be validated
-    expect(onError).toHaveBeenCalledWith({
-      standardErrors: [],
-      liquidErrors: [undefined],
-      tabType: undefined
-    });
-    expect(onSuccess).not.toHaveBeenCalled();
+    expect(onSuccess).toHaveBeenCalledWith(content, undefined);
+    expect(onError).not.toHaveBeenCalled();
   });
 
-  it("should validate tags that appear outside {% %} blocks", async () => {
+  it("calls onSuccess when API returns tags outside {% %} but no errors", async () => {
     const content = '{{ outsideTag }} {% for item in order.items %} {{ item.name }} {% endfor %}';
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [{ name: "outsideTag" }, { name: "item.name" }] }, isError: false })
@@ -369,20 +370,70 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
-    // outsideTag appears outside {% %} block, so it should be validated
-    // item.name appears inside block, so it should be skipped
-    expect(onError).toHaveBeenCalledWith({
-      standardErrors: [],
-      liquidErrors: [undefined],
-      tabType: undefined
+    expect(onSuccess).toHaveBeenCalledWith(content, undefined);
+    expect(onError).not.toHaveBeenCalled();
+  });
+
+  it("calls onSuccess when API returns tag in {{ }} and no errors", async () => {
+    const content = 'Hello {{ unsupportedTag }} world';
+    const getLiquidTags = jest.fn((content, cb) =>
+      cb({ askAiraResponse: { errors: [], data: [{ name: "unsupportedTag" }] }, isError: false })
+    );
+    await validateLiquidTemplateContent(content, {
+      getLiquidTags,
+      formatMessage,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags
     });
-    expect(onSuccess).not.toHaveBeenCalled();
+    expect(onSuccess).toHaveBeenCalledWith(content, undefined);
+    expect(onError).not.toHaveBeenCalled();
   });
 
-  it("should skip tags with dots that appear in {% %} syntax", async () => {
+  it("calls onSuccess when API returns tag with spacing variants and no errors", async () => {
+    const content = '{{ tag}} and {{tag }} and {{ tag }}';
+    const getLiquidTags = jest.fn((content, cb) =>
+      cb({
+        askAiraResponse: {
+          errors: [],
+          data: [{ name: "tag" }]
+        },
+        isError: false
+      })
+    );
+    await validateLiquidTemplateContent(content, {
+      getLiquidTags,
+      formatMessage,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags
+    });
+    expect(onSuccess).toHaveBeenCalledWith(content, undefined);
+    expect(onError).not.toHaveBeenCalled();
+  });
+
+  it("calls onSuccess when API returns tag inside {% %} blocks but no errors", async () => {
+    const content = '{% for x in some.unsupported %} {{ x }} {% endfor %}';
+    const getLiquidTags = jest.fn((content, cb) =>
+      cb({ askAiraResponse: { errors: [], data: [{ name: "some.unsupported" }] }, isError: false })
+    );
+    await validateLiquidTemplateContent(content, {
+      getLiquidTags,
+      formatMessage,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags
+    });
+    expect(onSuccess).toHaveBeenCalledWith(content, undefined);
+    expect(onError).not.toHaveBeenCalled();
+  });
+
+  it("calls onSuccess when API returns tags with dots in {% %} syntax but no errors", async () => {
     const content = '{% assign myVar = order.items %} Some text';
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [{ name: "order.items" }] }, isError: false })
@@ -393,10 +444,8 @@ describe("validateLiquidTemplateContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
-    // order.items appears in {% %} syntax, so it should be skipped
     expect(onSuccess).toHaveBeenCalledWith(content, undefined);
     expect(onError).not.toHaveBeenCalled();
   });
@@ -451,7 +500,6 @@ describe("validateMobilePushContent", () => {
     somethingWentWrong: { id: "wrong" },
     unsupportedTagsValidationError: { id: "unsupported" }
   };
-  const tagLookupMap = { foo: true };
   const eventContextTags = [{ tagName: "foo" }];
   const onError = jest.fn();
   const onSuccess = jest.fn();
@@ -460,7 +508,7 @@ describe("validateMobilePushContent", () => {
     jest.clearAllMocks();
   });
 
-  it("calls onError for empty formData", async () => {
+  it("calls onError for empty formData (validateMobilePushContent)", async () => {
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [] }, isError: false })
     );
@@ -469,18 +517,17 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
         currentTab: 1
       }
     );
     expect(onError).toHaveBeenCalled();
   });
 
-  it("calls onSuccess for valid android and ios content", async () => {
+  it("calls onSuccess for valid android and ios content (validateMobilePushContent)", async () => {
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [] }, isError: false })
     );
@@ -491,7 +538,6 @@ describe("validateMobilePushContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       currentTab: 1
     });
@@ -509,7 +555,6 @@ describe("validateMobilePushContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       currentTab: 1
     });
@@ -527,7 +572,6 @@ describe("validateMobilePushContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       currentTab: 2
     });
@@ -545,7 +589,6 @@ describe("validateMobilePushContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
     expect(onSuccess).toHaveBeenCalledWith(JSON.stringify(formData[0]), "android");
@@ -562,7 +605,6 @@ describe("validateMobilePushContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags
     });
     expect(onSuccess).toHaveBeenCalledWith("null", "android");
@@ -575,11 +617,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
         currentTab: 1,
       },
     );
@@ -593,11 +634,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
         currentTab: 1,
       },
     );
@@ -611,11 +651,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
         currentTab: 1,
       },
     );
@@ -629,11 +668,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
         currentTab: 1,
       },
     );
@@ -647,11 +685,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
       },
     );
     expect(onError).toHaveBeenCalled();
@@ -664,11 +701,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
       },
     );
     expect(onError).toHaveBeenCalled();
@@ -681,11 +717,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
       },
     );
     expect(onError).toHaveBeenCalled();
@@ -698,11 +733,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
       },
     );
     expect(onError).toHaveBeenCalled();
@@ -715,11 +749,10 @@ describe("validateMobilePushContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
       },
     );
     expect(onError).toHaveBeenCalled();
@@ -733,7 +766,6 @@ describe("validateInAppContent", () => {
     somethingWentWrong: { id: "wrong" },
     unsupportedTagsValidationError: { id: "unsupported" }
   };
-  const tagLookupMap = { foo: true };
   const eventContextTags = [{ tagName: "foo" }];
   const onError = jest.fn();
   const onSuccess = jest.fn();
@@ -742,7 +774,7 @@ describe("validateInAppContent", () => {
     jest.clearAllMocks();
   });
 
-  it("calls onError for empty formData", async () => {
+  it("calls onError for empty formData (validateInAppContent)", async () => {
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [] }, isError: false })
     );
@@ -751,17 +783,16 @@ describe("validateInAppContent", () => {
       {
         getLiquidTags,
         formatMessage,
-        messages,
-        onError,
-        onSuccess,
-        tagLookupMap,
-        eventContextTags,
+      messages,
+      onError,
+      onSuccess,
+      eventContextTags,
       }
     );
     expect(onError).toHaveBeenCalled();
   });
 
-  it("calls onSuccess for valid android and ios content", async () => {
+  it("calls onSuccess for valid android and ios content (validateInAppContent)", async () => {
     const getLiquidTags = jest.fn((content, cb) =>
       cb({ askAiraResponse: { errors: [], data: [] }, isError: false })
     );
@@ -781,7 +812,6 @@ describe("validateInAppContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       singleTab: ANDROID,
     });
@@ -808,7 +838,6 @@ describe("validateInAppContent", () => {
       messages,
       onError,
       onSuccess,
-      tagLookupMap,
       eventContextTags,
       singleTab: IOS,
     });
@@ -835,11 +864,11 @@ describe("getChannelData", () => {
     expect(getChannelData("SMS", formData)).toBe("Hi Test");
   });
 
-  it("returns string with undefineds for SMS channel with missing fields", () => {
+  it("returns string with undefineds for SMS when base and template-name are empty or undefined", () => {
     const formData = { base: {}, "template-name": undefined };
     expect(getChannelData("SMS", formData)).toBe("undefined undefined");
   });
-  it("returns string with undefineds for SMS channel with missing fields", () => {
+  it("returns string with undefineds for SMS when formData is empty string", () => {
     expect(getChannelData("SMS", "")).toBe("undefined undefined");
   });