@sentry/wizard 4.0.0 → 4.0.1

package/lib/Steps/BaseStep.ts

@@ -1,25 +0,0 @@
-import type { Answers } from 'inquirer';
-
-import type { Args } from '../Constants';
-import { debug, nl } from '../Helper/Logging';
-
-export abstract class BaseStep implements IStep {
-  protected _isDebug = false;
-  public constructor(protected _argv: Args) {
-    this._isDebug = _argv.debug;
-  }
-
-  public debug(msg: any): void {
-    if (this._isDebug) {
-      nl();
-      debug(msg);
-      nl();
-    }
-  }
-
-  public abstract emit(answers: Answers): Promise<Answers>;
-}
-
-export interface IStep {
-  emit(answers?: Answers): Promise<Answers>;
-}

package/lib/Steps/ChooseIntegration.ts

@@ -1,144 +0,0 @@
-import type { Answers } from 'inquirer';
-import { prompt } from 'inquirer';
-
-import { readFileSync } from 'node:fs';
-import { hasPackageInstalled } from '../../src/utils/package-json';
-import {
-  Args,
-  DEFAULT_URL,
-  getIntegrationChoices,
-  Integration,
-} from '../Constants';
-import { dim, red } from '../Helper/Logging';
-import { BaseStep } from './BaseStep';
-import { Cordova } from './Integrations/Cordova';
-import { Electron } from './Integrations/Electron';
-
-function getProjectPackage(): Record<string, unknown> {
-  let projectPackage: Record<string, unknown> = {};
-
-  const projectPackagePathCandidates = [
-    // If we run directly in setup-wizard
-    '../../package.json',
-
-    // If we run from the CLI
-    `${process.cwd()}/package.json`,
-  ];
-
-  for (const pathCandidate of projectPackagePathCandidates) {
-    let data: string;
-    try {
-      data = readFileSync(pathCandidate, 'utf-8');
-    } catch (error) {
-      // If the file does not exist, continue to the next candidate
-      continue;
-    }
-
-    try {
-      projectPackage = JSON.parse(data) as Record<string, unknown>;
-      break;
-    } catch (error) {
-      // If the file exists but is not valid JSON, log an error and continue.
-      // Note: we don't want to crash the wizard if the package.json is invalid,
-      // because it is only use by the integration detection logic.
-      // Furthmore other package managers, i.e. bun, allow JSON-with-comments which might
-      // throw errors with JSON.parse, and will require a different JSON parser in the future.
-      red(
-        `Failed to parse JSON from ${pathCandidate}, is your file a valid package.json?`,
-      );
-    }
-  }
-
-  return projectPackage;
-}
-
-type IntegrationPromptAnswer = {
-  integration: Integration;
-};
-
-export class ChooseIntegration extends BaseStep {
-  public async emit(_answers: Answers): Promise<Answers> {
-    const integrationPrompt = await this._getIntegrationPromptSelection();
-
-    let integration = null;
-    switch (integrationPrompt.integration) {
-      case Integration.cordova:
-        integration = new Cordova(sanitizeUrl(this._argv));
-        break;
-      case Integration.electron:
-        integration = new Electron(sanitizeUrl(this._argv));
-        break;
-    }
-
-    return { integration };
-  }
-
-  public tryDetectingIntegration(): Integration | undefined {
-    const projectPackage = getProjectPackage();
-
-    if (hasPackageInstalled('react-native', projectPackage)) {
-      return Integration.reactNative;
-    }
-    if (hasPackageInstalled('cordova', projectPackage)) {
-      return Integration.cordova;
-    }
-    if (hasPackageInstalled('electron', projectPackage)) {
-      return Integration.electron;
-    }
-    if (hasPackageInstalled('next', projectPackage)) {
-      return Integration.nextjs;
-    }
-    if (hasPackageInstalled('remix-run', projectPackage)) {
-      return Integration.remix;
-    }
-    if (hasPackageInstalled('@sveltejs/kit', projectPackage)) {
-      return Integration.sveltekit;
-    }
-
-    return;
-  }
-
-  private async _getIntegrationPromptSelection(): Promise<IntegrationPromptAnswer> {
-    // If we receive project type as an arg we skip asking
-    if (this._argv.integration) {
-      return { integration: this._argv.integration };
-    } else {
-      if (this._argv.quiet) {
-        throw new Error('You need to choose a platform');
-      }
-
-      const detectedDefaultSelection = this.tryDetectingIntegration();
-
-      return prompt([
-        {
-          choices: getIntegrationChoices(),
-          default: detectedDefaultSelection,
-          message: 'What platform do you want to set up?',
-          name: 'integration',
-          type: 'list',
-          pageSize: 10,
-        },
-      ]);
-    }
-  }
-}
-
-/**
- * For the `clack`-based wizard flows, which we only shim here, we don't set
- * a default url value. For backwards-compatibility with the other flows,
- * we fill it here and sanitize a user-enterd url.
- */
-function sanitizeUrl(argv: Args): Args {
-  if (!argv.url) {
-    argv.url = DEFAULT_URL;
-    dim(`no URL provided, fallback to ${argv.url}`);
-    return argv;
-  }
-
-  let baseUrl = argv.url;
-  baseUrl += baseUrl.endsWith('/') ? '' : '/';
-  baseUrl = baseUrl.replace(/:\/(?!\/)/g, '://');
-  argv.url = baseUrl;
-
-  return argv;
-}

package/lib/Steps/ConfigureProject.ts

@@ -1,10 +0,0 @@
-import type { Answers } from 'inquirer';
-
-import { getCurrentIntegration } from '../Helper/Wizard';
-import { BaseStep } from './BaseStep';
-
-export class ConfigureProject extends BaseStep {
-  public async emit(answers: Answers): Promise<Answers> {
-    return getCurrentIntegration(answers).emit(answers);
-  }
-}

package/lib/Steps/Initial.ts

@@ -1,35 +0,0 @@
-import type { Answers } from 'inquirer';
-import { join, dirname } from 'node:path';
-
-import { dim } from '../Helper/Logging';
-import { BaseStep } from './BaseStep';
-import { readFileSync } from 'node:fs';
-
-type PackageJSON = { version?: string };
-let wizardPackage: PackageJSON = {};
-
-try {
-  wizardPackage = process.env.npm_package_version
-    ? { version: process.env.npm_package_version }
-    : (JSON.parse(
-        readFileSync(
-          join(
-            dirname(require.resolve('@sentry/wizard')),
-            '..',
-            'package.json',
-          ),
-          'utf-8',
-        ),
-      ) as PackageJSON);
-} catch {
-  // We don't need to have this
-}
-
-export class Initial extends BaseStep {
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async emit(_answers: Answers): Promise<Answers> {
-    dim('Running Sentry Wizard...');
-    dim(`version: ${wizardPackage.version ?? 'DEV'}`);
-    return {};
-  }
-}

package/lib/Steps/Integrations/BaseIntegration.ts

@@ -1,42 +0,0 @@
-import type { Answers } from 'inquirer';
-
-import type { Args } from '../../Constants';
-import { BaseStep } from '../BaseStep';
-
-export abstract class BaseIntegration extends BaseStep {
-  public type: string;
-  protected _shouldConfigure: Promise<Answers>;
-
-  public constructor(protected _argv: Args) {
-    super(_argv);
-    // @ts-ignore property construct does not exist on BaseIntegration
-    this.type = this.construct;
-  }
-
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async uninstall(_answers: Answers): Promise<Answers> {
-    return {};
-  }
-
-  /**
-   * This can be used for example for platform:boolean to determine
-   * if we should configure iOS/Android.
-   * Basically this will be merged into answers so it can be checked by a later step.
-   */
-  public async shouldConfigure(_answers: Answers): Promise<Answers> {
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    if (this._shouldConfigure) {
-      return this._shouldConfigure;
-    }
-    this._shouldConfigure = Promise.resolve({ platform: true });
-    return this._shouldConfigure;
-  }
-
-  public async shouldEmit(_answers: Answers): Promise<boolean> {
-    return Object.values(await this.shouldConfigure(_answers)).some(
-      (active: boolean) => active,
-    );
-  }
-
-  public abstract emit(answers: Answers): Promise<Answers>;
-}

package/lib/Steps/Integrations/Cordova.ts

@@ -1,283 +0,0 @@
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import type { Answers } from 'inquirer';
-
-import type { Args } from '../../Constants';
-import { exists, matchesContent, patchMatchingFile } from '../../Helper/File';
-import { green } from '../../Helper/Logging';
-import { SentryCli } from '../../Helper/SentryCli';
-import { BaseIntegration } from './BaseIntegration';
-
-import xcode from 'xcode';
-import type { PBXShellScriptBuildPhase } from 'xcode';
-
-export class Cordova extends BaseIntegration {
-  protected _sentryCli: SentryCli;
-
-  protected _folderPrefix = 'platforms';
-  protected _pluginFolder: string[] = ['.'];
-
-  public constructor(protected _argv: Args) {
-    super(_argv);
-    this._sentryCli = new SentryCli(this._argv);
-  }
-
-  public async emit(answers: Answers): Promise<Answers> {
-    if (this._argv.uninstall) {
-      return this.uninstall(answers);
-    }
-
-    const sentryCliProperties =
-      this._sentryCli.convertAnswersToProperties(answers);
-
-    await patchMatchingFile(
-      `${this._folderPrefix}/ios/*.xcodeproj/project.pbxproj`,
-      this._patchXcodeProj.bind(this),
-    );
-
-    await this._addSentryProperties(sentryCliProperties);
-    green('Successfully set up for cordova');
-
-    return {};
-  }
-
-  public async uninstall(_answers: Answers): Promise<Answers> {
-    await patchMatchingFile(
-      '**/*.xcodeproj/project.pbxproj',
-      this._unpatchXcodeProj.bind(this),
-    );
-
-    return {};
-  }
-
-  public async shouldConfigure(_answers: Answers): Promise<Answers> {
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    if (this._shouldConfigure) {
-      return this._shouldConfigure;
-    }
-
-    let result = false;
-    if (!exists(path.join('sentry.properties'))) {
-      result = true;
-      this.debug('sentry.properties not exists');
-    }
-
-    if (
-      !matchesContent('**/*.xcodeproj/project.pbxproj', /SENTRY_PROPERTIES/gi)
-    ) {
-      result = true;
-      this.debug('**/*.xcodeproj/project.pbxproj not matched');
-    }
-
-    if (this._argv.uninstall) {
-      // if we uninstall we need to invert the result so we remove already patched
-      result = !result;
-    }
-
-    this._shouldConfigure = Promise.resolve({ cordova: result });
-    // eslint-disable-next-line @typescript-eslint/unbound-method
-    return this.shouldConfigure;
-  }
-
-  private _unpatchXcodeProj(filename: string): Promise<string> {
-    const proj = xcode.project(filename);
-    return new Promise((resolve, reject) => {
-      proj.parse((err: any) => {
-        if (err) {
-          reject(err);
-          return;
-        }
-
-        this._unpatchXcodeBuildScripts(proj);
-        resolve(proj.writeSync());
-      });
-    });
-  }
-
-  private _unpatchXcodeBuildScripts(proj: any): void {
-    const scripts = proj.hash.project.objects.PBXShellScriptBuildPhase || {};
-    const firstTarget = proj.getFirstTarget().uuid;
-    const nativeTargets = proj.hash.project.objects.PBXNativeTarget;
-
-    // scripts to kill entirely.
-    for (const key of Object.keys(scripts)) {
-      const script = scripts[key];
-
-      // ignore comments and keys that got deleted
-      if (typeof script === 'string' || script === undefined) {
-        continue;
-      }
-
-      if (
-        script.shellScript.match(/SENTRY_PROPERTIES/) ||
-        script.shellScript.match(/SENTRY_FRAMEWORK_PATCH/)
-      ) {
-        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-        delete scripts[key];
-        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-        delete scripts[`${key}_comment`];
-        const phases = nativeTargets[firstTarget].buildPhases;
-        if (phases) {
-          for (let i = 0; i < phases.length; i++) {
-            if (phases[i].value === key) {
-              phases.splice(i, 1);
-              break;
-            }
-          }
-        }
-        continue;
-      }
-    }
-  }
-
-  private _patchXcodeProj(
-    contents: string,
-    filename: string,
-  ): Promise<void | string> {
-    const proj = xcode.project(filename);
-    return new Promise((resolve, reject) => {
-      proj.parse((err: any) => {
-        if (err) {
-          reject(err);
-          return;
-        }
-
-        const buildScripts = [];
-        for (const val of Object.values(
-          proj.hash.project.objects.PBXShellScriptBuildPhase || {},
-        )) {
-          if ((val as PBXShellScriptBuildPhase).isa) {
-            buildScripts.push(val);
-          }
-        }
-
-        this._addNewXcodeBuildPhaseForSymbols(buildScripts, proj);
-        this._addNewXcodeBuildPhaseForStripping(buildScripts, proj);
-
-        // we always modify the xcode file in memory but we only want to save it
-        // in case the user wants configuration for ios.  This is why we check
-        // here first if changes are made before we might prompt the platform
-        // continue prompt.
-        const newContents = proj.writeSync();
-        if (newContents === contents) {
-          resolve();
-        } else {
-          resolve(newContents);
-        }
-      });
-    });
-  }
-
-  private _addNewXcodeBuildPhaseForSymbols(buildScripts: any, proj: any): void {
-    for (const script of buildScripts) {
-      if (script.shellScript.match(/SENTRY_PROPERTIES/)) {
-        return;
-      }
-    }
-    const cwd = path.join(process.cwd(), 'sentry.properties');
-    proj.addBuildPhase(
-      [],
-      'PBXShellScriptBuildPhase',
-      'Upload Debug Symbols to Sentry',
-      null,
-      {
-        shellPath: '/bin/sh',
-        shellScript:
-          // eslint-disable-next-line prefer-template
-          'echo "warning: uploading debug symbols - set SENTRY_SKIP_DSYM_UPLOAD=true to skip this"\\n' +
-          'if [ -n "$SENTRY_SKIP_DSYM_UPLOAD" ]; then\\n' +
-          '  echo "warning: skipping debug symbol upload"\\n' +
-          '  exit 0\\n' +
-          'fi\\n' +
-          'export SENTRY_PROPERTIES=' +
-          cwd +
-          '\\n' +
-          'function getProperty {\\n' +
-          '    PROP_KEY=$1\\n' +
-          '    PROP_VALUE=`cat $SENTRY_PROPERTIES | grep "$PROP_KEY" | cut -d\'=\' -f2`\\n' +
-          '    if [ -z "$PROP_VALUE" ]; then\\n' +
-          '        echo "plugins/sentry-cordova/node_modules/@sentry/cli/bin/sentry-cli"\\n' +
-          '    else\\n' +
-          '        echo $PROP_VALUE\\n' +
-          '    fi\\n' +
-          '}\\n' +
-          'if [ ! -f $SENTRY_PROPERTIES ]; then\\n' +
-          '  echo "warning: SENTRY: sentry.properties file not found! Skipping symbol upload."\\n' +
-          '  exit 0\\n' +
-          'fi\\n' +
-          'echo "# Reading property from $SENTRY_PROPERTIES"\\n' +
-          'SENTRY_CLI=$(getProperty "cli.executable")\\n' +
-          'SENTRY_COMMAND="../../$SENTRY_CLI upload-dsym"\\n' +
-          '$SENTRY_COMMAND',
-      },
-    );
-  }
-
-  private _addNewXcodeBuildPhaseForStripping(
-    buildScripts: any,
-    proj: any,
-  ): void {
-    for (const script of buildScripts) {
-      if (script.shellScript.match(/SENTRY_FRAMEWORK_PATCH/)) {
-        return;
-      }
-    }
-    // http://ikennd.ac/blog/2015/02/stripping-unwanted-architectures-from-dynamic-libraries-in-xcode/
-    proj.addBuildPhase(
-      [],
-      'PBXShellScriptBuildPhase',
-      'Sentry strip unused archs from Framework',
-      null,
-      {
-        shellPath: '/bin/sh',
-        shellScript:
-          '# SENTRY_FRAMEWORK_PATCH \\n' +
-          'echo "warning: patching framework - set SENTRY_SKIP_FRAMEWORK_PATCH=true to skip this"\\n' +
-          'if [ -n "$SENTRY_SKIP_FRAMEWORK_PATCH" ]; then\\n' +
-          '  echo "warning: skipping framework patch"\\n' +
-          '  exit 0\\n' +
-          'fi\\n' +
-          'APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"\\n' +
-          'find "$APP_PATH" -name \'Sentry*.framework\' -type d | while read -r FRAMEWORK\\n' +
-          'do\\n' +
-          'FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)\\n' +
-          'FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"\\n' +
-          'echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"\\n' +
-          'EXTRACTED_ARCHS=()\\n' +
-          'for ARCH in $ARCHS\\n' +
-          'do\\n' +
-          'echo "Checking if $FRAMEWORK_EXECUTABLE_PATH needs to be stripped."\\n' +
-          '# Do not skip if "Architectures in the fat file".\\n' +
-          '# Skip if Non-fat file or if file not found. \\n' +
-          'if lipo -info "$FRAMEWORK_EXECUTABLE_PATH" | grep -v " fat "; then\\n' +
-          '    echo "Strip not required, skipping the strip script."\\n' +
-          '    exit 0\\n' +
-          'fi\\n' +
-          'echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"\\n' +
-          'lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"\\n' +
-          'EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")\\n' +
-          'done\\n' +
-          'echo "Merging extracted architectures: ${ARCHS}"\\n' +
-          'lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"\\n' +
-          'rm "${EXTRACTED_ARCHS[@]}"\\n' +
-          'echo "Replacing original executable with thinned version"\\n' +
-          'rm "$FRAMEWORK_EXECUTABLE_PATH"\\n' +
-          'mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"\\n' +
-          'done',
-      },
-    );
-  }
-
-  private _addSentryProperties(properties: any): Promise<void> {
-    let rv = Promise.resolve();
-    const fn = path.join('sentry.properties');
-    if (exists(fn)) {
-      return rv;
-    }
-    rv = rv.then(() =>
-      fs.writeFileSync(fn, this._sentryCli.dumpProperties(properties)),
-    );
-
-    return rv;
-  }
-}