feat(samples): add support for handling push notifications (#32)

Author: xsahil03x

.github/workflows/stream_feeds_flutter_workflow.yml

@@ -45,12 +45,10 @@ jobs:
         run: melos bootstrap --verbose
 
       - name: Dart Analyze
-        run: |
-          melos run analyze
+        run: melos run analyze
 
       - name: Check formatting
-        run: |
-          melos run format:verify
+        run: melos run format:verify
 
       ## Test and coverage reporting
       - name: "Flutter Test"
@@ -72,18 +70,18 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: ⚙️ Set up Java
-        uses: actions/setup-java@v3
-        with:
-          distribution: "zulu"
-          java-version: "17"
-
       - name: Install Flutter
         uses: subosito/flutter-action@v2
         with:
           cache: true
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
           channel: ${{ env.FLUTTER_CHANNEL }}
-          flutter-version: ${{ env.FLUTTER_VERSION }}
+
+      - name: Install Tools
+        run: flutter pub global activate melos
+
+      - name: Bootstrap Workspace
+        run: melos bootstrap --verbose
 
       - name: Build APK
         working-directory: sample_app

all_lint_rules.yaml

@@ -3,10 +3,10 @@ linter:
     - always_declare_return_types
     - always_put_control_body_on_new_line
     - always_put_required_named_parameters_first
-    - always_require_non_null_named_parameters
     - always_specify_types
     - always_use_package_imports
     - annotate_overrides
+    - annotate_redeclares
     - avoid_annotating_with_dynamic
     - avoid_bool_literals_in_conditional_expressions
     - avoid_catches_without_on_clauses
@@ -20,6 +20,7 @@ linter:
     - avoid_field_initializers_in_const_classes
     - avoid_final_parameters
     - avoid_function_literals_in_foreach_calls
+    - avoid_futureor_void
     - avoid_implementing_value_types
     - avoid_init_to_null
     - avoid_js_rounded_ints
@@ -32,8 +33,6 @@ linter:
     - avoid_relative_lib_imports
     - avoid_renaming_method_parameters
     - avoid_return_types_on_setters
-    - avoid_returning_null
-    - avoid_returning_null_for_future
     - avoid_returning_null_for_void
     - avoid_returning_this
     - avoid_setters_without_getters
@@ -61,12 +60,15 @@ linter:
     - constant_identifier_names
     - control_flow_in_finally
     - curly_braces_in_flow_control_structures
+    - dangling_library_doc_comments
     - depend_on_referenced_packages
     - deprecated_consistency
+    - deprecated_member_use_from_same_package
     - diagnostic_describe_all_properties
     - directives_ordering
     - discarded_futures
     - do_not_use_environment
+    - document_ignores
     - empty_catches
     - empty_constructor_bodies
     - empty_statements
@@ -76,32 +78,41 @@ linter:
     - flutter_style_todos
     - hash_and_equals
     - implementation_imports
-    - iterable_contains_unrelated_type
+    - implicit_call_tearoffs
+    - implicit_reopen
+    - invalid_case_patterns
+    - invalid_runtime_check_with_js_interop_types
     - join_return_with_assignment
     - leading_newlines_in_multiline_strings
+    - library_annotations
     - library_names
     - library_prefixes
     - library_private_types_in_public_api
     - lines_longer_than_80_chars
-    - list_remove_unrelated_type
     - literal_only_boolean_expressions
+    - matching_super_parameters
+    - missing_code_block_language_in_doc_comment
     - missing_whitespace_between_adjacent_strings
     - no_adjacent_strings_in_list
     - no_default_cases
     - no_duplicate_case_values
     - no_leading_underscores_for_library_prefixes
     - no_leading_underscores_for_local_identifiers
+    - no_literal_bool_comparisons
     - no_logic_in_create_state
     - no_runtimeType_toString
+    - no_self_assignments
+    - no_wildcard_variable_uses
     - non_constant_identifier_names
     - noop_primitive_operations
     - null_check_on_nullable_type_parameter
     - null_closures
     - omit_local_variable_types
+    - omit_obvious_local_variable_types
+    - omit_obvious_property_types
     - one_member_abstracts
     - only_throw_errors
     - overridden_fields
-    - package_api_docs
     - package_names
     - package_prefixed_library_names
     - parameter_assignments
@@ -117,7 +128,6 @@ linter:
     - prefer_constructors_over_static_methods
     - prefer_contains
     - prefer_double_quotes
-    - prefer_equal_for_default_values
     - prefer_expression_function_bodies
     - prefer_final_fields
     - prefer_final_in_for_each
@@ -157,20 +167,31 @@ linter:
     - sort_constructors_first
     - sort_pub_dependencies
     - sort_unnamed_constructors_first
+    - specify_nonobvious_local_variable_types
+    - specify_nonobvious_property_types
+    - strict_top_level_inference
+    - switch_on_type
     - test_types_in_equals
     - throw_in_finally
     - tighten_type_of_initializing_formals
     - type_annotate_public_apis
     - type_init_formals
+    - type_literal_in_constant_pattern
     - unawaited_futures
+    - unintended_html_in_doc_comment
+    - unnecessary_async
     - unnecessary_await_in_return
     - unnecessary_brace_in_string_interps
+    - unnecessary_breaks
     - unnecessary_const
     - unnecessary_constructor_name
     - unnecessary_final
     - unnecessary_getters_setters
+    - unnecessary_ignore
     - unnecessary_lambdas
     - unnecessary_late
+    - unnecessary_library_directive
+    - unnecessary_library_name
     - unnecessary_new
     - unnecessary_null_aware_assignments
     - unnecessary_null_aware_operator_on_extension_on_nullable
@@ -185,9 +206,11 @@ linter:
     - unnecessary_string_interpolations
     - unnecessary_this
     - unnecessary_to_list_in_spreads
+    - unnecessary_unawaited
+    - unnecessary_underscores
     - unreachable_from_main
     - unrelated_type_equality_checks
-    - unsafe_html
+    - unsafe_variance
     - use_build_context_synchronously
     - use_colored_box
     - use_decorated_box
@@ -199,6 +222,7 @@ linter:
     - use_key_in_widget_constructors
     - use_late_for_private_fields_and_variables
     - use_named_constants
+    - use_null_aware_elements
     - use_raw_strings
     - use_rethrow_when_possible
     - use_setters_to_change_properties
@@ -207,5 +231,6 @@ linter:
     - use_super_parameters
     - use_test_throws_matchers
     - use_to_and_as_if_applicable
+    - use_truncating_division
     - valid_regexps
-    - void_checks
+    - void_checks

analysis_options.yaml

@@ -10,11 +10,10 @@ analyzer:
     # We explicitly enabled even conflicting rules and are fixing the conflict
     # in this file.
     included_file_warning: ignore
-
-    todo: ignore
   exclude:
     # exclude all the generated files
-    - packages/*/lib/**/*.g.dart
+    - packages/*/lib/**/*.*.dart
+    - packages/stream_feeds/lib/src/generated/**
 
 linter:
   rules:
@@ -93,6 +92,18 @@ linter:
     # There are situations where we use default in enums on purpose
     no_default_cases: false
 
-    # Temporarily disabled to find more important issues
+    # Redundant and not required
+    document_ignores: false
+
+    # Conflicts with `omit_local_variable_types`
+    specify_nonobvious_local_variable_types: false
+    specify_nonobvious_property_types: false
+
+    # False positives
+    unsafe_variance: false
+
+    # TODO: Remove once we remove support for flutter 3.27.4
+    omit_obvious_property_types: false
+
+    # TODO: Temporarily disabled to find more important issues
     public_member_api_docs: false
-    avoid_print: false

docs/analysis_options.yaml

@@ -7,4 +7,5 @@ analyzer:
 linter:
   rules:
     file_names: false
+    avoid_print: false
     avoid_redundant_argument_values: false

melos.yaml

@@ -20,7 +20,6 @@ command:
     # List of all the dependencies used in the project.
     dependencies:
       auto_route: ^10.0.0
-      cached_network_image: ^3.4.1
       collection: ^1.18.0
       chewie: ^1.11.3
       dio: ^5.9.0
@@ -31,7 +30,10 @@ command:
       get_it: ^8.0.3
       google_fonts: ^6.3.0
       file_picker: ^8.1.4
+      firebase_core: ^3.0.0
+      firebase_messaging: ^15.0.0
       flex_grid_view: ^0.1.0
+      flutter_local_notifications: ^18.0.1
       injectable: ^2.5.1
       http: ^1.1.0
       intl: ">=0.18.1 <=0.21.0"
@@ -51,6 +53,7 @@ command:
     dev_dependencies:
       auto_route_generator: ^10.0.0
       build_runner: ^2.4.15
+      flutter_launcher_icons: ^0.14.4
       freezed: ^3.0.0
       injectable_generator: ^2.7.0
       json_serializable: ^6.9.5

packages/stream_feeds/lib/src/client/feeds_client_impl.dart

@@ -448,16 +448,20 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
   }
 
   @override
-  Future<Result<void>> createDevice(
-    String id,
-    PushNotificationsProvider pushProvider,
-    String pushProviderName,
-  ) {
-    return _devicesRepository.createDevice(id, pushProvider, pushProviderName);
+  Future<Result<void>> createDevice({
+    required String id,
+    required PushNotificationsProvider pushProvider,
+    required String pushProviderName,
+  }) {
+    return _devicesRepository.createDevice(
+      id,
+      pushProvider,
+      pushProviderName,
+    );
   }
 
   @override
-  Future<Result<void>> deleteDevice(String id) {
+  Future<Result<void>> deleteDevice({required String id}) {
     return _devicesRepository.deleteDevice(id);
   }
 

packages/stream_feeds/lib/src/feeds_client.dart

@@ -653,9 +653,9 @@ abstract interface class StreamFeedsClient {
   /// Example:
   /// ```dart
   /// final result = await client.createDevice(
-  ///   'firebase-token-123',
-  ///   PushNotificationsProvider.firebase,
-  ///   'MyApp Firebase Config',
+  ///   id: 'firebase-token-123',
+  ///   pushProvider: PushNotificationsProvider.firebase,
+  ///   pushProviderName: 'MyApp Firebase Config',
   /// );
   ///
   /// switch (result) {
@@ -667,11 +667,11 @@ abstract interface class StreamFeedsClient {
   /// ```
   ///
   /// Returns a [Result] indicating success or failure of the device creation operation.
-  Future<Result<void>> createDevice(
-    String id,
-    PushNotificationsProvider pushProvider,
-    String pushProviderName,
-  );
+  Future<Result<void>> createDevice({
+    required String id,
+    required PushNotificationsProvider pushProvider,
+    required String pushProviderName,
+  });
 
   /// Deletes a device by its unique identifier.
   ///
@@ -680,7 +680,7 @@ abstract interface class StreamFeedsClient {
   ///
   /// Example:
   /// ```dart
-  /// final result = await client.deleteDevice('firebase-token-123');
+  /// final result = await client.deleteDevice(id: 'firebase-token-123');
   ///
   /// switch (result) {
   ///   case Success():
@@ -691,7 +691,7 @@ abstract interface class StreamFeedsClient {
   /// ```
   ///
   /// Returns a [Result] indicating success or failure of the deletion operation.
-  Future<Result<void>> deleteDevice(String id);
+  Future<Result<void>> deleteDevice({required String id});
 
   /// Deletes a previously uploaded file from the CDN.
   ///

packages/stream_feeds/lib/src/models.dart

@@ -8,6 +8,7 @@ export 'models/feed_member_request_data.dart';
 export 'models/feeds_config.dart';
 export 'models/follow_data.dart';
 export 'models/poll_data.dart';
+export 'models/push_notifications_config.dart';
 export 'models/request/activity_add_comment_request.dart'
     show ActivityAddCommentRequest;
 export 'models/request/activity_update_comment_request.dart'

packages/stream_feeds/lib/src/repository/devices_repository.dart

@@ -35,7 +35,7 @@ class DevicesRepository {
     String id,
     PushNotificationsProvider pushProvider,
     String pushProviderName,
-  ) async {
+  ) {
     final request = api.CreateDeviceRequest(
       id: id,
       pushProvider: pushProvider.toRequest(),

packages/stream_feeds/lib/src/state/event/feed_event_handler.dart

@@ -3,6 +3,7 @@ import 'package:stream_core/stream_core.dart';
 import '../../generated/api/models.dart' as api;
 import '../../models/activity_data.dart';
 import '../../models/activity_pin_data.dart';
+import '../../models/aggregated_activity_data.dart';
 import '../../models/bookmark_data.dart';
 import '../../models/comment_data.dart';
 import '../../models/feed_data.dart';
@@ -65,6 +66,14 @@ class FeedEventHandler implements StateEventHandler {
       return state.onActivityMarked(event.toModel());
     }
 
+    if (event is api.NotificationFeedUpdatedEvent) {
+      if (event.fid != fid.rawValue) return;
+      return state.onNotificationFeedUpdated(
+        event.aggregatedActivities?.map((it) => it.toModel()).toList(),
+        event.notificationStatus,
+      );
+    }
+
     if (event is api.BookmarkAddedEvent) {
       if (!event.bookmark.activity.feeds.contains(fid.rawValue)) return;
       return state.onBookmarkAdded(event.bookmark.toModel());