@applitools/core 4.73.3 → 4.74.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [4.74.0](https://github.com/Applitools-Dev/sdk/compare/js/core@4.73.3...js/core@4.74.0) (2026-11-01)
+
+
+### Features
+
+* log allowlisted environment variables once at SDK initialization for diagnostics | AD-14135 ([#3883](https://github.com/Applitools-Dev/sdk/issues/3883)) ([f7d04b1](https://github.com/Applitools-Dev/sdk/commit/f7d04b19b016ce2dcd656ca543a30128f3b4b309))
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.25.0
+  #### Features
+
+  * update iOS device names for the iOS 27 UFG upgrade | AD-17131 ([#4401](https://github.com/Applitools-Dev/sdk/issues/4401)) ([22ea8f6](https://github.com/Applitools-Dev/sdk/commit/22ea8f6d57d812f8bc1563c6fb459fabfaca38df))
+
 ## [4.73.3](https://github.com/Applitools-Dev/sdk/compare/js/core@4.73.2...js/core@4.73.3) (2026-10-29)
 
 

package/dist/core.js

@@ -45,10 +45,12 @@ const extract_test_environment_1 = require("./utils/extract-test-environment");
 const ensure_offline_folder_1 = require("./utils/ensure-offline-folder");
 const validate_sdk_version_1 = require("./utils/validate-sdk-version");
 const memory_usage_logging_1 = require("./utils/memory-usage-logging");
+const log_env_snapshot_1 = require("./utils/log-env-snapshot");
 const take_snapshots_1 = require("./ufg/take-snapshots");
 function makeCore({ spec, clients, base: defaultBase, concurrency = utils.general.getEnvValue('CONCURRENCY', 'number'), environment: defaultEnvironment, agentId = 'core', cwd = process.cwd(), maskLog = false, logger: defaultLogger, asyncCache, } = {}) {
     const logger = (0, logger_1.makeLogger)({ logger: defaultLogger, format: { label: 'core' }, maskLog });
     (0, memory_usage_logging_1.startMemoryUsageLogging)({ logger });
+    (0, log_env_snapshot_1.logEnvSnapshot)({ logger });
     const environment = (0, extract_test_environment_1.extractTestEnvironment)(defaultEnvironment);
     const offlineLocationPath = (0, ensure_offline_folder_1.ensureOfflineFolder)();
     logger.log(`[pid=${process.pid} Core is initialized ${defaultBase ? 'with' : 'without'} custom base core ${offlineLocationPath ? `and offline location ${offlineLocationPath} ` : ''}and environment `, environment);

package/dist/utils/log-env-snapshot.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__resetLogEnvSnapshotForTests = exports.logEnvSnapshot = void 0;
+// Module-level flag: persists for the lifetime of the Node process across multiple makeCore() calls — once-per-process by design.
+let hasLogged = false;
+const APPLITOOLS_DIAGNOSTIC_VARS = [
+    'APPLITOOLS_SERVER_URL',
+    'APPLITOOLS_BATCH_ID',
+    'APPLITOOLS_BATCH_NAME',
+    'APPLITOOLS_BATCH_SEQUENCE_NAME',
+    'APPLITOOLS_APP_NAME',
+    'APPLITOOLS_BUILD_MODE',
+    'APPLITOOLS_IS_DISABLED',
+    'APPLITOOLS_DONT_CLOSE_BATCHES',
+    'APPLITOOLS_BATCH_NOTIFY',
+    'APPLITOOLS_CONCURRENCY',
+    'APPLITOOLS_CONCURRENT_TABS',
+    'APPLITOOLS_RENDER_CONCURRENCY',
+    'APPLITOOLS_HTTP_VERSION',
+    'APPLITOOLS_LOG_DIR',
+    'APPLITOOLS_LOG_FILE',
+    'APPLITOOLS_LOG_LEVEL',
+    'APPLITOOLS_SHOW_LOGS',
+    'APPLITOOLS_LOG_COLORS',
+    'APPLITOOLS_MASK_LOG',
+    'APPLITOOLS_DEBUG_SCREENSHOTS_DIR',
+    'APPLITOOLS_DISABLE_AGENT_CACHIFY',
+    'APPLITOOLS_NAMESPACE',
+    'APPLITOOLS_FRAMEWORK_PROTOCOL',
+    'APPLITOOLS_FRAMEWORK_VERSION',
+    'APPLITOOLS_FRAMEWORK_MAJOR_VERSION',
+    'APPLITOOLS_USE_DNS_CACHE',
+    'APPLITOOLS_USE_SELF_HEALING',
+    'APPLITOOLS_SKIP_BRANCH_LOOKUP_IN_SHALLOW_CLONE',
+    'APPLITOOLS_ENABLE_BRANCH_LOOKUP_FALLBACK_LIST',
+    'APPLITOOLS_BASELINE_BRANCH',
+    'APPLITOOLS_PARENT_BRANCH',
+    'APPLITOOLS_BASELINE_BRANCH_NAME',
+    'APPLITOOLS_PARENT_BRANCH_NAME',
+    'APPLITOOLS_BRANCH',
+    'APPLITOOLS_BRANCH_NAME',
+    'APPLITOOLS_OFFLINE_LOCATION_PATH',
+    'APPLITOOLS_OFFLINE_LOG_LIMIT',
+    'APPLITOOLS_EYES_SERVER_URL',
+    'APPLITOOLS_UFG_SERVER_URL',
+    'APPLITOOLS_EXECUTION_CLOUD_URL',
+    'APPLITOOLS_EXECUTION_CLOUD_REGION',
+    'APPLITOOLS_EG_SERVER_URL',
+    'APPLITOOLS_EG_INACTIVITY_TIMEOUT',
+    'APPLITOOLS_EG_TIMEOUT',
+    'APPLITOOLS_EC_TUNNEL_USE_FRP',
+    'APPLITOOLS_TUNNEL_MANAGER_SOCK',
+    'APPLITOOLS_EG_TUNNEL_LOG_LEVEL',
+    'APPLITOOLS_HEARTBEAT_INTERVAL',
+];
+const APPLITOOLS_SENSITIVE_VARS = [
+    'APPLITOOLS_API_KEY',
+    'APPLITOOLS_API_KEY_READ',
+    'APPLITOOLS_PROXY',
+    'APPLITOOLS_PROXY_URL',
+];
+const GIT_CI_VARS = [
+    'GITHUB_ACTIONS',
+    'GITHUB_HEAD_REF',
+    'GITHUB_REF',
+    'GITHUB_RUN_ID',
+    'CI_COMMIT_REF_NAME',
+    'CI_JOB_ID',
+    'CIRCLE_BRANCH',
+    'CIRCLE_BUILD_NUM',
+    'BRANCH_NAME',
+    'GIT_BRANCH',
+    'BUILD_SOURCEBRANCHNAME',
+    'BUILD_BUILDID',
+    'BITBUCKET_BRANCH',
+    'BITBUCKET_BUILD_NUMBER',
+    'TRAVIS_BRANCH',
+    'TRAVIS_BUILD_ID',
+    'BUILDKITE_BRANCH',
+    'BUILDKITE_BUILD_ID',
+    'CODEBUILD_WEBHOOK_HEAD_REF',
+    'CODEBUILD_BUILD_ID',
+    'BUILD_ID',
+    'BUILD_NUMBER',
+    'BAMBOO',
+];
+const CI_MARKER_VARS = [
+    'CI',
+    'CONTINUOUS_INTEGRATION',
+    'JENKINS_URL',
+    'TEAMCITY_VERSION',
+    'TF_BUILD',
+    'GITLAB_CI',
+];
+const FRAMEWORK_VARS = [
+    'PLAYWRIGHT_BROWSERS_PATH',
+    'PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD',
+    'PLAYWRIGHT_SKIP_BROWSER_GC',
+    'PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS',
+    'PLAYWRIGHT_HOST_PLATFORM_OVERRIDE',
+    'PLAYWRIGHT_DOWNLOAD_HOST',
+    'PLAYWRIGHT_CHROMIUM_DOWNLOAD_HOST',
+    'PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST',
+    'PLAYWRIGHT_WEBKIT_DOWNLOAD_HOST',
+    'PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT',
+    'PLAYWRIGHT_TEST_BASE_URL',
+    'PLAYWRIGHT_FORCE_TTY',
+    'PLAYWRIGHT_HTML_REPORT',
+    'PLAYWRIGHT_HTML_OUTPUT_DIR',
+    'PLAYWRIGHT_HTML_OPEN',
+    'PWDEBUG',
+    'PWTEST_CHILD_PROCESS_TIMEOUT',
+    'PWTEST_FORCE_EXIT_TIMEOUT',
+    'PWTEST_WATCH',
+    'PW_TEST_REPORTER',
+    'PW_TEST_REUSE_CONTEXT',
+    'PW_TEST_SOURCE_TRANSFORM',
+    'PW_TEST_HTML_REPORT_OPEN',
+    'PW_TEST_CONNECT_EXPOSE_NETWORK',
+    'PW_DISABLE_TS_ESM',
+    'PW_EXPERIMENTAL_SERVICE_WORKER_NETWORK_EVENTS',
+    'CYPRESS_VERSION',
+    'CYPRESS_INSTALL_BINARY',
+    'CYPRESS_CACHE_FOLDER',
+    'CYPRESS_RUN_BINARY',
+    'PUPPETEER_DISABLE_HEADLESS_WARNING',
+    'PUPPETEER_EXECUTABLE_PATH',
+    'PUPPETEER_SKIP_DOWNLOAD',
+    'SELENIUM_REMOTE_URL',
+    'SELENIUM_BROWSER',
+    'SELENIUM_SERVER_JAR',
+];
+// Remote-browser connect settings routinely embed cloud-grid credentials (tokens in the URL or headers).
+const FRAMEWORK_SENSITIVE_VARS = ['PW_TEST_CONNECT_WS_ENDPOINT', 'PW_TEST_CONNECT_HEADERS'];
+const KNOWN_APPLITOOLS_VARS = new Set([...APPLITOOLS_DIAGNOSTIC_VARS, ...APPLITOOLS_SENSITIVE_VARS]);
+const SENSITIVE_NAME_PATTERN = /KEY|TOKEN|SECRET|PASS|AUTH|PROXY|CREDENTIAL/;
+const MAX_VALUE_LENGTH = 10000;
+function logEnvSnapshot({ logger, env = process.env }) {
+    if (hasLogged)
+        return;
+    hasLogged = true;
+    try {
+        // Force maskLog: true as defense-in-depth for the env-snapshot block, regardless of the consumer's logger setting.
+        const childLogger = logger.extend({ tags: ['env-snapshot'], maskLog: true });
+        const groups = [
+            { label: 'applitools', names: APPLITOOLS_DIAGNOSTIC_VARS },
+            { label: 'applitools-sensitive', names: APPLITOOLS_SENSITIVE_VARS, sensitive: true },
+            { label: 'git-ci', names: GIT_CI_VARS },
+            { label: 'ci-markers', names: CI_MARKER_VARS },
+            { label: 'framework', names: FRAMEWORK_VARS },
+            { label: 'framework-sensitive', names: FRAMEWORK_SENSITIVE_VARS, sensitive: true },
+        ];
+        // With masking off the user already accepts raw values in the log, so widen to every
+        // APPLITOOLS_* var — this surfaces typos such as APPLITOOLS_LOGS_DIR.
+        if (isMaskLogDisabled(env)) {
+            const names = Object.keys(env)
+                .filter(name => name.startsWith('APPLITOOLS_') && !KNOWN_APPLITOOLS_VARS.has(name))
+                .sort();
+            groups.push({ label: 'applitools-other', names });
+        }
+        const isSensitive = (group, name) => group.sensitive || SENSITIVE_NAME_PATTERN.test(name);
+        // Two-pass: register every sensitive value with the logger mask set before
+        // emitting any line — masking only applies to values registered before the log call.
+        for (const group of groups) {
+            for (const name of group.names) {
+                if (!isSensitive(group, name))
+                    continue;
+                const value = safeRead(env, name);
+                if (value)
+                    childLogger.mask(value);
+            }
+        }
+        for (const group of groups) {
+            const entries = [];
+            for (const name of group.names) {
+                const raw = safeRead(env, name);
+                if (raw === undefined || raw === '')
+                    continue;
+                // Presence only for secrets, so the snapshot never carries one even when masking is off.
+                entries.push([name, isSensitive(group, name) ? '<set>' : trim(raw)]);
+            }
+            if (entries.length === 0)
+                continue;
+            childLogger.log(`[env-snapshot:${group.label}] ` + entries.map(([k, v]) => `${k}=${JSON.stringify(v)}`).join(' '));
+        }
+    }
+    catch {
+        // Best-effort diagnostics; never propagate. No re-log here — if `logger` is the
+        // source of the throw, calling it again just loops.
+    }
+}
+exports.logEnvSnapshot = logEnvSnapshot;
+function safeRead(env, name) {
+    try {
+        const v = env[name];
+        return typeof v === 'string' ? v : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+// Same rule the formatter applies via getEnvValue('MASK_LOG', 'boolean'): any value other than true/1 turns masking off.
+function isMaskLogDisabled(env) {
+    const value = safeRead(env, 'APPLITOOLS_MASK_LOG');
+    return value !== undefined && value !== 'null' && !['true', '1'].includes(value);
+}
+function trim(value) {
+    return value.length <= MAX_VALUE_LENGTH ? value : value.slice(0, MAX_VALUE_LENGTH);
+}
+/** @internal */
+function __resetLogEnvSnapshotForTests() {
+    hasLogged = false;
+}
+exports.__resetLogEnvSnapshotForTests = __resetLogEnvSnapshotForTests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.73.3",
+  "version": "4.74.0",
   "homepage": "https://applitools.com",
   "license": "SEE LICENSE IN LICENSE",
   "author": {
@@ -67,7 +67,7 @@
     "@applitools/screenshoter": "3.12.36",
     "@applitools/snippets": "2.9.10",
     "@applitools/socket": "1.3.18",
-    "@applitools/ufg-client": "1.24.2",
+    "@applitools/ufg-client": "1.25.0",
     "@applitools/utils": "1.15.3",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",

package/types/utils/log-env-snapshot.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { type Logger } from '@applitools/logger';
+export declare function logEnvSnapshot({ logger, env }: {
+    logger: Logger;
+    env?: NodeJS.ProcessEnv;
+}): void;
+/** @internal */
+export declare function __resetLogEnvSnapshotForTests(): void;