@sentry/wizard 4.0.0 → 4.0.1

package/src/react-native/xcode.ts

@@ -1,302 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-import * as fs from 'node:fs';
-// @ts-ignore - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
-
-type BuildPhase = { shellScript: string };
-type BuildPhaseMap = Record<string, BuildPhase>;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function getValidExistingBuildPhases(xcodeProject: any): BuildPhaseMap {
-  const map: BuildPhaseMap = {};
-  const raw = xcodeProject.hash.project.objects.PBXShellScriptBuildPhase || {};
-  for (const key in raw) {
-    const val = raw[key];
-    val.isa && (map[key] = val);
-  }
-
-  return map;
-}
-
-export function patchBundlePhase(
-  bundlePhase: BuildPhase | undefined,
-  patch: (script: string) => string,
-) {
-  if (!bundlePhase) {
-    clack.log.warn(
-      `Could not find ${chalk.cyan(
-        'Bundle React Native code and images',
-      )} build phase.`,
-    );
-    return;
-  }
-
-  const bundlePhaseIncludesSentry = doesBundlePhaseIncludeSentry(bundlePhase);
-  if (bundlePhaseIncludesSentry) {
-    clack.log.warn(
-      `Build phase ${chalk.cyan(
-        'Bundle React Native code and images',
-      )} already includes Sentry.`,
-    );
-    return;
-  }
-
-  const script: string = JSON.parse(bundlePhase.shellScript);
-  bundlePhase.shellScript = JSON.stringify(patch(script));
-  clack.log.success(
-    `Patched Build phase ${chalk.cyan('Bundle React Native code and images')}.`,
-  );
-}
-
-export function unPatchBundlePhase(bundlePhase: BuildPhase | undefined) {
-  if (!bundlePhase) {
-    clack.log.warn(
-      `Could not find ${chalk.cyan(
-        'Bundle React Native code and images',
-      )} build phase.`,
-    );
-    return;
-  }
-
-  if (
-    !bundlePhase.shellScript.match(/sentry-cli\s+react-native\s+xcode/i) &&
-    !bundlePhase.shellScript.includes('sentry-xcode.sh')
-  ) {
-    clack.log.success(
-      `Build phase ${chalk.cyan(
-        'Bundle React Native code and images',
-      )} does not include Sentry.`,
-    );
-    return;
-  }
-
-  bundlePhase.shellScript = JSON.stringify(
-    removeSentryFromBundleShellScript(
-      <string>JSON.parse(bundlePhase.shellScript),
-    ),
-  );
-  clack.log.success(
-    `Build phase ${chalk.cyan(
-      'Bundle React Native code and images',
-    )} unpatched successfully.`,
-  );
-}
-
-export function removeSentryFromBundleShellScript(script: string): string {
-  return (
-    script
-      // remove sentry properties export
-      .replace(/^export SENTRY_PROPERTIES=sentry.properties\r?\n/m, '')
-      .replace(
-        /^\/bin\/sh .*?..\/node_modules\/@sentry\/react-native\/scripts\/collect-modules.sh"?\r?\n/m,
-        '',
-      )
-      // unwrap react-native-xcode.sh command.  In case someone replaced it
-      // entirely with the sentry-cli command we need to put the original
-      // version back in.
-      .replace(
-        /\.\.\/node_modules\/@sentry\/cli\/bin\/sentry-cli\s+react-native\s+xcode\s+\$REACT_NATIVE_XCODE/i,
-        '$REACT_NATIVE_XCODE',
-      )
-      .replace(
-        //  eslint-disable-next-line no-useless-escape
-        /\"\/bin\/sh.*?sentry-xcode.sh\s+\$REACT_NATIVE_XCODE/i,
-        // eslint-disable-next-line no-useless-escape
-        '"$REACT_NATIVE_XCODE',
-      )
-  );
-}
-
-export function findBundlePhase(buildPhases: BuildPhaseMap) {
-  return Object.values(buildPhases).find((buildPhase) =>
-    buildPhase.shellScript.match(/\/scripts\/react-native-xcode\.sh/i),
-  );
-}
-
-export function doesBundlePhaseIncludeSentry(buildPhase: BuildPhase) {
-  const containsSentryCliRNCommand = !!buildPhase.shellScript.match(
-    /sentry-cli\s+react-native\s+xcode/i,
-  );
-  const containsBundledScript =
-    buildPhase.shellScript.includes('sentry-xcode.sh');
-  return containsSentryCliRNCommand || containsBundledScript;
-}
-
-export function addSentryWithBundledScriptsToBundleShellScript(
-  script: string,
-): string {
-  const isLikelyPlainReactNativeScript = script.includes('$REACT_NATIVE_XCODE');
-  if (isLikelyPlainReactNativeScript) {
-    return script.replace(
-      '$REACT_NATIVE_XCODE',
-      // eslint-disable-next-line no-useless-escape
-      '\\"/bin/sh ../node_modules/@sentry/react-native/scripts/sentry-xcode.sh $REACT_NATIVE_XCODE\\"',
-    );
-  }
-
-  const isLikelyExpoScript = script.includes('expo');
-  if (isLikelyExpoScript) {
-    const SENTRY_REACT_NATIVE_XCODE_PATH =
-      "`\"$NODE_BINARY\" --print \"require('path').dirname(require.resolve('@sentry/react-native/package.json')) + '/scripts/sentry-xcode.sh'\"`";
-    return script.replace(
-      /^.*?(packager|scripts)\/react-native-xcode\.sh\s*(\\'\\\\")?/m,
-      // eslint-disable-next-line no-useless-escape
-      (match: string) => `/bin/sh ${SENTRY_REACT_NATIVE_XCODE_PATH} ${match}`,
-    );
-  }
-
-  return script;
-}
-
-export function addSentryWithCliToBundleShellScript(script: string): string {
-  return (
-    'export SENTRY_PROPERTIES=sentry.properties\n' +
-    'export EXTRA_PACKAGER_ARGS="--sourcemap-output $DERIVED_FILE_DIR/main.jsbundle.map"\n' +
-    script.replace(
-      '$REACT_NATIVE_XCODE',
-      () =>
-        // eslint-disable-next-line no-useless-escape
-        '\\"../node_modules/@sentry/cli/bin/sentry-cli react-native xcode $REACT_NATIVE_XCODE\\"',
-    ) +
-    '\n/bin/sh -c "$WITH_ENVIRONMENT ../node_modules/@sentry/react-native/scripts/collect-modules.sh"\n'
-  );
-}
-
-export function addDebugFilesUploadPhaseWithBundledScripts(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  xcodeProject: any,
-  { debugFilesUploadPhaseExists }: { debugFilesUploadPhaseExists: boolean },
-) {
-  if (debugFilesUploadPhaseExists) {
-    clack.log.warn(
-      `Build phase ${chalk.cyan(
-        'Upload Debug Symbols to Sentry',
-      )} already exists.`,
-    );
-    return;
-  }
-
-  xcodeProject.addBuildPhase(
-    [],
-    'PBXShellScriptBuildPhase',
-    'Upload Debug Symbols to Sentry',
-    null,
-    {
-      shellPath: '/bin/sh',
-      shellScript: `/bin/sh ../node_modules/@sentry/react-native/scripts/sentry-xcode-debug-files.sh`,
-    },
-  );
-  clack.log.success(
-    `Added Build phase ${chalk.cyan('Upload Debug Symbols to Sentry')}.`,
-  );
-}
-
-export function addDebugFilesUploadPhaseWithCli(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  xcodeProject: any,
-  { debugFilesUploadPhaseExists }: { debugFilesUploadPhaseExists: boolean },
-) {
-  if (debugFilesUploadPhaseExists) {
-    clack.log.warn(
-      `Build phase ${chalk.cyan(
-        'Upload Debug Symbols to Sentry',
-      )} already exists.`,
-    );
-    return;
-  }
-
-  xcodeProject.addBuildPhase(
-    [],
-    'PBXShellScriptBuildPhase',
-    'Upload Debug Symbols to Sentry',
-    null,
-    {
-      shellPath: '/bin/sh',
-      shellScript: `
-WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
-if [ -f "$WITH_ENVIRONMENT" ]; then
-  . "$WITH_ENVIRONMENT"
-fi
-export SENTRY_PROPERTIES=sentry.properties
-[ "$SENTRY_INCLUDE_NATIVE_SOURCES" = "true" ] && INCLUDE_SOURCES_FLAG="--include-sources" || INCLUDE_SOURCES_FLAG=""
-../node_modules/@sentry/cli/bin/sentry-cli debug-files upload "$INCLUDE_SOURCES_FLAG" "$DWARF_DSYM_FOLDER_PATH"
-`,
-    },
-  );
-  clack.log.success(
-    `Added Build phase ${chalk.cyan('Upload Debug Symbols to Sentry')}.`,
-  );
-}
-
-export function unPatchDebugFilesUploadPhase(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  xcodeProject: any,
-) {
-  const buildPhasesMap =
-    xcodeProject.hash.project.objects.PBXShellScriptBuildPhase || {};
-
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  const debugFilesUploadPhaseResult = findDebugFilesUploadPhase(buildPhasesMap);
-  if (!debugFilesUploadPhaseResult) {
-    clack.log.success(
-      `Build phase ${chalk.cyan('Upload Debug Symbols to Sentry')} not found.`,
-    );
-    return;
-  }
-
-  const [debugFilesUploadPhaseKey] = debugFilesUploadPhaseResult;
-  const firstTarget: string = xcodeProject.getFirstTarget().uuid;
-  const nativeTargets = xcodeProject.hash.project.objects.PBXNativeTarget;
-
-  // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-  delete buildPhasesMap[debugFilesUploadPhaseKey];
-  // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-  delete buildPhasesMap[`${debugFilesUploadPhaseKey}_comment`];
-  const phases = nativeTargets[firstTarget].buildPhases;
-  if (phases) {
-    for (let i = 0; i < phases.length; i++) {
-      if (phases[i].value === debugFilesUploadPhaseKey) {
-        phases.splice(i, 1);
-        break;
-      }
-    }
-  }
-  clack.log.success(
-    `Build phase ${chalk.cyan(
-      'Upload Debug Symbols to Sentry',
-    )} removed successfully.`,
-  );
-}
-
-export function findDebugFilesUploadPhase(
-  buildPhasesMap: Record<string, BuildPhase>,
-): [key: string, buildPhase: BuildPhase] | undefined {
-  return Object.entries(buildPhasesMap).find(([_, buildPhase]) => {
-    const containsCliDebugUpload =
-      typeof buildPhase !== 'string' &&
-      !!buildPhase.shellScript.match(
-        /sentry-cli\s+(upload-dsym|debug-files upload)\b/,
-      );
-    const containsBundledDebugUpload =
-      typeof buildPhase !== 'string' &&
-      buildPhase.shellScript.includes('sentry-xcode-debug-files.sh');
-    return containsCliDebugUpload || containsBundledDebugUpload;
-  });
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function writeXcodeProject(xcodeProjectPath: string, xcodeProject: any) {
-  const newContent = xcodeProject.writeSync();
-  const currentContent = fs.readFileSync(xcodeProjectPath, 'utf-8');
-  if (newContent === currentContent) {
-    return;
-  }
-
-  fs.writeFileSync(xcodeProjectPath, newContent, 'utf-8');
-  clack.log.success(
-    chalk.green(`Xcode project ${chalk.cyan(xcodeProjectPath)} changes saved.`),
-  );
-}

package/src/remix/codemods/express-server.ts

@@ -1,44 +0,0 @@
-import {
-  loadFile,
-  // @ts-expect-error - magicast is ESM and TS complains about that. It works though
-} from 'magicast';
-import * as fs from 'fs';
-
-import { findFile } from '../../utils/ast-utils';
-
-// Try to find the Express server implementation that contains `createRequestHandler` from `@remix-run/express`
-export async function findCustomExpressServerImplementation() {
-  const possiblePaths = [
-    'server',
-    'server/index',
-    'app/server',
-    'app/server/index',
-  ];
-
-  for (const filePath of possiblePaths) {
-    const filename = findFile(filePath);
-
-    if (!filename) {
-      continue;
-    }
-
-    const fileStat = fs.statSync(filename);
-
-    if (!fileStat.isFile()) {
-      continue;
-    }
-
-    const fileMod = await loadFile(filename);
-    const createRequestHandlerImport = fileMod.imports.$items.find(
-      (imp) =>
-        imp.from === '@remix-run/express' &&
-        imp.imported === 'createRequestHandler',
-    );
-
-    if (createRequestHandlerImport) {
-      return filename;
-    }
-  }
-
-  return null;
-}

package/src/remix/codemods/handle-error.ts

@@ -1,118 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-
-// @ts-expect-error - magicast is ESM and TS complains about that. It works though
-import type { ProxifiedModule } from 'magicast';
-import type { Program } from '@babel/types';
-
-import * as recast from 'recast';
-
-import { HANDLE_ERROR_TEMPLATE_V2 } from '../templates';
-import { getAfterImportsInsertionIndex, hasSentryContent } from '../utils';
-
-// @ts-expect-error - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
-
-// @ts-expect-error - magicast is ESM and TS complains about that. It works though
-import { generateCode } from 'magicast';
-
-export function instrumentHandleError(
-  originalEntryServerMod: ProxifiedModule<any>,
-  serverEntryFilename: string,
-): boolean {
-  const originalEntryServerModAST = originalEntryServerMod.$ast as Program;
-
-  const handleErrorFunctionExport = originalEntryServerModAST.body.find(
-    (node) => {
-      return (
-        node.type === 'ExportNamedDeclaration' &&
-        node.declaration?.type === 'FunctionDeclaration' &&
-        node.declaration.id?.name === 'handleError'
-      );
-    },
-  );
-
-  const handleErrorFunctionVariableDeclarationExport =
-    originalEntryServerModAST.body.find(
-      (node) =>
-        node.type === 'ExportNamedDeclaration' &&
-        node.declaration?.type === 'VariableDeclaration' &&
-        // @ts-expect-error - id should always have a name in this case
-        node.declaration.declarations[0].id.name === 'handleError',
-    );
-
-  if (
-    !handleErrorFunctionExport &&
-    !handleErrorFunctionVariableDeclarationExport
-  ) {
-    clack.log.warn(
-      `Could not find function ${chalk.cyan('handleError')} in ${chalk.cyan(
-        serverEntryFilename,
-      )}. Creating one for you.`,
-    );
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    const implementation = recast.parse(HANDLE_ERROR_TEMPLATE_V2).program
-      .body[0];
-
-    originalEntryServerModAST.body.splice(
-      getAfterImportsInsertionIndex(originalEntryServerModAST),
-      0,
-      // @ts-expect-error - string works here because the AST is proxified by magicast
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-      recast.types.builders.exportNamedDeclaration(implementation),
-    );
-  } else if (
-    (handleErrorFunctionExport &&
-      ['wrapHandleErrorWithSentry', 'sentryHandleError'].some((util) =>
-        hasSentryContent(
-          generateCode(handleErrorFunctionExport).code,
-          originalEntryServerMod.$code,
-          util,
-        ),
-      )) ||
-    (handleErrorFunctionVariableDeclarationExport &&
-      ['wrapHandleErrorWithSentry', 'sentryHandleError'].some((util) =>
-        hasSentryContent(
-          generateCode(handleErrorFunctionVariableDeclarationExport).code,
-          originalEntryServerMod.$code,
-          util,
-        ),
-      ))
-  ) {
-    return false;
-  } else if (handleErrorFunctionExport) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    const implementation = recast.parse(HANDLE_ERROR_TEMPLATE_V2).program
-      .body[0];
-
-    // If the current handleError function has a body, we need to merge the new implementation with the existing one
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-    implementation.declarations[0].init.arguments[0].body.body.unshift(
-      // @ts-expect-error - declaration works here because the AST is proxified by magicast
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      ...handleErrorFunctionExport.declaration.body.body,
-    );
-
-    // @ts-expect-error - declaration works here because the AST is proxified by magicast
-    handleErrorFunctionExport.declaration = implementation;
-  } else if (handleErrorFunctionVariableDeclarationExport) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    const implementation = recast.parse(HANDLE_ERROR_TEMPLATE_V2).program
-      .body[0];
-
-    // If the current handleError function has a body, we need to merge the new implementation with the existing one
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-    implementation.declarations[0].init.arguments[0].body.body.unshift(
-      // @ts-expect-error - declaration works here because the AST is proxified by magicast
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      ...handleErrorFunctionVariableDeclarationExport.declaration
-        .declarations[0].init.body.body,
-    );
-
-    // @ts-expect-error - declaration works here because the AST is proxified by magicast
-    handleErrorFunctionVariableDeclarationExport.declaration = implementation;
-  }
-
-  return true;
-}

package/src/remix/codemods/root-common.ts

@@ -1,63 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-argument */
-
-import * as recast from 'recast';
-// @ts-expect-error - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
-
-// @ts-expect-error - magicast is ESM and TS complains about that. It works though
-import { builders, ProxifiedModule, generateCode } from 'magicast';
-
-export function wrapAppWithSentry(
-  rootRouteAst: ProxifiedModule,
-  rootFileName: string,
-) {
-  rootRouteAst.imports.$add({
-    from: '@sentry/remix',
-    imported: 'withSentry',
-    local: 'withSentry',
-  });
-
-  recast.visit(rootRouteAst.$ast, {
-    visitExportDefaultDeclaration(path) {
-      if (path.value.declaration.type === 'FunctionDeclaration') {
-        // Move the function declaration just before the default export
-        path.insertBefore(path.value.declaration);
-
-        // Get the name of the function to be wrapped
-        const functionName: string = path.value.declaration.id.name as string;
-
-        // Create the wrapped function call
-        const functionCall = recast.types.builders.callExpression(
-          recast.types.builders.identifier('withSentry'),
-          [recast.types.builders.identifier(functionName)],
-        );
-
-        // Replace the default export with the wrapped function call
-        path.value.declaration = functionCall;
-      } else if (path.value.declaration.type === 'Identifier') {
-        const rootRouteExport = rootRouteAst.exports.default;
-
-        const expressionToWrap = generateCode(rootRouteExport.$ast).code;
-
-        rootRouteAst.exports.default = builders.raw(
-          `withSentry(${expressionToWrap})`,
-        );
-      } else {
-        clack.log.warn(
-          chalk.yellow(
-            `Couldn't instrument ${chalk.bold(
-              rootFileName,
-            )} automatically. Wrap your default export with: ${chalk.dim(
-              'withSentry()',
-            )}\n`,
-          ),
-        );
-      }
-
-      this.traverse(path);
-    },
-  });
-}

package/src/remix/codemods/root-v1.ts

@@ -1,41 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-
-import * as path from 'path';
-
-// @ts-expect-error - clack is ESM and TS complains about that. It works though
-import clack from '@clack/prompts';
-import chalk from 'chalk';
-
-// @ts-expect-error - magicast is ESM and TS complains about that. It works though
-import { loadFile, writeFile } from 'magicast';
-import { wrapAppWithSentry } from './root-common';
-
-export async function instrumentRootRouteV1(
-  rootFileName: string,
-): Promise<void> {
-  try {
-    const rootRouteAst = await loadFile(
-      path.join(process.cwd(), 'app', rootFileName),
-    );
-
-    wrapAppWithSentry(rootRouteAst, rootFileName);
-
-    await writeFile(
-      rootRouteAst.$ast,
-      path.join(process.cwd(), 'app', rootFileName),
-    );
-  } catch (e: unknown) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-    clack.log.warn(
-      chalk.yellow(
-        `Something went wrong writing to ${chalk.bold(rootFileName)}`,
-      ),
-    );
-    clack.log.info(
-      `Please put the following code snippet into ${chalk.bold(
-        rootFileName,
-      )}: ${chalk.dim('You probably have to clean it up a bit.')}\n`,
-    );
-  }
-}