@sentry/wizard 4.0.0 → 4.0.1

package/lib/Helper/Logging.ts

@@ -1,44 +0,0 @@
-import Chalk from 'chalk';
-
-export function prepareMessage(msg: unknown): string {
-  if (typeof msg === 'string') {
-    return msg;
-  }
-  if (msg instanceof Error) {
-    return `${msg.stack || ''}`;
-  }
-  return JSON.stringify(msg, null, '\t');
-}
-
-export function l(msg: string): void {
-  // eslint-disable-next-line no-console
-  console.log(msg);
-}
-
-export function nl(): void {
-  return l('');
-}
-
-export function green(msg: string): void {
-  return l(Chalk.green(prepareMessage(msg)));
-}
-
-export function red(msg: string): void {
-  return l(Chalk.red(prepareMessage(msg)));
-}
-
-export function dim(msg: string): void {
-  return l(Chalk.dim(prepareMessage(msg)));
-}
-
-export function yellow(msg: string): void {
-  return l(Chalk.yellow(prepareMessage(msg)));
-}
-
-export function cyan(msg: string): void {
-  return l(Chalk.cyan(prepareMessage(msg)));
-}
-
-export function debug(msg: any): void {
-  return l(Chalk.italic.yellow(prepareMessage(msg)));
-}

package/lib/Helper/MergeConfig.ts

@@ -1,19 +0,0 @@
-import * as fs from 'fs';
-
-// merges the config files
-export function mergeConfigFile(
-  sourcePath: string,
-  templatePath: string,
-): boolean {
-  try {
-    const templateFile = fs.readFileSync(templatePath, 'utf8');
-    const sourceFile = fs.readFileSync(sourcePath, 'utf8');
-    const newText = templateFile.replace('// ORIGINAL CONFIG', sourceFile);
-    // eslint-disable-next-line @typescript-eslint/no-implied-eval
-    Function(newText); // check if the file is valid javascript
-    fs.writeFileSync(sourcePath, newText);
-    return true;
-  } catch (error) {
-    return false;
-  }
-}

package/lib/Helper/Package.ts

@@ -1,80 +0,0 @@
-import { satisfies, subset, valid, validRange } from 'semver';
-
-import { green, red } from './Logging';
-
-export function checkPackageVersion(
-  appPackage: {
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-  },
-  packageName: string,
-  acceptableVersions: string,
-  canBeLatest: boolean,
-): boolean {
-  const depsVersion = appPackage?.dependencies?.[packageName] ?? '';
-  const devDepsVersion = appPackage?.devDependencies?.[packageName] ?? '';
-
-  if (!depsVersion && !devDepsVersion) {
-    red(`✗ ${packageName} isn't in your dependencies.`);
-    red('  Please install it with yarn/npm.');
-    return false;
-  }
-  if (
-    !fulfillsVersionRange(depsVersion, acceptableVersions, canBeLatest) &&
-    !fulfillsVersionRange(devDepsVersion, acceptableVersions, canBeLatest)
-  ) {
-    red(
-      `✗ Your \`package.json\` specifies a version of \`${packageName}\` outside of the compatible version range ${acceptableVersions}.\n`,
-    );
-    return false;
-  }
-  green(
-    `✓ A compatible version of \`${packageName}\` is specified in \`package.json\`.`,
-  );
-  return true;
-}
-
-function fulfillsVersionRange(
-  version: string,
-  acceptableVersions: string,
-  canBeLatest: boolean,
-): boolean {
-  if (version === 'latest') {
-    return canBeLatest;
-  }
-
-  let cleanedUserVersion, isRange;
-
-  if (valid(version)) {
-    cleanedUserVersion = valid(version);
-    isRange = false;
-  } else if (validRange(version)) {
-    cleanedUserVersion = validRange(version);
-    isRange = true;
-  }
-
-  return (
-    // If the given version is a bogus format, this will still be undefined and we'll automatically reject it
-    !!cleanedUserVersion &&
-    (isRange
-      ? subset(cleanedUserVersion, acceptableVersions)
-      : satisfies(cleanedUserVersion, acceptableVersions))
-  );
-}
-
-/**
- * Determines if the passed `package.json` object has the passed package installed.
- *
- * @param appPackage The `package.json` object
- * @param packageName The name of the package to check for
- *
- * @returns `true` if the package is installed, `false` otherwise
- */
-export function hasPackageInstalled(
-  appPackage: Record<string, any>,
-  packageName: string,
-): boolean {
-  const depsVersion = appPackage.dependencies[packageName];
-  const devDepsVersion = appPackage.devDependencies[packageName];
-  return !!depsVersion || !!devDepsVersion;
-}

package/lib/Helper/SentryCli.ts

@@ -1,139 +0,0 @@
-import * as fs from 'node:fs';
-import type { Answers } from 'inquirer';
-import * as path from 'node:path';
-
-import type { Args } from '../Constants';
-import { addToGitignore } from './Git';
-import { green, l, nl, red } from './Logging';
-
-const SENTRYCLIRC_FILENAME = '.sentryclirc';
-const GITIGNORE_FILENAME = '.gitignore';
-const PROPERTIES_FILENAME = 'sentry.properties';
-
-export interface SentryCliProps {
-  [s: string]: string;
-}
-
-type SentryCliConfig = Record<string, SentryCliProps>;
-
-export class SentryCli {
-  // eslint-disable-next-line @typescript-eslint/typedef
-  private _resolve = require.resolve;
-
-  public constructor(protected _argv: Args) {}
-
-  public setResolveFunction(resolve: (path: string) => string): void {
-    this._resolve = resolve as any;
-  }
-
-  public convertAnswersToProperties(answers: Answers): SentryCliProps {
-    const props: SentryCliProps = {};
-    props['defaults/url'] = this._argv.url;
-    props['defaults/org'] = answers.config?.organization?.slug ?? null;
-    props['defaults/project'] = answers.config?.project?.slug ?? null;
-    props['auth/token'] = answers.config?.auth?.token ?? null;
-    try {
-      const cliPath = this._resolve('@sentry/cli/bin/sentry-cli', {
-        paths: [process.cwd()],
-      });
-      props['cli/executable'] = path
-        .relative(process.cwd(), cliPath)
-        .replace(/\\/g, '\\\\');
-    } catch (e) {
-      // we do nothing and leave everything as it is
-    }
-    return props;
-  }
-
-  /** Create the contents of a `sentry.properties` file */
-  public dumpProperties(props: SentryCliProps): string {
-    const rv = [];
-    for (const [key, value] of Object.entries(props)) {
-      const normalizedKey = key.replace(/\//g, '.');
-      if (value === undefined || value === null) {
-        // comment that property out since it has no value
-        rv.push(`#${normalizedKey}=`);
-      } else {
-        rv.push(`${normalizedKey}=${value}`);
-      }
-    }
-    // eslint-disable-next-line prefer-template
-    return rv.join('\n') + '\n';
-  }
-
-  public dumpConfig(config: SentryCliConfig): string {
-    const dumpedSections: string[] = [];
-    for (const [sectionName, val] of Object.entries(config)) {
-      const props = this.dumpProperties(val);
-      const section = `[${sectionName}]\n${props}`;
-      dumpedSections.push(section);
-    }
-    return dumpedSections.join('\n');
-  }
-
-  /**
-   * Creates `.sentryclirc` and `sentry.properties` files with the CLI properties
-   * obtained from the user answers (or from logging into Sentry).
-   * The `.sentryclirc` only contains the auth token and will be added to the
-   * user's `.gitignore` file. The properties file contains the rest of the
-   * properties (org, project, etc.).
-   *
-   * @param sentryCli instance of the Sentry CLI
-   * @param cliProps the properties to write to the files
-   */
-  public async createSentryCliConfig(cliProps: SentryCliProps): Promise<void> {
-    const { 'auth/token': authToken, ...cliPropsToWrite } = cliProps;
-
-    /**
-     * To not commit the auth token to the VCS, instead of adding it to the
-     * properties file (like the rest of props), it's added to the Sentry CLI
-     * config, which is added to the gitignore. This way makes the properties
-     * file safe to commit without exposing any auth tokens.
-     */
-    if (authToken) {
-      try {
-        await fs.promises.appendFile(
-          SENTRYCLIRC_FILENAME,
-          this.dumpConfig({ auth: { token: authToken } }),
-        );
-        green(`✓ Successfully added the auth token to ${SENTRYCLIRC_FILENAME}`);
-      } catch {
-        red(
-          `⚠ Could not add the auth token to ${SENTRYCLIRC_FILENAME}, ` +
-            `please add it to identify your user account:\n${authToken}`,
-        );
-        nl();
-      }
-    } else {
-      red(
-        `⚠ Did not find an auth token, please add your token to ${SENTRYCLIRC_FILENAME}`,
-      );
-      l(
-        'To generate an auth token, visit https://sentry.io/settings/account/api/auth-tokens/',
-      );
-      l(
-        'To learn how to configure Sentry CLI, visit ' +
-          'https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-sentry-cli',
-      );
-    }
-
-    await addToGitignore(
-      SENTRYCLIRC_FILENAME,
-      `⚠ Could not add ${SENTRYCLIRC_FILENAME} to ${GITIGNORE_FILENAME}, please add it to not commit your auth key.`,
-    );
-
-    try {
-      await fs.promises.writeFile(
-        `./${PROPERTIES_FILENAME}`,
-        this.dumpProperties(cliPropsToWrite),
-      );
-      green('✓ Successfully created sentry.properties');
-    } catch {
-      red(`⚠ Could not add org and project data to ${PROPERTIES_FILENAME}`);
-      l(
-        'See docs for a manual setup: https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#configure-sentry-cli',
-      );
-    }
-    nl();
-  }
-}

package/lib/Helper/Wizard.ts

@@ -1,58 +0,0 @@
-import type { Answers } from 'inquirer';
-
-import type { Args } from '../Constants';
-import type { IStep } from '../Steps/BaseStep';
-import type { BaseIntegration } from '../Steps/Integrations/BaseIntegration';
-import { BottomBar } from './BottomBar';
-import { debug, dim, nl, red } from './Logging';
-
-function sanitizeAndValidateArgs(argv: Args): void {
-  if (argv.quiet === undefined) {
-    argv.quiet = true;
-    dim('will activate quiet mode for you');
-  }
-  // @ts-ignore skip-connect does not exist on args
-  if (argv['skip-connect']) {
-    // @ts-ignore skip-connect does not exist on args
-    argv.skipConnect = argv['skip-connect'];
-    // @ts-ignore skip-connect does not exist on args
-    delete argv['skip-connect'];
-  }
-  // @ts-ignore skip-connect does not exist on args
-  argv.promoCode = argv['promo-code'];
-}
-
-export function getCurrentIntegration(answers: Answers): BaseIntegration {
-  return answers.integration as BaseIntegration;
-}
-
-export async function startWizard<M extends IStep>(
-  argv: Args,
-  ...steps: Array<{ new (debug: Args): M }>
-): Promise<Answers> {
-  try {
-    sanitizeAndValidateArgs(argv);
-    if (argv.debug) {
-      debug(argv);
-    }
-    if (argv.quiet) {
-      dim("Quiet mode On, DAMA, don't ask me anything");
-    }
-    return await steps
-      .map((step) => new step(argv))
-      .reduce(async (answer, step) => {
-        const prevAnswer = await answer;
-        const answers = await step.emit(prevAnswer);
-        return { ...prevAnswer, ...answers };
-      }, Promise.resolve({}));
-  } catch (e) {
-    BottomBar.hide();
-    nl();
-    red('Sentry Wizard failed with:');
-    red(argv.debug ? e : e.message);
-    nl();
-    red('Protip: Add --debug to see whats going on');
-    red('OR use --help to see your options');
-    process.exit(1);
-  }
-}

package/lib/Helper/__tests__/File.ts

@@ -1,15 +0,0 @@
-/// <reference types="jest" />
-import { exists, matchesContent } from '../File';
-
-describe('SentryCli', () => {
-  test('exists', () => {
-    expect(exists('**/File.ts')).toBeTruthy();
-    expect(exists('Filea.ts')).toBeFalsy();
-  });
-
-  test('matchesContent', () => {
-    expect(matchesContent('**/File.ts', /exists/g)).toBeTruthy();
-    expect(matchesContent('**/File.ts', /blabla/g)).toBeFalsy();
-    expect(matchesContent('Filea.ts', /exists/g)).toBeFalsy();
-  });
-});

package/lib/Helper/__tests__/MergeConfig.ts

@@ -1,98 +0,0 @@
-/// <reference types="jest" />
-import * as fs from 'fs';
-import * as path from 'path';
-
-import { mergeConfigFile } from '../MergeConfig';
-
-const configPath = path.join(__dirname, '..', 'test-fixtures/next.config.js');
-const templatePath = path.join(
-  __dirname,
-  '..',
-  '..',
-  '..',
-  'scripts/NextJs/configs/next.config.template.js',
-);
-
-function configFileNames(num: number): {
-  sourcePath: string;
-  mergedPath: string;
-} {
-  const sourcePath = path.join(
-    __dirname,
-    '..',
-    `test-fixtures/next.config.${num}.js`,
-  );
-  const mergedPath = path.join(
-    __dirname,
-    '..',
-    `test-fixtures/next.config.${num}-merged.js`,
-  );
-  return { sourcePath, mergedPath };
-}
-
-describe('Merging next.config.js', () => {
-  afterEach(() => {
-    fs.unlinkSync(configPath);
-  });
-
-  test('merge basic next.config.js return true', () => {
-    const { sourcePath } = configFileNames(1);
-    fs.copyFileSync(sourcePath, configPath);
-
-    expect(mergeConfigFile(configPath, templatePath)).toBe(true);
-  });
-
-  test('merge basic next.config.js', () => {
-    const { sourcePath, mergedPath } = configFileNames(1);
-    fs.copyFileSync(sourcePath, configPath);
-
-    mergeConfigFile(configPath, templatePath);
-
-    expect(fs.readFileSync(configPath, 'utf8')).toEqual(
-      fs.readFileSync(mergedPath, 'utf8'),
-    );
-  });
-
-  test('merge invalid javascript config return false', () => {
-    const { sourcePath } = configFileNames(2);
-    fs.copyFileSync(sourcePath, configPath);
-
-    expect(mergeConfigFile(configPath, templatePath)).toBe(false);
-  });
-
-  test('merge more complicated next.config.js return true', () => {
-    const { sourcePath } = configFileNames(3);
-    fs.copyFileSync(sourcePath, configPath);
-
-    expect(mergeConfigFile(configPath, templatePath)).toBe(true);
-  });
-
-  test('merge more complicated next.config.js', () => {
-    const { sourcePath, mergedPath } = configFileNames(3);
-    fs.copyFileSync(sourcePath, configPath);
-
-    mergeConfigFile(configPath, templatePath);
-
-    expect(fs.readFileSync(configPath, 'utf8')).toEqual(
-      fs.readFileSync(mergedPath, 'utf8'),
-    );
-  });
-
-  test('merge next.config.js with function return true', () => {
-    const { sourcePath } = configFileNames(4);
-    fs.copyFileSync(sourcePath, configPath);
-
-    expect(mergeConfigFile(configPath, templatePath)).toBe(true);
-  });
-
-  test('merge next.config.js with function', () => {
-    const { sourcePath, mergedPath } = configFileNames(4);
-    fs.copyFileSync(sourcePath, configPath);
-
-    mergeConfigFile(configPath, templatePath);
-
-    expect(fs.readFileSync(configPath, 'utf8')).toEqual(
-      fs.readFileSync(mergedPath, 'utf8'),
-    );
-  });
-});

package/lib/Helper/__tests__/SentryCli.ts

@@ -1,86 +0,0 @@
-/// <reference types="jest" />
-import type { Answers } from 'inquirer';
-
-import type { Args } from '../../Constants';
-import { Integration, Platform } from '../../Constants';
-import { SentryCli } from '../SentryCli';
-
-const args: Args = {
-  debug: false,
-  integration: Integration.reactNative,
-  platform: [Platform.ios],
-  quiet: false,
-  skipConnect: false,
-  uninstall: false,
-  url: 'https://localhost:1234',
-  signup: false,
-  disableTelemetry: false,
-};
-
-const demoAnswers: Answers = {
-  config: {
-    auth: {
-      token: 'abcd',
-    },
-    organization: {
-      slug: 'test_org',
-    },
-    project: {
-      slug: 'test_proj',
-    },
-  },
-};
-
-describe('SentryCli', () => {
-  test('convertAnswersToProperties', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules/sentry/cli');
-    const sentry = new SentryCli(args);
-    sentry.setResolveFunction(resolveFunc);
-    const props = sentry.convertAnswersToProperties(demoAnswers);
-    expect(props['defaults/url']).toBe('https://localhost:1234');
-    expect(props['defaults/org']).toBe('test_org');
-    expect(props['defaults/project']).toBe('test_proj');
-    expect(props['auth/token']).toBe('abcd');
-    expect(props['cli/executable']).toBe('node_modules/sentry/cli');
-  });
-
-  test('dump properties', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules/sentry/cli');
-    const sentry = new SentryCli(args);
-    sentry.setResolveFunction(resolveFunc);
-    const props = sentry.convertAnswersToProperties(demoAnswers);
-    expect(sentry.dumpProperties(props))
-      .toBe(`defaults.url=https://localhost:1234
-defaults.org=test_org
-defaults.project=test_proj
-auth.token=abcd
-cli.executable=node_modules/sentry/cli
-`);
-  });
-
-  test('convertAnswersToProperties windows', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules\\sentry\\cli');
-    const sentry = new SentryCli(args);
-    sentry.setResolveFunction(resolveFunc);
-    const props = sentry.convertAnswersToProperties(demoAnswers);
-    expect(props['defaults/url']).toBe('https://localhost:1234');
-    expect(props['defaults/org']).toBe('test_org');
-    expect(props['defaults/project']).toBe('test_proj');
-    expect(props['auth/token']).toBe('abcd');
-    expect(props['cli/executable']).toBe('node_modules\\\\sentry\\\\cli');
-  });
-
-  test('dump properties windows', () => {
-    const resolveFunc = jest.fn().mockReturnValue('node_modules\\sentry\\cli');
-    const sentry = new SentryCli(args);
-    sentry.setResolveFunction(resolveFunc);
-    const props = sentry.convertAnswersToProperties(demoAnswers);
-    expect(sentry.dumpProperties(props))
-      .toBe(`defaults.url=https://localhost:1234
-defaults.org=test_org
-defaults.project=test_proj
-auth.token=abcd
-cli.executable=node_modules\\\\sentry\\\\cli
-`);
-  });
-});

package/lib/Helper/test-fixtures/next.config.1-merged.js

@@ -1,18 +0,0 @@
-// This file sets a custom webpack configuration to use your Next.js app
-// with Sentry.
-// https://nextjs.org/docs/api-reference/next.config.js/introduction
-// https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
-const { withSentryConfig } = require('@sentry/nextjs');
-
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  reactStrictMode: true,
-};
-
-module.exports = nextConfig;
-
-module.exports = withSentryConfig(
-  module.exports,
-  { silent: true },
-  { hideSourceMaps: true },
-);

package/lib/Helper/test-fixtures/next.config.1.js

@@ -1,6 +0,0 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  reactStrictMode: true,
-};
-
-module.exports = nextConfig;

package/lib/Helper/test-fixtures/next.config.2.js

@@ -1,8 +0,0 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  reactStrictMode: true,
-
-
-  
-
-module.exports = nextConfig;

package/lib/Helper/test-fixtures/next.config.3-merged.js

@@ -1,21 +0,0 @@
-// This file sets a custom webpack configuration to use your Next.js app
-// with Sentry.
-// https://nextjs.org/docs/api-reference/next.config.js/introduction
-// https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
-const { withSentryConfig } = require('@sentry/nextjs');
-
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  reactStrictMode: true,
-  images: {
-    domains: [],
-  },
-};
-
-module.exports = nextConfig;
-
-module.exports = withSentryConfig(
-  module.exports,
-  { silent: true },
-  { hideSourceMaps: true },
-);

package/lib/Helper/test-fixtures/next.config.3.js

@@ -1,9 +0,0 @@
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  reactStrictMode: true,
-  images: {
-    domains: [],
-  },
-};
-
-module.exports = nextConfig;

package/lib/Helper/test-fixtures/next.config.4-merged.js

@@ -1,21 +0,0 @@
-// This file sets a custom webpack configuration to use your Next.js app
-// with Sentry.
-// https://nextjs.org/docs/api-reference/next.config.js/introduction
-// https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
-const { withSentryConfig } = require('@sentry/nextjs');
-
-module.exports = (phase, { defaultConfig }) => {
-  /**
-   * @type {import('next').NextConfig}
-   */
-  const nextConfig = {
-    /* config options here */
-  };
-  return nextConfig;
-};
-
-module.exports = withSentryConfig(
-  module.exports,
-  { silent: true },
-  { hideSourceMaps: true },
-);

package/lib/Helper/test-fixtures/next.config.4.js

@@ -1,9 +0,0 @@
-module.exports = (phase, { defaultConfig }) => {
-  /**
-   * @type {import('next').NextConfig}
-   */
-  const nextConfig = {
-    /* config options here */
-  };
-  return nextConfig;
-};

package/lib/Setup.ts

@@ -1,40 +0,0 @@
-import { enableDebugLogs } from '../src/utils/debug';
-
-import { readEnvironment } from './Helper/Env';
-import { startWizard } from './Helper/Wizard';
-import * as Step from './Steps';
-
-/**
- * @deprecated this function is the entry point to the old, step-based wizards located in `lib`.
- * When creating new wizards, we now add them to clack-based wizards under `src`.
- * Therefor, do not call this function anymore.
- * Use `run` from {@link ../src/run.ts} instead.
- */
-export async function run(argv: any): Promise<any> {
-  const args = { ...argv, ...readEnvironment() };
-
-  if (argv.debug) {
-    enableDebugLogs();
-  }
-
-  if (args.uninstall === undefined) {
-    args.uninstall = false;
-  }
-  const steps = [
-    Step.Initial,
-    Step.Welcome,
-    Step.ChooseIntegration,
-    Step.ShouldConfigure,
-  ];
-  if (args.uninstall === false) {
-    steps.push(
-      Step.OpenSentry,
-      Step.WaitForSentry,
-      Step.SentryProjectSelector,
-      Step.PromptForParameters,
-    );
-  }
-  steps.push(Step.ConfigureProject, Step.Result);
-
-  return startWizard(args, ...steps);
-}