apify-test-tools 0.10.1-beta.2 → 0.10.1-beta.4

package/.github/actions/checkout-restore-dependencies/action.yaml

@@ -65,7 +65,8 @@ runs:
           run: npm ci
 
         # Repos can still have older version locally but on cloud we enforce uniformity.
-        # This causes minor mismatch in package-lock.json and node_modules but it shouldn't cause any issues.
+        # --no-save swaps the package in node_modules only and leaves the repo's package.json and
+        # package-lock.json untouched, so node_modules is ahead of the lockfile but the checkout stays clean.
         - name: Enforce test tools version required by these workflows
           # We don't override beta so we can use it to test branch-specific versions of apify-test-tools
           # Needs the npm token too: a repo whose .npmrc routes all traffic through a private
@@ -79,7 +80,7 @@ runs:
               echo "Package-lock version of apify-test-tools: $locked_version"
               if [[ "$locked_version" == *"-beta"* ]]; then
                 echo "Beta version detected, reinstalling $locked_version to ensure cache consistency"
-                npm install apify-test-tools@$locked_version --audit=false --no-fund;
+                npm install "apify-test-tools@$locked_version" --no-save --audit=false --no-fund;
               else
                 # The workflows name the exact package version they ship with, so a tag is a complete
                 # statement: these workflows and this library. A frozen major tag then keeps
@@ -90,5 +91,5 @@ runs:
                 # version; the release that publishes X is the commit that pins X.
                 pinned_version=$(cat "${{ github.action_path }}/../../workflows-package-version")
                 echo "Installing apify-test-tools@$pinned_version (pinned by these workflows)"
-                npm install "apify-test-tools@$pinned_version" --audit=false --no-fund;
+                npm install "apify-test-tools@$pinned_version" --no-save --audit=false --no-fund;
               fi

package/.github/workflows/public_platform-tests-claude-investigate-and-fix.yaml

@@ -70,6 +70,9 @@ on:
             TESTER_APIFY_TOKEN_READ_ONLY:
                 required: true
                 description: Apify token used only for read-only investigation — reading the failing run, its log and its storages.
+            NPM_TOKEN:
+                required: false
+                description: Read-only token for installing private npm packages before Claude runs.
 
 jobs:
     investigate:
@@ -166,8 +169,10 @@ jobs:
             id-token: write
             actions: read
         steps:
-            - name: Checkout repository
-              uses: actions/checkout@v5
+            - name: Setup repository and dependencies
+              uses: apify/apify-test-tools/.github/actions/checkout-restore-dependencies@workflows-v0
+              with:
+                  npm-token: ${{ secrets.NPM_TOKEN }}
 
             - name: Run Claude Code
               id: claude

package/.github/workflows/public_platform-tests.yaml

@@ -49,7 +49,6 @@ jobs:
                   return_code=$?
                   npx apify-test-tools report-tests \
                     --report-file ./test-output.json \
-                    --workspace . \
                     --workflow-name "${{ github.workflow }}" \
                     --job-url "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
                     --report-slack-channel "${{ inputs.report-slack-channel || format('#notif-{0}', github.event.repository.name) }}"

package/.github/workflows-package-version

@@ -1 +1 @@
-0.10.0
+0.10.1

package/CHANGELOG.md

@@ -5,10 +5,16 @@ All notable changes to this project will be documented in this file.
 <!-- git-cliff-unreleased-start -->
 ## 0.10.1 - **not yet released**
 
+### 🚀 Features
+
+- **relative-path:** Path safety and manipulation lib ([#154](https://github.com/apify/apify-test-tools/pull/154)) ([c151a1c](https://github.com/apify/apify-test-tools/commit/c151a1c2755fef98b335d48a3461f5042b90def9)) by [@JuanGalilea](https://github.com/JuanGalilea)
+- **logger:** Add logger and ban console statements ([#170](https://github.com/apify/apify-test-tools/pull/170)) ([b295d36](https://github.com/apify/apify-test-tools/commit/b295d363276c92fc6c30dd34d7a90acef5d380bf)) by [@JuanGalilea](https://github.com/JuanGalilea), closes [#156](https://github.com/apify/apify-test-tools/issues/156)
+
 ### 🐛 Bug Fixes
 
 - **internal-workflows:** Wait out npm&#x27;s async publish before holding the major tag ([#160](https://github.com/apify/apify-test-tools/pull/160)) ([78434f0](https://github.com/apify/apify-test-tools/commit/78434f03d288ecbd383d55d56a1610f06ded298f)) by [@metalwarrior665](https://github.com/metalwarrior665)
 - Skip builds and tests when the net diff is empty ([#171](https://github.com/apify/apify-test-tools/pull/171)) ([874d70c](https://github.com/apify/apify-test-tools/commit/874d70ca5506f7ec742a1808c9bf6c670f08552c)) by [@artogahr](https://github.com/artogahr)
+- **workflows:** Add npm install step to Claude fix workflow ([#161](https://github.com/apify/apify-test-tools/pull/161)) ([d8884e0](https://github.com/apify/apify-test-tools/commit/d8884e07f778de14c8d9d7f0ec9e0a1672c224ad)) by [@foxt451](https://github.com/foxt451), closes [#39](https://github.com/apify/apify-test-tools/issues/39)
 
 
 <!-- git-cliff-unreleased-end -->

package/CONTRIBUTING.md

@@ -14,6 +14,15 @@ The package consists of three parts:
 - `bin/slack.ts` sending notifications to slack
 - `bin/test-report.ts` processing vitest's test reports
 
+CLI command results use `writeJson` from `bin/output.ts` to write newline-terminated JSON to stdout.
+Use the CLI `logger` from `bin/logger.ts` for diagnostics; every level writes to stderr.
+ESLint rejects `console.log` throughout the codebase and all direct `console` calls in `bin/`.
+The importable library in `lib/` keeps its own diagnostics; CLI log levels apply only to `bin/`.
+
+The CLI's global `--log-level` option accepts `debug`, `info` (default), `warn`, `error`, or `silent`.
+It filters diagnostics without affecting command results. Use `logger.debug` for detailed troubleshooting,
+`logger.info` for progress, `logger.warn` for recoverable problems, and `logger.error` for failures.
+
 ## Test library
 
 - `lib/extend-expect.ts` - custom matchers
@@ -39,11 +48,12 @@ git clone git@github.com:apify-store/testing-repo-for-github-actions.git
 
 #### Working on the CLI
 
-To work on the library, point the cli to your repo with `--workspace` (it defaults to the current directory):
+To work on the library, run the cli from the root of your testing repo:
 
 ```sh
-npx tsx bin/main.ts --help
-npx tsx bin/main.ts --workspace ../path/to/testing-repo-for-github-actions get-commits --target-branch master --source-branch feat/testing-feature-branch
+cd /path/to/testing-repo-for-github-actions
+npx tsx /path/to/apify-test-tools/bin/main.ts --help
+npx tsx /path/to/apify-test-tools/bin/main.ts get-commits --target-branch master --source-branch feat/testing-feature-branch
 ```
 
 #### Working on the library

package/README.md

@@ -595,7 +595,7 @@ The main local flow is:
 4. Build Actors on Apify (with your new code)
 5. Run tests against those builds. You can change tests and run on the same builds.
 
-Run every command from the root of the actor repository you want to work with (or point `--workspace` at it).
+Run every command from the root of the actor repository you want to work with.
 
 #### 4. Build affected Actors
 
@@ -725,5 +725,5 @@ skips the check.
 For development on `apify-test-tools` itself, use `tsx` directly:
 
 ```bash
-tsx bin/main.ts --workspace local-clone get-actor-configs
+cd local-clone && tsx ../bin/main.ts get-actor-configs
 ```

package/bin/build-from-local.ts

@@ -8,6 +8,7 @@ import { ActorSourceType } from 'apify-client';
 
 import { dryRunBuildData, LOCAL_SOURCE_VERSION_NUMBER, runAndSummarizeBuilds } from './build.js';
 import { buildDockerIgnoreMatcher } from './dockerignore.js';
+import { logger } from './logger.js';
 import { isPathWithinScope } from './path-utils.js';
 import type { ActorConfig, BuildData } from './types.js';
 import type { SourceFile } from './utils.js';
@@ -34,7 +35,7 @@ export const collectSourceFiles = async (actorName: string, actorDir: string): P
     const isMonorepoActor = !!contextAbsDir && isOutsideDir(contextAbsDir, absActorDir);
 
     const dockerContextDirAbs = isMonorepoActor ? contextAbsDir! : absActorDir;
-    const keptFilePaths = collectNonIgnoredFiles(dockerContextDirAbs, repoRoot);
+    const keptFilePaths = await collectNonIgnoredFiles(dockerContextDirAbs, repoRoot);
 
     if (!isMonorepoActor) {
         return Promise.all(keptFilePaths.map(async (filePath) => readSourceFile(filePath, dockerContextDirAbs)));
@@ -64,9 +65,9 @@ export const collectSourceFiles = async (actorName: string, actorDir: string): P
 // regardless of .gitignore/.dockerignore, matching Apify CLI's own behavior. Files matching the
 // hardcoded secret-pattern backstop (keys, certs, .env variants) are dropped unconditionally,
 // .actor/ included, since those should never ship regardless of what the ignore files say.
-export const collectNonIgnoredFiles = (dockerContextDir: string, repoRoot: string): string[] => {
-    const relativePaths = listRepoFilePaths(repoRoot, dockerContextDir);
-    const ignoredPaths = getGitignoredPaths(relativePaths);
+export const collectNonIgnoredFiles = async (dockerContextDir: string, repoRoot: string): Promise<string[]> => {
+    const relativePaths = await listRepoFilePaths(repoRoot, dockerContextDir);
+    const ignoredPaths = await getGitignoredPaths(relativePaths, repoRoot);
     const rootRelativePaths = new Map(
         relativePaths.map((relPath) => [
             relPath,
@@ -104,7 +105,7 @@ export const flattenMonorepoContext = async (
     actorJson: Record<string, unknown>,
     keptContextFiles: string[],
 ): Promise<{ tempDir: string; filePaths: string[] }> => {
-    console.error(`[${actorName}]: monorepo actor detected — flattening from Docker context`);
+    logger.info(`[${actorName}]: monorepo actor detected — flattening from Docker context`);
 
     const tempDir = await fs.mkdtemp(path.join(os.tmpdir(), `apify-build-${actorName.replace('/', '_')}-`));
     const filePaths: string[] = [];
@@ -194,9 +195,9 @@ export const runBuildsFromLocal = async ({
     dryRun: boolean;
 }): Promise<BuildData[]> => {
     if (dryRun) {
-        console.error('[DRY RUN] Would build from local source:');
+        logger.info('[DRY RUN] Would build from local source:');
         for (const { actorFullName, folder } of actorConfigs) {
-            console.error(`  ${actorFullName} (${folder})`);
+            logger.info(`  ${actorFullName} (${folder})`);
         }
         return actorConfigs.map(({ actorFullName }) => dryRunBuildData(actorFullName, LOCAL_SOURCE_VERSION_NUMBER));
     }

package/bin/build.ts

@@ -2,6 +2,7 @@ import type * as ApifyClientTypes from 'apify-client';
 import { ActorSourceType, ApifyClient } from 'apify-client';
 
 import { normalizeRepoUrl } from './git.js';
+import { logger } from './logger.js';
 import type { ActorConfig, BuildData } from './types.js';
 
 type BuildPrActorOptions = {
@@ -28,7 +29,7 @@ const ACTOR_SETUP_REQUIREMENT =
  */
 export const resolveDefaultVersion = (actorFullName: string, actorInfo: ApifyClientTypes.Actor) => {
     const defaultBuildTag = actorInfo.defaultRunOptions.build;
-    console.error(`Default build tag for ${actorFullName} is ${defaultBuildTag}`);
+    logger.info(`Default build tag for ${actorFullName} is ${defaultBuildTag}`);
 
     // We could technically allow this but in most cases this is accidentally set wrongly and there is a workaround
     if (defaultBuildTag.match(/\d+\.\d+\.\d+/)) {
@@ -43,7 +44,7 @@ export const resolveDefaultVersion = (actorFullName: string, actorInfo: ApifyCli
         throw new Error(`[${actorFullName}] No build found for tag "${defaultBuildTag}". ${ACTOR_SETUP_REQUIREMENT}`);
     }
     const defaultVersionNumber = defaultBuildNumber.match(/(\d+\.\d+)\.\d+/)![1];
-    console.error(`Default version for ${actorFullName} is ${defaultVersionNumber}`);
+    logger.info(`Default version for ${actorFullName} is ${defaultVersionNumber}`);
 
     const defaultVersion = actorInfo.versions.find((version) => version.versionNumber === defaultVersionNumber);
 
@@ -139,7 +140,7 @@ export class ApifyBuilder {
         // We also get back actId so the testing actor can both match by actor ID and name
         const { id, actId, buildNumber } = await actorClient.build(versionNumber, { useCache });
 
-        console.error(`[${this.actorFullName}]: ${id} (${buildNumber})`);
+        logger.info(`[${this.actorFullName}]: ${id} (${buildNumber})`);
         return { buildId: id, actorRawId: actId, buildNumber, actorFullName: this.actorFullName };
     };
 
@@ -147,20 +148,20 @@ export class ApifyBuilder {
         const build = await this.apifyClient.build(buildId).waitForFinish();
         const versionNumber = build.buildNumber;
         if (build.status === 'FAILED' || build.status === 'TIMED-OUT') {
-            console.error(`[${this.actorFullName}]: ${versionNumber}`);
+            logger.error(`[${this.actorFullName}]: ${versionNumber}`);
             try {
                 const log = await this.apifyClient.build(buildId).log().get();
                 const logTail = log?.split('\n').slice(-40).join('\n');
-                console.error(`\n--- BUILD LOG (last 40 lines) ---\n${logTail}\n---`);
+                logger.error(`\n--- BUILD LOG (last 40 lines) ---\n${logTail}\n---`);
             } catch (err) {
-                console.error(`[${this.actorFullName}]: Failed to fetch build log: ${err}`);
+                logger.error(`[${this.actorFullName}]: Failed to fetch build log: ${err}`);
             }
             throw new Error(
                 `[BUILD][${this.actorFullName}]: Build ${buildId} (${versionNumber}) failed. ` +
                     `Not continuing with other builds and tests.`,
             );
         }
-        console.error(`[${this.actorFullName}]: ${versionNumber}`);
+        logger.info(`[${this.actorFullName}]: ${versionNumber}`);
         return build;
     };
 
@@ -227,7 +228,7 @@ export class ApifyBuilder {
         type CorrectBuildColletionItem = (typeof items)[0] & { buildNumber: string };
         const buildsToDelete = (items as CorrectBuildColletionItem[]).filter((build) => {
             if (build.buildNumber === defaultBuildNumber) {
-                console.error(
+                logger.info(
                     `[DELETE OLD BUILDS][${this.actorFullName}]: Skipping default build ${defaultBuildNumber} (${defaultBuildTag}). ` +
                         `We never delete default builds`,
                 );
@@ -238,7 +239,7 @@ export class ApifyBuilder {
                 (protectedBuildNumber) => protectedBuildNumber.buildNumber === build.buildNumber,
             );
             if (protectedTagFound) {
-                console.error(
+                logger.info(
                     `[DELETE OLD BUILDS][${this.actorFullName}]: Skipping protected build ${protectedTagFound.buildNumber} (${protectedTagFound.tag}).`,
                 );
                 return false;
@@ -247,7 +248,7 @@ export class ApifyBuilder {
             if (taggedDevelBuildNumber && build.buildNumber === taggedDevelBuildNumber) {
                 const shouldDeleteDevelBuild = build.startedAt.getTime() < daysAgoUnixDevel;
                 if (shouldDeleteDevelBuild) {
-                    console.error(
+                    logger.info(
                         `[DELETE OLD BUILDS][${this.actorFullName}]: Removing olf devel build ${taggedDevelBuildNumber}.`,
                     );
                 }
@@ -256,7 +257,7 @@ export class ApifyBuilder {
             return build.startedAt.getTime() < daysAgoUnixProd;
         });
 
-        console.error(
+        logger.info(
             `[DELETE OLD BUILDS][${this.actorFullName}]: Deleting ${buildsToDelete.length} old builds that are non-default and ` +
                 `older than 30 days from total ${items.length}`,
         );
@@ -271,8 +272,8 @@ export const waitAndSummarizeBuilds = async (
     buildersMap: Map<string, ApifyBuilder>,
     label: string,
 ): Promise<BuildData[]> => {
-    console.error('=========================================');
-    console.error(`FINISHED ${label}:`);
+    logger.info('=========================================');
+    logger.info(`FINISHED ${label}:`);
     await Promise.all(
         startedBuilds.map(async (buildData) => {
             const builder = buildersMap.get(buildData.actorFullName)!;
@@ -280,12 +281,12 @@ export const waitAndSummarizeBuilds = async (
         }),
     );
 
-    console.error('=========================================');
-    console.error('SUMMARY:');
+    logger.info('=========================================');
+    logger.info('SUMMARY:');
     for (const buildData of startedBuilds.sort((a, b) => a.actorFullName.localeCompare(b.actorFullName))) {
-        console.error(`[${buildData.actorFullName}]: ${buildData.buildNumber}`);
+        logger.info(`[${buildData.actorFullName}]: ${buildData.buildNumber}`);
     }
-    console.error('=========================================');
+    logger.info('=========================================');
 
     return startedBuilds;
 };
@@ -298,8 +299,8 @@ export const runAndSummarizeBuilds = async (
     const buildersByActorFullName = new Map<string, ApifyBuilder>(
         actorConfigs.map((actorConfig) => [actorConfig.actorFullName, ApifyBuilder.fromActorConfig(actorConfig)]),
     );
-    console.error('=========================================');
-    console.error(`STARTED ${label}:`);
+    logger.info('=========================================');
+    logger.info(`STARTED ${label}:`);
     const startedBuilds = await Promise.all(
         actorConfigs.map(async (actorConfig) =>
             buildOneActor(actorConfig, buildersByActorFullName.get(actorConfig.actorFullName)!),
@@ -366,9 +367,9 @@ export const runBuilds = async ({
     );
 
     if (dryRun) {
-        console.error('[DRY RUN] Would build:');
+        logger.info('[DRY RUN] Would build:');
         for (const { actorConfig, versionNumber } of buildConfigs) {
-            console.error(`  ${actorConfig.actorFullName} (${versionNumber})`);
+            logger.info(`  ${actorConfig.actorFullName} (${versionNumber})`);
         }
         return buildConfigs.map(({ actorConfig, versionNumber }) =>
             dryRunBuildData(actorConfig.actorFullName, versionNumber),

package/bin/diff-changes.ts

@@ -1,5 +1,6 @@
 import { isCosmeticOnlyJsonSchemaChange } from './diff-json-schema.js';
 import { type DockerIgnoreMatcher, loadDockerIgnore } from './dockerignore.js';
+import { logger } from './logger.js';
 import { findContainingScope, hoistPath, isPathWithinScope } from './path-utils.js';
 import type { ActorConfig, Commit } from './types.js';
 
@@ -44,12 +45,12 @@ type FileChangeForActor =
  * 6. .json inside the actor's own `.actor/` dir with only cosmetic schema diffs → cosmetic (semantically verified)
  * 7. Everything else → functional
  */
-const classifyFileChange = (
+const classifyFileChange = async (
     originalFilePath: string,
     actorConfig: ActorConfig,
     commits: Commit[],
     dockerIgnoreMatcher: DockerIgnoreMatcher,
-): FileChangeForActor => {
+): Promise<FileChangeForActor> => {
     const lowercaseFilePath = originalFilePath.toLowerCase();
 
     // TODO: hardcodes that there's a single repo-wide changelog belonging to every actor. Should instead
@@ -89,7 +90,7 @@ const classifyFileChange = (
     }
 
     if (lowercaseFilePath.endsWith('.json') && isUnderActorDotDir) {
-        const isCosmetic = isCosmeticOnlyJsonSchemaChange(commits, originalFilePath);
+        const isCosmetic = await isCosmeticOnlyJsonSchemaChange(commits, originalFilePath);
         if (isCosmetic) {
             return { impact: 'cosmetic', semanticallyVerified: true };
         }
@@ -159,19 +160,19 @@ const groupFilesByActorSet = (fileToActors: Map<string, Set<string>>): ChangeGro
 const logChangeGroups = (groups: ChangeGroup[]): void => {
     for (const { actors, files } of groups) {
         if (actors.length > 1) {
-            console.error(`[DIFF]: Shared changes for actors ${actors.join(', ')}: ${files.join(', ')}`);
+            logger.info(`[DIFF]: Shared changes for actors ${actors.join(', ')}: ${files.join(', ')}`);
         } else {
-            console.error(`[DIFF]: Changes specific to actor ${actors[0]}: ${files.join(', ')}`);
+            logger.info(`[DIFF]: Changes specific to actor ${actors[0]}: ${files.join(', ')}`);
         }
     }
 };
 
-export const getChangedActors = ({
+export const getChangedActors = async ({
     filepathsChanged,
     actorConfigs,
     isLatest = false,
     commits,
-}: ShouldBuildAndTestOptions): ActorConfig[] => {
+}: ShouldBuildAndTestOptions): Promise<ActorConfig[]> => {
     const actorsChangedMap = new Map<string, ActorChangeEntry>();
 
     for (const actorConfig of actorConfigs) {
@@ -184,7 +185,7 @@ export const getChangedActors = ({
                 continue;
             }
 
-            const change = classifyFileChange(originalFilePath, actorConfig, commits, dockerIgnoreMatcher);
+            const change = await classifyFileChange(originalFilePath, actorConfig, commits, dockerIgnoreMatcher);
 
             if (change.impact === 'ignored' || change.impact === 'outside-context') continue;
             if (change.impact === 'cosmetic' && !isLatest) continue;
@@ -205,9 +206,9 @@ export const getChangedActors = ({
 
     if (actorsChanged.length > 0) {
         const actors = actorsChanged.map((config) => config.actorFullName);
-        console.error(`[DIFF]: Actors to be built and tested: ${actors.join(', ')}`);
+        logger.info(`[DIFF]: Actors to be built and tested: ${actors.join(', ')}`);
     } else {
-        console.error(`[DIFF]: No relevant files changed, skipping builds and tests`);
+        logger.info(`[DIFF]: No relevant files changed, skipping builds and tests`);
     }
 
     return actorsChanged;

package/bin/diff-json-schema.ts

@@ -1,5 +1,6 @@
+import { logger } from './logger.js';
 import type { Commit } from './types.js';
-import { spawnCommandInGhWorkspace } from './utils.js';
+import { runGitCommand } from './utils.js';
 
 const COSMETIC_JSON_FIELD_NAMES = new Set([
     'title',
@@ -28,21 +29,22 @@ const isCosmeticObjectChange = (oldVal: unknown, newVal: unknown, currentKey?: s
  * Returns true if the two JSON strings differ only in cosmetic fields
  * (title, description, example, enumTitles, sectionCaption, sectionDescription).
  */
-export const isCosmeticOnlyJsonSchemaChange = (commits: Commit[], changedFilepath: string): boolean => {
+export const isCosmeticOnlyJsonSchemaChange = async (commits: Commit[], changedFilepath: string): Promise<boolean> => {
     // TODO: validate this is the right commit range
     const oldRef = `${commits[0].sha}~`;
     const newRef = commits[commits.length - 1].sha;
-    let oldJson: unknown;
-    let newJson: unknown;
-    try {
-        const oldContent = spawnCommandInGhWorkspace(`git show ${oldRef}:${changedFilepath}`);
-        const newContent = spawnCommandInGhWorkspace(`git show ${newRef}:${changedFilepath}`);
 
-        oldJson = JSON.parse(oldContent);
-        newJson = JSON.parse(newContent);
-    } catch {
-        console.error(
-            `Failed to get or parse JSON content for ${changedFilepath} at refs ${oldRef} and ${newRef}, maybe it is new file or deleted? Treating it as a non-cosmetic change.`,
+    const [oldJson, newJson] = await Promise.all([
+        runGitCommand(['show', `${oldRef}:${changedFilepath}`])
+            .then(JSON.parse)
+            .catch(() => undefined),
+        runGitCommand(['show', `${newRef}:${changedFilepath}`])
+            .then(JSON.parse)
+            .catch(() => undefined),
+    ]);
+    if (!oldJson || !newJson) {
+        logger.info(
+            `Failed to get JSON content for ${changedFilepath} at refs ${oldRef} and ${newRef}, maybe it is new file or deleted? Treating it as a non-cosmetic change.`,
         );
         return false;
     }