@scrymore/scry-deployer 0.12.4-nightly.20261010032437 → 0.12.4

package/README.md

@@ -1073,6 +1073,10 @@ otherwise quote in full.
 
 Nothing is reported on a successful run.
 
+Your own mistakes (a missing or wrong `--dir`, a folder with no images, a missing key or
+env var) print a message and exit 1 but are not reported. Nothing is reported when
+`NODE_ENV=test` or `CI` is set to a true value.
+
 **To opt out**, set either variable:
 
 ```bash
@@ -1080,7 +1084,7 @@ export SCRY_TELEMETRY=0     # Scry-specific
 export DO_NOT_TRACK=1       # respected across many CLI tools
 ```
 
-Both are honoured everywhere, including CI.
+Both are honoured everywhere.
 
 ## 🔧 Troubleshooting the Init Command
 

package/bin/cli.js

@@ -9,7 +9,7 @@ const os = require('os');
 const { zipDirectory } = require('../lib/archive.js');
 const { getApiClient, uploadBuild, sanitizeServerText } = require('../lib/apiClient.js');
 const { createLogger } = require('../lib/logger.js');
-const { ApiError } = require('../lib/errors.js');
+const { ApiError, UserInputError } = require('../lib/errors.js');
 const { loadConfig } = require('../lib/config.js');
 const { captureScreenshots } = require('../lib/screencap.js');
 const { analyzeStorybook } = require('../lib/analysis.js');
@@ -651,11 +651,16 @@ async function handleError(error, argv) {
         logger.debug(err.stack);
     }
 
-    // Report with an allowlisted subset of argv. Sending argv wholesale shipped
-    // the customer's --api-key to Sentry on every error.
-    captureCliError(err, argv);
-    // Ensure the event is sent before the process exits
-    try { await flushTelemetry(2000); } catch { /* telemetry must never mask the real error */ }
+    // A user's own mistake (wrong folder, no images, missing env var) is printed above with
+    // how to fix it and exits 1; it is not a defect, so it is not reported (it only spent
+    // error-reporting quota). Everything else is reported.
+    if (!(err instanceof UserInputError)) {
+        // Report with an allowlisted subset of argv. Sending argv wholesale shipped
+        // the customer's --api-key to Sentry on every error.
+        captureCliError(err, argv);
+        // Ensure the event is sent before the process exits
+        try { await flushTelemetry(2000); } catch { /* telemetry must never mask the real error */ }
+    }
 
     process.exit(1);
 }
@@ -775,15 +780,15 @@ async function main() {
 
                 // Validate required fields
                 if (!config.dir) {
-                    throw new Error('--dir is required. You can provide it via CLI arguments, config file, or environment variables.');
+                    throw new UserInputError('--dir is required. You can provide it via CLI arguments, config file, or environment variables.');
                 }
 
                 // Validate directory exists and is valid
                 if (!fs.existsSync(config.dir)) {
-                    throw new Error(`Directory not found at path: ${config.dir}`);
+                    throw new UserInputError(`Directory not found at path: ${config.dir}`);
                 }
                 if (!fs.lstatSync(config.dir).isDirectory()) {
-                    throw new Error(`Path is not a directory: ${config.dir}`);
+                    throw new UserInputError(`Path is not a directory: ${config.dir}`);
                 }
 
                 // Advisory, bounded to 2 s, never fails the deploy.
@@ -1119,14 +1124,14 @@ async function main() {
                 const config = loadConfig(argv);
 
                 if (!config.dir) {
-                    throw new Error('--dir is required. Provide a path to the image directory.');
+                    throw new UserInputError('--dir is required. Provide a path to the image directory.');
                 }
 
                 if (!fs.existsSync(config.dir)) {
-                    throw new Error(`Directory not found: ${config.dir}`);
+                    throw new UserInputError(`Directory not found: ${config.dir}`);
                 }
                 if (!fs.lstatSync(config.dir).isDirectory()) {
-                    throw new Error(`Path is not a directory: ${config.dir}`);
+                    throw new UserInputError(`Path is not a directory: ${config.dir}`);
                 }
 
                 if (config.local) {
@@ -1182,7 +1187,7 @@ function resolveLocalProcessingKeys(config) {
         const envName = env.split(' ')[0];
         resolved[key] = config[key] || process.env[envName] || (key === 'jinaApiKey' ? process.env.JINA_API_KEY : undefined);
         if (!resolved[key]) {
-            throw new Error(`${flag} or ${env} env var is required for local mode`);
+            throw new UserInputError(`${flag} or ${env} env var is required for local mode`);
         }
     }
 

package/lib/errors.js

@@ -43,8 +43,22 @@ class UploadError extends AppError {
   }
 }
 
+/**
+ * The user's own mistake, with a message that already says how to fix it: a
+ * missing or wrong folder, a folder with no images, a required key or env var
+ * that was not given. The CLI prints the message and exits 1 like any other
+ * error, but it is not a defect in the CLI, so it is never sent to error
+ * reporting (it would only spend quota on something we cannot fix).
+ */
+class UserInputError extends AppError {
+  constructor(message) {
+    super(message);
+  }
+}
+
 module.exports = {
   AppError,
+  UserInputError,
   FileSystemError,
   ApiError,
   UploadError,

package/lib/imageUpload.js

@@ -4,6 +4,7 @@ const os = require('os');
 const { zipDirectory } = require('./archive.js');
 const { getApiClient, requestPresignedUrl, putToPresignedUrl } = require('./apiClient.js');
 const { createLogger } = require('./logger.js');
+const { UserInputError } = require('./errors.js');
 
 const IMAGE_EXTENSIONS = new Set(['.png', '.jpg', '.jpeg']);
 
@@ -59,7 +60,7 @@ async function runQueueImageUpload(config) {
   logger.info('Scanning for images...');
   const imageFiles = findImageFiles(config.dir);
   if (imageFiles.length === 0) {
-    throw new Error(`No image files (.png, .jpg, .jpeg) found in: ${config.dir}`);
+    throw new UserInputError(`No image files (.png, .jpg, .jpeg) found in: ${config.dir}`);
   }
   logger.success(`Found ${imageFiles.length} images`);
 

package/lib/localImageProcessing.js

@@ -3,6 +3,7 @@ const path = require('path');
 const crypto = require('crypto');
 const { XMLParser } = require('fast-xml-parser');
 const { createLogger } = require('./logger.js');
+const { UserInputError } = require('./errors.js');
 const { findImageFiles } = require('./imageUpload.js');
 const { sanitizeServerText } = require('./apiClient.js');
 
@@ -659,7 +660,7 @@ async function runLocalImageProcessing(config) {
   logger.info('Step 1: Scanning for images...');
   const imageFiles = findImageFiles(config.dir);
   if (imageFiles.length === 0) {
-    throw new Error(`No image files (.png, .jpg, .jpeg) found in: ${config.dir}`);
+    throw new UserInputError(`No image files (.png, .jpg, .jpeg) found in: ${config.dir}`);
   }
   logger.success(`Found ${imageFiles.length} images (${elapsed()})`);
 

package/lib/telemetry.js

@@ -22,6 +22,7 @@ const Sentry = require('@sentry/node');
  */
 
 const { version: PACKAGE_VERSION } = require('../package.json');
+const { UserInputError } = require('./errors.js');
 
 const DSN =
   'https://c66ce229a1db2289f145eebd02436d9c@o4507889391828992.ingest.us.sentry.io/4510699330732032';
@@ -115,7 +116,19 @@ function scrub(value) {
 function telemetryDisabled() {
   const off = (v) => v === '1' || v === 'true' || v === 'yes';
   return off(process.env.DO_NOT_TRACK) || process.env.SCRY_TELEMETRY === '0' ||
-    process.env.SCRY_TELEMETRY === 'false';
+    process.env.SCRY_TELEMETRY === 'false' || isAutomatedRun();
+}
+
+/**
+ * A test run or a CI job: failures there are expected and routine (our own
+ * suites run the real CLI against deliberately broken input, and a CI job
+ * retries), so they never use error-reporting quota. `CI` counts when it is
+ * set to anything but an explicit false value.
+ */
+function isAutomatedRun() {
+  const ci = process.env.CI;
+  const ciOn = ci !== undefined && ci !== '' && ci !== '0' && ci.toLowerCase() !== 'false';
+  return process.env.NODE_ENV === 'test' || ciOn;
 }
 
 /** Only the fields on the allowlist, and scrubbed even then. */
@@ -185,6 +198,8 @@ function initTelemetry() {
 /** Report an error with only the context that is safe to leave the machine. */
 function captureCliError(error, argv) {
   if (telemetryDisabled()) return;
+  // Second line of defence behind handleError: a user's own mistake is never reported.
+  if (error instanceof UserInputError) return;
 
   Sentry.withScope((scope) => {
     const safe = sanitizeArgv(argv);
@@ -210,6 +225,7 @@ module.exports = {
   captureCliError,
   flushTelemetry,
   telemetryDisabled,
+  isAutomatedRun,
   sanitizeArgv,
   redactArgv,
   scrub,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrymore/scry-deployer",
-  "version": "0.12.4-nightly.20261010032437",
+  "version": "0.12.4",
   "description": "A CLI to automate the deployment of Storybook static builds.",
   "main": "index.js",
   "bin": {