feat: Add self-contained binary artifacts (#806)

The added forced resolution for `simple-plist` is to fix bundling issues
with this package that is solved in the latest version.

Context: wollardj/simple-plist/issues#58

Fixes #758.

Author: BYK

.github/workflows/build.yml

@@ -10,6 +10,9 @@ jobs:
   job_build:
     name: Build
     runs-on: ubuntu-latest
+    env:
+      APPLE_CERT_PATH: /tmp/certs.p12
+      APPLE_API_KEY_PATH: /tmp/apple_key.json
     steps:
       - uses: actions/checkout@v4
       - name: Set up Node
@@ -21,14 +24,38 @@ jobs:
         run: yarn install --frozen-lockfile
       - name: Build
         run: yarn build
+      - name: Setup Apple Code Signing
+        env:
+          APPLE_CERT_DATA: ${{ secrets.APPLE_CERT_DATA }}
+          APPLE_API_KEY: ${{ secrets.APPLE_API_KEY }}
+        run: |
+          curl -L 'https://github.com/indygreg/apple-platform-rs/releases/download/apple-codesign%2F0.28.0/apple-codesign-0.28.0-x86_64-unknown-linux-musl.tar.gz' | tar -xz --strip-components=1
+          mv rcodesign /usr/local/bin/rcodesign
+          echo "$APPLE_CERT_DATA" | base64 --decode > ${{ env.APPLE_CERT_PATH }}
+          echo "$APPLE_API_KEY" | base64 --decode > ${{ env.APPLE_API_KEY_PATH }}
+      - name: Fossilize Cache
+        uses: actions/cache@v4
+        with:
+          key: yarn-${{ hashFiles('yarn.lock') }}
+          restore-keys: yarn-
+          path: |
+            ${{ github.workspace }}/.node-cache
+      - name: Build SEA Binaries
+        env:
+          APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
+          APPLE_CERT_PASSWORD: ${{ secrets.APPLE_CERT_PASSWORD }}
+        run: yarn fossilize -n 22 --sign -p linux-x64 -p linux-arm64 -p win-x64 -p darwin-x64 -p darwin-arm64
       - name: Pack
         run: yarn pack
       - name: Archive Artifacts
         uses: actions/upload-artifact@v4
         with:
           name: ${{ github.sha }}
+          if-no-files-found: error
+          compression-level: 3
           path: |
             ${{ github.workspace }}/*.tgz
+            ${{ github.workspace }}/dist-bin/*
 
   job_lint:
     name: Lint
@@ -108,8 +135,12 @@ jobs:
           flutter pub get
       - name: Install dependencies with yarn
         run: yarn install --frozen-lockfile
+      - name: Download built binaries from build job
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ github.sha }}
       - name: Run End-to-End Tests
-        run: yarn test:e2e ${{ matrix.wizard }}
+        run: yarn test:e2e:bin ${{ matrix.wizard }}
       - name: Push code coverage to codecov
         uses: codecov/codecov-action@13ce06bfc6bbe3ecf90edbbf1bc32fe5978ca1d3 # [email protected]
         with:

.gitignore

@@ -16,6 +16,7 @@ npm-debug.log
 ios
 ./android
 yarn-error.log
+.node-cache
 
 scratch/
 
@@ -26,6 +27,9 @@ scratch/
 
 sentry.properties
 dist/
+dist-bin/
+# npm package
+*.tgz
 coverage/
 plugins
 
@@ -36,4 +40,4 @@ package-lock.json
 
 .env
 
-.sentryclirc
+.sentryclirc

CHANGELOG.md

@@ -8,6 +8,7 @@
 - ref: No more dynamic requires ([#801](https://github.com/getsentry/sentry-wizard/pull/801))
 - ref: Remove @sentry/cli as a dependency ([#802](https://github.com/getsentry/sentry-wizard/pull/802))
 - fix: Fix broken legacy wizard ([#811](https://github.com/getsentry/sentry-wizard/pull/811))
+- feat: Add self-contained binary artifacts ([#806](https://github.com/getsentry/sentry-wizard/pull/806))
 - fix: Add fallback from parsing project package path candidates ([#814](https://github.com/getsentry/sentry-wizard/pull/814))
 - fix: Refactor the wizard version lookup to handle gracefully ([#816](https://github.com/getsentry/sentry-wizard/pull/816))
 

bin.ts

@@ -52,85 +52,90 @@ const PRESELECTED_PROJECT_OPTIONS = {
 };
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-const argv = yargs(hideBin(process.argv)).options({
-  debug: {
-    default: false,
-    describe: 'Enable verbose logging\nenv: SENTRY_WIZARD_DEBUG',
-    type: 'boolean',
-  },
-  uninstall: {
-    default: false,
-    describe: 'Revert project setup process\nenv: SENTRY_WIZARD_UNINSTALL',
-    type: 'boolean',
-  },
-  'skip-connect': {
-    default: false,
-    describe:
-      'Skips the connection to the server\nenv: SENTRY_WIZARD_SKIP_CONNECT',
-    type: 'boolean',
-  },
-  quiet: {
-    default: false,
-    describe:
-      'Do not fallback to prompting user asking questions\nenv: SENTRY_WIZARD_QUIET',
-    type: 'boolean',
-  },
-  i: {
-    alias: 'integration',
-    choices: Object.keys(Integration),
-    describe: 'Choose the integration to setup\nenv: SENTRY_WIZARD_INTEGRATION',
-  },
-  p: {
-    alias: 'platform',
-    choices: Object.keys(Platform),
-    describe: 'Choose platform(s)\nenv: SENTRY_WIZARD_PLATFORM',
-    type: 'array',
-  },
-  u: {
-    alias: 'url',
-    describe: 'The url to your Sentry installation\nenv: SENTRY_WIZARD_URL',
-  },
-  project: {
-    type: 'string',
-    describe: 'The Sentry project slug to use',
-    defaultDescription: 'Select project during setup',
-    default: undefined,
-  },
-  org: {
-    type: 'string',
-    describe: 'The Sentry org slug to use',
-    defaultDescription: 'Select org during setup',
-    default: undefined,
-  },
-  saas: {
-    default: false,
-    describe: 'Skip the self-hosted or SaaS URL selection process',
-    defaultDescription: 'Select self-hosted or SaaS during setup',
-    type: 'boolean',
-  },
-  s: {
-    alias: 'signup',
-    default: false,
-    describe: 'Redirect to signup page if not logged in',
-    type: 'boolean',
-  },
-  'disable-telemetry': {
-    default: false,
-    describe: "Don't send telemetry data to Sentry",
-    type: 'boolean',
-  },
-  'promo-code': {
-    alias: 'promo-code',
-    describe: 'A promo code that will be applied during signup',
-    type: 'string',
-  },
-  'force-install': {
-    default: false,
-    describe: 'Force install the SDK NPM package',
-    type: 'boolean',
-  },
-  ...PRESELECTED_PROJECT_OPTIONS,
-}).argv;
+const argv = yargs(hideBin(process.argv), process.cwd())
+  .options({
+    debug: {
+      default: false,
+      describe: 'Enable verbose logging\nenv: SENTRY_WIZARD_DEBUG',
+      type: 'boolean',
+    },
+    uninstall: {
+      default: false,
+      describe: 'Revert project setup process\nenv: SENTRY_WIZARD_UNINSTALL',
+      type: 'boolean',
+    },
+    'skip-connect': {
+      default: false,
+      describe:
+        'Skips the connection to the server\nenv: SENTRY_WIZARD_SKIP_CONNECT',
+      type: 'boolean',
+    },
+    quiet: {
+      default: false,
+      describe:
+        'Do not fallback to prompting user asking questions\nenv: SENTRY_WIZARD_QUIET',
+      type: 'boolean',
+    },
+    i: {
+      alias: 'integration',
+      choices: Object.keys(Integration),
+      describe:
+        'Choose the integration to setup\nenv: SENTRY_WIZARD_INTEGRATION',
+    },
+    p: {
+      alias: 'platform',
+      choices: Object.keys(Platform),
+      describe: 'Choose platform(s)\nenv: SENTRY_WIZARD_PLATFORM',
+      type: 'array',
+    },
+    u: {
+      alias: 'url',
+      describe: 'The url to your Sentry installation\nenv: SENTRY_WIZARD_URL',
+    },
+    project: {
+      type: 'string',
+      describe: 'The Sentry project slug to use',
+      defaultDescription: 'Select project during setup',
+      default: undefined,
+    },
+    org: {
+      type: 'string',
+      describe: 'The Sentry org slug to use',
+      defaultDescription: 'Select org during setup',
+      default: undefined,
+    },
+    saas: {
+      default: false,
+      describe: 'Skip the self-hosted or SaaS URL selection process',
+      defaultDescription: 'Select self-hosted or SaaS during setup',
+      type: 'boolean',
+    },
+    s: {
+      alias: 'signup',
+      default: false,
+      describe: 'Redirect to signup page if not logged in',
+      type: 'boolean',
+    },
+    'disable-telemetry': {
+      default: false,
+      describe: "Don't send telemetry data to Sentry",
+      type: 'boolean',
+    },
+    'promo-code': {
+      alias: 'promo-code',
+      describe: 'A promo code that will be applied during signup',
+      type: 'string',
+    },
+    'force-install': {
+      default: false,
+      describe: 'Force install the SDK NPM package',
+      type: 'boolean',
+    },
+    ...PRESELECTED_PROJECT_OPTIONS,
+  })
+  // This prevents `yargs` from trying to read the local package.json
+  // as it's not available in the Node Single Executable Binary artifacts versions
+  .version(process.env.npm_package_version as string).argv;
 
 // @ts-expect-error - for some reason TS doesn't recognize the aliases as valid properties
 // meaning it only knows e.g. u but not url. Maybe a bug in this old version of yargs?

e2e-tests/tests/flutter.test.ts

@@ -1,20 +1,20 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 /* eslint-disable jest/expect-expect */
 import { Integration } from '../../lib/Constants';
 import {
+  KEYS,
   // checkEnvBuildPlugin,
   cleanupGit,
-  KEYS,
   revertLocalChanges,
 } from '../utils';
 import { startWizardInstance } from '../utils';
 import {
   checkFileContents,
+  checkIfFlutterBuilds,
   // checkFileExists,
   checkSentryProperties,
-  checkIfFlutterBuilds,
 } from '../utils';
-import * as path from 'path';
-import * as fs from 'fs';
 
 describe('Flutter', () => {
   const integration = Integration.flutter;
@@ -26,67 +26,67 @@ describe('Flutter', () => {
   describe('with apple platforms', () => {
     beforeAll(async () => {
       const wizardInstance = startWizardInstance(integration, projectDir);
-  
+
       const tracingOptionPrompted = await wizardInstance.waitForOutput(
         // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold.
         'to track the performance of your application?',
       );
-  
+
       const profilingOptionPrompted = tracingOptionPrompted &&
         (await wizardInstance.sendStdinAndWaitForOutput(
           [KEYS.ENTER],
           // "Do you want to enable Profiling", sometimes doesn't work as `Profiling` can be printed in bold.
           'to analyze CPU usage and optimize performance-critical code on iOS & macOS?',
         ));
-  
+
       profilingOptionPrompted &&
         (await wizardInstance.sendStdinAndWaitForOutput(
           [KEYS.ENTER],
           'Successfully installed the Sentry Flutter SDK!',
         ));
-  
+
       wizardInstance.kill();
     });
-  
+
     afterAll(() => {
       revertLocalChanges(projectDir);
       cleanupGit(projectDir);
     });
-  
+
     test('pubspec.yaml is updated.', () => {
       checkFileContents(`${projectDir}/pubspec.yaml`, `sentry_flutter:`); // dependencies
       checkFileContents(`${projectDir}/pubspec.yaml`, `sentry_dart_plugin:`); // dev_dependencies
       checkFileContents(`${projectDir}/pubspec.yaml`, `sentry:`); // gradle plugin options
     });
-  
+
     test('sentry.properties exists and has auth token', () => {
       checkSentryProperties(projectDir);
     });
-  
+
     test('.gitignore has sentry.properties', () => {
       checkFileContents(`${projectDir}/.gitignore`, `sentry.properties`);
     });
-    
+
     test('lib/main.dart calls sentry init', () => {
       checkFileContents(`${projectDir}/lib/main.dart`, `import 'package:sentry_flutter/sentry_flutter.dart';`);
       checkFileContents(`${projectDir}/lib/main.dart`, `await SentryFlutter.init(`);
     });
-  
+
     test('lib/main.dart enables tracing and profiling', () => {
       checkFileContents(`${projectDir}/lib/main.dart`, `options.tracesSampleRate = 1.0;`);
       checkFileContents(`${projectDir}/lib/main.dart`, `options.profilesSampleRate = 1.0;`);
     });
-  
+
     test('builds correctly', async () => {
       await checkIfFlutterBuilds(projectDir, '✓ Built build/web');
     });
   });
 
   describe('without apple platforms', () => {
     beforeAll(async () => {
-      
+
       const wizardInstance = startWizardInstance(integration, projectDir);
-  
+
       if (fs.existsSync(`${projectDir}/ios`)) {
         fs.renameSync(`${projectDir}/ios`, `${projectDir}/_ios`);
       }
@@ -104,16 +104,16 @@ describe('Flutter', () => {
         // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold.
         'to track the performance of your application?',
         ));
-  
+
       tracingOptionPrompted &&
         (await wizardInstance.sendStdinAndWaitForOutput(
           [KEYS.ENTER],
           'Successfully installed the Sentry Flutter SDK!',
         ));
-  
+
       wizardInstance.kill();
     });
-  
+
     afterAll(() => {
       revertLocalChanges(projectDir);
       cleanupGit(projectDir);