@sentry/cli 1.77.2 → 1.77.3

package/scripts/install.js

@@ -2,348 +2,30 @@
 
 'use strict';
 
+const http = require('http');
 const fs = require('fs');
-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 fetch = require('node-fetch');
-const HttpsProxyAgent = require('https-proxy-agent');
-const ProgressBar = require('progress');
-const Proxy = require('proxy-from-env');
-const which = require('which');
-
-const helper = require('../js/helper');
-const pkgInfo = require('../package.json');
-const Logger = require('../js/logger');
-
-const logger = 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 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'`
-  );
-}
-
-function shouldRenderProgressBar() {
-  const silentFlag = process.argv.some((v) => v === '--silent');
-  const silentConfig = process.env.npm_config_loglevel === 'silent';
-  const silentEnv = process.env.SENTRYCLI_NO_PROGRESS_BAR;
-  const ciEnv = process.env.CI === 'true' || process.env.CI === '1';
-  const notTTY = !process.stdout.isTTY;
-  // If any of possible options is set, skip rendering of progress bar
-  return !(silentFlag || silentConfig || silentEnv || ciEnv || notTTY);
-}
-
-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':
-      // Windows arm machines can run x64 binaries
-      if (arch === 'arm64') {
-        archString = 'x86_64';
-      }
-      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,
+const { downloadBinary } = require('../js/install');
+
+if (process.env.SENTRYCLI_LOCAL_CDNURL) {
+  // For testing, mock the CDN by spawning a local server
+  const server = http.createServer((request, response) => {
+    const contents = fs.readFileSync(path.join(__dirname, '../js/__mocks__/sentry-cli'));
+    response.writeHead(200, {
+      'Content-Type': 'application/octet-stream',
+      'Content-Length': String(contents.byteLength),
     });
-  }
-
-  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 keys = ['npm_config_cache', 'npm_config_cache_folder', 'npm_config_yarn_offline_mirror'];
-
-  for (let key of [...keys, ...keys.map((k) => k.toUpperCase())]) {
-    if (process.env[key]) return process.env[key];
-  }
-
-  if (process.env.APPDATA) {
-    return path.join(process.env.APPDATA, 'npm-cache');
-  }
-
-  return 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) {
-  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.');
-  }
-}
-
-async function downloadBinary() {
-  const arch = os.arch();
-  const platform = os.platform();
-  const outputPath = helper.getFallbackBinaryPath();
-
-  if (process.env.SENTRYCLI_USE_LOCAL === '1') {
-    try {
-      const binPaths = which.sync('sentry-cli', { all: true });
-      if (!binPaths.length) throw new Error('Binary not found');
-      const binPath = binPaths[binPaths.length - 1];
-      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) {
-    throw 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;
-  }
-
-  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}`);
-  }
-
-  let response;
-  try {
-    response = await fetch(downloadUrl, {
-      agent,
-      compress: false,
-      headers: {
-        'accept-encoding': 'gzip, deflate, br',
-      },
-      redirect: 'follow',
-    });
-  } catch (error) {
-    let errorMsg = `Unable to download sentry-cli binary from ${downloadUrl}.\nError message: ${error.message}`;
-    if (error.code) {
-      errorMsg += `\nError code: ${error.code}`;
-    }
-    throw new Error(errorMsg);
-  }
-
-  if (!response.ok) {
-    let errorMsg = `Unable to download sentry-cli binary from ${downloadUrl}.\nServer returned: ${response.status}`;
-    if (response.statusText) {
-      errorMsg += ` - ${response.statusText}`;
-    }
-    throw new Error(errorMsg);
-  }
-
-  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];
-  let downloadedBytes = 0;
-  const totalBytes = parseInt(response.headers.get('content-length'), 10);
-  const progressBar = createProgressBar(name, totalBytes);
-  const tempPath = getTempFile(cachedPath);
-  fs.mkdirSync(path.dirname(tempPath), { recursive: true });
-
-  await new Promise((resolve, reject) => {
-    response.body
-      .on('error', (e) => reject(e))
-      .on('data', (chunk) => {
-        downloadedBytes += chunk.length;
-        progressBar.tick(chunk.length);
-      })
-      .pipe(decompressor)
-      .pipe(fs.createWriteStream(tempPath, { mode: '0755' }))
-      .on('error', (e) => reject(e))
-      .on('close', () => {
-        if (downloadedBytes >= totalBytes) {
-          resolve();
-        } else {
-          reject(new Error('connection interrupted'));
-        }
-      });
+    response.end(contents);
   });
 
-  if (process.env.SENTRYCLI_SKIP_CHECKSUM_VALIDATION !== '1') {
-    validateChecksum(tempPath, name);
-  }
-
-  fs.copyFileSync(tempPath, cachedPath);
-  fs.copyFileSync(tempPath, outputPath);
-  fs.unlinkSync(tempPath);
-}
-
-async function checkVersion() {
-  const output = await helper.execute(['--version']);
-  const version = output.replace('sentry-cli ', '').trim();
-  const expected = pkgInfo.version;
-  if (version !== expected) {
-    throw new Error(`Unexpected sentry-cli version "${version}", expected "${expected}"`);
-  }
-}
-
-if (process.env.SENTRYCLI_SKIP_DOWNLOAD === '1') {
-  logger.log(`Skipping download because SENTRYCLI_SKIP_DOWNLOAD=1 detected.`);
-  process.exit(0);
-}
-
-const { packageName: distributionPackageName, subpath: distributionSubpath } =
-  helper.getDistributionForThisPlatform();
-
-if (distributionPackageName === undefined) {
-  helper.throwUnsupportedPlatformError();
+  server.listen(8999);
+  process.on('exit', () => server.close());
 }
 
-try {
-  require.resolve(`${distributionPackageName}/${distributionSubpath}`);
-  // If the `resolve` call succeeds it means a binary was installed successfully via optional dependencies so we can skip the manual postinstall download.
-  process.exit(0);
-} catch (e) {
-  // Optional dependencies likely didn't get installed - proceed with fallback downloading manually
-  // Log message inspired by esbuild: https://github.com/evanw/esbuild/blob/914f6080c77cfe32a54888caa51ca6ea13873ce9/lib/npm/node-install.ts#L253
-  logger.log(
-    `Sentry CLI failed to locate the "${distributionPackageName}" package after installation!
-
-This can happen if you use an option to disable optional dependencies during installation, like "--no-optional", "--ignore-optional", or "--omit=optional". Sentry CLI uses the "optionalDependencies" package.json feature to install the correct binary for your platform and operating system. This post-install script will now try to work around this by manually downloading the Sentry CLI binary from the Sentry CDN. If this fails, you need to remove the "--no-optional", "--ignore-optional", and "--omit=optional" flags for Sentry CLI to work.`
-  );
-
-  downloadBinary()
-    .then(() => checkVersion())
-    .then(() => {
-      process.exit(0);
-    })
-    .catch((e) => {
-      console.error(e);
-      process.exit(1);
-    });
-}
+downloadBinary()
+  .then(() => process.exit(0))
+  .catch(e => {
+    // eslint-disable-next-line no-console
+    console.error(e.toString());
+    process.exit(1);
+  });

package/scripts/test-vercel-nft.js

@@ -1,16 +1,27 @@
+const major = process.versions.node.split('.')[0];
+
+// @vercel/nft doe not support Node.js v8
+if (major < 10) {
+  process.exit(0);
+}
+
+// eslint-disable-next-line import/no-extraneous-dependencies
 const { nodeFileTrace } = require('@vercel/nft');
 
 const entryPoint = require.resolve('..');
 
 // Trace the module entrypoint
-nodeFileTrace([entryPoint]).then((result) => {
+nodeFileTrace([entryPoint]).then(result => {
+  // eslint-disable-next-line no-console
   console.log('@vercel/nft traced dependencies:', Array.from(result.fileList));
 
   // If either binary is picked up, fail the test
   if (result.fileList.has('sentry-cli') || result.fileList.has('sentry-cli.exe')) {
+    // eslint-disable-next-line no-console
     console.error('ERROR: The sentry-cli binary should not be found by @vercel/nft');
     process.exit(-1);
   } else {
+    // eslint-disable-next-line no-console
     console.log('The sentry-cli binary was not traced by @vercel/nft');
   }
 });

package/scripts/wheels

@@ -1,174 +0,0 @@
-#!/usr/bin/env python3
-import argparse
-import base64
-import hashlib
-import os.path
-import shutil
-import tempfile
-import zipfile
-from typing import NamedTuple
-
-
-class Wheel(NamedTuple):
-    src: str
-    plat: str
-    exe: str = 'sentry-cli'
-
-
-WHEELS = (
-    Wheel(
-        src='sentry-cli-Darwin-arm64',
-        plat='macosx_11_0_arm64',
-    ),
-    Wheel(
-        src='sentry-cli-Darwin-universal',
-        plat='macosx_11_0_universal2',
-    ),
-    Wheel(
-        src='sentry-cli-Darwin-x86_64',
-        plat='macosx_10_15_x86_64',
-    ),
-    Wheel(
-        src='sentry-cli-Linux-aarch64',
-        plat='manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64',
-    ),
-    Wheel(
-        src='sentry-cli-Linux-armv7',
-        plat='manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l',
-    ),
-    Wheel(
-        src='sentry-cli-Linux-i686',
-        plat='manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686',
-    ),
-    Wheel(
-        src='sentry-cli-Linux-x86_64',
-        plat='manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64',
-    ),
-    Wheel(
-        src='sentry-cli-Windows-i686.exe',
-        plat='win32',
-        exe='sentry-cli.exe',
-    ),
-    Wheel(
-        src='sentry-cli-Windows-x86_64.exe',
-        plat='win_amd64',
-        exe='sentry-cli.exe',
-    ),
-)
-
-
-def main() -> int:
-    parser = argparse.ArgumentParser()
-    parser.add_argument('--binaries', required=True)
-    parser.add_argument('--base', required=True)
-    parser.add_argument('--dest', required=True)
-    args = parser.parse_args()
-
-    expected = {wheel.src for wheel in WHEELS}
-    received = set(os.listdir(args.binaries))
-    if expected < received:
-        raise SystemExit(
-            f'Unexpected binaries:\n\n'
-            f'- extra: {", ".join(sorted(received - expected))}\n'
-            f'- missing: {", ".join(sorted(expected - received))}'
-        )
-
-    sdist_path = wheel_path = None
-    for fname in os.listdir(args.base):
-        if fname.endswith('.tar.gz'):
-            sdist_path = os.path.join(args.base, fname)
-        elif fname.endswith('.whl'):
-            wheel_path = os.path.join(args.base, fname)
-        else:
-            raise SystemExit(f'unexpected file in `--base`: {fname}')
-
-    if sdist_path is None or wheel_path is None:
-        raise SystemExit('expected wheel and sdist in `--base`')
-
-    os.makedirs(args.dest, exist_ok=True)
-    shutil.copy(sdist_path, args.dest)
-
-    for wheel in WHEELS:
-        binary_src = os.path.join(args.binaries, wheel.src)
-        binary_size = os.stat(binary_src).st_size
-        with open(binary_src, 'rb') as bf:
-            digest = hashlib.sha256(bf.read()).digest()
-            digest_b64 = base64.urlsafe_b64encode(digest).rstrip(b'=').decode()
-
-        basename = os.path.basename(wheel_path)
-        wheelname, _ = os.path.splitext(basename)
-        name, version, py, abi, plat = wheelname.split('-')
-
-        with tempfile.TemporaryDirectory() as tmp:
-            with zipfile.ZipFile(wheel_path) as zipf:
-                zipf.extractall(tmp)
-
-            distinfo = os.path.join(tmp, f'{name}-{version}.dist-info')
-            scripts = os.path.join(tmp, f'{name}-{version}.data', 'scripts')
-
-            # replace the script binary with our copy
-            os.remove(os.path.join(scripts, 'sentry-cli'))
-            shutil.copy(binary_src, os.path.join(scripts, wheel.exe))
-
-            # rewrite RECORD to include the new file
-            record_fname = os.path.join(distinfo, 'RECORD')
-            with open(record_fname) as f:
-                record_lines = list(f)
-
-            record = f'{name}-{version}.data/scripts/sentry-cli,'
-            for i, line in enumerate(record_lines):
-                if line.startswith(record):
-                    record_lines[i] = (
-                        f'{name}-{version}.data/scripts/{wheel.exe},'
-                        f'sha256={digest_b64},'
-                        f'{binary_size}\n'
-                    )
-                    break
-            else:
-                raise SystemExit(f'could not find {record!r} in RECORD')
-
-            with open(record_fname, 'w') as f:
-                f.writelines(record_lines)
-
-            # rewrite WHEEL to have the new tags
-            wheel_fname = os.path.join(distinfo, 'WHEEL')
-            with open(wheel_fname) as f:
-                wheel_lines = list(f)
-
-            for i, line in enumerate(wheel_lines):
-                if line.startswith('Tag: '):
-                    wheel_lines[i:i + 1] = [
-                        f'Tag: {py}-{abi}-{plat}\n'
-                        for plat in wheel.plat.split('.')
-                    ]
-                    break
-            else:
-                raise SystemExit("could not find 'Tag: ' in WHEEL")
-
-            with open(wheel_fname, 'w') as f:
-                f.writelines(wheel_lines)
-
-            # write out the final zip
-            new_basename = f'{name}-{version}-{py}-{abi}-{wheel.plat}.whl'
-            tmp_new_wheel = os.path.join(tmp, new_basename)
-            fnames = sorted(
-                os.path.join(root, fname)
-                for root, _, fnames in os.walk(tmp)
-                for fname in fnames
-            )
-            with zipfile.ZipFile(tmp_new_wheel, 'w') as zipf:
-                for fname in fnames:
-                    zinfo = zipfile.ZipInfo(os.path.relpath(fname, tmp))
-                    if '/scripts/' in zinfo.filename:
-                        zinfo.external_attr = 0o100755 << 16
-                    with open(fname, 'rb') as fb:
-                        zipf.writestr(zinfo, fb.read())
-
-            # move into dest
-            shutil.move(tmp_new_wheel, args.dest)
-
-    return 0
-
-
-if __name__ == '__main__':
-    raise SystemExit(main())