@sentry/wizard 3.28.0 → 3.30.0

package/src/utils/clack-utils.ts

@@ -670,6 +670,52 @@ async function addCliConfigFileToGitIgnore(filename: string): Promise<void> {
   }
 }
 
+export async function runPrettierIfInstalled(): Promise<void> {
+  return traceStep('run-prettier', async () => {
+    const packageJson = await getPackageDotJson();
+    const prettierInstalled = hasPackageInstalled('prettier', packageJson);
+
+    if (prettierInstalled) {
+      // prompt the user if they want to run prettier
+      const shouldRunPrettier = await abortIfCancelled(
+        clack.confirm({
+          message:
+            'Looks like you have Prettier in your project. Do you want to run it on your files?',
+        }),
+      );
+
+      if (!shouldRunPrettier) {
+        return;
+      }
+    } else {
+      return;
+    }
+
+    const prettierSpinner = clack.spinner();
+    prettierSpinner.start('Running Prettier on your files.');
+
+    try {
+      await new Promise<void>((resolve, reject) => {
+        childProcess.exec('npx prettier --write .', (err) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve();
+          }
+        });
+      });
+    } catch {
+      prettierSpinner.stop('Prettier failed to run.');
+      clack.log.error(
+        'Prettier failed to run. There may be formatting issues in your updated files.',
+      );
+      return;
+    }
+
+    prettierSpinner.stop('Prettier has formatted your files.');
+  });
+}
+
 /**
  * Checks if @param packageId is listed as a dependency in @param packageJson.
  * If not, it will ask users if they want to continue without the package.
@@ -734,7 +780,7 @@ export async function getPackageDotJson(): Promise<PackageDotJson> {
   return packageJson || {};
 }
 
-async function getPackageManager(): Promise<PackageManager> {
+export async function getPackageManager(): Promise<PackageManager> {
   const detectedPackageManager = detectPackageManger();
 
   if (detectedPackageManager) {
@@ -823,7 +869,7 @@ export async function getOrAskForProjectData(
   }
 
   const selectedProject = await traceStep('select-project', () =>
-    askForProjectSelection(projects),
+    askForProjectSelection(projects, options.orgSlug, options.projectSlug),
   );
 
   const { token } = apiKeys ?? {};
@@ -1041,14 +1087,38 @@ async function askForWizardLogin(options: {
 
 async function askForProjectSelection(
   projects: SentryProjectData[],
+  orgSlug?: string,
+  projectSlug?: string,
 ): Promise<SentryProjectData> {
   const label = (project: SentryProjectData): string => {
     return `${project.organization.slug}/${project.slug}`;
   };
-  const sortedProjects = [...projects];
+
+  const filteredProjects = filterProjectsBySlugs(
+    projects,
+    orgSlug,
+    projectSlug,
+  );
+
+  if (filteredProjects.length === 1) {
+    const selection = filteredProjects[0];
+
+    Sentry.setTag('project', selection.slug);
+    Sentry.setUser({ id: selection.organization.slug });
+    clack.log.step(`Selected project ${label(selection)}`);
+
+    return selection;
+  }
+
+  if (filteredProjects.length === 0) {
+    clack.log.warn('Could not find a project with the provided slugs.');
+  }
+
+  const sortedProjects = filteredProjects.length ? filteredProjects : projects;
   sortedProjects.sort((a: SentryProjectData, b: SentryProjectData) => {
     return label(a).localeCompare(label(b));
   });
+
   const selection: SentryProjectData | symbol = await abortIfCancelled(
     clack.select({
       maxItems: 12,
@@ -1068,6 +1138,26 @@ async function askForProjectSelection(
   return selection;
 }
 
+function filterProjectsBySlugs(
+  projects: SentryProjectData[],
+  orgSlug?: string,
+  projectSlug?: string,
+): SentryProjectData[] {
+  if (!orgSlug && !projectSlug) {
+    return projects;
+  }
+  if (orgSlug && !projectSlug) {
+    return projects.filter((p) => p.organization.slug === orgSlug);
+  }
+  if (!orgSlug && projectSlug) {
+    return projects.filter((p) => p.slug === projectSlug);
+  }
+
+  return projects.filter(
+    (p) => p.organization.slug === orgSlug && p.slug === projectSlug,
+  );
+}
+
 /**
  * Asks users if they have a config file for @param tool (e.g. Vite).
  * If yes, asks users to specify the path to their config file.

package/src/utils/types.ts

@@ -33,6 +33,20 @@ export type WizardOptions = {
    */
   url?: string;
 
+  /**
+   * The org to pre-select in the wizard.
+   * This can be passed via the `--org` arg.
+   * Example: `--org my-org`
+   */
+  orgSlug?: string;
+
+  /**
+   * Project slug to pre-select in the wizard.
+   * This can be passed via the `--project` arg.
+   * Example: `--project my-project`
+   */
+  projectSlug?: string;
+
   /**
    * If this is set, the wizard will skip the login and project selection step.
    * (This can not yet be set externally but for example when redirecting from

package/test/remix/client-entry.test.ts

@@ -0,0 +1,122 @@
+// @ts-expect-error - magicast is ESM and TS complains about that. It works though
+import { parseModule } from 'magicast';
+import { updateEntryClientMod } from '../../src/remix/sdk-setup';
+
+describe('initializeSentryOnEntryClient', () => {
+  it('should initialize Sentry on client entry with all features enabled', () => {
+    // Empty entry.client.tsx file for testing
+    const originalEntryClientMod = parseModule('');
+
+    const dsn = 'https://sentry.io/123';
+    const selectedFeatures = {
+      performance: true,
+      replay: true,
+    };
+
+    const result = updateEntryClientMod(
+      originalEntryClientMod,
+      dsn,
+      selectedFeatures,
+    );
+
+    expect(result.generate().code).toMatchInlineSnapshot(`
+      "import {  useEffect,} from "react";
+
+      import {
+        useLocation,
+        useMatches,
+      } from "@remix-run/react";
+
+      import * as Sentry from "@sentry/remix";
+
+      Sentry.init({
+          dsn: "https://sentry.io/123",
+          tracesSampleRate: 1,
+
+          integrations: [Sentry.browserTracingIntegration({
+            useEffect,
+            useLocation,
+            useMatches
+          }), Sentry.replayIntegration({
+              maskAllText: true,
+              blockAllMedia: true
+          })],
+
+          replaysSessionSampleRate: 0.1,
+          replaysOnErrorSampleRate: 1
+      })"
+    `);
+  });
+
+  it('should initialize Sentry on client entry when performance disabled', () => {
+    // Empty entry.client.tsx file for testing
+    const originalEntryClientMod = parseModule('');
+
+    const dsn = 'https://sentry.io/123';
+    const selectedFeatures = {
+      performance: false,
+      replay: true,
+    };
+
+    const result = updateEntryClientMod(
+      originalEntryClientMod,
+      dsn,
+      selectedFeatures,
+    );
+
+    expect(result.generate().code).toMatchInlineSnapshot(`
+      "import * as Sentry from "@sentry/remix";
+
+      Sentry.init({
+          dsn: "https://sentry.io/123",
+
+          integrations: [Sentry.replayIntegration({
+              maskAllText: true,
+              blockAllMedia: true
+          })],
+
+          replaysSessionSampleRate: 0.1,
+          replaysOnErrorSampleRate: 1
+      })"
+    `);
+  });
+
+  it('should initialize Sentry on client entry when replay disabled', () => {
+    // Empty entry.client.tsx file for testing
+    const originalEntryClientMod = parseModule('');
+
+    const dsn = 'https://sentry.io/123';
+    const selectedFeatures = {
+      performance: true,
+      replay: false,
+    };
+
+    const result = updateEntryClientMod(
+      originalEntryClientMod,
+      dsn,
+      selectedFeatures,
+    );
+
+    expect(result.generate().code).toMatchInlineSnapshot(`
+      "import {  useEffect,} from "react";
+
+      import {
+        useLocation,
+        useMatches,
+      } from "@remix-run/react";
+
+      import * as Sentry from "@sentry/remix";
+
+      Sentry.init({
+          dsn: "https://sentry.io/123",
+          tracesSampleRate: 1,
+
+          integrations: [Sentry.browserTracingIntegration({
+            useEffect,
+            useLocation,
+            useMatches
+          })]
+      })"
+    `);
+  });
+});

package/test/remix/server-instrumentation.test.ts

@@ -0,0 +1,38 @@
+import { generateServerInstrumentationFile } from '../../src/remix/sdk-setup';
+
+describe('generateServerInstrumentationFile', () => {
+  it('should generate server instrumentation file', () => {
+    const result = generateServerInstrumentationFile('https://sentry.io/123', {
+      performance: true,
+      replay: true,
+    });
+
+    expect(result.instrumentationFileMod.generate().code)
+      .toMatchInlineSnapshot(`
+      "import * as Sentry from "@sentry/remix";
+
+      Sentry.init({
+          dsn: "https://sentry.io/123",
+          tracesSampleRate: 1,
+          autoInstrumentRemix: true
+      })"
+    `);
+  });
+
+  it('should generate server instrumentation file when performance is disabled', () => {
+    const result = generateServerInstrumentationFile('https://sentry.io/123', {
+      performance: false,
+      replay: true,
+    });
+
+    expect(result.instrumentationFileMod.generate().code)
+      .toMatchInlineSnapshot(`
+      "import * as Sentry from "@sentry/remix";
+
+      Sentry.init({
+          dsn: "https://sentry.io/123",
+          autoInstrumentRemix: true
+      })"
+    `);
+  });
+});