add websockets updates settings in timeline settings

Big-Fig · Oct 4, 2020 · 3166d82 · 3166d82
1 parent ab7583a
commit 3166d82
Show file tree

Hide file tree

Showing 11 changed files with 88 additions and 16 deletions.
diff --git a/assets/langs/en-US.json b/assets/langs/en-US.json
@@ -708,6 +708,12 @@
           "only_remote": {
             "label": "Only remote"
           },
+          "web_sockets_updates": {
+            "label": "WebSockets updates",
+            "disabled": {
+              "desc": "WebSockets disabled in account settings"
+            }
+          },
           "only_local": {
             "label": "Only local"
           },

diff --git a/lib/app/localization/localization_loader.dart b/lib/app/localization/localization_loader.dart
@@ -724,6 +724,12 @@ class CodegenLoader extends AssetLoader{
           "only_remote": {
             "label": "Only remote"
           },
+          "web_sockets_updates": {
+            "label": "WebSockets updates",
+            "disabled": {
+              "desc": "WebSockets disabled in account settings"
+            }
+          },
           "only_local": {
             "label": "Only local"
           },

diff --git a/lib/app/timeline/settings/timeline_settings_filter_support_extension.dart b/lib/app/timeline/settings/timeline_settings_filter_support_extension.dart
@@ -1,5 +1,7 @@
+import 'package:fedi/app/account/my/settings/my_account_settings_local_preference_bloc.dart';
 import 'package:fedi/app/auth/instance/auth_instance_model.dart';
 import 'package:fedi/app/timeline/timeline_model.dart';
+import 'package:flutter/cupertino.dart';
 
 
 extension TimelineRemoteTypeFilterSupportExtension on TimelineType {
@@ -53,6 +55,10 @@ extension TimelineRemoteTypeFilterSupportExtension on TimelineType {
     // require additional pagination handling
     return false;
   }
+  bool isWebSocketsUpdatesFilterSupportedOnInstance(BuildContext context) {
+    var myAccountSettingsLocalPreferenceBloc = IMyAccountSettingsLocalPreferenceBloc.of(context, listen: false);
+    return myAccountSettingsLocalPreferenceBloc.value?.isRealtimeWebSocketsEnabled ?? true;
+  }
 
   bool isOnlyRemoteFilterSupportedOnInstance(AuthInstance authInstance) {
     switch (this) {

diff --git a/lib/app/timeline/settings/timeline_settings_form_bloc.dart b/lib/app/timeline/settings/timeline_settings_form_bloc.dart
@@ -48,6 +48,8 @@ abstract class ITimelineSettingsFormBloc extends IFormBloc {
 
   FormListValueFieldBloc<PleromaVisibility> get excludeVisibilitiesFieldBloc;
 
+  IFormBoolFieldBloc get webSocketsUpdatesFieldBloc;
+
   void fill({
     @required TimelineType type,
     @required TimelineSettings newSettings,

diff --git a/lib/app/timeline/settings/timeline_settings_form_bloc_impl.dart b/lib/app/timeline/settings/timeline_settings_form_bloc_impl.dart
@@ -66,6 +66,9 @@ class TimelineSettingsFormBloc extends FormBloc
   @override
   FormListValueFieldBloc<PleromaVisibility> excludeVisibilitiesFieldBloc;
 
+  @override
+  final IFormBoolFieldBloc webSocketsUpdatesFieldBloc;
+
   TimelineType type;
 
   TimelineSettingsFormBloc({
@@ -127,8 +130,9 @@ class TimelineSettingsFormBloc extends FormBloc
             originValue: originalSettings?.replyVisibilityFilter,
             validators: []),
         excludeVisibilitiesFieldBloc = FormListValueFieldBloc(
-            originValue: originalSettings?.excludeVisibilities,
-            validators: []) {
+            originValue: originalSettings?.excludeVisibilities, validators: []),
+        webSocketsUpdatesFieldBloc = FormBoolFieldBloc(
+            originValue: originalSettings?.webSocketsUpdates ?? true) {
     addDisposable(subject: _timelineSettingsSubject);
 
     addDisposable(disposable: excludeRepliesFieldBloc);
@@ -215,6 +219,7 @@ class TimelineSettingsFormBloc extends FormBloc
       onlyFromRemoteAccount: onlyFromRemoteAccountFieldBloc.currentValue,
       excludeReblogs: excludeReblogsFieldBloc.currentValue,
       onlyPinned: onlyPinnedFieldBloc.currentValue,
+      webSocketsUpdates: webSocketsUpdatesFieldBloc.currentValue
     );
     if (newPreferences != oldPreferences) {
       _timelineSettingsSubject.add(newPreferences);

diff --git a/lib/app/timeline/settings/timeline_settings_model.dart b/lib/app/timeline/settings/timeline_settings_model.dart
@@ -26,12 +26,14 @@ class TimelineSettings extends IPreferencesObject {
         onlyLocal: false,
         withMuted: false,
         excludeVisibilities: [],
+        websocketsUpdates: true,
       );
 
   static TimelineSettings createDefaultHomeSettings() => TimelineSettings.home(
         onlyLocal: false,
         withMuted: false,
         excludeVisibilities: [],
+        websocketsUpdates: true,
       );
 
   static TimelineSettings createDefaultCustomListSettings({
@@ -41,6 +43,7 @@ class TimelineSettings extends IPreferencesObject {
         withMuted: false,
         excludeVisibilities: [],
         onlyInRemoteList: onlyInRemoteList,
+        websocketsUpdates: true,
       );
 
   static TimelineSettings createDefaultHashtagSettings({
@@ -52,6 +55,7 @@ class TimelineSettings extends IPreferencesObject {
         withMuted: false,
         excludeVisibilities: [],
         withRemoteHashtag: withRemoteHashtag,
+        websocketsUpdates: true,
       );
 
   static TimelineSettings createDefaultAccountSettings({
@@ -63,6 +67,7 @@ class TimelineSettings extends IPreferencesObject {
         excludeReplies: false,
         onlyPinned: false,
         onlyFromRemoteAccount: onlyFromRemoteAccount,
+        websocketsUpdates: true,
       );
 
   @HiveField(1)
@@ -117,6 +122,10 @@ class TimelineSettings extends IPreferencesObject {
   @JsonKey(name: "exclude_reblogs")
   final bool excludeReblogs;
 
+  @HiveField(16)
+  @JsonKey(name: "web_sockets_updates")
+  final bool webSocketsUpdates;
+
   TimelineSettings({
     @required this.onlyWithMedia,
     @required this.excludeReplies,
@@ -131,12 +140,14 @@ class TimelineSettings extends IPreferencesObject {
     @required this.onlyFromRemoteAccount,
     @required this.onlyPinned,
     @required this.excludeReblogs,
+    @required this.webSocketsUpdates,
   });
 
   TimelineSettings.home({
     @required bool onlyLocal,
     @required bool withMuted,
     @required List<PleromaVisibility> excludeVisibilities,
+    @required bool websocketsUpdates,
   }) : this(
           onlyWithMedia: null,
           excludeReplies: null,
@@ -153,6 +164,7 @@ class TimelineSettings extends IPreferencesObject {
           onlyFromRemoteAccount: null,
           onlyPinned: null,
           excludeReblogs: null,
+          webSocketsUpdates: websocketsUpdates,
         );
 
   TimelineSettings.public({
@@ -161,6 +173,7 @@ class TimelineSettings extends IPreferencesObject {
     @required bool onlyLocal,
     @required bool withMuted,
     @required List<PleromaVisibility> excludeVisibilities,
+    @required bool websocketsUpdates,
   }) : this(
           onlyWithMedia: onlyWithMedia,
           excludeReplies: null,
@@ -177,6 +190,7 @@ class TimelineSettings extends IPreferencesObject {
           onlyFromRemoteAccount: null,
           onlyPinned: null,
           excludeReblogs: null,
+          webSocketsUpdates: websocketsUpdates,
         );
 
   TimelineSettings.hashtag({
@@ -185,6 +199,7 @@ class TimelineSettings extends IPreferencesObject {
     @required bool withMuted,
     @required List<PleromaVisibility> excludeVisibilities,
     @required String withRemoteHashtag,
+    @required bool websocketsUpdates,
   }) : this(
           onlyWithMedia: onlyWithMedia,
           excludeReplies: null,
@@ -201,12 +216,14 @@ class TimelineSettings extends IPreferencesObject {
           onlyFromRemoteAccount: null,
           onlyPinned: null,
           excludeReblogs: null,
+          webSocketsUpdates: websocketsUpdates,
         );
 
   TimelineSettings.list({
     @required bool withMuted,
     @required List<PleromaVisibility> excludeVisibilities,
     @required IPleromaList onlyInRemoteList,
+    @required bool websocketsUpdates,
   }) : this(
           onlyWithMedia: null,
           excludeReplies: null,
@@ -223,6 +240,7 @@ class TimelineSettings extends IPreferencesObject {
           onlyFromRemoteAccount: null,
           onlyPinned: null,
           excludeReblogs: null,
+          webSocketsUpdates: websocketsUpdates,
         );
 
   TimelineSettings.account({
@@ -231,6 +249,7 @@ class TimelineSettings extends IPreferencesObject {
     @required bool excludeReplies,
     @required bool excludeReblogs,
     @required bool onlyPinned,
+    @required bool websocketsUpdates,
   }) : this(
           onlyWithMedia: onlyWithMedia,
           excludeReplies: excludeReplies,
@@ -245,6 +264,7 @@ class TimelineSettings extends IPreferencesObject {
           onlyFromRemoteAccount: onlyFromRemoteAccount,
           onlyPinned: onlyPinned,
           excludeReblogs: excludeReblogs,
+          webSocketsUpdates: websocketsUpdates,
         );
 
   TimelineSettings copyWith({
@@ -260,8 +280,9 @@ class TimelineSettings extends IPreferencesObject {
     PleromaTag withRemoteHashtag,
     String replyVisibilityFilterString,
     PleromaAccount onlyFromRemoteAccount,
-    bool excludeReblogs,
     bool onlyPinned,
+    bool excludeReblogs,
+    bool webSocketsUpdates,
   }) =>
       TimelineSettings(
         onlyWithMedia: onlyWithMedia ?? this.onlyWithMedia,
@@ -278,11 +299,11 @@ class TimelineSettings extends IPreferencesObject {
             replyVisibilityFilterString ?? this.replyVisibilityFilterString,
         onlyFromRemoteAccount:
             onlyFromRemoteAccount ?? this.onlyFromRemoteAccount,
-        excludeReblogs: excludeReblogs ?? this.excludeReblogs,
         onlyPinned: onlyPinned ?? this.onlyPinned,
+        excludeReblogs: excludeReblogs ?? this.excludeReblogs,
+        webSocketsUpdates: webSocketsUpdates ?? this.webSocketsUpdates,
       );
 
-
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
@@ -300,7 +321,8 @@ class TimelineSettings extends IPreferencesObject {
           replyVisibilityFilterString == other.replyVisibilityFilterString &&
           onlyFromRemoteAccount == other.onlyFromRemoteAccount &&
           onlyPinned == other.onlyPinned &&
-          excludeReblogs == other.excludeReblogs;
+          excludeReblogs == other.excludeReblogs &&
+          webSocketsUpdates == other.webSocketsUpdates;
 
   @override
   int get hashCode =>
@@ -316,6 +338,7 @@ class TimelineSettings extends IPreferencesObject {
       replyVisibilityFilterString.hashCode ^
       onlyFromRemoteAccount.hashCode ^
       onlyPinned.hashCode ^
+      webSocketsUpdates.hashCode ^
       excludeReblogs.hashCode;
 
   @override
@@ -332,6 +355,7 @@ class TimelineSettings extends IPreferencesObject {
         ' PleromaReplyVisibilityFilterString:'
         ' $replyVisibilityFilterString,'
         ' onlyFromAccountWithRemoteId: $onlyFromRemoteAccount,'
+        ' websocketsUpdates: $webSocketsUpdates,'
         ' onlyPinned: $onlyPinned, excludeReblogs: $excludeReblogs}';
   }
 

diff --git a/lib/app/timeline/settings/timeline_settings_model.g.dart b/lib/app/timeline/settings/timeline_settings_model.g.dart
diff --git a/lib/app/timeline/settings/timeline_settings_widget.dart b/lib/app/timeline/settings/timeline_settings_widget.dart
@@ -39,6 +39,7 @@ class TimelineSettingsWidget extends StatelessWidget {
           buildWithMutedField(context, settingsBloc, authInstance),
           buildOnlyMediaField(context, settingsBloc, authInstance),
           buildOnlyLocalField(context, settingsBloc, authInstance),
+          buildWebSocketsUpdatesField(context, settingsBloc, authInstance),
           buildReplyVisibilityFilterField(context, settingsBloc, authInstance),
         ];
         break;
@@ -48,6 +49,7 @@ class TimelineSettingsWidget extends StatelessWidget {
           buildOnlyMediaField(context, settingsBloc, authInstance),
           buildOnlyLocalField(context, settingsBloc, authInstance),
           buildOnlyRemoteField(context, settingsBloc, authInstance),
+          buildWebSocketsUpdatesField(context, settingsBloc, authInstance),
           buildReplyVisibilityFilterField(context, settingsBloc, authInstance),
         ];
         break;
@@ -56,6 +58,7 @@ class TimelineSettingsWidget extends StatelessWidget {
           buildCustomListField(context, settingsBloc, authInstance),
           buildWithMutedField(context, settingsBloc, authInstance),
           buildOnlyMediaField(context, settingsBloc, authInstance),
+          buildWebSocketsUpdatesField(context, settingsBloc, authInstance),
         ];
         break;
 
@@ -65,6 +68,7 @@ class TimelineSettingsWidget extends StatelessWidget {
           buildWithMutedField(context, settingsBloc, authInstance),
           buildOnlyMediaField(context, settingsBloc, authInstance),
           buildOnlyLocalField(context, settingsBloc, authInstance),
+          buildWebSocketsUpdatesField(context, settingsBloc, authInstance),
         ];
         break;
       case TimelineType.account:
@@ -74,6 +78,7 @@ class TimelineSettingsWidget extends StatelessWidget {
           buildOnlyPinnedField(context, settingsBloc, authInstance),
           buildExcludeReblogsField(context, settingsBloc, authInstance),
           buildExcludeRepliesField(context, settingsBloc, authInstance),
+          buildWebSocketsUpdatesField(context, settingsBloc, authInstance),
           buildHashtagField(context, settingsBloc, authInstance),
         ];
         break;
@@ -171,6 +176,20 @@ class TimelineSettingsWidget extends StatelessWidget {
     );
   }
 
+  FormBoolFieldFormRowWidget buildWebSocketsUpdatesField(
+    BuildContext context,
+    ITimelineSettingsFormBloc settingsBloc,
+    AuthInstance authInstance,
+  ) {
+    return buildBoolField(
+      label: tr("app.timeline.settings.field.web_sockets_updates.label"),
+      fieldBloc: settingsBloc.webSocketsUpdatesFieldBloc,
+      isSupported: type.isWebSocketsUpdatesFilterSupportedOnInstance(context),
+      errorDesc:
+          tr("app.timeline.settings.field.web_sockets_updates.disabled.desc"),
+    );
+  }
+
   FormBoolFieldFormRowWidget buildExcludeNsfwField(
     BuildContext context,
     ITimelineSettingsFormBloc settingsBloc,
@@ -261,14 +280,15 @@ class TimelineSettingsWidget extends StatelessWidget {
     @required String label,
     @required IFormBoolFieldBloc fieldBloc,
     @required bool isSupported,
+    String errorDesc,
   }) {
     return FormBoolFieldFormRowWidget(
       label: label,
       field: fieldBloc,
       enabled: isSupported,
       desc: isSupported
           ? null
-          : "app.timeline.settings.field.not_supported.desc".tr(),
+          : errorDesc ?? "app.timeline.settings.field.not_supported.desc".tr(),
     );
   }
 }
diff --git a/lib/app/timeline/status/timeline_status_cached_list_bloc_impl.dart b/lib/app/timeline/status/timeline_status_cached_list_bloc_impl.dart
@@ -50,7 +50,7 @@ class TimelineStatusCachedListBloc extends DisposableOwner
     @required this.webSocketsHandlerManagerBloc,
   }) {
     // todo: rework listen, due to settings change
-    if (listenWebSockets) {
+    if (listenWebSockets && (timeline.webSocketsUpdates ?? true)) {
       switch (timelineType) {
         case TimelineType.public:
           addDisposable(