Fix: Use App Name if Package Name is not available (#411)

* Fix: Use App Name if Package Name is not available

* add comment describing the code

* replace invalid chars with underscore

* Formatting

* Improve comment

* Add PR ID to changelog

* Use TestFixture

* improve test fixture

Author: ueman

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Fix: `Sentry.close()` closes native SDK integrations (#388)
 * Fix: Mark `Sentry.currentHub` as deprecated (#406)
+* Fix: Use name from pubspec.yaml for release if package id is not available (#411)
 
 # 5.0.0
 

flutter/lib/src/default_integrations.dart

@@ -367,8 +367,15 @@ class LoadReleaseIntegration extends Integration<SentryFlutterOptions> {
       if (!kIsWeb) {
         if (options.release == null || options.dist == null) {
           final packageInfo = await _packageLoader();
+          var name = packageInfo.packageName;
+          if (name.isEmpty) {
+            // Not all platforms have a packageName.
+            // If no packageName is available, use the appName instead.
+            name = _cleanAppName(packageInfo.appName);
+          }
+
           final release =
-              '${packageInfo.packageName}@${packageInfo.version}+${packageInfo.buildNumber}';
+              '$name@${packageInfo.version}+${packageInfo.buildNumber}';
           options.logger(SentryLevel.debug, 'release: $release');
 
           options.release = options.release ?? release;
@@ -382,4 +389,16 @@ class LoadReleaseIntegration extends Integration<SentryFlutterOptions> {
 
     options.sdk.addIntegration('loadReleaseIntegration');
   }
+
+  String _cleanAppName(String appName) {
+    // Replace disallowed chars with an underscore '_'
+    // https://docs.sentry.io/platforms/flutter/configuration/releases/#bind-the-version
+    return appName
+        .replaceAll('/', '_')
+        .replaceAll('\\', '_')
+        .replaceAll('\t', '_')
+        .replaceAll('\r\n', '_')
+        .replaceAll('\r', '_')
+        .replaceAll('\n', '_');
+  }
 }

flutter/test/default_integrations_test.dart

@@ -227,40 +227,79 @@ void main() {
   });
 
   group('$LoadReleaseIntegration', () {
-    Future<PackageInfo> loadRelease() {
-      return Future.value(PackageInfo(
-        appName: 'sentry_flutter',
-        packageName: 'foo.bar',
-        version: '1.2.3',
-        buildNumber: '789',
-      ));
-    }
+    late Fixture fixture;
+
+    setUp(() {
+      fixture = Fixture();
+    });
 
     test('does not overwrite options', () async {
-      final options = SentryFlutterOptions(dsn: fakeDsn);
-      options.release = '1.0.0';
-      options.dist = 'dist';
+      fixture.options.release = '1.0.0';
+      fixture.options.dist = 'dist';
 
-      final integration = LoadReleaseIntegration(loadRelease);
-      await integration.call(MockHub(), options);
+      await fixture.getIntegration().call(MockHub(), fixture.options);
 
-      expect(options.release, '1.0.0');
-      expect(options.dist, 'dist');
+      expect(fixture.options.release, '1.0.0');
+      expect(fixture.options.dist, 'dist');
     });
 
     test('sets release and dist if not set on options', () async {
-      final options = SentryFlutterOptions(dsn: fakeDsn);
+      await fixture.getIntegration().call(MockHub(), fixture.options);
 
-      final integration = LoadReleaseIntegration(loadRelease);
-      await integration.call(MockHub(), options);
+      expect(fixture.options.release, '[email protected]+789');
+      expect(fixture.options.dist, '789');
+    });
+
+    test('sets app name as in release if packagename is empty', () async {
+      final loader = () {
+        return Future.value(PackageInfo(
+          appName: 'sentry_flutter',
+          packageName: '',
+          version: '1.2.3',
+          buildNumber: '789',
+        ));
+      };
+      await fixture
+          .getIntegration(loader: loader)
+          .call(MockHub(), fixture.options);
+
+      expect(fixture.options.release, '[email protected]+789');
+      expect(fixture.options.dist, '789');
+    });
 
-      expect(options.release, '[email protected]+789');
-      expect(options.dist, '789');
+    test('release name does not contain ivalid chars', () async {
+      final loader = () {
+        return Future.value(PackageInfo(
+          appName: '\\/sentry\tflutter \r\nfoo\nbar\r',
+          packageName: '',
+          version: '1.2.3',
+          buildNumber: '789',
+        ));
+      };
+      await fixture
+          .getIntegration(loader: loader)
+          .call(MockHub(), fixture.options);
+
+      expect(fixture.options.release, '__sentry_flutter [email protected]+789');
+      expect(fixture.options.dist, '789');
     });
   });
 }
 
 class Fixture {
   final hub = MockHub();
-  final options = SentryFlutterOptions();
+  final options = SentryFlutterOptions(dsn: fakeDsn);
+
+  LoadReleaseIntegration getIntegration({PackageLoader? loader}) {
+    return LoadReleaseIntegration(loader ?? loadRelease);
+  }
+
+  Future<PackageInfo> loadRelease() {
+    return Future.value(PackageInfo(
+      appName: 'sentry_flutter',
+      packageName: 'foo.bar',
+      version: '1.2.3',
+      buildNumber: '789',
+    ));
+  }
 }