@sentry/wizard 3.18.1 → 3.20.0

package/src/remix/remix-wizard.ts

@@ -23,6 +23,7 @@ import {
   isRemixV2,
   loadRemixConfig,
   runRemixReveal,
+  instrumentExpressServer,
 } from './sdk-setup';
 import { debug } from '../utils/debug';
 import { traceStep, withTelemetry } from '../telemetry';
@@ -152,6 +153,25 @@ async function runRemixWizardWithTelemetry(
     }
   });
 
+  await traceStep('Instrument custom Express server', async () => {
+    try {
+      const hasExpressAdapter = hasPackageInstalled(
+        '@remix-run/express',
+        packageJson,
+      );
+
+      if (!hasExpressAdapter) {
+        return;
+      }
+
+      await instrumentExpressServer();
+    } catch (e) {
+      clack.log.warn(`Could not instrument custom Express server.
+  Please do it manually using instructions from https://docs.sentry.io/platforms/javascript/guides/remix/manual-setup/#custom-express-server`);
+      debug(e);
+    }
+  });
+
   clack.outro(`
 ${chalk.green(
   'Sentry has been successfully configured for your Remix project.',

package/src/remix/sdk-setup.ts

@@ -22,6 +22,10 @@ import { getInitCallInsertionIndex, hasSentryContent } from './utils';
 import { instrumentRootRouteV1 } from './codemods/root-v1';
 import { instrumentRootRouteV2 } from './codemods/root-v2';
 import { instrumentHandleError } from './codemods/handle-error';
+import {
+  findCustomExpressServerImplementation,
+  instrumentExpressCreateRequestHandler,
+} from './codemods/express-server';
 import { getPackageDotJson } from '../utils/clack-utils';
 
 export type PartialRemixConfig = {
@@ -347,3 +351,16 @@ export async function initializeSentryOnEntryServer(
     )}.`,
   );
 }
+
+export async function instrumentExpressServer() {
+  const expressServerPath = await findCustomExpressServerImplementation();
+
+  if (!expressServerPath) {
+    clack.log.warn(
+      `Could not find custom Express server implementation. Please instrument it manually.`,
+    );
+    return;
+  }
+
+  await instrumentExpressCreateRequestHandler(expressServerPath);
+}

package/src/sourcemaps/sourcemaps-wizard.ts

@@ -233,7 +233,7 @@ async function startToolSetupFlow(
   }
 }
 
-async function configureCI(
+export async function configureCI(
   selectedTool: SupportedTools,
   authToken: string,
 ): Promise<void> {
@@ -243,7 +243,7 @@ async function configureCI(
       options: [
         {
           label: 'Yes',
-          hint: 'I use a tool like Github Actions, Gitlab, CircleCI, TravisCI, Jenkins, ...',
+          hint: 'I use a tool like Github Actions, Gitlab, CircleCI, TravisCI, Jenkins, Vercel, ...',
           value: true,
         },
         {

package/src/sveltekit/sveltekit-wizard.ts

@@ -8,6 +8,7 @@ import {
   abort,
   abortIfCancelled,
   addSentryCliConfig,
+  askShouldCreateExamplePage,
   confirmContinueIfNoOrDirtyGitRepo,
   ensurePackageIsInstalled,
   getOrAskForProjectData,
@@ -21,6 +22,7 @@ import { createExamplePage } from './sdk-example';
 import { createOrMergeSvelteKitFiles, loadSvelteConfig } from './sdk-setup';
 import { traceStep, withTelemetry } from '../telemetry';
 import { getKitVersionBucket, getSvelteVersionBucket } from './utils';
+import { NPM, detectPackageManger } from '../utils/package-manager';
 
 export async function runSvelteKitWizard(
   options: WizardOptions,
@@ -128,41 +130,55 @@ export async function runSvelteKitWizardWithTelemetry(
     return;
   }
 
-  try {
-    await traceStep('create-example-page', () =>
-      createExamplePage(svelteConfig, {
-        selfHosted,
-        url: sentryUrl,
-        orgSlug: selectedProject.organization.slug,
-        projectId: selectedProject.id,
-      }),
-    );
-  } catch (e: unknown) {
-    clack.log.error('Error while creating an example page to test Sentry:');
-    clack.log.info(
-      chalk.dim(
-        typeof e === 'object' && e != null && 'toString' in e
-          ? e.toString()
-          : typeof e === 'string'
-          ? e
-          : 'Unknown error',
-      ),
-    );
-    Sentry.captureException(
-      'Error while creating an example Svelte page to test Sentry',
-    );
-    await abort('Exiting Wizard');
-    return;
+  const shouldCreateExamplePage = await askShouldCreateExamplePage(
+    'sentry-example',
+  );
+
+  if (shouldCreateExamplePage) {
+    try {
+      await traceStep('create-example-page', () =>
+        createExamplePage(svelteConfig, {
+          selfHosted,
+          url: sentryUrl,
+          orgSlug: selectedProject.organization.slug,
+          projectId: selectedProject.id,
+        }),
+      );
+    } catch (e: unknown) {
+      clack.log.error('Error while creating an example page to test Sentry:');
+      clack.log.info(
+        chalk.dim(
+          typeof e === 'object' && e != null && 'toString' in e
+            ? e.toString()
+            : typeof e === 'string'
+            ? e
+            : 'Unknown error',
+        ),
+      );
+      Sentry.captureException(
+        'Error while creating an example Svelte page to test Sentry',
+      );
+      await abort('Exiting Wizard');
+      return;
+    }
   }
 
-  clack.outro(`
-${chalk.green('Successfully installed the Sentry SvelteKit SDK!')}
+  clack.outro(buildOutroMessage(shouldCreateExamplePage));
+}
+
+function buildOutroMessage(shouldCreateExamplePage: boolean): string {
+  const packageManager = detectPackageManger() || NPM;
+
+  let msg = chalk.green('\nSuccessfully installed the Sentry SvelteKit SDK!');
+
+  if (shouldCreateExamplePage) {
+    msg += `\n\nYou can validate your setup by starting your dev environment (${chalk.cyan(
+      `\`${packageManager.runScriptCommand} dev\``,
+    )}) and visiting ${chalk.cyan('"/sentry-example"')}.`;
+  }
 
-${chalk.cyan(
-  'You can validate your setup by starting your dev environment (`npm run dev`) and visiting "/sentry-example".',
-)}
+  msg += `\n\nCheck out the SDK documentation for further configuration:
+https://docs.sentry.io/platforms/javascript/guides/sveltekit/`;
 
-Check out the SDK documentation for further configuration:
-https://docs.sentry.io/platforms/javascript/guides/sveltekit/
-  `);
+  return msg;
 }

package/src/utils/clack-utils.ts

@@ -1126,7 +1126,7 @@ type CodeSnippetFormatter = (
  * This is useful for printing the snippet to the console as part of copy/paste instructions.
  *
  * @param callback the callback that returns the formatted code snippet.
- * It exposes takes the helper functions for marking code as unchaned, new or removed.
+ * It exposes takes the helper functions for marking code as unchanged, new or removed.
  * These functions no-op if no special formatting should be applied
  * and otherwise apply the appropriate formatting/coloring.
  * (@see {@link CodeSnippetFormatter})
@@ -1161,7 +1161,7 @@ export function makeCodeSnippet(
  * @param moreInformation (optional) the message to be printed after the file was created
  * For example, this can be a link to more information about configuring the tool.
  *
- * @returns true on sucess, false otherwise
+ * @returns true on success, false otherwise
  */
 export async function createNewConfigFile(
   filepath: string,
@@ -1194,3 +1194,24 @@ export async function createNewConfigFile(
 
   return false;
 }
+
+export async function askShouldCreateExamplePage(
+  customRoute?: string,
+): Promise<boolean> {
+  const route = chalk.cyan(customRoute ?? '/sentry-example-page');
+  return traceStep('ask-create-example-page', () =>
+    abortIfCancelled(
+      clack.select({
+        message: `Do you want to create an example page ("${route}") to test your Sentry setup?`,
+        options: [
+          {
+            value: true,
+            label: 'Yes',
+            hint: 'Recommended - Check your git status before committing!',
+          },
+          { value: false, label: 'No' },
+        ],
+      }),
+    ),
+  );
+}