ref: Transition to binaries over npm (#1836)

Author: Luca Forstner

.eslintrc

@@ -5,12 +5,14 @@
     "node": true
   },
   "parserOptions": {
-    "ecmaVersion": "latest"
+    "ecmaVersion": 9
   },
-  "overrides": [{
-    "env": {
-      "jest": true
-    },
-    "files": ["*.test.js"]
-  }]
+  "overrides": [
+    {
+      "env": {
+        "jest": true
+      },
+      "files": ["*.test.js"]
+    }
+  ]
 }

.github/workflows/ci.yml

@@ -74,7 +74,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x, 20.x]
 
     name: Test Node ${{ matrix.node-version }}
     runs-on: ubuntu-latest
@@ -88,52 +88,9 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - run: npm install
-        env:
-          SENTRYCLI_LOCAL_CDNURL: 'http://localhost:8999/'
 
       # older node versions need an older nft
       - run: npm install @vercel/[email protected]
         if: matrix.node-version == '10.x' || matrix.node-version == '12.x'
 
       - run: npm test
-
-  test_install:
-    # Don't run install test on release branches, as at this point binaries were not published to CDN yet.
-    if: ${{ !startsWith(github.ref, 'refs/heads/release/') }}
-
-    strategy:
-      fail-fast: false
-      matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
-
-    name: Test install script on Node ${{ matrix.node-version }}
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          path: sentry-cli-dep
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup empty test app
-        run: mkdir test-app && cd test-app && npm init --yes
-
-      - name: Install @sentry/cli
-        run: npm install ../sentry-cli-dep --install-links
-        working-directory: ./test-app
-
-      - name: Ensure binary can be called from paths
-        run: |
-          node_modules/.bin/sentry-cli help
-          node_modules/@sentry/cli/sentry-cli help
-        working-directory: ./test-app
-
-      - name: Install @sentry/cli globally
-        run: npm install ./sentry-cli-dep --install-links -g
-
-      - name: Ensure binary is installed globally
-        run: sentry-cli help

.gitignore

@@ -6,6 +6,7 @@ coverage
 dist
 dump
 checksums.txt
+yarn-error.log
 
 /sentry-cli
 /sentry-cli.exe

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 "You know what they say. Fool me once, strike one, but fool me twice... strike three." — Michael Scott
 
+## 2.22.3
+
+ref: Transition to binaries over npm (#1836)
+
 ## 2.22.2
 
 This release contains no changes and was done for technical purposes.

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  setupFiles: ['<rootDir>/setupTests.js'],
+  testPathIgnorePatterns: ['<rootDir>/src/'],
+};

js/__tests__/helper.test.js

@@ -1,15 +1,10 @@
 const os = require('os');
-const path = require('path');
 
 const helper = require('../helper');
 
 const SOURCEMAPS_OPTIONS = require('../releases/options/uploadSourcemaps');
 
 describe('SentryCli helper', () => {
-  beforeEach(() => {
-    helper.mockBinaryPath(path.resolve(__dirname, '../__mocks__/sentry-cli'));
-  });
-
   test('call sentry-cli --version', () => {
     expect.assertions(1);
     return helper

js/helper.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const os = require('os');
-const path = require('path');
 const childProcess = require('child_process');
 
 const BINARY_DISTRIBUTIONS = [
@@ -80,14 +79,6 @@ function getBinaryPath() {
     return process.env.SENTRY_BINARY_PATH;
   }
 
-  if (!process.env.USE_SENTRY_BINARY_NPM_DISTRIBUTION) {
-    const parts = [];
-    parts.push(__dirname);
-    parts.push('..');
-    parts.push(`sentry-cli${process.platform === 'win32' ? '.exe' : ''}`);
-    return path.resolve(...parts);
-  }
-
   const { packageName, subpath } = getDistributionForThisPlatform();
 
   if (packageName === undefined) {
@@ -141,7 +132,9 @@ let binaryPath = getBinaryPath();
  * Overrides the default binary path with a mock value, useful for testing.
  *
  * @param {string} mockPath The new path to the mock sentry-cli binary
+ * @deprecated This was used in tests internally and will be removed in the next major version.
  */
+// TODO(v3): Remove this function
 function mockBinaryPath(mockPath) {
   binaryPath = mockPath;
 }

package.json

@@ -27,7 +27,7 @@
     "eslint-config-prettier": "^8.5.0",
     "jest": "^27.5.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.6.2"
+    "prettier": "2.8.8"
   },
   "optionalDependencies": {
     "@sentry/cli-darwin": "2.22.2",
@@ -39,7 +39,6 @@
     "@sentry/cli-win32-x64": "2.22.2"
   },
   "scripts": {
-    "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",
@@ -58,7 +57,7 @@
     ]
   },
   "volta": {
-    "node": "10.24.1",
+    "node": "20.10.0",
     "yarn": "1.22.19"
   }
 }

scripts/install.js

@@ -2,8 +2,13 @@
 
 'use strict';
 
+// TODO(v3): Remove this file
+
+console.log(
+  'DEPRECATION NOTICE: The Sentry CLI install script has been deprecated. The package now uses "optionalDependencies" instead to install architecture-compatible binaries distributed over npm.'
+);
+
 const fs = require('fs');
-const http = require('http');
 const os = require('os');
 const path = require('path');
 const crypto = require('crypto');
@@ -303,27 +308,12 @@ async function downloadBinary() {
 async function checkVersion() {
   const output = await helper.execute(['--version']);
   const version = output.replace('sentry-cli ', '').trim();
-  const expected = process.env.SENTRYCLI_LOCAL_CDNURL ? 'DEV' : pkgInfo.version;
+  const expected = pkgInfo.version;
   if (version !== expected) {
     throw new Error(`Unexpected sentry-cli version "${version}", expected "${expected}"`);
   }
 }
 
-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),
-    });
-    response.end(contents);
-  });
-
-  server.listen(8999);
-  process.on('exit', () => server.close());
-}
-
 if (process.env.SENTRYCLI_SKIP_DOWNLOAD === '1') {
   logger.log(`Skipping download because SENTRYCLI_SKIP_DOWNLOAD=1 detected.`);
   process.exit(0);

setupTests.js

@@ -0,0 +1,3 @@
+const path = require('path');
+
+process.env.SENTRY_BINARY_PATH = path.join(__dirname, 'js', '__mocks__', 'sentry-cli');