push registration no longer depends on notification permission, reporting effective opt-in and os permission
This commit is contained in:
@@ -3,41 +3,71 @@ import 'dart:convert';
|
||||
import 'dart:io';
|
||||
|
||||
import 'package:device_info_plus/device_info_plus.dart';
|
||||
import 'package:firebase_messaging/firebase_messaging.dart';
|
||||
import 'package:package_info_plus/package_info_plus.dart';
|
||||
|
||||
import '../../../../push/push_registration.dart';
|
||||
import '../../../../push/push_registration_store.dart';
|
||||
import '../../../../push/push_registration_type.dart';
|
||||
import '../../marianumconnect_query.dart';
|
||||
import 'telemetry_device_id.dart';
|
||||
|
||||
typedef _PushState = ({
|
||||
bool enabled,
|
||||
AuthorizationStatus? permission,
|
||||
String? pushDeviceIdentifier,
|
||||
});
|
||||
|
||||
/// Sends a telemetry heartbeat to MarianumConnect (`POST me/telemetry`) —
|
||||
/// upserts the stable install id, platform, app version and device info. Sent
|
||||
/// on app start, again once push registration completes that session (so a
|
||||
/// fresh registration isn't under-reported until the next launch), and on
|
||||
/// resume after the app spent more than 15 minutes in the background.
|
||||
/// on app start, on resume and once push registration completes, throttled to
|
||||
/// one per 15 minutes unless the push state changed in between.
|
||||
/// Bearer-authenticated via the shared dio interceptor. Replaces the legacy
|
||||
/// mhsl.eu `server/userIndex/update` call.
|
||||
class TelemetryHeartbeat extends MarianumConnectQuery {
|
||||
TelemetryHeartbeat({super.dio});
|
||||
|
||||
static const Duration _interval = Duration(minutes: 15);
|
||||
|
||||
// Wall-clock throttle rather than Debouncer.throttle: a Timer does not tick
|
||||
// reliably while the app is suspended, so the window would still be open on
|
||||
// the resume it is supposed to let through.
|
||||
static DateTime? _lastSentAt;
|
||||
static _PushState? _lastPushState;
|
||||
|
||||
/// Fire-and-forget: schedules a heartbeat and swallows any error, so a failed
|
||||
/// send never disrupts app start. Used from the app shell's initState and
|
||||
/// lifecycle handler, and re-emitted once push registration completes (see
|
||||
/// `_MainState._syncPush`).
|
||||
/// send never disrupts app start. A changed push state (toggle, OS
|
||||
/// permission — e.g. back from the system settings — or a fresh
|
||||
/// registration) bypasses the throttle: the server picks visible vs. silent
|
||||
/// delivery from it, so it must not wait for the next window.
|
||||
static void report({required bool notificationsEnabled}) {
|
||||
unawaited(
|
||||
TelemetryHeartbeat()
|
||||
.send(notificationsEnabled: notificationsEnabled)
|
||||
.catchError((Object _) {}),
|
||||
);
|
||||
unawaited(_report(notificationsEnabled).catchError((Object _) {}));
|
||||
}
|
||||
|
||||
Future<void> send({required bool notificationsEnabled}) => guard(() async {
|
||||
static Future<void> _report(bool enabled) async {
|
||||
final pushState = (
|
||||
enabled: enabled,
|
||||
permission: await PushRegistration.osPermissionStatus(),
|
||||
pushDeviceIdentifier: await const PushRegistrationStore()
|
||||
.deviceIdentifier(PushRegistrationType.general),
|
||||
);
|
||||
final now = DateTime.now();
|
||||
final last = _lastSentAt;
|
||||
if (last != null &&
|
||||
now.difference(last) < _interval &&
|
||||
pushState == _lastPushState) {
|
||||
return;
|
||||
}
|
||||
// Claimed before sending so overlapping triggers don't both go out.
|
||||
_lastSentAt = now;
|
||||
_lastPushState = pushState;
|
||||
await TelemetryHeartbeat()._send(pushState);
|
||||
}
|
||||
|
||||
Future<void> _send(_PushState push) => guard(() async {
|
||||
final info = DeviceInfoPlugin();
|
||||
final package = await PackageInfo.fromPlatform();
|
||||
final deviceIdentifier = await TelemetryDeviceId.resolve();
|
||||
final pushDeviceIdentifier = await const PushRegistrationStore()
|
||||
.deviceIdentifier(PushRegistrationType.general);
|
||||
|
||||
var platform = 'unknown';
|
||||
String? deviceModel;
|
||||
@@ -62,11 +92,12 @@ class TelemetryHeartbeat extends MarianumConnectQuery {
|
||||
data: {
|
||||
'deviceIdentifier': deviceIdentifier,
|
||||
// `pushDeviceIdentifier` reflects a *completed* registration and is
|
||||
// absent until it lands; `pushEnabled` carries the user's intent
|
||||
// (the notification toggle) so the backend can tell "user wants push"
|
||||
// apart from "registration not finished yet".
|
||||
'pushDeviceIdentifier': ?pushDeviceIdentifier,
|
||||
'pushEnabled': notificationsEnabled,
|
||||
// absent until it lands; `pushEnabled` carries the user's intent (the
|
||||
// toggle). The server combines it with `osPermission` into the
|
||||
// visible-vs-silent delivery decision.
|
||||
'pushDeviceIdentifier': ?push.pushDeviceIdentifier,
|
||||
'pushEnabled': push.enabled,
|
||||
'osPermission': ?osPermissionWireValue(push.permission),
|
||||
'platform': platform,
|
||||
'appVersion': package.version,
|
||||
'appBuild': int.tryParse(package.buildNumber),
|
||||
@@ -77,3 +108,13 @@ class TelemetryHeartbeat extends MarianumConnectQuery {
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
/// Wire value of the OS notification permission for the heartbeat.
|
||||
String? osPermissionWireValue(AuthorizationStatus? status) => switch (status) {
|
||||
AuthorizationStatus.authorized => 'granted',
|
||||
AuthorizationStatus.provisional => 'provisional',
|
||||
AuthorizationStatus.denied ||
|
||||
AuthorizationStatus.deniedPermanently => 'denied',
|
||||
AuthorizationStatus.notDetermined => 'notDetermined',
|
||||
null => null,
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user