apify-test-tools 0.6.0 → 0.6.1

package/test/unit/should-built-and-test.test.ts

@@ -1,7 +1,9 @@
-import { describe, expect, test } from 'vitest';
+import type { MockInstance } from 'vitest';
+import { beforeEach, describe, expect, test, vi } from 'vitest';
 
-import type { ActorConfig } from '../../bin/types.js';
-import { getChangedActors } from '../../bin/utils.js';
+import { getChangedActors } from '../../bin/diff-changes.js';
+import * as DiffJsonSchema from '../../bin/diff-json-schema.js';
+import type { ActorConfig, Commit } from '../../bin/types.js';
 
 describe('Should build and test parser', () => {
     // From https://github.com/apify-store/testing-repo-for-github-actions
@@ -23,89 +25,226 @@ describe('Should build and test parser', () => {
         },
     ];
 
-    test('Ignores dev-only readme', async () => {
+    const commits: Commit[] = [
+        { sha: 'Commit1', author: '', date: '', message: '' },
+        { sha: 'Commit3', author: '', date: '', message: '' },
+    ];
+
+    let isCosmeticOnlyJsonSchemaSpy: MockInstance;
+
+    beforeEach(() => {
+        // Default: JSON changes are functional (triggers build/test)
+        isCosmeticOnlyJsonSchemaSpy = vi.spyOn(DiffJsonSchema, 'isCosmeticOnlyJsonSchemaChange').mockReturnValue(false);
+    });
+
+    test('Ignores dev-only readme', () => {
         const FILES = ['README.md', 'code/README.md', 'shared/README.md'];
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: false, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual([]);
-        expect(codeChanged).toBe(false);
     });
 
-    test('Ignores other ignored files and folders', async () => {
+    test('Ignores other ignored files and folders', () => {
         const FILES = ['.vscode/', '.gitignore', '.husky/', '.eslintrc', '.editorconfig', '.actor/'];
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: false, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual([]);
-        expect(codeChanged).toBe(false);
     });
 
-    test('Only builds latest for all Actors', async () => {
+    test('Only builds latest for all Actors', () => {
         const FILES = ['shared/CHANGELOG.md', 'CHANGELOG.md'];
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: true, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: true,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual(ACTOR_CONFIGS.filter(({ isStandalone }) => !isStandalone));
-        expect(codeChanged).toBe(false);
     });
 
-    test('Code updated, tests miniactors', async () => {
+    test('Code updated, tests miniactors', () => {
         const FILES = ['code/src/main.ts', 'package.json'];
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: false, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual(ACTOR_CONFIGS.filter(({ isStandalone }) => !isStandalone));
-        expect(codeChanged).toBe(true);
     });
 
-    test('Specific Actor functionality configs updated', async () => {
-        const FILES = ['actors/lukaskrivka_testing-github-integration-1/.actor/actor.json', 'standalone-actors/lukaskrivka_test-standalone/Dockerfile'];
+    test('Specific Actor functionality configs updated', () => {
+        const FILES = [
+            'actors/lukaskrivka_testing-github-integration-1/.actor/actor.json',
+            'standalone-actors/lukaskrivka_test-standalone/Dockerfile',
+        ];
+        // Default mock returns false = functional change
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: false, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual([ACTOR_CONFIGS[0], ACTOR_CONFIGS[2]]);
-        expect(codeChanged).toBe(false);
     });
 
-    test('src/main.ts updated', async () => {
-        const FILES = [
-            'src/main.ts',
-        ];
+    test('src/main.ts updated', () => {
+        const FILES = ['src/main.ts'];
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: true, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: true,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual(ACTOR_CONFIGS.slice(0, 2));
-        expect(codeChanged).toBe(false);
     });
 
-    test('Miniactor, Code and standalone actor updated,', async () => {
+    test('Miniactor, Code and standalone actor updated,', () => {
         const FILES = [
             'actors/lukaskrivka_testing-github-integration-1/.actor/actor.json',
             'code/src/main.ts',
             'standalone-actors/lukaskrivka_test-standalone/Dockerfile',
         ];
+        // Default mock returns false = functional change for the JSON file
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: false, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual(ACTOR_CONFIGS);
-        expect(codeChanged).toBe(true);
     });
 
-    test('Specific Actor non-functional configs updated', async () => {
-        const FILES = ['actors/lukaskrivka_testing-github-integration-2/.actor/README.md', 'standalone-actors/lukaskrivka_test-standalone/CHANGELOG.md'];
+    test('Specific Actor non-functional configs updated', () => {
+        const FILES = [
+            'actors/lukaskrivka_testing-github-integration-2/.actor/README.md',
+            'standalone-actors/lukaskrivka_test-standalone/CHANGELOG.md',
+        ];
+
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
+
+        expect(actorsChanged).toEqual([]);
+    });
+
+    test('JSON file with cosmetic-only changes in PR context (isLatest=false) skips tests', () => {
+        const FILES = ['actors/lukaskrivka_testing-github-integration-1/.actor/actor.json'];
+        isCosmeticOnlyJsonSchemaSpy.mockReturnValue(true);
+
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
+
+        expect(actorsChanged).toEqual([]);
+    });
+
+    test('JSON file with cosmetic-only changes in latest context still triggers build', () => {
+        const FILES = ['actors/lukaskrivka_testing-github-integration-1/.actor/actor.json'];
+        isCosmeticOnlyJsonSchemaSpy.mockReturnValue(true);
+
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: true,
+            filepathsChanged: FILES,
+            commits,
+        });
+
+        expect(actorsChanged).toEqual([ACTOR_CONFIGS[0]]);
+    });
+
+    test('JSON file with functional changes triggers tests', () => {
+        const FILES = ['actors/lukaskrivka_testing-github-integration-1/.actor/actor.json'];
+        // Default mock returns false = functional change
 
-        const { actorsChanged, codeChanged } = await getChangedActors({ actorConfigs: ACTOR_CONFIGS, isLatest: false, filepathsChanged: FILES });
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
+
+        expect(actorsChanged).toEqual([ACTOR_CONFIGS[0]]);
+    });
+
+    test('Mix: one actor has cosmetic-only JSON change, another has functional JSON change', () => {
+        const FILES = [
+            'actors/lukaskrivka_testing-github-integration-1/.actor/actor.json',
+            'actors/lukaskrivka_testing-github-integration-2/.actor/input_schema.json',
+        ];
+        // Actor 1 JSON is cosmetic-only, actor 2 JSON is functional
+        isCosmeticOnlyJsonSchemaSpy.mockImplementation(
+            (_commits, filepath: string) => !filepath.includes('input_schema.json'),
+        );
+
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
+
+        // Only the second actor (functional change) should be built and tested
+        expect(actorsChanged).toEqual([ACTOR_CONFIGS[1]]);
+    });
+
+    test('Standalone actor with cosmetic-only JSON change in PR context skips tests', () => {
+        const FILES = ['standalone-actors/lukaskrivka_test-standalone/.actor/actor.json'];
+        isCosmeticOnlyJsonSchemaSpy.mockReturnValue(true);
+
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
+        });
 
         expect(actorsChanged).toEqual([]);
-        expect(codeChanged).toBe(false);
     });
 
-    test('Google Maps real user-case that had undefined', async () => {
-        const FILES = ['actors/compass_Google-Maps-Reviews-Scraper/.actor/INPUT_SCHEMA.json', 'actors/compass_crawler-google-places/.actor/INPUT_SCHEMA.json',
-            'code/src/consts.ts', 'code/src/crawlers/cheerio/routes.ts', 'code/src/detail_page_handle.ts', 'code/src/enqueue_places.ts',
-            'code/src/helper-classes/initialize-all.ts', 'code/src/helper-classes/stats.ts', 'code/src/helper-classes/unmatched-categories.ts',
-            'code/src/main.ts', 'code/src/typedefs/general.ts', 'code/src/utils/background-enqueue.ts'];
+    test('Google Maps real user-case that had undefined', () => {
+        const FILES = [
+            'actors/compass_Google-Maps-Reviews-Scraper/.actor/INPUT_SCHEMA.json',
+            'actors/compass_crawler-google-places/.actor/INPUT_SCHEMA.json',
+            'code/src/consts.ts',
+            'code/src/crawlers/cheerio/routes.ts',
+            'code/src/detail_page_handle.ts',
+            'code/src/enqueue_places.ts',
+            'code/src/helper-classes/initialize-all.ts',
+            'code/src/helper-classes/stats.ts',
+            'code/src/helper-classes/unmatched-categories.ts',
+            'code/src/main.ts',
+            'code/src/typedefs/general.ts',
+            'code/src/utils/background-enqueue.ts',
+        ];
 
         const ACTOR_CONFIGS_GOOGLE_MAPS: ActorConfig[] = [
             {
@@ -156,11 +295,13 @@ describe('Should build and test parser', () => {
             },
         ];
 
-        const { actorsChanged, codeChanged } = await getChangedActors({
-            actorConfigs: ACTOR_CONFIGS_GOOGLE_MAPS, isLatest: false, filepathsChanged: FILES,
+        const actorsChanged = getChangedActors({
+            actorConfigs: ACTOR_CONFIGS_GOOGLE_MAPS,
+            isLatest: false,
+            filepathsChanged: FILES,
+            commits,
         });
 
         expect(actorsChanged).toEqual(ACTOR_CONFIGS_GOOGLE_MAPS.filter(({ isStandalone }) => !isStandalone));
-        expect(codeChanged).toBe(true);
     });
 });

package/bin/consts.ts

@@ -1,6 +0,0 @@
-// Technically, upgrades in shared or packages might not need impact every actor
-// but we cannot really know that
-export const DEFAULT_BUILD_ALL_FOLDERS = ['code', 'shared', 'packages'];
-
-export const PERSISTED_GH_JOBS_KVS_ID = 'XIBdO8EJePdD0KiAI';
-export const MINIACTORS_LIST_STORE_ID = 'ftXklt2f2mN30Oc3y';

package/dist/bin/consts.d.ts

@@ -1,4 +0,0 @@
-export declare const DEFAULT_BUILD_ALL_FOLDERS: string[];
-export declare const PERSISTED_GH_JOBS_KVS_ID = "XIBdO8EJePdD0KiAI";
-export declare const MINIACTORS_LIST_STORE_ID = "ftXklt2f2mN30Oc3y";
-//# sourceMappingURL=consts.d.ts.map

package/dist/bin/consts.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../bin/consts.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,yBAAyB,UAAiC,CAAC;AAExE,eAAO,MAAM,wBAAwB,sBAAsB,CAAC;AAC5D,eAAO,MAAM,wBAAwB,sBAAsB,CAAC"}

package/dist/bin/consts.js

@@ -1,6 +0,0 @@
-// Technically, upgrades in shared or packages might not need impact every actor
-// but we cannot really know that
-export const DEFAULT_BUILD_ALL_FOLDERS = ['code', 'shared', 'packages'];
-export const PERSISTED_GH_JOBS_KVS_ID = 'XIBdO8EJePdD0KiAI';
-export const MINIACTORS_LIST_STORE_ID = 'ftXklt2f2mN30Oc3y';
-//# sourceMappingURL=consts.js.map

package/dist/bin/consts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"consts.js","sourceRoot":"","sources":["../../bin/consts.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,iCAAiC;AACjC,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAExE,MAAM,CAAC,MAAM,wBAAwB,GAAG,mBAAmB,CAAC;AAC5D,MAAM,CAAC,MAAM,wBAAwB,GAAG,mBAAmB,CAAC"}