Firebase Remote Config Integration

.craft.yml

@@ -18,6 +18,7 @@ targets:
       drift:
       isar:
       link:
+      firebase_remote_config:
   - name: github
   - name: registry
     sdks:
@@ -31,4 +32,6 @@ targets:
       pub:sentry_hive:
       pub:sentry_isar:
       # TODO: after we published link we need to add it to the registry repo and then uncomment here
-      # pub:sentry_link:
+      # pub:sentry_link:
+      # TODO: after we published firebase we need to add it to the registry repo and then uncomment here
+      # pub:sentry_firebase_remote_config:

.github/workflows/diagrams.yml

@@ -51,6 +51,14 @@ jobs:
         working-directory: ./isar
         run: lakos . -i "{test/**,example/**}" | dot -Tsvg -o class-diagram.svg
 
+      - name: link
+        working-directory: ./link
+        run: lakos . -i "{test/**,example/**}" | dot -Tsvg -o class-diagram.svg
+
+      - name: firebase_remote_config
+        working-directory: ./firebase_remote_config
+        run: lakos . -i "{test/**,example/**}" | dot -Tsvg -o class-diagram.svg
+
         # Source: https://stackoverflow.com/a/58035262
       - name: Extract branch name
         shell: bash

.github/workflows/firebase_remote_config.yml

@@ -0,0 +1,56 @@
+name: sentry-firebase-remote-config
+on:
+  push:
+    branches:
+      - main
+      - release/**
+  pull_request:
+    paths:
+      - '!**/*.md'
+      - '!**/class-diagram.svg'
+      - '.github/workflows/firebase_remote_config.yml'
+      - '.github/workflows/analyze.yml'
+      - '.github/actions/dart-test/**'
+      - '.github/actions/coverage/**'
+      - 'dart/**'
+      - 'flutter/**'
+      - 'firebase_remote_config/**'
+
+# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: '${{ matrix.os }} | ${{ matrix.sdk }}'
+    runs-on: ${{ matrix.os }}-latest
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos, ubuntu, windows]
+        sdk: [stable, beta]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/flutter-test
+        with:
+          directory: firebase_remote_config
+          web: false
+
+#       TODO: don't set coverage for now to finish publishing it
+#      - uses: ./.github/actions/coverage
+#        if: runner.os == 'Linux' && matrix.sdk == 'stable'
+#        with:
+#          token: ${{ secrets.CODECOV_TOKEN }}
+#          directory: firebase_remote_config
+#          coverage: sentry_firebase_remote_config
+#          min-coverage: 55
+
+  analyze:
+    uses: ./.github/workflows/analyze.yml
+    with:
+      package: firebase_remote_config
+      sdk: flutter

CHANGELOG.md

@@ -9,6 +9,20 @@
 // Manually track a feature flag
 Sentry.addFeatureFlag('my-feature', true);
 ```
+- Firebase Remote Config Integration ([#2837](https://github.com/getsentry/sentry-dart/pull/2837))
+```dart
+// Add the integration to automatically track feature flags from firebase remote config.
+await SentryFlutter.init(
+  (options) {
+    options.dsn = 'https://[email protected]/add-your-dsn-here';
+    options.addIntegration(
+      SentryFirebaseRemoteConfigIntegration(
+        firebaseRemoteConfig: yourRirebaseRemoteConfig,
+      ),
+    );
+  },
+);
+```
 
 ### Behavioral changes
 

firebase_remote_config/.gitignore

@@ -0,0 +1,14 @@
+# Omit committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/

firebase_remote_config/.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "09de023485e95e6d1225c2baa44b8feb85e0d45f"
+  channel: "stable"
+
+project_type: package

firebase_remote_config/CHANGELOG.md

@@ -0,0 +1 @@
+../CHANGELOG.md

firebase_remote_config/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

firebase_remote_config/README.md

@@ -0,0 +1,98 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+
+===========
+
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+Sentry integration for `firebase_remote_config` package
+===========
+
+| package     | build                                                                                                                                                                                | pub                                                                                                  | likes                                                                                                | popularity                                                                                                     | pub points |
+|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| ------- |
+| sentry_firebase_remote_config | [![build](https://github.com/getsentry/sentry-dart/actions/workflows/firebase.yml/badge.svg?branch=main)](https://github.com/getsentry/sentry-dart/actions?query=workflow%3Asentry-firebase) | [![pub package](https://img.shields.io/pub/v/sentry_firebase_remote_config.svg)](https://pub.dev/packages/sentry_firebase_remote_config) | [![likes](https://img.shields.io/pub/likes/sentry_firebase_remote_config)](https://pub.dev/packages/sentry_firebase_remote_config/score) | [![popularity](https://img.shields.io/pub/popularity/sentry_firebase_remote_config)](https://pub.dev/packages/sentry_firebase_remote_config/score) | [![pub points](https://img.shields.io/pub/points/sentry_firebase_remote_config)](https://pub.dev/packages/sentry_firebase_remote_config/score)
+
+Integration for [`firebase_remote_config`](https://pub.dev/packages/firebase_remote_config) package. Track changes to firebase boolean values as feature flags in Sentry.io
+
+#### Usage
+
+- Sign up for a Sentry.io account and get a DSN at https://sentry.io.
+
+- Follow the installing instructions on [pub.dev](https://pub.dev/packages/sentry/install).
+
+- Initialize the Sentry SDK using the DSN issued by Sentry.io.
+
+- Call...
+
+```dart
+import 'package:firebase_core/firebase_core.dart';
+import 'package:firebase_remote_config_example/home_page.dart';
+import 'package:flutter/material.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+import 'package:sentry_firebase_remote_config/sentry_firebase_remote_config.dart';
+
+import 'firebase_options.dart';
+
+Future<void> main() async {
+  WidgetsFlutterBinding.ensureInitialized();
+  await Firebase.initializeApp(
+    options: DefaultFirebaseOptions.currentPlatform,
+  );
+
+  final remoteConfig = FirebaseRemoteConfig.instance;
+  await remoteConfig.setConfigSettings(RemoteConfigSettings(
+    fetchTimeout: const Duration(minutes: 1),
+    minimumFetchInterval: const Duration(hours: 1),
+  ));
+
+  await SentryFlutter.init(
+    (options) {
+      options.dsn = 'https://[email protected]/add-your-dsn-here';
+
+      final sentryFirebaseRemoteConfigIntegration = SentryFirebaseRemoteConfigIntegration(
+        firebaseRemoteConfig: remoteConfig,
+        // Don't call `await remoteConfig.activate();` when firebase config is updated. Per default this is true.
+        activateOnConfigUpdated: false,
+      );
+      options.addIntegration(sentryFirebaseRemoteConfigIntegration);
+    },
+  );
+
+  runApp(const RemoteConfigApp());
+}
+
+class RemoteConfigApp extends StatelessWidget {
+  const RemoteConfigApp({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: 'Remote Config Example',
+      home: const HomePage(),
+      theme: ThemeData(
+        useMaterial3: true,
+        primarySwatch: Colors.blue,
+      ),
+    );
+  }
+}
+```
+
+#### Resources
+
+* [![Flutter docs](https://img.shields.io/badge/documentation-sentry.io-green.svg?label=flutter%20docs)](https://docs.sentry.io/platforms/flutter/)
+* [![Dart docs](https://img.shields.io/badge/documentation-sentry.io-green.svg?label=dart%20docs)](https://docs.sentry.io/platforms/dart/)
+* [![Discussions](https://img.shields.io/github/discussions/getsentry/sentry-dart.svg)](https://github.com/getsentry/sentry-dart/discussions)
+* [![Discord Chat](https://img.shields.io/discord/621778831602221064?logo=discord&logoColor=ffffff&color=7389D8)](https://discord.gg/PXa5Apfe7K)
+* [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](https://stackoverflow.com/questions/tagged/sentry)
+* [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)

firebase_remote_config/analysis_options.yaml

@@ -0,0 +1,32 @@
+include: package:lints/recommended.yaml
+
+analyzer:
+  language:
+    strict-casts: true
+    strict-inference: true
+    strict-raw-types: true
+  errors:
+    # treat missing required parameters as a warning (not a hint)
+    missing_required_param: error
+    # treat missing returns as a warning (not a hint)
+    missing_return: error
+    # allow having TODOs in the code
+    todo: ignore
+    # allow self-reference to deprecated members (we do this because otherwise we have
+    # to annotate every member in every test, assert, etc, when we deprecate something)
+    deprecated_member_use_from_same_package: warning
+    # ignore sentry/path on pubspec as we change it on deployment
+    invalid_dependency: ignore
+  exclude:
+    - example/**
+    - test/mocks/mocks.mocks.dart
+
+linter:
+  rules:
+    - prefer_final_locals
+    - prefer_single_quotes
+    - prefer_relative_imports
+    - unnecessary_brace_in_string_interps
+    - implementation_imports
+    - require_trailing_commas
+    - unawaited_futures

firebase_remote_config/dartdoc_options.yaml

@@ -0,0 +1 @@
+../dart/dartdoc_options.yaml

firebase_remote_config/example/example.dart

@@ -0,0 +1,52 @@
+import 'package:firebase_core/firebase_core.dart';
+import 'package:firebase_remote_config_example/home_page.dart';
+import 'package:flutter/material.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+import 'package:sentry_firebase_remote_config/sentry_firebase_remote_config.dart';
+
+import 'firebase_options.dart';
+
+Future<void> main() async {
+  WidgetsFlutterBinding.ensureInitialized();
+  await Firebase.initializeApp(
+    options: DefaultFirebaseOptions.currentPlatform,
+  );
+
+  final remoteConfig = FirebaseRemoteConfig.instance;
+  await remoteConfig.setConfigSettings(RemoteConfigSettings(
+    fetchTimeout: const Duration(minutes: 1),
+    minimumFetchInterval: const Duration(hours: 1),
+  ));
+
+  await SentryFlutter.init(
+    (options) {
+      options.dsn = 'https://[email protected]/add-your-dsn-here';
+
+      final sentryFirebaseRemoteConfigIntegration =
+          SentryFirebaseRemoteConfigIntegration(
+        firebaseRemoteConfig: remoteConfig,
+        // Don't call `await remoteConfig.activate();` when firebase config is updated. Per default this is true.
+        activateOnConfigUpdated: false,
+      );
+      options.addIntegration(sentryFirebaseRemoteConfigIntegration);
+    },
+  );
+
+  runApp(const RemoteConfigApp());
+}
+
+class RemoteConfigApp extends StatelessWidget {
+  const RemoteConfigApp({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: 'Remote Config Example',
+      home: const HomePage(),
+      theme: ThemeData(
+        useMaterial3: true,
+        primarySwatch: Colors.blue,
+      ),
+    );
+  }
+}

firebase_remote_config/lib/sentry_firebase_remote_config.dart

@@ -0,0 +1,3 @@
+library;
+
+export 'src/sentry_firebase_remote_config_integration.dart';