feat: customTags optional field added (#153)

Author: Eduard-iCH

README.md

@@ -127,6 +127,9 @@ await vrt.track({
   // Optional
   device: "PC",
 
+  // Optional
+  customTags: "Cloud, DarkTheme, Auth",
+
   // Array of areas to be ignored
   // Optional
   ignoreAreas: [

lib/helpers/__snapshots__/dto.helper.spec.ts.snap

@@ -68,6 +68,10 @@ FormData {
         "device",
         "device",
       ],
+      Array [
+        "customTags",
+        "customTags",
+      ],
       Array [
         "ignoreAreas",
         "[{\\"x\\":1,\\"y\\":2,\\"height\\":300,\\"width\\":400}]",
@@ -122,6 +126,10 @@ FormData {
         "type": "return",
         "value": undefined,
       },
+      Object {
+        "type": "return",
+        "value": undefined,
+      },
     ],
   },
   "destroy": [MockFunction],
@@ -321,6 +329,10 @@ FormData {
         "device",
         "device",
       ],
+      Array [
+        "customTags",
+        "customTags",
+      ],
       Array [
         "ignoreAreas",
         "[{\\"x\\":1,\\"y\\":2,\\"height\\":300,\\"width\\":400}]",
@@ -375,6 +387,10 @@ FormData {
         "type": "return",
         "value": undefined,
       },
+      Object {
+        "type": "return",
+        "value": undefined,
+      },
     ],
   },
   "destroy": [MockFunction],

lib/helpers/dto.helper.spec.ts

@@ -19,6 +19,7 @@ describe("multipartDtoToFormData", () => {
         imagePath: "./lib/__data__/2.png",
         os: "os",
         device: "device",
+        customTags: "customTags",
         viewport: "viewport",
         browser: "browser",
         diffTollerancePercent: 0.123,
@@ -64,6 +65,7 @@ describe("bufferDtoToFormData", () => {
         imageBuffer: Buffer.of(1, 2, 3),
         os: "os",
         device: "device",
+        customTags: "customTags",
         viewport: "viewport",
         browser: "browser",
         diffTollerancePercent: 0.123,

lib/helpers/dto.helper.ts

@@ -15,6 +15,7 @@ export const multipartDtoToFormData = (dto: TestRunMultipartDto): FormData => {
   dto.browser && data.append("browser", dto.browser);
   dto.viewport && data.append("viewport", dto.viewport);
   dto.device && data.append("device", dto.device);
+  dto.customTags && data.append("customTags", dto.customTags);
   dto.ignoreAreas &&
     data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
   dto.diffTollerancePercent &&
@@ -34,6 +35,7 @@ export const bufferDtoToFormData = (dto: TestRunBufferDto): FormData => {
   dto.browser && data.append("browser", dto.browser);
   dto.viewport && data.append("viewport", dto.viewport);
   dto.device && data.append("device", dto.device);
+  dto.customTags && data.append("customTags", dto.customTags);
   dto.ignoreAreas &&
     data.append("ignoreAreas", JSON.stringify(dto.ignoreAreas));
   dto.diffTollerancePercent &&

lib/helpers/type.helper.spec.ts

@@ -9,6 +9,7 @@ describe("instanceOfTestRunBase64", () => {
         imagePath: "iamge",
         os: "os",
         device: "device",
+        customTags: "customTags",
         viewport: "viewport",
         browser: "browser",
       },
@@ -20,6 +21,7 @@ describe("instanceOfTestRunBase64", () => {
         imageBase64: "iamge",
         os: "os",
         device: "device",
+        customTags: "customTags",
         viewport: "viewport",
         browser: "browser",
       },

lib/types/request/testRun.dto.ts

@@ -11,6 +11,8 @@ export interface TestRunDto {
 
   device?: string;
 
+  customTags?: string;
+
   branchName: string;
 
   buildId: string;

lib/types/testRun.ts

@@ -6,6 +6,7 @@ interface TestRun {
   browser?: string;
   viewport?: string;
   device?: string;
+  customTags?: string;
   diffTollerancePercent?: number;
   ignoreAreas?: IgnoreArea[];
 }

lib/visualRegressionTracker.spec.ts

@@ -113,6 +113,7 @@ const testRunBase64: TestRunBase64 = {
   imageBase64: "iamge",
   os: "os",
   device: "device",
+  customTags: "customTags",
   viewport: "viewport",
   browser: "browser",
   ignoreAreas: [
@@ -130,6 +131,7 @@ const testRunMultipart: TestRunMultipart = {
   imagePath: "./lib/__data__/2.png",
   os: "os",
   device: "device",
+  customTags: "customTags",
   viewport: "viewport",
   browser: "browser",
   ignoreAreas: [
@@ -147,6 +149,7 @@ const testRunBuffer: TestRunBuffer = {
   imageBuffer: Buffer.of(1, 2, 3),
   os: "os",
   device: "device",
+  customTags: "customTags",
   viewport: "viewport",
   browser: "browser",
   ignoreAreas: [
@@ -437,6 +440,7 @@ describe("VisualRegressionTracker", () => {
           imageBase64: testRunBase64.imageBase64,
           os: testRunBase64.os,
           device: testRunBase64.device,
+          customTags: testRunBase64.customTags,
           viewport: testRunBase64.viewport,
           browser: testRunBase64.browser,
           ignoreAreas: testRunBase64.ignoreAreas,