@sentry/wizard 3.5.0 → 3.6.0

package/src/telemetry.ts

@@ -6,6 +6,7 @@ import {
   makeNodeTransport,
   NodeClient,
   runWithAsyncContext,
+  trace,
 } from '@sentry/node';
 import packageJson from '../package.json';
 
@@ -26,6 +27,7 @@ export async function withTelemetry<F>(
   const transaction = sentryHub.startTransaction({
     name: 'sentry-wizard-execution',
     status: 'ok',
+    op: 'wizard.flow',
   });
   sentryHub.getScope().setSpan(transaction);
   const sentrySession = sentryHub.startSession();
@@ -74,6 +76,8 @@ function createSentryInstance(enabled: boolean, integration: string) {
     },
 
     transport: makeNodeTransport,
+
+    debug: true,
   });
 
   const hub = new Hub(client);
@@ -84,3 +88,7 @@ function createSentryInstance(enabled: boolean, integration: string) {
 
   return { sentryHub: hub, sentryClient: client };
 }
+
+export function traceStep<T>(step: string, callback: () => T): T {
+  return trace({ name: step, op: 'wizard.step' }, () => callback());
+}

package/src/utils/bash.ts

@@ -0,0 +1,44 @@
+import * as child_process from 'child_process';
+import * as https from 'https';
+import * as fs from 'fs';
+
+export function hasSentryCLI(): boolean {
+    try {
+        child_process.execSync('sentry-cli --version');
+        return true;
+    } catch (e) {
+        return false;
+    }
+}
+
+export async function installSentryCLI(): Promise<void> {
+    const httpAsync = new Promise((resolve, reject) => {
+        const file = fs.createWriteStream('installcli.sh');
+        https.get('https://sentry.io/get-cli/', (response) => {
+            response.pipe(file);
+            file.on('finish', () => {
+                file.close();
+                try {
+                    child_process.execSync('bash ./installcli.sh');
+                } catch (e) {
+                    reject(e);
+                    return
+                }
+                fs.unlinkSync('installcli.sh');
+                resolve(null);
+            });
+
+            file.on('error', (err) => {
+                fs.unlinkSync('installcli.sh');
+                reject(err);
+            });
+        });
+    });
+
+    await httpAsync;
+}
+
+export function execute(command: string): string {
+    const output = child_process.execSync(command);
+    return output.toString();
+}

package/src/utils/clack-utils.ts

@@ -10,6 +10,7 @@ import { URL } from 'url';
 import { promisify } from 'util';
 import * as Sentry from '@sentry/node';
 import { windowedSelect } from './vendor/clack-custom-select';
+import { hasPackageInstalled, PackageDotJson } from './package-json';
 
 const opn = require('opn') as (
   url: string,
@@ -24,16 +25,11 @@ interface WizardProjectData {
   projects: SentryProjectData[];
 }
 
-export type PackageDotJson = {
-  scripts?: Record<string, string>;
-  dependencies?: Record<string, string>;
-  devDependencies?: Record<string, string>;
-};
-
 export interface SentryProjectData {
   id: string;
   slug: string;
   name: string;
+  platform: string;
   organization: {
     slug: string;
   };
@@ -130,10 +126,16 @@ export async function confirmContinueEvenThoughNoGitRepo(): Promise<void> {
   }
 }
 
+export async function askToInstallSentryCLI(): Promise<boolean> {
+  return await abortIfCancelled(clack.confirm({
+    message: "You don't have Sentry CLI installed. Do you want to install it?"
+  }));
+}
+
 export async function askForWizardLogin(options: {
   url: string;
   promoCode?: string;
-  platform?: 'javascript-nextjs' | 'javascript-sveltekit';
+  platform?: 'javascript-nextjs' | 'javascript-sveltekit' | 'apple-ios';
 }): Promise<WizardProjectData> {
   Sentry.setTag('has-promo-code', !!options.promoCode);
 
@@ -186,8 +188,7 @@ export async function askForWizardLogin(options: {
   const urlToOpen = loginUrl.toString();
   clack.log.info(
     `${chalk.bold(
-      `If the browser window didn't open automatically, please open the following link to ${
-        hasSentryAccount ? 'log' : 'sign'
+      `If the browser window didn't open automatically, please open the following link to ${hasSentryAccount ? 'log' : 'sign'
       } into Sentry:`,
     )}\n\n${chalk.cyan(urlToOpen)}`,
   );
@@ -234,6 +235,23 @@ export async function askForWizardLogin(options: {
   return data;
 }
 
+export async function askForItemSelection(items: string[], message: string): Promise<{ value: string, index: number }> {
+  const selection: { value: string, index: number } | symbol = await abortIfCancelled(
+    windowedSelect({
+      maxItems: 12,
+      message: message,
+      options: items.map((item, index) => {
+        return {
+          value: { value: item, index: index },
+          label: item,
+        };
+      }),
+    }),
+  );
+
+  return selection;
+}
+
 export async function askForProjectSelection(
   projects: SentryProjectData[],
 ): Promise<SentryProjectData> {
@@ -251,6 +269,7 @@ export async function askForProjectSelection(
   );
 
   Sentry.setTag('project', selection.slug);
+  Sentry.setTag('project-platform', selection.platform);
   Sentry.setUser({ id: selection.organization.slug });
 
   return selection;
@@ -359,9 +378,8 @@ export async function askForSelfHosted(urlFromArgs?: string): Promise<{
       tmpUrlFromArgs ||
       (await abortIfCancelled(
         clack.text({
-          message: `Please enter the URL of your ${
-            urlFromArgs ? '' : 'self-hosted '
-          }Sentry instance.`,
+          message: `Please enter the URL of your ${urlFromArgs ? '' : 'self-hosted '
+            }Sentry instance.`,
           placeholder: 'https://sentry.io/',
         }),
       ));
@@ -584,32 +602,8 @@ export async function getPackageDotJson(): Promise<PackageDotJson> {
   return packageJson || {};
 }
 
-export function hasPackageInstalled(
-  packageName: string,
-  packageJson: PackageDotJson,
-): boolean {
-  return getPackageVersion(packageName, packageJson) !== undefined;
-}
-
-export function getPackageVersion(
-  packageName: string,
-  packageJson: PackageDotJson,
-): string | undefined {
-  return (
-    packageJson?.dependencies?.[packageName] ||
-    packageJson?.devDependencies?.[packageName]
-  );
-}
-
 async function getPackageManager(): Promise<string> {
-  let detectedPackageManager;
-  if (fs.existsSync(path.join(process.cwd(), 'yarn.lock'))) {
-    detectedPackageManager = 'yarn';
-  } else if (fs.existsSync(path.join(process.cwd(), 'package-lock.json'))) {
-    detectedPackageManager = 'npm';
-  } else if (fs.existsSync(path.join(process.cwd(), 'pnpm-lock.yaml'))) {
-    detectedPackageManager = 'pnpm';
-  }
+  const detectedPackageManager = detectPackageManager();
 
   if (detectedPackageManager) {
     return detectedPackageManager;
@@ -630,3 +624,16 @@ async function getPackageManager(): Promise<string> {
 
   return selectedPackageManager;
 }
+
+export function detectPackageManager(): 'yarn' | 'npm' | 'pnpm' | undefined {
+  if (fs.existsSync(path.join(process.cwd(), 'yarn.lock'))) {
+    return 'yarn';
+  }
+  if (fs.existsSync(path.join(process.cwd(), 'package-lock.json'))) {
+    return 'npm';
+  }
+  if (fs.existsSync(path.join(process.cwd(), 'pnpm-lock.yaml'))) {
+    return 'pnpm';
+  }
+  return undefined;
+}

package/src/utils/package-json.ts

@@ -0,0 +1,45 @@
+export type PackageDotJson = {
+  scripts?: Record<string, string>;
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+};
+
+type NpmPackage = {
+  name: string;
+  version: string;
+};
+
+/**
+ * Checks if @param packageJson has any of the @param packageNamesList package names
+ * listed as a dependency or devDependency.
+ * If so, it returns the first package name that is found, including the
+ * version (range) specified in the package.json.
+ */
+export function findInstalledPackageFromList(
+  packageNamesList: string[],
+  packageJson: PackageDotJson,
+): NpmPackage | undefined {
+  return packageNamesList
+    .map((packageName) => ({
+      name: packageName,
+      version: getPackageVersion(packageName, packageJson),
+    }))
+    .find((sdkPackage): sdkPackage is NpmPackage => !!sdkPackage.version);
+}
+
+export function hasPackageInstalled(
+  packageName: string,
+  packageJson: PackageDotJson,
+): boolean {
+  return getPackageVersion(packageName, packageJson) !== undefined;
+}
+
+export function getPackageVersion(
+  packageName: string,
+  packageJson: PackageDotJson,
+): string | undefined {
+  return (
+    packageJson?.dependencies?.[packageName] ||
+    packageJson?.devDependencies?.[packageName]
+  );
+}

package/src/utils/types.ts

@@ -1,4 +1,9 @@
 export type WizardOptions = {
+  /**
+   * Controls whether the wizard should send telemetry data to Sentry.
+   */
+  telemetryEnabled: boolean;
+
   /**
    * The promo code to use while signing up for Sentry.
    * This can be passed via the --promo-code arg.