Skip to content

Refactor/push notification registration #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 22, 2025
Merged

Refactor/push notification registration #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bd03f9
refactor(notifications): improve device registration idempotency and …
fulleni Nov 22, 2025
156b767
refactor(notifications): improve device registration process
fulleni Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 32 additions & 17 deletions lib/notifications/services/firebase_push_notification_service.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'package:data_repository/data_repository.dart';
import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:flutter_news_app_mobile_client_full_source_code/notifications/services/push_notification_service.dart';
import 'package:logging/logging.dart';
import 'package:uuid/uuid.dart';

/// A concrete implementation of [PushNotificationService] for Firebase Cloud
/// Messaging (FCM).
Expand Down Expand Up @@ -115,35 +116,50 @@ class FirebasePushNotificationService implements PushNotificationService {
}

_logger.fine('FCM token received for registration: $token');
// The device ID is now a composite key of userId and provider name to
// ensure idempotency and align with the backend's delete-then-create
// pattern.
final deviceId = '${userId}_${PushNotificationProvider.firebase.name}';

// First, attempt to delete any existing device registration for this user
// and provider. This ensures a clean state and handles token updates
// by effectively performing a "delete-then-create".

// To ensure a user only receives notifications on their most recently
// used device, we proactively clear all of their previous device
// registrations before creating a new one. This prevents "ghost"
// notifications from being sent to old, unused installations (e.g.,
// after a user gets a new phone or reinstalls the app).
try {
await _pushNotificationDeviceRepository.delete(id: deviceId);
_logger.info('Existing device registration deleted for $deviceId.');
} on NotFoundException {
_logger.info(
'No existing device registration found for $deviceId. Proceeding with creation.',
final existingDevices = await _pushNotificationDeviceRepository.readAll(
userId: userId,
);

if (existingDevices.items.isNotEmpty) {
_logger.info(
'Found ${existingDevices.items.length} existing device(s) for user $userId. Deleting...',
);
await Future.wait(
existingDevices.items.map(
(device) => _pushNotificationDeviceRepository.delete(
id: device.id,
userId: userId,
),
),
);
_logger.info('All existing devices for user $userId deleted.');
}
} catch (e, s) {
// If the proactive cleanup fails (e.g., due to a temporary network
// issue), we log the error but do not halt the registration process.
// The backend's passive, self-healing mechanism (which prunes invalid
// tokens upon send failure) will eventually clean up any orphaned
// device records. This ensures that a failure in cleanup does not
// prevent the user from receiving notifications on their new device.
_logger.warning(
'Failed to delete existing device registration for $deviceId. Proceeding with creation anyway. Error: $e',
'Could not clean up existing devices for user $userId, proceeding with registration. Error: $e',
e,
s,
);
}

final newDevice = PushNotificationDevice(
id: deviceId,
id: const Uuid().v4(),
userId: userId,
platform: Platform.isIOS ? DevicePlatform.ios : DevicePlatform.android,
providerTokens: {PushNotificationProvider.firebase: token},
// Timestamps are managed by the backend, but we provide initial values.
createdAt: DateTime.now(),
updatedAt: DateTime.now(),
);
Expand All @@ -152,7 +168,6 @@ class FirebasePushNotificationService implements PushNotificationService {
_logger.info('Device successfully registered with backend.');
} catch (e, s) {
_logger.severe('Failed to register device.', e, s);
// Re-throwing allows the caller (e.g., AppBloc) to know about the failure.
rethrow;
}
}
Expand Down
47 changes: 32 additions & 15 deletions lib/notifications/services/one_signal_push_notification_service.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'package:data_repository/data_repository.dart';
import 'package:flutter_news_app_mobile_client_full_source_code/notifications/services/push_notification_service.dart';
import 'package:logging/logging.dart';
import 'package:onesignal_flutter/onesignal_flutter.dart';
import 'package:uuid/uuid.dart';

/// A concrete implementation of [PushNotificationService] for OneSignal.
class OneSignalPushNotificationService extends PushNotificationService {
Expand Down Expand Up @@ -115,31 +116,47 @@ class OneSignalPushNotificationService extends PushNotificationService {
}

_logger.fine('OneSignal Player ID received: $token');
// The device ID is now a composite key of userId and provider name to
// ensure idempotency and align with the backend's delete-then-create
// pattern.
final deviceId = '${userId}_${PushNotificationProvider.oneSignal.name}';

// First, attempt to delete any existing device registration for this user
// and provider. This ensures a clean state and handles token updates
// by effectively performing a "delete-then-create".

// To ensure a user only receives notifications on their most recently
// used device, we proactively clear all of their previous device
// registrations before creating a new one. This prevents "ghost"
// notifications from being sent to old, unused installations (e.g.,
// after a user gets a new phone or reinstalls the app).
try {
await _pushNotificationDeviceRepository.delete(id: deviceId);
_logger.info('Existing device registration deleted for $deviceId.');
} on NotFoundException {
_logger.info(
'No existing device registration found for $deviceId. Proceeding with creation.',
final existingDevices = await _pushNotificationDeviceRepository.readAll(
userId: userId,
);

if (existingDevices.items.isNotEmpty) {
_logger.info(
'Found ${existingDevices.items.length} existing device(s) for user $userId. Deleting...',
);
await Future.wait(
existingDevices.items.map(
(device) => _pushNotificationDeviceRepository.delete(
id: device.id,
userId: userId,
),
),
);
_logger.info('All existing devices for user $userId deleted.');
}
} catch (e, s) {
// If the proactive cleanup fails (e.g., due to a temporary network
// issue), we log the error but do not halt the registration process.
// The backend's passive, self-healing mechanism (which prunes invalid
// tokens upon send failure) will eventually clean up any orphaned
// device records. This ensures that a failure in cleanup does not
// prevent the user from receiving notifications on their new device.
_logger.warning(
'Failed to delete existing device registration for $deviceId. Proceeding with creation anyway. Error: $e',
'Could not clean up existing devices for user $userId, proceeding with registration. Error: $e',
e,
s,
);
}

final newDevice = PushNotificationDevice(
id: deviceId,
id: const Uuid().v4(),
userId: userId,
platform: Platform.isIOS ? DevicePlatform.ios : DevicePlatform.android,
providerTokens: {PushNotificationProvider.oneSignal: token},
Expand Down
Loading