@sentry/wizard 3.39.0 → 3.41.0

package/test/flutter/code-tools.test.ts

@@ -0,0 +1,212 @@
+//@ts-ignore
+import {
+  patchMainContent,
+  getDependenciesLocation,
+  getDevDependenciesLocation,
+  getLastImportLineLocation,
+} from '../../src/flutter/code-tools';
+//@ts-ignore
+import { initSnippet } from '../../src/flutter/templates';
+
+describe('code-tools', () => {
+  const pubspec = `name: flutter_example
+description: An example flutter app.
+version: 1.0.0
+publish_to: 'none' # Remove this line if you wish to publish to pub.dev
+
+environment:
+  sdk: '>=2.17.0 <4.0.0'
+  flutter: '>=3.0.0'
+
+dependencies:
+  flutter:
+    sdk: flutter
+
+dev_dependencies:
+  flutter_lints: ^2.0.0
+`;
+
+  const simpleRunApp = `import 'package:flutter/widgets.dart';
+
+void main() {
+  runApp(const MyApp());
+}
+`;
+
+  const asyncRunApp = `import 'package:flutter/widgets.dart';
+
+void main() {
+  runApp(const MyApp());
+}
+`;
+
+  const selectedFeaturesMap = {
+    tracing: true,
+    profiling: true,
+  };
+
+  const simpleRunAppPatched = `import 'package:flutter/widgets.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+
+Future<void> main() async {
+  ${initSnippet('dsn', selectedFeaturesMap, 'const MyApp()')}
+}
+`;
+
+  const paramRunApp = `import 'package:flutter/widgets.dart';
+
+Future<void> main() async {
+  await someFunction();
+  runApp(MyApp(param: SomeParam()));
+  await anotherFunction();
+}
+`;
+
+  const paramRunAppPatched = `import 'package:flutter/widgets.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+
+Future<void> main() async {
+  await someFunction();
+  ${initSnippet('dsn', selectedFeaturesMap, 'MyApp(param: SomeParam())')}
+  await anotherFunction();
+}
+`;
+
+  const multilineRunApp = `import 'package:flutter/widgets.dart';
+
+void main() {
+  runApp(
+    MyApp(
+      param: Param(),
+      multi: Another(1),
+      line: await bites(the: "dust"),
+    ),
+  );
+  anotherFunction();
+}
+`;
+
+  const multilineRunAppPatched = `import 'package:flutter/widgets.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+
+Future<void> main() async {
+  ${initSnippet(
+    'dsn',
+    selectedFeaturesMap,
+    `
+    MyApp(
+      param: Param(),
+      multi: Another(1),
+      line: await bites(the: "dust"),
+    ),
+  `,
+  )}
+  anotherFunction();
+}
+`;
+
+  describe('patchMainContent', () => {
+    it('wraps simple runApp', () => {
+      expect(patchMainContent('dsn', simpleRunApp, selectedFeaturesMap)).toBe(
+        simpleRunAppPatched,
+      );
+    });
+
+    it('wraps async runApp', () => {
+      expect(patchMainContent('dsn', asyncRunApp, selectedFeaturesMap)).toBe(
+        simpleRunAppPatched,
+      );
+    });
+
+    it('wraps runApp with parameterized app', () => {
+      expect(patchMainContent('dsn', paramRunApp, selectedFeaturesMap)).toBe(
+        paramRunAppPatched,
+      );
+    });
+
+    it('wraps multiline runApp', () => {
+      expect(
+        patchMainContent('dsn', multilineRunApp, selectedFeaturesMap),
+      ).toBe(multilineRunAppPatched);
+    });
+  });
+
+  describe('pubspec', () => {
+    it('returns proper line index for dependencies', () => {
+      expect(getDependenciesLocation(pubspec)).toBe(
+        pubspec.indexOf('  flutter:\n'),
+      );
+    });
+
+    it('returns proper line index for dev-dependencies', () => {
+      expect(getDevDependenciesLocation(pubspec)).toBe(
+        pubspec.indexOf('  flutter_lints: ^2.0.0\n'),
+      );
+    });
+  });
+
+  describe('getLastImportLineLocation', () => {
+    it('returns proper line index', () => {
+      const code =
+        `import 'foo:bar';\n` + `//<insert-location>\n` + `class X {}`;
+      expect(getLastImportLineLocation(code)).toBe(
+        code.indexOf('//<insert-location>'),
+      );
+    });
+
+    it('returns proper line index when alias import is used', () => {
+      const code =
+        `import 'package:my_library/utils.dart' as utils;\n` +
+        `//<insert-location>\n` +
+        `class X {}`;
+      expect(getLastImportLineLocation(code)).toBe(
+        code.indexOf('//<insert-location>'),
+      );
+    });
+
+    it('returns proper line index when specific parts import is used', () => {
+      const code =
+        `import 'dart:math' show pi, sin;\n` +
+        `//<insert-location>\n` +
+        `class X {}`;
+      expect(getLastImportLineLocation(code)).toBe(
+        code.indexOf('//<insert-location>'),
+      );
+    });
+
+    it('returns proper line index when hide import is used', () => {
+      const code =
+        `import 'dart:math' hide Random;\n` +
+        `//<insert-location>\n` +
+        `class X {}`;
+      expect(getLastImportLineLocation(code)).toBe(
+        code.indexOf('//<insert-location>'),
+      );
+    });
+
+    it('returns proper line index when deferred import is used', () => {
+      const code =
+        `import 'package:my_library/large_library.dart' deferred as largeLibrary;\n` +
+        `//<insert-location>\n` +
+        `class X {}`;
+      expect(getLastImportLineLocation(code)).toBe(
+        code.indexOf('//<insert-location>'),
+      );
+    });
+
+    it('returns proper line index when multiple imports (with newlines) are present', () => {
+      const code =
+        `import 'foo:bar';\n` +
+        `import 'package:my_library/utils.dart' as utils;\n` +
+        `import 'dart:math' show pi, sin;\n` +
+        `import 'dart:math' hide Random;\n` +
+        `\n` +
+        `import 'package:my_library/large_library.dart' deferred as largeLibrary;\n` +
+        `//<insert-location>\n` +
+        `class X {}`;
+      expect(getLastImportLineLocation(code)).toBe(
+        code.indexOf('//<insert-location>'),
+      );
+    });
+  });
+});

package/test/flutter/templates.test.ts

@@ -0,0 +1,100 @@
+import {
+  pubspecOptions,
+  sentryProperties,
+  initSnippet,
+} from '../../src/flutter/templates';
+
+describe('Flutter code templates', () => {
+  describe('pubspec', () => {
+    it('generates pubspec with project and org', () => {
+      const template = pubspecOptions('fixture-project', 'fixture-org');
+      expect(template).toMatchInlineSnapshot(`
+      "sentry:
+        upload_debug_symbols: true
+        upload_source_maps: true
+        project: fixture-project
+        org: fixture-org
+      "
+      `);
+    });
+  });
+  describe('sentry.properties', () => {
+    it('generates sentry.properties with token', () => {
+      const template = sentryProperties('fixture-token');
+      expect(template).toMatchInlineSnapshot(`"auth_token=fixture-token"`);
+    });
+  });
+  describe('init', () => {
+    it('generates Sentry config with all features enabled', () => {
+      const template = initSnippet(
+        'my-dsn',
+        {
+          tracing: true,
+          profiling: true,
+        },
+        'const MyApp()',
+      );
+      expect(template).toMatchInlineSnapshot(`
+      "await SentryFlutter.init(
+          (options) {
+            options.dsn = 'my-dsn';
+            // Set tracesSampleRate to 1.0 to capture 100% of transactions for tracing.
+            // We recommend adjusting this value in production.
+            options.tracesSampleRate = 1.0;
+            // The sampling rate for profiling is relative to tracesSampleRate
+            // Setting to 1.0 will profile 100% of sampled transactions:
+            options.profilesSampleRate = 1.0;
+          },
+          appRunner: () => runApp(SentryWidget(child: const MyApp())),
+        );
+        // TODO: Remove this line after sending the first sample event to sentry.
+        await Sentry.captureException(Exception('This is a sample exception.'));"
+      `);
+    });
+
+    it('generates Sentry config with profiling disabled', () => {
+      const template = initSnippet(
+        'my-dsn',
+        {
+          tracing: true,
+          profiling: false,
+        },
+        'const MyApp()',
+      );
+      expect(template).toMatchInlineSnapshot(`
+        "await SentryFlutter.init(
+            (options) {
+              options.dsn = 'my-dsn';
+              // Set tracesSampleRate to 1.0 to capture 100% of transactions for tracing.
+              // We recommend adjusting this value in production.
+              options.tracesSampleRate = 1.0;
+            },
+            appRunner: () => runApp(SentryWidget(child: const MyApp())),
+          );
+          // TODO: Remove this line after sending the first sample event to sentry.
+          await Sentry.captureException(Exception('This is a sample exception.'));"
+      `);
+    });
+
+    it('generates Sentry config with tracing disabled', () => {
+      const template = initSnippet(
+        'my-dsn',
+        {
+          tracing: false,
+          profiling: false,
+        },
+        'const MyApp()',
+      );
+      expect(template).toMatchInlineSnapshot(`
+        "await SentryFlutter.init(
+            (options) {
+              options.dsn = 'my-dsn';
+            },
+            appRunner: () => runApp(SentryWidget(child: const MyApp())),
+          );
+          // TODO: Remove this line after sending the first sample event to sentry.
+          await Sentry.captureException(Exception('This is a sample exception.'));"
+      `);
+    });
+  });
+});

package/test/utils/clack-utils.test.ts

@@ -1,9 +1,12 @@
 import {
   askForToolConfigPath,
   createNewConfigFile,
+  installPackage,
 } from '../../src/utils/clack-utils';
 
 import * as fs from 'fs';
+import * as ChildProcess from 'child_process';
+import { PackageManager } from '../../src/utils/package-manager';
 
 type ClackMock = {
   confirm: jest.Mock;
@@ -15,6 +18,7 @@ type ClackMock = {
     success: jest.Mock;
     warn: jest.Mock;
   };
+  spinner: () => { start: jest.Mock; stop: jest.Mock };
 };
 
 let clackMock: ClackMock;
@@ -31,6 +35,9 @@ jest.mock('@clack/prompts', () => {
     cancel: jest.fn(),
     // passthrough for abortIfCancelled
     isCancel: jest.fn().mockReturnValue(false),
+    spinner: jest
+      .fn()
+      .mockImplementation(() => ({ start: jest.fn(), stop: jest.fn() })),
   };
   return clackMock;
 });
@@ -140,3 +147,88 @@ describe('createNewConfigFile', () => {
     expect(result).toBe(false);
   });
 });
+
+describe('installPackage', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('force-installs a package if the forceInstall flag is set', async () => {
+    const packageManagerMock: PackageManager = {
+      name: 'npm',
+      label: 'NPM',
+      installCommand: 'npm install',
+      buildCommand: 'npm run build',
+      runScriptCommand: 'npm run',
+      flags: '',
+      forceInstallFlag: '--force',
+      detect: jest.fn(),
+      addOverride: jest.fn(),
+    };
+
+    const execSpy = jest
+      .spyOn(ChildProcess, 'exec')
+      // @ts-expect-error - don't care about the return value
+      .mockImplementationOnce((cmd, cb) => {
+        if (cb) {
+          // @ts-expect-error - don't care about the options value
+          cb(null, '', '');
+        }
+      });
+
+    await installPackage({
+      alreadyInstalled: false,
+      packageName: '@sentry/sveltekit',
+      packageNameDisplayLabel: '@sentry/sveltekit',
+      forceInstall: true,
+      askBeforeUpdating: false,
+      packageManager: packageManagerMock,
+    });
+
+    expect(execSpy).toHaveBeenCalledWith(
+      'npm install @sentry/sveltekit  --force',
+      expect.any(Function),
+    );
+  });
+
+  it.each([false, undefined])(
+    "doesn't force-install a package if the forceInstall flag is %s",
+    async (flag) => {
+      const packageManagerMock: PackageManager = {
+        name: 'npm',
+        label: 'NPM',
+        installCommand: 'npm install',
+        buildCommand: 'npm run build',
+        runScriptCommand: 'npm run',
+        flags: '',
+        forceInstallFlag: '--force',
+        detect: jest.fn(),
+        addOverride: jest.fn(),
+      };
+
+      const execSpy = jest
+        .spyOn(ChildProcess, 'exec')
+        // @ts-expect-error - don't care about the return value
+        .mockImplementationOnce((cmd, cb) => {
+          if (cb) {
+            // @ts-expect-error - don't care about the options value
+            cb(null, '', '');
+          }
+        });
+
+      await installPackage({
+        alreadyInstalled: false,
+        packageName: '@sentry/sveltekit',
+        packageNameDisplayLabel: '@sentry/sveltekit',
+        forceInstall: flag,
+        askBeforeUpdating: false,
+        packageManager: packageManagerMock,
+      });
+
+      expect(execSpy).toHaveBeenCalledWith(
+        'npm install @sentry/sveltekit  ',
+        expect.any(Function),
+      );
+    },
+  );
+});