@applitools/core 2.4.3 → 2.4.5

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+## 2.4.5 - 2023/3/31
+
+### Features
+- Added `removeDuplicateTests` property to the `GetManagerResultsSettings`
+### Bug fixes
+
+## 2.4.4 - 2023/3/30
+
+### Features
+### Bug fixes
+- Improve performance in DOM snapshot
+
 ## 2.4.3 - 2023/3/22
 
 ### Features

package/dist/get-manager-results.js

@@ -3,25 +3,49 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeGetManagerResults = void 0;
 const test_error_1 = require("./errors/test-error");
 const internal_error_1 = require("./errors/internal-error");
+const separate_duplicate_results_1 = require("./utils/separate-duplicate-results");
 function makeGetManagerResults({ core, storage, logger: defaultLogger, }) {
     return async function getManagerResults({ settings, logger = defaultLogger, } = {}) {
         var _a, _b, _c;
-        const containers = await Promise.all(storage.map(async (eyes) => {
+        let containers = await storage.reduce(async (promise, eyes) => {
             try {
                 const results = await eyes.getResults({ settings: { ...settings, throwErr: false }, logger });
-                return results.map(result => {
-                    return {
+                return promise.then(containers => {
+                    return containers.concat(results.map(result => ({
                         result,
                         error: result.status !== 'Passed' ? new test_error_1.TestError(result) : undefined,
                         userTestId: result.userTestId,
                         renderer: result.renderer,
-                    };
+                    })));
                 });
             }
             catch (error) {
-                return [{ error: new internal_error_1.InternalError(error), ...error.info }];
+                return promise.then(containers => containers.concat({ error: new internal_error_1.InternalError(error), ...error.info }));
             }
-        }));
+        }, Promise.resolve([]));
+        if (settings === null || settings === void 0 ? void 0 : settings.removeDuplicateTests) {
+            logger.log('User opted into removing duplicate tests, checking for duplicates...');
+            const [dedupedContainers, duplicateContainers] = (0, separate_duplicate_results_1.separateDuplicateResults)(containers);
+            containers = dedupedContainers;
+            if (!duplicateContainers.length)
+                logger.log('No duplicate tests found.');
+            else {
+                logger.log(`Duplicates found (${duplicateContainers.length} in total), cleaning them up...`);
+                await Promise.all(duplicateContainers.map(async (container) => {
+                    if (container.result) {
+                        await core.deleteTest({
+                            settings: {
+                                ...container.result.server,
+                                testId: container.result.id,
+                                batchId: container.result.batchId,
+                                secretToken: container.result.secretToken,
+                            },
+                        });
+                    }
+                }));
+                logger.log('Done cleaning up duplicate tests!');
+            }
+        }
         const batches = storage.reduce((batches, eyes) => {
             if (!eyes.test.keepBatchOpen) {
                 const settings = { ...eyes.test.server, batchId: eyes.test.batchId };
@@ -31,7 +55,7 @@ function makeGetManagerResults({ core, storage, logger: defaultLogger, }) {
         }, {});
         await core.closeBatch({ settings: Object.values(batches), logger }).catch(() => null);
         const summary = {
-            results: containers.flat(),
+            results: containers,
             passed: 0,
             unresolved: 0,
             failed: 0,

package/dist/utils/separate-duplicate-results.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.separateDuplicateResults = void 0;
+function separateDuplicateResults(containers) {
+    var _a;
+    const containerByBaselineId = new Map();
+    const duplicates = [];
+    const possibleDuplicateContainers = containers.filter(container => { var _a; return !((_a = container.result) === null || _a === void 0 ? void 0 : _a.keepIfDuplicate); });
+    for (const container of possibleDuplicateContainers) {
+        const baselineId = (_a = container.result) === null || _a === void 0 ? void 0 : _a.baselineId;
+        if (baselineId) {
+            const containerForThisBaseline = containerByBaselineId.get(baselineId);
+            if (containerForThisBaseline) {
+                const startedAt1 = Date.parse(containerForThisBaseline.result.startedAt);
+                const startedAt2 = Date.parse(container.result.startedAt);
+                if (startedAt2 > startedAt1) {
+                    duplicates.push(containerForThisBaseline);
+                    containerByBaselineId.set(baselineId, container);
+                }
+                else {
+                    duplicates.push(container);
+                }
+            }
+            else {
+                containerByBaselineId.set(baselineId, container);
+            }
+        }
+    }
+    return [
+        // tests to keep
+        !duplicates.length ? containers : containers.filter(container => !duplicates.includes(container)),
+        // tests to delete
+        duplicates,
+    ];
+}
+exports.separateDuplicateResults = separateDuplicateResults;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "2.4.3",
+  "version": "2.4.5",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -56,7 +56,7 @@
     "test:it": "MOCHA_GROUP=it node ../../node_modules/.bin/mocha './test/it/**/*.spec.ts'",
     "test:unit": "MOCHA_GROUP=unit node ../../node_modules/.bin/mocha './test/unit/**/*.spec.ts'",
     "test:sanity": "yarn test:unit",
-    "report": "bongo report --name 'core'",
+    "report": "bongo report --name 'core' --group 'core'",
     "setup": "yarn docker:setup",
     "docker:setup": "node ../../scripts/generate-docker-compose-config.js && docker-compose up -d",
     "docker:teardown": "docker-compose down",
@@ -75,19 +75,19 @@
     ]
   },
   "dependencies": {
-    "@applitools/core-base": "1.1.43",
+    "@applitools/core-base": "1.1.44",
     "@applitools/dom-capture": "11.2.1",
-    "@applitools/dom-snapshot": "4.7.6",
+    "@applitools/dom-snapshot": "4.7.7",
     "@applitools/driver": "1.11.37",
-    "@applitools/ec-client": "1.2.17",
+    "@applitools/ec-client": "1.2.18",
     "@applitools/logger": "1.1.48",
-    "@applitools/nml-client": "1.3.41",
+    "@applitools/nml-client": "1.3.42",
     "@applitools/req": "1.1.33",
-    "@applitools/screenshoter": "3.7.31",
+    "@applitools/screenshoter": "3.7.32",
     "@applitools/snippets": "2.4.17",
     "@applitools/socket": "1.0.10",
-    "@applitools/spec-driver-webdriver": "1.0.17",
-    "@applitools/ufg-client": "1.2.4",
+    "@applitools/spec-driver-webdriver": "1.0.18",
+    "@applitools/ufg-client": "1.2.5",
     "@applitools/utils": "1.3.32",
     "@types/ws": "8.5.4",
     "abort-controller": "3.0.0",
@@ -98,13 +98,13 @@
     "yargs": "17.6.2"
   },
   "devDependencies": {
-    "@applitools/bongo": "^3.0.2",
+    "@applitools/bongo": "^3.0.3",
     "@applitools/sdk-coverage-tests": "^3.0.0",
-    "@applitools/spec-driver-puppeteer": "^1.1.49",
-    "@applitools/spec-driver-selenium": "^1.5.34",
-    "@applitools/spec-driver-webdriverio": "^1.4.32",
+    "@applitools/spec-driver-puppeteer": "^1.1.50",
+    "@applitools/spec-driver-selenium": "^1.5.35",
+    "@applitools/spec-driver-webdriverio": "^1.4.33",
     "@applitools/test-server": "^1.1.28",
-    "@applitools/test-utils": "^1.5.14",
+    "@applitools/test-utils": "^1.5.15",
     "@types/node": "^12.20.55",
     "@types/selenium-webdriver": "^4.1.2",
     "@types/yargs": "^17.0.22",

package/types/get-eyes-results.d.ts

@@ -1,4 +1,4 @@
-import type { Eyes, GetResultsSettings, TestResult } from './types';
+import type { Eyes, GetEyesResultsSettings, TestResult } from './types';
 import { type SpecType } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
 type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
@@ -6,7 +6,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 export declare function makeGetEyesResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ eyes, logger: defaultLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
-    settings?: GetResultsSettings<TType> | undefined;
+    settings?: GetEyesResultsSettings<TType> | undefined;
     logger?: Logger | undefined;
 }) => Promise<TestResult<TType>[]>;
 export {};

package/types/get-manager-results.d.ts

@@ -1,4 +1,4 @@
-import type { Core, Eyes, GetResultsSettings, TestResultSummary } from './types';
+import type { Core, Eyes, GetManagerResultsSettings, TestResultSummary } from './types';
 import { type SpecType } from '@applitools/driver';
 import { type Logger } from '@applitools/logger';
 type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
@@ -7,7 +7,7 @@ type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     logger: Logger;
 };
 export declare function makeGetManagerResults<TSpec extends SpecType, TType extends 'classic' | 'ufg'>({ core, storage, logger: defaultLogger, }: Options<TSpec, TType>): ({ settings, logger, }?: {
-    settings?: GetResultsSettings<TType> | undefined;
+    settings?: GetManagerResultsSettings<TType> | undefined;
     logger?: Logger | undefined;
 }) => Promise<TestResultSummary<TType>>;
 export {};

package/types/make-manager.d.ts

@@ -1,4 +1,4 @@
-import type { Core, EyesManager, EyesManagerSettings } from './types';
+import type { Core, EyesManager, ManagerSettings } from './types';
 import type { Core as BaseCore } from '@applitools/core-base';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
@@ -13,7 +13,7 @@ type Options<TSpec extends SpecType> = {
 };
 export declare function makeMakeManager<TSpec extends SpecType>({ spec, concurrency: defaultConcurrency, core, base, agentId: defaultAgentId, cwd, logger: defaultLogger, }: Options<TSpec>): <TType extends "classic" | "ufg" = "classic">({ type, settings, logger, }?: {
     type?: TType | undefined;
-    settings?: EyesManagerSettings | undefined;
+    settings?: ManagerSettings | undefined;
     logger?: Logger | undefined;
 }) => Promise<EyesManager<TSpec, TType>>;
 export {};

package/types/types.d.ts

@@ -18,7 +18,7 @@ export interface Core<TSpec extends SpecType, TDefaultType extends 'classic' | '
     }): Promise<ECClient>;
     makeManager<TType extends 'classic' | 'ufg' = TDefaultType>(options?: {
         type: TType;
-        settings?: EyesManagerSettings;
+        settings?: ManagerSettings;
         logger?: Logger;
     }): Promise<EyesManager<TSpec, TType>>;
     openEyes<TType extends 'classic' | 'ufg' = TDefaultType>(options: {
@@ -56,7 +56,7 @@ export interface EyesManager<TSpec extends SpecType, TDefaultType extends 'class
         logger?: Logger;
     }): Promise<Eyes<TSpec, TType>>;
     getResults: (options?: {
-        settings?: GetResultsSettings<TDefaultType>;
+        settings?: GetManagerResultsSettings<TDefaultType>;
         logger?: Logger;
     }) => Promise<TestResultSummary<'classic' | 'ufg'>>;
 }
@@ -92,12 +92,12 @@ export interface Eyes<TSpec extends SpecType, TDefaultType extends 'classic' | '
         logger?: Logger;
     }): Promise<void>;
     getResults(options?: {
-        settings?: Partial<GetResultsSettings<TDefaultType>>;
+        settings?: Partial<GetEyesResultsSettings<TDefaultType>>;
         config?: Config<TSpec, TDefaultType>;
         logger?: Logger;
     }): Promise<TestResult<TDefaultType>[]>;
 }
-export interface EyesManagerSettings {
+export interface ManagerSettings {
     concurrency?: number;
     /** @deprecated */
     legacyConcurrency?: number;
@@ -117,6 +117,10 @@ export type AbortSettings<TType extends 'classic' | 'ufg'> = TType extends 'ufg'
 export type GetResultsSettings<TType extends 'classic' | 'ufg'> = (TType extends 'ufg' ? UFGCore.GetResultsSettings : ClassicCore.GetResultsSettings) & {
     throwErr?: boolean;
 };
+export type GetEyesResultsSettings<TType extends 'classic' | 'ufg'> = GetResultsSettings<TType>;
+export type GetManagerResultsSettings<TType extends 'classic' | 'ufg'> = GetEyesResultsSettings<TType> & {
+    removeDuplicateTests?: boolean;
+};
 export type CheckResult<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.CheckResult : ClassicCore.CheckResult;
 export type TestResult<TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.TestResult : ClassicCore.TestResult;
 export interface TestResultContainer<TType extends 'classic' | 'ufg'> {

package/types/utils/separate-duplicate-results.d.ts

@@ -0,0 +1,2 @@
+import { TestResultContainer } from '../types';
+export declare function separateDuplicateResults(containers: TestResultContainer<'classic' | 'ufg'>[]): TestResultContainer<"classic" | "ufg">[][];