@automattic/vip 4.0.13 → 4.1.1

package/dist/commands/export-sql.js

@@ -16,10 +16,14 @@ var _downloadFile = require("../lib/http/download-file");
 var _liveBackupCopy = _interopRequireWildcard(require("../lib/live-backup-copy"));
 var liveBackupCopy = _liveBackupCopy;
 var _retry = require("../lib/retry");
+var _userError = _interopRequireDefault(require("../lib/user-error"));
 var _utils = require("../lib/utils");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const EXPORT_SQL_PROGRESS_POLL_INTERVAL = 1000;
+
+// Maximum allowed size for a live backup copy configuration file (500 KB).
+const MAX_LIVE_BACKUP_CONFIG_SIZE_BYTES = 500 * 1024;
 const BACKUP_AND_JOB_STATUS_QUERY = (0, _graphqlTag.default)`
 	query AppBackupAndJobStatus($appId: Int!, $envId: Int!) {
 		app(id: $appId) {
@@ -455,10 +459,10 @@ class ExportSQLCommand {
   }
   async generateLiveBackupCopy() {
     if (!this.liveBackupCopyCLIOptions) {
-      throw new Error('Configuration file is required for live backup copy.');
+      throw new _userError.default('Configuration file is required for live backup copy.');
     }
     if (!this.app.id || !this.env.id) {
-      throw new Error('App ID and Environment ID are required to start live backup copy.');
+      throw new _userError.default('App ID and Environment ID are required to start live backup copy.');
     }
     const config = this.getLiveBackupConfigFromCLIOptions();
     try {
@@ -478,7 +482,7 @@ class ExportSQLCommand {
       this.progressTracker.stepSuccess(this.steps.DOWNLOAD_LINK, [this.generateDownloadURLOutputString(result.url)]);
       return result;
     } catch (err) {
-      const message = err instanceof Error ? err.message : 'Unknown error';
+      const message = (0, _utils.parseApiError)(err) ?? 'Unknown error';
       await this.track('error', {
         error_type: 'live_backup_copy',
         error_message: message,
@@ -512,17 +516,23 @@ class ExportSQLCommand {
     };
   }
   loadLiveBackupCopyConfig(configFile) {
-    if (!_fs.default.existsSync(configFile)) {
-      throw new Error(`Configuration file not found: ${configFile}`);
-    }
     try {
-      return JSON.parse(_fs.default.readFileSync(configFile, 'utf-8'));
+      // Read the file once to avoid a check-then-use race condition.
+      const fileContents = _fs.default.readFileSync(configFile, 'utf-8');
+      const size = Buffer.byteLength(fileContents);
+      if (size > MAX_LIVE_BACKUP_CONFIG_SIZE_BYTES) {
+        throw new _userError.default(`Configuration file is too large (${(0, _format.formatBytes)(size)}); the maximum allowed size is ${(0, _format.formatBytes)(MAX_LIVE_BACKUP_CONFIG_SIZE_BYTES)}. For large or complex exports, use the \`--wpcli-command\` option instead.`);
+      }
+      return JSON.parse(fileContents);
     } catch (err) {
+      if (err instanceof _userError.default) {
+        throw err;
+      }
       const errMessage = err instanceof Error ? err.message : 'Unknown error';
       if (err instanceof SyntaxError) {
-        throw new Error(`Invalid JSON in configuration file: ${configFile} - ${errMessage}`);
+        throw new _userError.default(`Invalid JSON in configuration file: ${configFile} - ${errMessage}`);
       }
-      throw new Error(`Error reading configuration file: ${configFile} - ${errMessage}`);
+      throw new _userError.default(`Error reading configuration file: ${configFile} - ${errMessage}`);
     }
   }
 }

package/dist/lib/utils.js

@@ -79,19 +79,49 @@ function getAbsolutePath(filePath) {
 }
 
 /**
- * Parse error object and return probable error.
+ * Extract a message from a raw HTTP response body (Apollo's `ServerError.bodyText`).
  *
- * @param {Error} Error object
+ * The body may be either `{"status":"error","message":"..."}` (e.g. a 413 whose
+ * top-level message is only `Received status code 413`) or a GraphQL
+ * `{"errors":[{"message":"..."}]}` payload.
+ */
+function parseJSONBodyErrorMessage(bodyText) {
+  try {
+    const body = JSON.parse(bodyText);
+    if (body?.errors?.[0]?.message) {
+      return body.errors[0].message;
+    }
+    if (body?.message) {
+      return body.message;
+    }
+  } catch {
+    // Body wasn't JSON; nothing to extract.
+  }
+  return null;
+}
+/**
+ * Parse error object and return probable error.
  *
- * @return {string|null} Error string when error was found, otherwise null.
+ * Accepts either a known API error shape or an `unknown` value (e.g. a caught
+ * error), so callers do not need to cast before passing it in.
  */
-function parseApiError(err) {
+function parseApiError(error) {
+  const err = error;
   if (err?.networkError?.message) {
     return err?.networkError?.message;
   }
   if (err?.graphQLErrors?.[0]?.message) {
     return err.graphQLErrors[0].message;
   }
+
+  // Apollo's `ServerError` exposes the raw HTTP response body as `bodyText`,
+  // which often holds a more specific message than the generic top-level one.
+  if (typeof err?.bodyText === 'string') {
+    const bodyTextMessage = parseJSONBodyErrorMessage(err.bodyText);
+    if (bodyTextMessage) {
+      return bodyTextMessage;
+    }
+  }
   if (err?.message) {
     return err?.message;
   }

package/docs/RELEASING.md

@@ -76,6 +76,12 @@ You can release either using GitHub Actions or locally.
 
 This is the preferred method for pushing out the latest release. The workflow runs a bunch of validations, generates a build, bump versions + tags, pushes out to npm, and bumps to the next dev version.
 
+The repository uses `package-lock.json` for npm 12 development and CI installs. An identical
+`npm-shrinkwrap.json` is published with npm 11 so npm 11 and older consumers retain a locked CLI
+dependency tree. Run `npm run sync:shrinkwrap` after changing `package-lock.json`; CI rejects drift
+between the two files. The publish workflows intentionally use npm 11 because npm 12 excludes
+`npm-shrinkwrap.json` from package tarballs.
+
 Please keep in mind internal guidelines before releasing.
 
 To release, follow these steps:
@@ -119,7 +125,7 @@ To publish locally, follow these steps:
 1. Push the tag to GitHub (`git push --tags`)
 1. Push the trunk branch `git push`
 1. Make sure you're part of the Automattic organization in npm
-1. Publish the release to npm (`npm publish --access public`) the script will do some extra checks (
+1. Use npm 11 and publish the release (`npx --yes --package=npm@11 npm publish --access public`). The script will do some extra checks (
    node version, branch, etc) to ensure everything is correct. If all looks good, the new version
    will be published and you can proceed.
 1. Edit [the release on GitHub](https://github.com/Automattic/vip-cli/releases) to include a description
@@ -137,8 +143,8 @@ In order to do that, please follow this:
 
 <summary><details>
 
-1. Manually change the version in `package.json` and `package-lock.json` to a dev version. Example: `1.4.0-dev1`
-1. Run `npm publish --tag next` (When `--tag` is specified, we bypass the usual branch protection that doesn't allow you to publish form a brunch other than `trunk`).
+1. Set the dev version with npm 11 so both lockfiles remain synchronized. Example: `npx --yes --package=npm@11 npm version --no-git-tag-version 1.4.0-dev1`.
+1. Run `npx --yes --package=npm@11 npm publish --tag next` (When `--tag` is specified, we bypass the usual branch protection that doesn't allow you to publish form a brunch other than `trunk`).
 
 You can repeat this with every new version until you're happy with your version and ready to a public release. We currently don't support multiple branches for multiple versions. When it's the case, this process needs to be done for every version in every branch.
 

package/helpers/sync-shrinkwrap.js

@@ -0,0 +1,32 @@
+const { copyFileSync, readFileSync } = require( 'node:fs' );
+const path = require( 'node:path' );
+
+const PACKAGE_LOCK = 'package-lock.json';
+const NPM_SHRINKWRAP = 'npm-shrinkwrap.json';
+
+function syncShrinkwrap( { cwd = process.cwd(), check = false } = {} ) {
+	const packageLockPath = path.join( cwd, PACKAGE_LOCK );
+	const shrinkwrapPath = path.join( cwd, NPM_SHRINKWRAP );
+
+	if ( check ) {
+		const packageLock = readFileSync( packageLockPath );
+		const shrinkwrap = readFileSync( shrinkwrapPath );
+		if ( ! packageLock.equals( shrinkwrap ) ) {
+			throw new Error( `${ NPM_SHRINKWRAP } is out of sync with ${ PACKAGE_LOCK }` );
+		}
+		return;
+	}
+
+	copyFileSync( packageLockPath, shrinkwrapPath );
+}
+
+if ( require.main === module ) {
+	try {
+		syncShrinkwrap( { check: process.argv.includes( '--check' ) } );
+	} catch ( error ) {
+		console.error( error.message );
+		process.exitCode = 1;
+	}
+}
+
+module.exports = { syncShrinkwrap };