@sentry/cli 1.77.2 → 1.77.3

package/js/install.js

@@ -0,0 +1,305 @@
+'use strict';
+
+const fs = require('fs');
+const http = require('http');
+const os = require('os');
+const path = require('path');
+const crypto = require('crypto');
+const zlib = require('zlib');
+const stream = require('stream');
+const process = require('process');
+
+const HttpsProxyAgent = require('https-proxy-agent');
+const fetch = require('node-fetch');
+const ProgressBar = require('progress');
+const Proxy = require('proxy-from-env');
+// NOTE: Can be dropped in favor of `fs.mkdirSync(path, { recursive: true })` once we stop supporting Node 8.x
+const mkdirp = require('mkdirp');
+const which = require('which');
+
+const helper = require('./helper');
+const pkgInfo = require('../package.json');
+const Logger = require('./logger');
+
+function getLogStream(defaultStream) {
+  const logStream = process.env.SENTRYCLI_LOG_STREAM || defaultStream;
+
+  if (logStream === 'stdout') {
+    return process.stdout;
+  }
+
+  if (logStream === 'stderr') {
+    return process.stderr;
+  }
+
+  throw new Error(
+    `Incorrect SENTRYCLI_LOG_STREAM env variable. Possible values: 'stdout' | 'stderr'`
+  );
+}
+
+const ttyLogger = new Logger(getLogStream('stderr'));
+
+const CDN_URL =
+  process.env.SENTRYCLI_LOCAL_CDNURL ||
+  process.env.npm_config_sentrycli_cdnurl ||
+  process.env.SENTRYCLI_CDNURL ||
+  'https://downloads.sentry-cdn.com/sentry-cli';
+
+function shouldRenderProgressBar() {
+  const silentFlag = process.argv.some((v) => v === '--silent');
+  const silentConfig = process.env.npm_config_loglevel === 'silent';
+  // Leave `SENTRY_NO_PROGRESS_BAR` for backwards compatibility
+  const silentEnv = process.env.SENTRYCLI_NO_PROGRESS_BAR || process.env.SENTRY_NO_PROGRESS_BAR;
+  const ciEnv = process.env.CI === 'true';
+  // If any of possible options is set, skip rendering of progress bar
+  return !(silentFlag || silentConfig || silentEnv || ciEnv);
+}
+
+function getDownloadUrl(platform, arch) {
+  const releasesUrl = `${CDN_URL}/${pkgInfo.version}/sentry-cli`;
+  let archString = '';
+  switch (arch) {
+    case 'x64':
+      archString = 'x86_64';
+      break;
+    case 'x86':
+    case 'ia32':
+      archString = 'i686';
+      break;
+    case 'arm64':
+      archString = 'aarch64';
+      break;
+    case 'arm':
+      archString = 'armv7';
+      break;
+    default:
+      archString = arch;
+  }
+  switch (platform) {
+    case 'darwin':
+      return `${releasesUrl}-Darwin-universal`;
+    case 'win32':
+      return `${releasesUrl}-Windows-${archString}.exe`;
+    case 'linux':
+    case 'freebsd':
+      return `${releasesUrl}-Linux-${archString}`;
+    default:
+      return null;
+  }
+}
+
+function createProgressBar(name, total) {
+  const incorrectTotal = typeof total !== 'number' || Number.isNaN(total);
+
+  if (incorrectTotal || !shouldRenderProgressBar()) {
+    return {
+      tick: () => {},
+    };
+  }
+
+  const logStream = getLogStream('stdout');
+
+  if (logStream.isTTY) {
+    return new ProgressBar(`fetching ${name} :bar :percent :etas`, {
+      complete: '█',
+      incomplete: '░',
+      width: 20,
+      total,
+    });
+  }
+
+  let pct = null;
+  let current = 0;
+  return {
+    tick: (length) => {
+      current += length;
+      const next = Math.round((current / total) * 100);
+      if (next > pct) {
+        pct = next;
+        logStream.write(`fetching ${name} ${pct}%\n`);
+      }
+    },
+  };
+}
+
+function npmCache() {
+  const env = process.env;
+  return (
+    env.npm_config_cache ||
+    env.npm_config_cache_folder ||
+    env.npm_config_yarn_offline_mirror ||
+    (env.APPDATA ? path.join(env.APPDATA, 'npm-cache') : path.join(os.homedir(), '.npm'))
+  );
+}
+
+function getCachedPath(url) {
+  const digest = crypto.createHash('md5').update(url).digest('hex').slice(0, 6);
+
+  return path.join(
+    npmCache(),
+    'sentry-cli',
+    `${digest}-${path.basename(url).replace(/[^a-zA-Z0-9.]+/g, '-')}`
+  );
+}
+
+function getTempFile(cached) {
+  return `${cached}.${process.pid}-${Math.random().toString(16).slice(2)}.tmp`;
+}
+
+function validateChecksum(tempPath, name, logger) {
+  let storedHash;
+  try {
+    const checksums = fs.readFileSync(path.join(__dirname, '../checksums.txt'), 'utf8');
+    const entries = checksums.split('\n');
+    for (let i = 0; i < entries.length; i++) {
+      const [key, value] = entries[i].split('=');
+      if (key === name) {
+        storedHash = value;
+        break;
+      }
+    }
+  } catch (e) {
+    logger.log(
+      'Checksums are generated when the package is published to npm. They are not available directly in the source repository. Skipping validation.'
+    );
+    return;
+  }
+
+  if (!storedHash) {
+    logger.log(`Checksum for ${name} not found, skipping validation.`);
+    return;
+  }
+
+  const currentHash = crypto.createHash('sha256').update(fs.readFileSync(tempPath)).digest('hex');
+
+  if (storedHash !== currentHash) {
+    fs.unlinkSync(tempPath);
+    throw new Error(
+      `Checksum validation for ${name} failed.\nExpected: ${storedHash}\nReceived: ${currentHash}`
+    );
+  } else {
+    logger.log('Checksum validation passed.');
+  }
+}
+
+function checkVersion() {
+  return helper.execute(['--version']).then((output) => {
+    const version = output.replace('sentry-cli ', '').trim();
+    const expected = process.env.SENTRYCLI_LOCAL_CDNURL ? 'DEV' : pkgInfo.version;
+    if (version !== expected) {
+      throw new Error(`Unexpected sentry-cli version "${version}", expected "${expected}"`);
+    }
+  });
+}
+
+function downloadBinary(logger = ttyLogger) {
+  if (process.env.SENTRYCLI_SKIP_DOWNLOAD === '1') {
+    logger.log(`Skipping download because SENTRYCLI_SKIP_DOWNLOAD=1 detected.`);
+    return Promise.resolve();
+  }
+
+  const arch = os.arch();
+  const platform = os.platform();
+  const outputPath = helper.getPath();
+
+  if (process.env.SENTRYCLI_USE_LOCAL === '1') {
+    try {
+      const binPath = which.sync('sentry-cli');
+      logger.log(`Using local binary: ${binPath}`);
+      fs.copyFileSync(binPath, outputPath);
+      return Promise.resolve();
+    } catch (e) {
+      throw new Error(
+        'Configured installation of local binary, but it was not found.' +
+          'Make sure that `sentry-cli` executable is available in your $PATH or disable SENTRYCLI_USE_LOCAL env variable.'
+      );
+    }
+  }
+
+  const downloadUrl = getDownloadUrl(platform, arch);
+  if (!downloadUrl) {
+    return Promise.reject(new Error(`Unsupported target ${platform}-${arch}`));
+  }
+
+  const cachedPath = getCachedPath(downloadUrl);
+  if (fs.existsSync(cachedPath)) {
+    logger.log(`Using cached binary: ${cachedPath}`);
+    fs.copyFileSync(cachedPath, outputPath);
+    return Promise.resolve();
+  }
+
+  const proxyUrl = Proxy.getProxyForUrl(downloadUrl);
+  const agent = proxyUrl ? new HttpsProxyAgent(proxyUrl) : null;
+
+  logger.log(`Downloading from ${downloadUrl}`);
+
+  if (proxyUrl) {
+    logger.log(`Using proxy URL: ${proxyUrl}`);
+  }
+
+  return fetch(downloadUrl, {
+    agent,
+    compress: false,
+    headers: {
+      'accept-encoding': 'gzip, deflate, br',
+    },
+    redirect: 'follow',
+  })
+    .then((response) => {
+      if (!response.ok) {
+        throw new Error(
+          `Unable to download sentry-cli binary from ${downloadUrl}.\nServer returned ${response.status}: ${response.statusText}.`
+        );
+      }
+
+      const contentEncoding = response.headers.get('content-encoding');
+      let decompressor;
+      if (/\bgzip\b/.test(contentEncoding)) {
+        decompressor = zlib.createGunzip();
+      } else if (/\bdeflate\b/.test(contentEncoding)) {
+        decompressor = zlib.createInflate();
+      } else if (/\bbr\b/.test(contentEncoding)) {
+        decompressor = zlib.createBrotliDecompress();
+      } else {
+        decompressor = new stream.PassThrough();
+      }
+      const name = downloadUrl.match(/.*\/(.*?)$/)[1];
+      const total = parseInt(response.headers.get('content-length'), 10);
+      const progressBar = createProgressBar(name, total);
+      const tempPath = getTempFile(cachedPath);
+      mkdirp.sync(path.dirname(tempPath));
+
+      return new Promise((resolve, reject) => {
+        response.body
+          .on('error', (e) => reject(e))
+          .on('data', (chunk) => progressBar.tick(chunk.length))
+          .pipe(decompressor)
+          .pipe(fs.createWriteStream(tempPath, { mode: '0755' }))
+          .on('error', (e) => reject(e))
+          .on('close', () => resolve());
+      }).then(() => {
+        if (process.env.SENTRYCLI_SKIP_CHECKSUM_VALIDATION !== '1') {
+          validateChecksum(tempPath, name, logger);
+        }
+        fs.copyFileSync(tempPath, cachedPath);
+        fs.copyFileSync(tempPath, outputPath);
+        fs.unlinkSync(tempPath);
+      });
+    })
+    .then(() => {
+      return checkVersion();
+    })
+    .catch((error) => {
+      if (error instanceof fetch.FetchError) {
+        throw new Error(
+          `Unable to download sentry-cli binary from ${downloadUrl}.\nError code: ${error.code}`
+        );
+      } else {
+        throw error;
+      }
+    });
+}
+
+module.exports = {
+  downloadBinary,
+};

package/js/releases/index.js

@@ -50,7 +50,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the release has been created.
    * @memberof SentryReleases
    */
-  async new(release, options) {
+  new(release, options) {
     const args = ['releases', 'new', release].concat(helper.getProjectFlagsFromOptions(options));
     return this.execute(args, null);
   }
@@ -76,7 +76,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the commits have been associated
    * @memberof SentryReleases
    */
-  async setCommits(release, options) {
+  setCommits(release, options) {
     if (!options || (!options.auto && (!options.repo || !options.commit))) {
       throw new Error('options.auto, or options.repo and options.commit must be specified');
     }
@@ -95,6 +95,10 @@ class Releases {
       commitFlags.push('--ignore-missing');
     }
 
+    if (options.ignoreEmpty) {
+      commitFlags.push('--ignore-empty');
+    }
+
     return this.execute(['releases', 'set-commits', release].concat(commitFlags));
   }
 
@@ -106,7 +110,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the release has been finalized.
    * @memberof SentryReleases
    */
-  async finalize(release) {
+  finalize(release) {
     return this.execute(['releases', 'finalize', release], null);
   }
 
@@ -117,9 +121,10 @@ class Releases {
    * @returns {Promise.<string>} A promise that resolves to the version string.
    * @memberof SentryReleases
    */
-  async proposeVersion() {
-    const version = await this.execute(['releases', 'propose-version'], null);
-    return version.trim();
+  proposeVersion() {
+    return this.execute(['releases', 'propose-version'], null).then(
+      version => version && version.trim()
+    );
   }
 
   /**
@@ -140,15 +145,13 @@ class Releases {
    *   ignoreFile: null,          // path to a file with ignore rules
    *   rewrite: false,            // preprocess sourcemaps before uploading
    *   sourceMapReference: true,  // add a source map reference to source files
-   *   dedupe: true,              // deduplicate already uploaded files
    *   stripPrefix: [],           // remove certain prefices from filenames
    *   stripCommonPrefix: false,  // guess common prefices to remove from filenames
    *   validate: false,           // validate source maps and cancel the upload on error
    *   urlPrefix: '',             // add a prefix source map urls after stripping them
    *   urlSuffix: '',             // add a suffix source map urls after stripping them
    *   ext: ['js', 'map', 'jsbundle', 'bundle'],  // override file extensions to scan for
-   *   projects: ['node'],        // provide a list of projects
-   *   decompress: false          // decompress gzip files before uploading
+   *   projects: ['node']        // provide a list of projects
    * });
    *
    * @param {string} release Unique name of the release.
@@ -156,7 +159,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the upload has completed successfully.
    * @memberof SentryReleases
    */
-  async uploadSourceMaps(release, options) {
+  uploadSourceMaps(release, options) {
     if (!options || !options.include || !Array.isArray(options.include)) {
       throw new Error(
         '`options.include` must be a vaild array of paths and/or path descriptor objects.'
@@ -166,7 +169,7 @@ class Releases {
     // Each entry in the `include` array will map to an array of promises, which
     // will in turn contain one promise per literal path value. Thus `uploads`
     // will be an array of Promise arrays, which we'll flatten later.
-    const uploads = options.include.map((includeEntry) => {
+    const uploads = options.include.map(includeEntry => {
       let pathOptions;
       let uploadPaths;
 
@@ -197,7 +200,7 @@ class Releases {
         .concat(helper.getProjectFlagsFromOptions(options))
         .concat(['files', release, 'upload-sourcemaps']);
 
-      return uploadPaths.map((path) =>
+      return uploadPaths.map(path =>
         // `execute()` is async and thus we're returning a promise here
         this.execute(helper.prepareCommand([...args, path], SOURCEMAPS_SCHEMA, newOptions), true)
       );
@@ -218,7 +221,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the list comes back from the server.
    * @memberof SentryReleases
    */
-  async listDeploys(release) {
+  listDeploys(release) {
     return this.execute(['releases', 'deploys', release, 'list'], null);
   }
 
@@ -244,7 +247,7 @@ class Releases {
    * @returns {Promise} A promise that resolves when the deploy has been created.
    * @memberof SentryReleases
    */
-  async newDeploy(release, options) {
+  newDeploy(release, options) {
     if (!options || !options.env) {
       throw new Error('options.env must be a vaild name');
     }
@@ -258,7 +261,7 @@ class Releases {
    * @param {boolean} live We inherit stdio to display `sentry-cli` output directly.
    * @returns {Promise.<string>} A promise that resolves to the standard output.
    */
-  async execute(args, live) {
+  execute(args, live) {
     return helper.execute(args, live, this.options.silent, this.configFile, this.options);
   }
 }

package/js/releases/options/uploadSourcemaps.js

@@ -11,10 +11,6 @@ module.exports = {
     param: '--dist',
     type: 'string',
   },
-  decompress: {
-    param: '--decompress',
-    type: 'boolean',
-  },
   rewrite: {
     param: '--rewrite',
     invertedParam: '--no-rewrite',
@@ -24,10 +20,6 @@ module.exports = {
     invertedParam: '--no-sourcemap-reference',
     type: 'boolean',
   },
-  dedupe: {
-    invertedParam: '--no-dedupe',
-    type: 'boolean',
-  },
   stripPrefix: {
     param: '--strip-prefix',
     type: 'array',
@@ -52,8 +44,4 @@ module.exports = {
     param: '--ext',
     type: 'array',
   },
-  useArtifactBundle: {
-    param: '--use-artifact-bundle',
-    type: 'boolean',
-  },
 };

package/package.json

@@ -1,45 +1,30 @@
 {
   "name": "@sentry/cli",
-  "version": "1.77.2",
+  "version": "1.77.3",
   "description": "A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/cli/",
-  "repository": "git://github.com/getsentry/sentry-cli.git",
   "homepage": "https://docs.sentry.io/hosted/learn/cli/",
-  "author": "Sentry",
   "license": "BSD-3-Clause",
+  "keywords": [
+    "sentry",
+    "sentry-cli",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/getsentry/sentry-cli"
+  },
+  "bugs": {
+    "url": "https://github.com/getsentry/sentry-cli/issues"
+  },
   "engines": {
-    "node": ">= 10"
+    "node": ">= 8"
   },
   "main": "js/index.js",
-  "types": "js/index.d.ts",
   "bin": {
     "sentry-cli": "bin/sentry-cli"
   },
-  "dependencies": {
-    "https-proxy-agent": "^5.0.0",
-    "node-fetch": "^2.6.7",
-    "progress": "^2.0.3",
-    "proxy-from-env": "^1.1.0",
-    "which": "^2.0.2"
-  },
-  "devDependencies": {
-    "@vercel/nft": "^0.22.1",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.5.0",
-    "jest": "^27.5.1",
-    "npm-run-all": "^4.1.5",
-    "prettier": "2.8.8"
-  },
-  "optionalDependencies": {
-    "@sentry/cli-darwin": "1.77.2",
-    "@sentry/cli-linux-arm": "1.77.2",
-    "@sentry/cli-linux-arm64": "1.77.2",
-    "@sentry/cli-linux-i686": "1.77.2",
-    "@sentry/cli-linux-x64": "1.77.2",
-    "@sentry/cli-win32-i686": "1.77.2",
-    "@sentry/cli-win32-x64": "1.77.2"
-  },
   "scripts": {
-    "postinstall": "node ./scripts/install.js",
+    "install": "node ./scripts/install.js",
     "fix": "npm-run-all fix:eslint fix:prettier",
     "fix:eslint": "eslint --fix bin/* scripts/**/*.js js/**/*.js",
     "fix:prettier": "prettier --write bin/* scripts/**/*.js js/**/*.js",
@@ -50,15 +35,36 @@
     "test:prettier": "prettier --check  bin/* scripts/**/*.js js/**/*.js",
     "test:vercel-nft": "node scripts/test-vercel-nft.js"
   },
+  "dependencies": {
+    "https-proxy-agent": "^5.0.0",
+    "mkdirp": "^0.5.5",
+    "node-fetch": "^2.6.7",
+    "progress": "^2.0.3",
+    "proxy-from-env": "^1.1.0",
+    "which": "^2.0.2"
+  },
+  "devDependencies": {
+    "@vercel/nft": "^0.22.1",
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb-base": "^14.1.0",
+    "eslint-config-prettier": "^6.10.1",
+    "eslint-plugin-import": "^2.20.2",
+    "jest": "^25.3.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^1.19.1"
+  },
   "jest": {
-    "collectCoverage": true,
+    "collectCoverage": false,
     "testEnvironment": "node",
     "testPathIgnorePatterns": [
-      "<rootDir>/src"
+      "src/utils"
     ]
   },
   "volta": {
-    "node": "20.10.0",
+    "node": "10.24.1",
     "yarn": "1.22.19"
+  },
+  "publishConfig": {
+    "tag": "v1"
   }
 }

package/scripts/build-in-docker.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -eux
 
-DOCKER_IMAGE="messense/rust-musl-cross:${DOCKER_TAG}"
+DOCKER_IMAGE="getsentry/rust-musl-cross:${DOCKER_TAG}"
 BUILD_DIR="/work"
 
 DOCKER_RUN_OPTS="
@@ -9,6 +9,7 @@ DOCKER_RUN_OPTS="
   -v $(pwd):${BUILD_DIR}:ro
   -v $(pwd)/target:${BUILD_DIR}/target
   -v $HOME/.cargo/registry:/root/.cargo/registry
+  -e ARMV7_UNKNOWN_LINUX_MUSLEABI_OPENSSL_NO_VENDOR=1
   ${DOCKER_IMAGE}
 "
 

package/scripts/bump-version.sh

@@ -21,17 +21,4 @@ cargo update -p sentry-cli
 
 # Do not tag and commit changes made by "npm version"
 export npm_config_git_tag_version=false
-
-# Bump main sentry cli npm package
 npm version "${TARGET}"
-
-# Bump the binary npm distributions
-for dir in $SCRIPT_DIR/../npm-binary-distributions/*; do
-    cd $dir
-    npm version "${TARGET}"
-    cd -
-done
-
-# Update the optional deps in the main cli npm package
-# Requires jq to be installed - should be installed ootb on github runners
-jq '.optionalDependencies |= map_values("'"${TARGET}"'")' $SCRIPT_DIR/../package.json > package.json.tmp && mv package.json.tmp $SCRIPT_DIR/../package.json