Sentry Supabase Integration

.craft.yml

@@ -19,6 +19,7 @@ targets:
       packages/isar:
       packages/link:
       packages/firebase_remote_config:
+      packages/supabase:
   - name: github
   - name: registry
     sdks:
@@ -33,3 +34,5 @@ targets:
       pub:sentry_isar:
       pub:sentry_link:
       pub:sentry_firebase_remote_config:
+      # TODO: after we published supabase we need to add it to the registry repo and then uncomment here
+      # pub:sentry_supabase:

.github/workflows/diagrams.yml

@@ -59,6 +59,10 @@ jobs:
         working-directory: ./packages/firebase_remote_config
         run: lakos . -i "{test/**,example/**}" | dot -Tsvg -o class-diagram.svg
 
+      - name: supabase
+        working-directory: ./packages/supabase
+        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/supabase.yml

@@ -0,0 +1,56 @@
+name: sentry-supabase
+on:
+  push:
+    branches:
+      - main
+      - release/**
+  pull_request:
+    paths:
+      - '!**/*.md'
+      - '!**/class-diagram.svg'
+      - '.github/workflows/supabase.yml'
+      - '.github/workflows/analyze.yml'
+      - '.github/actions/dart-test/**'
+      - '.github/actions/coverage/**'
+      - 'packages/dart/**'
+      - 'packages/flutter/**'
+      - 'packages/supabase/**'
+
+# 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: packages/supabase
+          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: packages/supabase
+#          coverage: sentry_supabase
+#          min-coverage: 55
+
+  analyze:
+    uses: ./.github/workflows/analyze.yml
+    with:
+      package: packages/supabase
+      sdk: flutter

CHANGELOG.md

@@ -4,6 +4,13 @@
 
 ### Features
 
+- Sentry Supabase Integration ([#2913](https://github.com/getsentry/sentry-dart/pull/2913))
+  - Adds the `sentry_supabase` package to instrument supabase with Sentry breadcrumbs, traces and errors.
+
+## 9.7.0
+
+### Features
+
 - Mark file sync spans run in the main isolate with `blocked_main_thread` ([#3270](https://github.com/getsentry/sentry-dart/pull/3270))
  - This allows Sentry to create issues automatically out of file spans running a certain time on the main thread: https://docs.sentry.io/product/issues/issue-details/performance-issues/file-main-thread-io/
 

packages/dart/lib/src/sentry_trace_origins.dart

@@ -27,4 +27,5 @@ class SentryTraceOrigins {
   static const autoDbDriftQueryInterceptor = 'auto.db.drift.query.interceptor';
   static const autoUiTimeToDisplay = 'auto.ui.time_to_display';
   static const manualUiTimeToDisplay = 'manual.ui.time_to_display';
+  static const autoDbSupabase = 'auto.db.supabase';
 }

packages/supabase/.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/

packages/supabase/CHANGELOG.md

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

packages/supabase/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.

packages/supabase/README.md

@@ -0,0 +1,65 @@
+<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 `supabase` package
+===========
+
+| package     | build                                                                                                                                                                                | pub                                                                                                  | likes                                                                                                | popularity                                                                                                     | pub points |
+|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| ------- |
+| sentry_supabase | [![build](https://github.com/getsentry/sentry-dart/actions/workflows/supabase.yml/badge.svg?branch=main)](https://github.com/getsentry/sentry-dart/actions?query=workflow%3Asentry-supabase) | [![pub package](https://img.shields.io/pub/v/sentry_supabase.svg)](https://pub.dev/packages/sentry_supabase) | [![likes](https://img.shields.io/pub/likes/sentry_supabase)](https://pub.dev/packages/sentry_supabase/score) | [![popularity](https://img.shields.io/pub/popularity/sentry_supabase)](https://pub.dev/packages/sentry_supabase/score) | [![pub points](https://img.shields.io/pub/points/sentry_supabase)](https://pub.dev/packages/sentry_supabase/score)
+
+Integration for [`supabase`](https://pub.dev/packages/supabase) package. 
+
+#### 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:supabase_flutter/supabase_flutter.dart';
+import 'package:sentry_supabase/sentry_supabase.dart';
+
+// Create a [SentrySupabaseClient] and pass it to Supabase during initialization.
+
+final sentrySupabaseClient = SentrySupabaseClient();
+await Supabase.initialize(
+  url: '<YOUR_SUPABASE_URL>',
+  anonKey: '<YOUR_SUPABASE_ANON_KEY>',
+  httpClient: sentrySupabaseClient,
+);
+
+// Now all [Supabase] operations and queries will
+// be instrumented with Sentry breadcrumbs, traces and errors.
+
+final issues = await Supabase.instance.client
+  .from('issues')
+  .select();
+```
+
+#### 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)

packages/supabase/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

packages/supabase/dartdoc_options.yaml

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

packages/supabase/example/example.dart

@@ -0,0 +1,18 @@
+import 'package:supabase_flutter/supabase_flutter.dart';
+import 'package:sentry_supabase/sentry_supabase.dart';
+
+Future<void> main() async {
+  // Create a [SentrySupabaseClient] and pass it to Supabase during initialization.
+
+  final sentrySupabaseClient = SentrySupabaseClient();
+  await Supabase.initialize(
+    url: '<YOUR_SUPABASE_URL>',
+    anonKey: '<YOUR_SUPABASE_ANON_KEY>',
+    httpClient: sentrySupabaseClient,
+  );
+
+  // Now all [Supabase] operations and queries will
+  // be instrumented with Sentry breadcrumbs, traces and errors.
+
+  final issues = await Supabase.instance.client.from('issues').select();
+}

packages/supabase/lib/sentry_supabase.dart

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

packages/supabase/lib/src/operation.dart

@@ -0,0 +1,11 @@
+enum Operation {
+  select('select'),
+  insert('insert'),
+  upsert('upsert'),
+  update('update'),
+  delete('delete'),
+  unknown('unknown');
+
+  final String value;
+  const Operation(this.value);
+}

packages/supabase/lib/src/sentry_supabase_breadcrumb_client.dart

@@ -0,0 +1,54 @@
+import 'package:http/http.dart';
+import 'package:sentry/sentry.dart';
+
+import 'sentry_supabase_request.dart';
+
+class SentrySupabaseBreadcrumbClient extends BaseClient {
+  final Client _innerClient;
+  final Hub _hub;
+
+  SentrySupabaseBreadcrumbClient(this._innerClient, this._hub);
+
+  @override
+  Future<StreamedResponse> send(BaseRequest request) async {
+    final supabaseRequest = SentrySupabaseRequest.fromRequest(
+      request,
+      // ignore: invalid_use_of_internal_member
+      options: _hub.options,
+    );
+
+    if (supabaseRequest == null) {
+      return _innerClient.send(request);
+    }
+
+    final breadcrumb = Breadcrumb(
+      message: 'from(${supabaseRequest.table})',
+      category: 'db.${supabaseRequest.operation.value}',
+      type: 'supabase',
+    );
+
+    breadcrumb.data ??= {};
+
+    breadcrumb.data?['table'] = supabaseRequest.table;
+    breadcrumb.data?['operation'] = supabaseRequest.operation.value;
+
+    // ignore: invalid_use_of_internal_member
+    if (supabaseRequest.query.isNotEmpty && _hub.options.sendDefaultPii) {
+      breadcrumb.data?['query'] = supabaseRequest.query;
+    }
+
+    // ignore: invalid_use_of_internal_member
+    if (supabaseRequest.body != null && _hub.options.sendDefaultPii) {
+      breadcrumb.data?['body'] = supabaseRequest.body;
+    }
+
+    await _hub.addBreadcrumb(breadcrumb);
+
+    return _innerClient.send(request);
+  }
+
+  @override
+  void close() {
+    _innerClient.close();
+  }
+}