@sentry/wizard 4.0.0 → 4.0.1

package/lib/Steps/Integrations/Electron.ts

@@ -1,164 +0,0 @@
-import * as fs from 'node:fs';
-import type { Answers } from 'inquirer';
-import { prompt } from 'inquirer';
-import * as path from 'node:path';
-
-import type { Args } from '../../Constants';
-import { dim, green, l, nl, red } from '../../Helper/Logging';
-import { SentryCli } from '../../Helper/SentryCli';
-import { BaseIntegration } from './BaseIntegration';
-
-const MIN_ELECTRON_VERSION_STRING = '2.0.0';
-const MIN_ELECTRON_VERSION = parseInt(
-  MIN_ELECTRON_VERSION_STRING.replace(/\D+/g, ''),
-  10,
-);
-
-const CODE_EXAMPLE_MAIN = `// ESM
-import * as Sentry from '@sentry/electron/main';
-// CommonJs
-const Sentry = require('@sentry/electron/main');
-
-Sentry.init({
-  dsn: '___DSN___',
-});`;
-
-const CODE_EXAMPLE_RENDERER = `// ESM
-import * as Sentry from '@sentry/electron/renderer';
-// CommonJs
-const Sentry = require('@sentry/electron/renderer');
-
-Sentry.init({});`;
-
-type PackageJSON = {
-  dependencies?: Record<string, string>;
-  devDependencies?: Record<string, string>;
-};
-let appPackage: PackageJSON = {};
-
-function printExample(example: string, title = ''): void {
-  if (title) {
-    l(title);
-  }
-
-  nl();
-  dim(example.replace(/^/gm, '    '));
-  nl();
-}
-
-try {
-  appPackage = JSON.parse(
-    fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf-8'),
-  ) as PackageJSON;
-} catch {
-  // We don't need to have this
-}
-
-export class Electron extends BaseIntegration {
-  protected _sentryCli: SentryCli;
-
-  public constructor(protected _argv: Args) {
-    super(_argv);
-    this._sentryCli = new SentryCli(this._argv);
-  }
-
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async emit(answers: Answers): Promise<Answers> {
-    const dsn = answers.config?.dsn?.public ?? null;
-    nl();
-
-    const sentryCliProps = this._sentryCli.convertAnswersToProperties(answers);
-    fs.writeFileSync(
-      './sentry.properties',
-      this._sentryCli.dumpProperties(sentryCliProps),
-    );
-    green('Successfully created sentry.properties');
-    nl();
-
-    printExample(
-      CODE_EXAMPLE_MAIN.replace('___DSN___', dsn),
-      'Add these lines in to your main process code to setup Sentry:',
-    );
-
-    printExample(
-      CODE_EXAMPLE_RENDERER,
-      'Add these lines in to your renderer processes code to setup Sentry:',
-    );
-
-    l('For more information, see https://docs.sentry.io/clients/electron/');
-    nl();
-
-    return {};
-  }
-
-  public async shouldConfigure(_answers: Answers): Promise<Answers> {
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    if (this._shouldConfigure) {
-      return this._shouldConfigure;
-    }
-
-    let success = true;
-    nl();
-
-    success =
-      this._checkDep('electron', MIN_ELECTRON_VERSION_STRING) && success;
-    success = this._checkDep('@sentry/electron') && success;
-
-    let continued: Answers = { continue: true };
-    if (!success && !this._argv.quiet) {
-      continued = await prompt({
-        message:
-          'There were errors during your project checkup, do you still want to continue?',
-        name: 'continue',
-        default: false,
-        type: 'confirm',
-      });
-    }
-
-    nl();
-
-    if (!continued?.continue) {
-      throw new Error('Please install the required dependencies to continue.');
-    }
-
-    this._shouldConfigure = Promise.resolve({ electron: true });
-    // eslint-disable-next-line @typescript-eslint/unbound-method
-    return this.shouldConfigure;
-  }
-
-  private _checkDep(packageName: string, minVersion?: string): boolean {
-    const depVersion = parseInt(
-      (appPackage.dependencies?.[packageName] || '0').replace(/\D+/g, ''),
-      10,
-    );
-    const devDepVersion = parseInt(
-      (appPackage.devDependencies?.[packageName] || '0').replace(/\D+/g, ''),
-      10,
-    );
-
-    if (
-      !appPackage.dependencies?.[packageName] &&
-      !appPackage.devDependencies?.[packageName]
-    ) {
-      red(`✗ ${packageName} isn't in your dependencies`);
-      red('  please install it with yarn/npm');
-      return false;
-    }
-    if (
-      minVersion &&
-      depVersion < MIN_ELECTRON_VERSION &&
-      devDepVersion < MIN_ELECTRON_VERSION
-    ) {
-      red(
-        `✗ Your installed version of ${packageName} is to old, >${MIN_ELECTRON_VERSION_STRING} needed`,
-      );
-      return false;
-    }
-    if (minVersion) {
-      green(`✓ ${packageName} > ${minVersion} is installed`);
-    } else {
-      green(`✓ ${packageName} is installed`);
-    }
-    return true;
-  }
-}

package/lib/Steps/Integrations/MobileProject.ts

@@ -1,72 +0,0 @@
-import type { Answers } from 'inquirer';
-import { prompt } from 'inquirer';
-
-import { getPlatformChoices, Platform } from '../../Constants';
-import { dim } from '../../Helper/Logging';
-import { BaseIntegration } from './BaseIntegration';
-
-export abstract class MobileProject extends BaseIntegration {
-  protected _platforms: Platform[];
-
-  public getPlatforms(answers: Answers): string[] {
-    if (!answers.shouldConfigurePlatforms) {
-      throw new Error('No platform selected');
-    }
-    const shouldConfigurePlatforms =
-      answers.shouldConfigurePlatforms as Partial<Record<Platform, boolean>>;
-    return Object.entries(shouldConfigurePlatforms)
-      .filter((pair) => pair[1])
-      .map((pair) => pair[0]); // only return the keys
-  }
-
-  public async shouldConfigure(answers: Answers): Promise<Answers> {
-    let { shouldConfigurePlatforms } = answers as {
-      shouldConfigurePlatforms?: Partial<Record<Platform, boolean>>;
-    };
-    if (shouldConfigurePlatforms) {
-      return { shouldConfigurePlatforms };
-    }
-
-    const isPlatformSet =
-      this._argv.platform &&
-      Array.isArray(this._argv.platform) &&
-      this._argv.platform.length;
-
-    this._platforms = isPlatformSet
-      ? this._argv.platform
-      : (await this._platformSelector()).platform;
-
-    shouldConfigurePlatforms = {};
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    for (const platform of Object.values(Platform)) {
-      shouldConfigurePlatforms[platform] = this._platforms.includes(platform)
-        ? await this._shouldConfigurePlatform(platform)
-        : false;
-      if (
-        shouldConfigurePlatforms[platform] === false &&
-        this._argv.uninstall === false
-      ) {
-        dim(`will not configure ${platform}`);
-      }
-    }
-    return { shouldConfigurePlatforms };
-  }
-
-  protected _platformSelector(): Promise<Answers> {
-    if (this._argv.quiet) {
-      throw new Error('You need to choose a platform');
-    }
-    return prompt([
-      {
-        choices: getPlatformChoices(),
-        message: 'Select the platforms you like to set up:',
-        name: 'platform',
-        type: 'checkbox',
-      },
-    ]);
-  }
-
-  protected abstract _shouldConfigurePlatform(
-    platform: Platform,
-  ): Promise<boolean>;
-}

package/lib/Steps/OpenSentry.ts

@@ -1,80 +0,0 @@
-import { URL } from 'node:url';
-import type { Answers } from 'inquirer';
-
-import { mapIntegrationToPlatform } from '../Constants';
-import { BottomBar } from '../Helper/BottomBar';
-import { dim, green, l, nl, red } from '../Helper/Logging';
-import { getCurrentIntegration } from '../Helper/Wizard';
-import { BaseStep } from './BaseStep';
-
-import opn from 'opn';
-
-export class OpenSentry extends BaseStep {
-  public async emit(answers: Answers): Promise<Answers> {
-    if (!(await getCurrentIntegration(answers).shouldEmit(answers))) {
-      dim('Skipping connection to Sentry due files already patched');
-      return {};
-    }
-    if (this._argv.skipConnect) {
-      dim('Skipping connection to Sentry');
-      return {};
-    }
-
-    const baseUrl = this._argv.url;
-
-    BottomBar.show('Loading wizard...');
-    this.debug(`Loading wizard for ${baseUrl}`);
-
-    try {
-      const response = await fetch(`${baseUrl}api/0/wizard/`);
-      if (!response.ok) {
-        throw new Error(
-          `Failed to connect to Sentry: ${response.status} ${response.statusText}`,
-        );
-      }
-      const data = (await response.json()) as { hash: string };
-
-      BottomBar.hide();
-
-      const urlObj = new URL(`${baseUrl}account/settings/wizard/${data.hash}/`);
-      if (this._argv.signup) {
-        urlObj.searchParams.set('signup', '1');
-        // integration maps to platform in the wizard
-        if (this._argv.integration) {
-          const platform = mapIntegrationToPlatform(this._argv.integration);
-          if (platform) {
-            urlObj.searchParams.set('project_platform', platform);
-          }
-        }
-        if (this._argv.promoCode) {
-          urlObj.searchParams.set('code', this._argv.promoCode);
-        }
-      }
-
-      const urlToOpen = urlObj.toString();
-
-      // opn throws in environments that don't have a browser (e.g. remote shells) so we just noop here
-      const noop = () => {}; // eslint-disable-line @typescript-eslint/no-empty-function
-      opn(urlToOpen, { wait: false }).then((cp) => cp.on('error', noop), noop);
-
-      nl();
-      l('Please open');
-      green(urlToOpen);
-      l("in your browser (if it's not open already)");
-      nl();
-
-      return { hash: data.hash };
-    } catch (e) {
-      this._argv.skipConnect = true;
-      BottomBar.hide();
-      nl();
-      red(
-        `Wizard couldn't connect to ${baseUrl}\nmake sure the url is correct`,
-      );
-      l(
-        'But no worries, we fall back to asking you stuff instead, so here we go:',
-      );
-      return {};
-    }
-  }
-}

package/lib/Steps/PromptForParameters.ts

@@ -1,200 +0,0 @@
-import type { Answers } from 'inquirer';
-import { prompt } from 'inquirer';
-
-import { dim } from '../Helper/Logging';
-import { getCurrentIntegration } from '../Helper/Wizard';
-import { BaseStep } from './BaseStep';
-
-export class PromptForParameters extends BaseStep {
-  public async emit(answers: Answers): Promise<Answers> {
-    this.debug(answers);
-    if (!(await getCurrentIntegration(answers).shouldEmit(answers))) {
-      return {};
-    }
-    if (this._argv.quiet) {
-      return {};
-    }
-
-    let url = this._getFullUrl(answers);
-    const organization: any = await prompt([
-      {
-        message: 'Organization Slug:',
-        name: 'slug',
-        type: 'input',
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        validate: this._validateSlug,
-        when: this._shouldAsk(answers, 'config.organization.slug', () => {
-          dim('Please copy/paste your organization slug');
-          dim(`It can be found in the url ${url}`);
-        }),
-      },
-    ]);
-
-    url = this._getFullUrl(answers, organization.slug);
-    const project: any = await prompt([
-      {
-        message: 'Project Slug:',
-        name: 'slug',
-        type: 'input',
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        validate: this._validateSlug,
-        when: this._shouldAsk(answers, 'config.project.slug', () => {
-          dim('Please copy/paste your project slug');
-          dim(`It can be found in the url ${url}`);
-        }),
-      },
-    ]);
-
-    url = this._getFullUrl(answers, organization.slug, project.slug);
-    const dsnKeyUrl = this._getDSNKeyUrl(answers, project.slug);
-    const dsn = await prompt([
-      {
-        message: 'DSN:',
-        name: 'public',
-        type: 'input',
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        validate: this._validateDSN,
-        when: this._shouldAsk(answers, 'config.dsn.public', () => {
-          dim('Please copy/paste your DSN');
-          dim(`It can be found here: ${dsnKeyUrl}`);
-        }),
-      },
-    ]);
-
-    const auth = await prompt([
-      {
-        message: 'Auth Token:',
-        name: 'token',
-        type: 'input',
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        validate: this._validateAuthToken,
-        when: this._shouldAsk(answers, 'config.auth.token', () => {
-          dim('Please copy/paste your auth token');
-          dim(`It can be found here: ${this._argv.url}api/`);
-          dim(
-            'In case there is none yet, create one with [project:releases] permission',
-          );
-        }),
-      },
-    ]);
-
-    return {
-      config: {
-        ...answers.config,
-        auth,
-        dsn,
-        project,
-        organization,
-      },
-    };
-  }
-
-  private _getFullUrl(
-    answers: Answers,
-    organizationSlug?: string,
-    projectSlug?: string,
-  ): string {
-    const baseUrl = this._argv.url;
-    const orgSlug =
-      answers.config?.organization?.slug ??
-      organizationSlug ??
-      'organization_slug';
-    const projSlug =
-      answers.config?.project?.slug ?? projectSlug ?? 'project_slug';
-    return `${baseUrl}${orgSlug}/${projSlug}`;
-  }
-
-  private _getDSNKeyUrl(answers: Answers, projectSlug?: string): string {
-    const baseUrl = this._argv.url;
-    const projSlug =
-      answers.config?.project?.slug ?? projectSlug ?? 'project_slug';
-    return `${baseUrl}settings/projects/${projSlug}/keys`;
-  }
-
-  private _shouldAsk(
-    answers: Answers,
-    configKey: string,
-    preHook?: () => void,
-  ): boolean {
-    const shouldAsk = answers[configKey] != null;
-    if (shouldAsk && preHook) {
-      preHook();
-    }
-    return shouldAsk;
-  }
-
-  private _validateAuthToken(input: string): boolean | string {
-    const isOrgToken = input.startsWith('sntrys_');
-
-    if (isOrgToken) {
-      if (!isValidOrgToken(input)) {
-        return 'Make sure you correctly copied your auth token. It should start with "sntrys_"';
-      }
-      return true;
-    }
-
-    if (!input.match(/(sntrys_)?[0-9a-f]{64}/g)) {
-      return 'Make sure you copied the correct auth token, it should be 64 hex chars';
-    }
-    return true;
-  }
-
-  private _validateSlug(input: string): boolean | string {
-    if (input.match(/[A-Z]/g)) {
-      return 'Please copy the slug from the url, it should be all lowercase';
-    }
-    if (input.length === 0) {
-      return "Can't be empty";
-    }
-    return true;
-  }
-
-  private _validateDSN(input: string): boolean | string {
-    const match = input.match(
-      /^(?:(\w+):)?\/\/(?:(\w+)(:\w+)?@)?([\w.-]+)(?::(\d+))?(\/.*)$/,
-    );
-    if (!match) {
-      return 'Invalid DSN format';
-    }
-    if (match[1] !== 'http' && match[1] !== 'https') {
-      return `Unsupported protocol for DSN: ${match[1]}`;
-    }
-    return true;
-  }
-}
-
-type MaybeOrgAuthToken = {
-  iat?: number;
-  url?: string;
-  org?: string;
-  region_url?: string;
-};
-
-/**
- * Trying to parse and decode an org auth token. Based on:
- * - https://github.com/getsentry/rfcs/blob/main/text/0091-ci-upload-tokens.md#parsing-tokens
- * - https://github.com/getsentry/rfcs/blob/main/text/0091-ci-upload-tokens.md#token-facts
- */
-function isValidOrgToken(input: string): boolean {
-  if (!input.startsWith('sntrys_')) {
-    return false;
-  }
-
-  const tokenParts = input.split('_');
-  if (tokenParts.length < 3) {
-    return false;
-  }
-
-  try {
-    const payload = tokenParts[1];
-    const decodedPayload = Buffer.from(payload, 'base64').toString();
-    const jsonPayload = JSON.parse(decodedPayload) as MaybeOrgAuthToken;
-    if (!jsonPayload.iat || !jsonPayload.url || !jsonPayload.org) {
-      return false;
-    }
-  } catch {
-    return false;
-  }
-
-  return true;
-}

package/lib/Steps/Result.ts

@@ -1,22 +0,0 @@
-import type { Answers } from 'inquirer';
-
-import { green, nl } from '../Helper/Logging';
-import { BaseStep } from './BaseStep';
-
-export class Result extends BaseStep {
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async emit(answers: Answers): Promise<Answers> {
-    this.debug(answers);
-    nl();
-    if (this._argv.uninstall) {
-      green('😢  Successfully removed Sentry from your project 😢');
-    } else {
-      green('🎉  Successfully set up Sentry for your project 🎉');
-    }
-    // We need to exit here to stop everything
-    setTimeout(() => {
-      process.exit();
-    }, 100);
-    return {};
-  }
-}

package/lib/Steps/SentryProjectSelector.ts

@@ -1,83 +0,0 @@
-import type { Answers } from 'inquirer';
-import { prompt } from 'inquirer';
-
-import { BaseStep } from './BaseStep';
-
-type Project = {
-  id: string;
-  slug: string;
-  organization?: {
-    name: string;
-    slug: string;
-  };
-  keys: {
-    dsn: {
-      public: string;
-      private: string;
-    };
-  }[];
-};
-
-function sleep(n: number): Promise<void> {
-  return new Promise((resolve) => setTimeout(resolve, n));
-}
-
-export class SentryProjectSelector extends BaseStep {
-  public async emit(answers: Answers): Promise<any> {
-    this.debug(answers);
-
-    if (!answers.wizard) {
-      // we skip this completely because the wizard wasn't running
-      return {};
-    }
-
-    if (!answers.wizard.projects || answers.wizard.projects.length === 0) {
-      throw new Error(
-        'No Projects found. Please create a new Project in Sentry and try again.',
-      );
-    }
-
-    let selectedProject: { selectedProject: Project } | null = null;
-    if (answers.wizard.projects.length === 1) {
-      selectedProject = {
-        selectedProject: answers.wizard.projects[0] as Project,
-      };
-      // the wizard CLI closes too quickly when we skip the prompt
-      // as it will cause the UI to be stuck saying Waiting for wizard to connect
-      await sleep(1000);
-    } else {
-      selectedProject = await prompt([
-        {
-          choices: answers.wizard.projects.map((project: any) => {
-            return {
-              name: `${project.organization.name} / ${project.slug}`,
-              value: project,
-            };
-          }),
-          message: 'Please select your project in Sentry:',
-          name: 'selectedProject',
-          type: 'list',
-        },
-      ]);
-    }
-    const dsn = selectedProject?.selectedProject.keys[0]?.dsn ?? {
-      public: null,
-      private: null,
-    };
-    return {
-      config: {
-        auth: {
-          token: answers.wizard.apiKeys?.token ?? null,
-        },
-        dsn,
-        organization: {
-          slug: selectedProject?.selectedProject.organization?.slug ?? null,
-        },
-        project: {
-          id: selectedProject?.selectedProject.id ?? null,
-          slug: selectedProject?.selectedProject.slug ?? null,
-        },
-      },
-    };
-  }
-}

package/lib/Steps/ShouldConfigure.ts

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

package/lib/Steps/WaitForSentry.ts

@@ -1,56 +0,0 @@
-import type { Answers } from 'inquirer';
-
-import { BottomBar } from '../Helper/BottomBar';
-import { getCurrentIntegration } from '../Helper/Wizard';
-import { BaseStep } from './BaseStep';
-
-export class WaitForSentry extends BaseStep {
-  public async emit(answers: Answers): Promise<Answers> {
-    if (!(await getCurrentIntegration(answers).shouldEmit(answers))) {
-      return {};
-    }
-    if (this._argv.skipConnect) {
-      return {};
-    }
-
-    if (!answers.hash) {
-      throw new Error(`No wizard hash found ${answers}`);
-    }
-
-    return new Promise((resolve, _reject) => {
-      this.debug(answers);
-
-      BottomBar.show('Waiting for Sentry...');
-      const baseUrl = this._argv.url;
-
-      const pingSentry = async (): Promise<void> => {
-        const response = await fetch(`${baseUrl}api/0/wizard/${answers.hash}/`);
-        this.debug('Polling received data');
-        if (!response.ok) {
-          throw new Error(
-            `Received status ${response.status} ${response.statusText}`,
-          );
-        }
-        const data = await response.json();
-        // Delete the wizard hash since we were able to fetch the data
-        await fetch(`${baseUrl}api/0/wizard/${answers.hash}/`, {
-          method: 'DELETE',
-        });
-        BottomBar.hide();
-        this.debug('Polling Success!');
-        resolve({ wizard: data });
-      };
-
-      const poll = (): void => {
-        this.debug(`Polling: ${baseUrl}api/0/wizard/${answers.hash}/`);
-        pingSentry().catch((e) => {
-          this.debug('Polling received:');
-          this.debug(e);
-          setTimeout(poll, 1000);
-        });
-      };
-
-      poll();
-    });
-  }
-}