feat(flutter): Add Flutter support #735

denrase · 2024-12-03T10:12:59Z

Add flutter as a platform
Patch main.dart with import, sentry setup and sample snippet
Patch pubspec.yaml with sentry_flutter dependency and plugin to upload debug symbols and source maps

Closes getsentry/sentry-dart#2424
Relates to #558

# Conflicts: # CHANGELOG.md

denrase · 2024-12-09T13:57:59Z

@buenaflor Ready for the first review/feedback round :)

buenaflor

I'll have another look later

src/flutter/flutter-wizzard.ts

Lms24

Hey, leaving a first pass review for general wizard recommendations. This is not technical as I have very little to no context around Flutter.

Ideally, we can make the SDK features selectable from the start as we've done recently with the JS-SDK wizards. See Make Sentry features selectable in wizard #558
Great to see some tests for this flow! :) I recommend adding an e2e test app as well as this proved quite useful for our other wizards.

Feel free to disregard my advice as I'll happily leave the final call to the mobile team. Don't want to block you, just share some recommendations :)

src/flutter/flutter-wizzard.ts

…o feat/flutter-support # Conflicts: # CHANGELOG.md

denrase · 2024-12-19T10:21:12Z

@bruno-garcia We have added replay as an option, but we are not sure if we should, as it is still beta on Flutter. Do you have any guidance/thoughts?

# Conflicts: # CHANGELOG.md

denrase · 2024-12-30T15:40:02Z

Removed the Replay option for now, as this is still considered bet on Flutter/Mobile.

buenaflor · 2025-01-07T10:54:52Z

@krystofwoldrich could you also have a quick look since you already have quite some rn wizard exp :)

# Conflicts: # CHANGELOG.md

denrase · 2025-01-09T10:49:22Z

Profiling is now only asked as an option in the flutter wizard if we have an ios/macos folder. Also added tests for this.

buenaflor · 2025-01-13T13:11:45Z

src/flutter/templates.ts

+    appRunner: () => runApp(${runApp}),
+  );
+  // TODO: Remove this line after sending the first sample event to sentry.
+  await Sentry.captureMessage('This is a sample exception.');`;


Suggested change

await Sentry.captureMessage('This is a sample exception.');`;

await Sentry.captureException(Exception('This is a sample exception.'));`;

buenaflor · 2025-01-13T13:13:17Z

@denrase e2e test is failing

krystofwoldrich · 2025-01-13T16:02:49Z

src/flutter/flutter-wizard.ts

+  return withTelemetry(
+    {
+      enabled: options.telemetryEnabled,
+      integration: 'android',


This is the integration name reported to Sentry Telemetry.

Suggested change

integration: 'android',

integration: 'flutter',

krystofwoldrich · 2025-01-13T16:10:57Z

src/flutter/flutter-wizard.ts

+    await getOrAskForProjectData(options, 'flutter');
+
+  const projectDir = process.cwd();
+  const pubspecFile = findFile(projectDir, 'pubspec.yaml');


I believe we should not look for this file, if the user is in a directory without pubspec.yaml, likely they are not in root of the project they want to patch.

We should handle the missing pubspecFile and let user know they are not in Flutter project dir.

krystofwoldrich · 2025-01-13T16:13:11Z

src/flutter/flutter-wizard.ts

+  );
+  if (!pubspecPatched) {
+    clack.log.warn(
+      "Could not add Sentry to your apps pubspec.yaml file. You'll have to add it manually.\nPlease follow the instructions at https://docs.sentry.io/platforms/flutter/#install",


Let me know if it's out of scope, but the other wizards show code pastable code snippets so users don't have to leave the wizard and look online for the code.

Example from RN:

sentry-wizard/src/react-native/javascript.ts

Lines 31 to 35 in fe849fe

await showCopyPasteInstructions(

'App.js or _layout.tsx',

getSentryInitColoredCodeSnippet(dsn),

'This ensures the Sentry SDK is ready to capture errors.',

);

krystofwoldrich · 2025-01-13T16:17:02Z

src/flutter/flutter-wizard.ts

+  );
+  if (!propertiesAdded) {
+    clack.log.warn(
+      `We could not add "sentry.properties" file in your project directory in order to provide an auth token for Sentry CLI. You'll have to add it manually, or you can set the SENTRY_AUTH_TOKEN environment variable instead. See https://docs.sentry.io/cli/configuration/#auth-token for more information.`,


Usually filenames are highlighted by cyan.

Wizard Develop docs describe the use of colors.

https://develop.sentry.dev/sdk/expected-features/setup-wizards/#colors

krystofwoldrich · 2025-01-13T16:23:29Z

src/flutter/flutter-wizard.ts

+    fs.existsSync(`${projectDir}/ios`) || fs.existsSync(`${projectDir}/macos`);
+
+  const mainPatched = await traceStep('Patch main.dart', () =>
+    codetools.patchMain(mainFile, dsn, canEnableProfiling),


If we can't patch the mainFile we should show a copy pastable code snippet.

krystofwoldrich · 2025-01-13T16:25:36Z

src/flutter/code-tools.ts

+  if (!pubspecFile || !fs.existsSync(pubspecFile)) {
+    clack.log.warn('No pubspec.yaml source file found in filesystem.');
+    Sentry.captureException('No pubspec.yaml source file');
+    return false;
+  }
+  let pubspecContent = fs.readFileSync(pubspecFile, 'utf8');


It's better practice to try catch the readFile instead of checking for existence. The read might still throw and this would crash the wizard.

krystofwoldrich · 2025-01-13T16:38:06Z

src/flutter/code-tools.ts

+      chalk.greenBright(
+        `${chalk.bold(
+          'main.dart',
+        )} is already patched with test error snippet.`,


It's maybe better to call out that Sentry is already in the main.dart instead of the test error.

krystofwoldrich · 2025-01-13T16:59:02Z

src/flutter/flutter-wizard.ts

+  const { selectedProject, selfHosted, sentryUrl, authToken } =
+    await getOrAskForProjectData(options, 'flutter');
+
+  const projectDir = process.cwd();


Not sure if it applies (if it's common users have old outdated apps), but we could check min dart and flutter versions before the wizard starts patching.

krystofwoldrich · 2025-01-13T17:01:23Z

Added some comments based on my experience with RN Wizard.

denrase added 11 commits November 27, 2024 12:30

add test to find last import line

db3f33d

add basic wizzard and patch import in main.dart

1ccd8cd

patch pubspec.yaml

fd82fb5

Merge branch 'master' into feat/flutter-support

7516db9

# Conflicts: # CHANGELOG.md

add sentry dart plugin options and propeties to pubspec file

95a01e6

patch main with sentry init, fetch sentry_flutter version

8a6839e

Merge branch 'master' into feat/flutter-support

7844198

update template, check already added to pubspec

9e8fecd

order flutter behind reactNative

b6cd5db

cleanup

d7e5f4a

update order

cf0c522

denrase changed the title ~~WIP: Flutter Support~~ Add Flutter support Dec 9, 2024

denrase changed the title ~~Add Flutter support~~ feat(flutter): Add Flutter support Dec 9, 2024

add cl entry

7a10349

denrase marked this pull request as ready for review December 9, 2024 13:57

buenaflor reviewed Dec 10, 2024

View reviewed changes

src/flutter/flutter-wizzard.ts Outdated Show resolved Hide resolved

src/flutter/flutter-wizzard.ts Outdated Show resolved Hide resolved

Lms24 reviewed Dec 10, 2024

View reviewed changes

smeubank reviewed Dec 12, 2024

View reviewed changes

src/flutter/flutter-wizzard.ts Outdated Show resolved Hide resolved

denrase added 10 commits December 16, 2024 12:50

Merge branch 'master' into feat/flutter-support

c971115

fix typos

23c3db4

remove comment

51e0fd4

introduce options in flutter templates

d3ae482

options in setup, dont upload sources, upload debug symbols

fce1ddd

setup flutter e2e test

c15ca33

add flutter test app

e8c2f59

fix Flutter e2e test

56b7889

update docs/readme

17dcd69

Merge branch 'master' of https://github.com/denrase/sentry-wizard int…

1d55981

…o feat/flutter-support # Conflicts: # CHANGELOG.md

denrase requested a review from smeubank December 19, 2024 10:20

denrase requested a review from Lms24 December 19, 2024 10:20

denrase added 2 commits December 30, 2024 16:18

Merge branch 'master' into feat/flutter-support

4d78e0f

# Conflicts: # CHANGELOG.md

Disable replay option for now

8cf3b5a

denrase requested a review from buenaflor December 30, 2024 15:40

denrase added 3 commits January 7, 2025 11:28

run prettier

2c2c712

fix tests

941b525

run prettier

771fd0f

buenaflor requested a review from krystofwoldrich January 7, 2025 10:53

denrase added 2 commits January 9, 2025 11:46

don’t add profiling if ios/macos is not configured

3f575bc

Merge branch 'master' into feat/flutter-support

0560f49

# Conflicts: # CHANGELOG.md

run prettier

7a97d99

buenaflor reviewed Jan 13, 2025

View reviewed changes

buenaflor mentioned this pull request Jan 13, 2025

Make Sentry features selectable in wizard #558

Open

krystofwoldrich reviewed Jan 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(flutter): Add Flutter support #735

feat(flutter): Add Flutter support #735

denrase commented Dec 3, 2024 •

edited

Loading

denrase commented Dec 9, 2024

buenaflor left a comment

Lms24 left a comment

denrase commented Dec 19, 2024

denrase commented Dec 30, 2024

buenaflor commented Jan 7, 2025

denrase commented Jan 9, 2025

buenaflor Jan 13, 2025

buenaflor commented Jan 13, 2025

krystofwoldrich Jan 13, 2025

krystofwoldrich Jan 13, 2025 •

edited

Loading

krystofwoldrich Jan 13, 2025

krystofwoldrich Jan 13, 2025

krystofwoldrich Jan 13, 2025 •

edited

Loading

krystofwoldrich Jan 13, 2025

krystofwoldrich Jan 13, 2025

krystofwoldrich Jan 13, 2025

krystofwoldrich commented Jan 13, 2025

	await Sentry.captureMessage('This is a sample exception.');`;
	await Sentry.captureException(Exception('This is a sample exception.'));`;

	await showCopyPasteInstructions(
	'App.js or _layout.tsx',
	getSentryInitColoredCodeSnippet(dsn),
	'This ensures the Sentry SDK is ready to capture errors.',
	);

feat(flutter): Add Flutter support #735

Are you sure you want to change the base?

feat(flutter): Add Flutter support #735

Conversation

denrase commented Dec 3, 2024 • edited Loading

denrase commented Dec 9, 2024

buenaflor left a comment

Choose a reason for hiding this comment

Lms24 left a comment

Choose a reason for hiding this comment

denrase commented Dec 19, 2024

denrase commented Dec 30, 2024

buenaflor commented Jan 7, 2025

denrase commented Jan 9, 2025

buenaflor Jan 13, 2025

Choose a reason for hiding this comment

buenaflor commented Jan 13, 2025

krystofwoldrich Jan 13, 2025

Choose a reason for hiding this comment

krystofwoldrich Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

krystofwoldrich Jan 13, 2025

Choose a reason for hiding this comment

krystofwoldrich Jan 13, 2025

Choose a reason for hiding this comment

krystofwoldrich Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

krystofwoldrich Jan 13, 2025

Choose a reason for hiding this comment

krystofwoldrich Jan 13, 2025

Choose a reason for hiding this comment

krystofwoldrich Jan 13, 2025

Choose a reason for hiding this comment

krystofwoldrich commented Jan 13, 2025

denrase commented Dec 3, 2024 •

edited

Loading

krystofwoldrich Jan 13, 2025 •

edited

Loading

krystofwoldrich Jan 13, 2025 •

edited

Loading