action_sheet: Always confirm before unsubscribing from a channel

chrisbobbe · chrisbobbe · commit 156f4d4a7766 · 2025-10-01T13:53:06.000-07:00
Fixes #1827. (That is, always confirm when unsubscribing via the action sheet -- I've added a test that we *don't* always confirm in the "All channels" page, since that could be annoying, as mentioned in the issue.)
diff --git a/assets/l10n/app_en.arb b/assets/l10n/app_en.arb
@@ -143,6 +143,10 @@
       "channelName": {"type": "String", "example": "mobile"}
     }
   },
+  "unsubscribeConfirmationDialogMessageCanResubscribe": "Are you sure you want to unsubscribe?",
+  "@unsubscribeConfirmationDialogMessageCanResubscribe": {
+    "description": "Message for a confirmation dialog for unsubscribing from a channel when you will have permission to resubscribe."
+  },
   "unsubscribeConfirmationDialogMessageCannotResubscribe": "Once you leave this channel, you will not be able to rejoin.",
   "@unsubscribeConfirmationDialogMessageCannotResubscribe": {
     "description": "Message for a confirmation dialog for unsubscribing from a channel when you will not have permission to resubscribe."
diff --git a/lib/generated/l10n/zulip_localizations.dart b/lib/generated/l10n/zulip_localizations.dart
@@ -341,6 +341,12 @@ abstract class ZulipLocalizations {
   /// **'Unsubscribe from {channelName}?'**
   String unsubscribeConfirmationDialogTitle(String channelName);
 
+  /// Message for a confirmation dialog for unsubscribing from a channel when you will have permission to resubscribe.
+  ///
+  /// In en, this message translates to:
+  /// **'Are you sure you want to unsubscribe?'**
+  String get unsubscribeConfirmationDialogMessageCanResubscribe;
+
   /// Message for a confirmation dialog for unsubscribing from a channel when you will not have permission to resubscribe.
   ///
   /// In en, this message translates to:
diff --git a/lib/generated/l10n/zulip_localizations_ar.dart b/lib/generated/l10n/zulip_localizations_ar.dart
@@ -123,6 +123,10 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
     return 'Unsubscribe from $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_de.dart b/lib/generated/l10n/zulip_localizations_de.dart
@@ -125,6 +125,10 @@ class ZulipLocalizationsDe extends ZulipLocalizations {
     return '$channelName deabonnieren?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_en.dart b/lib/generated/l10n/zulip_localizations_en.dart
@@ -123,6 +123,10 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
     return 'Unsubscribe from $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_fr.dart b/lib/generated/l10n/zulip_localizations_fr.dart
@@ -125,6 +125,10 @@ class ZulipLocalizationsFr extends ZulipLocalizations {
     return 'Se désinscrire de $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_it.dart b/lib/generated/l10n/zulip_localizations_it.dart
@@ -124,6 +124,10 @@ class ZulipLocalizationsIt extends ZulipLocalizations {
     return 'Unsubscribe from $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_ja.dart b/lib/generated/l10n/zulip_localizations_ja.dart
@@ -122,6 +122,10 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
     return '$channelName から退出しますか？';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_nb.dart b/lib/generated/l10n/zulip_localizations_nb.dart
@@ -123,6 +123,10 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
     return 'Unsubscribe from $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_pl.dart b/lib/generated/l10n/zulip_localizations_pl.dart
@@ -125,6 +125,10 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
     return 'Odsubskrybować z $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_ru.dart b/lib/generated/l10n/zulip_localizations_ru.dart
@@ -125,6 +125,10 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
     return 'Отменить подписку на $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_sk.dart b/lib/generated/l10n/zulip_localizations_sk.dart
@@ -123,6 +123,10 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
     return 'Unsubscribe from $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_sl.dart b/lib/generated/l10n/zulip_localizations_sl.dart
@@ -123,6 +123,10 @@ class ZulipLocalizationsSl extends ZulipLocalizations {
     return 'Odjava iz $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_uk.dart b/lib/generated/l10n/zulip_localizations_uk.dart
@@ -126,6 +126,10 @@ class ZulipLocalizationsUk extends ZulipLocalizations {
     return 'Відписатися від $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/generated/l10n/zulip_localizations_zh.dart b/lib/generated/l10n/zulip_localizations_zh.dart
@@ -123,6 +123,10 @@ class ZulipLocalizationsZh extends ZulipLocalizations {
     return 'Unsubscribe from $channelName?';
   }
 
+  @override
+  String get unsubscribeConfirmationDialogMessageCanResubscribe =>
+      'Are you sure you want to unsubscribe?';
+
   @override
   String get unsubscribeConfirmationDialogMessageCannotResubscribe =>
       'Once you leave this channel, you will not be able to rejoin.';
diff --git a/lib/widgets/actions.dart b/lib/widgets/actions.dart
@@ -244,6 +244,7 @@ abstract final class ZulipAction {
 
   static Future<void> unsubscribeFromChannel(BuildContext context, {
     required int channelId,
+    bool alwaysAsk = true,
   }) async {
     final store = PerAccountStoreWidget.of(context);
     final subscription = store.subscriptions[channelId];
@@ -253,9 +254,9 @@ abstract final class ZulipAction {
     final couldResubscribe = !subscription.inviteOnly
       || store.selfHasPermissionForGroupSetting(subscription.canSubscribeGroup,
            GroupSettingType.stream, 'can_subscribe_group');
+    final zulipLocalizations = ZulipLocalizations.of(context);
     if (!couldResubscribe) {
       // TODO(#1788) warn if org would lose content access (nobody can subscribe)
-      final zulipLocalizations = ZulipLocalizations.of(context);
 
       final dialog = showSuggestedActionDialog(context: context,
         title: zulipLocalizations.unsubscribeConfirmationDialogTitle(subscription.name),
@@ -264,6 +265,13 @@ abstract final class ZulipAction {
         actionButtonText: zulipLocalizations.unsubscribeConfirmationDialogConfirmButton);
       if (await dialog.result != true) return;
       if (!context.mounted) return;
+    } else if (alwaysAsk) {
+      final dialog = showSuggestedActionDialog(context: context,
+        title: zulipLocalizations.unsubscribeConfirmationDialogTitle(subscription.name),
+        message: zulipLocalizations.unsubscribeConfirmationDialogMessageCanResubscribe,
+        actionButtonText: zulipLocalizations.unsubscribeConfirmationDialogConfirmButton);
+      if (await dialog.result != true) return;
+      if (!context.mounted) return;
     }
 
     try {
diff --git a/lib/widgets/all_channels.dart b/lib/widgets/all_channels.dart
@@ -139,7 +139,10 @@ class _SubscribeToggle extends StatelessWidget {
             subscriptions: [channel.name]);
         } else {
           await ZulipAction.unsubscribeFromChannel(context,
-            channelId: channel.streamId);
+            channelId: channel.streamId,
+            // Only show the confirmation dialog when you wouldn't be able to
+            // resubscribe.
+            alwaysAsk: false);
         }
       },
       // TODO(#741) interpret API errors for user
diff --git a/test/widgets/action_sheet_test.dart b/test/widgets/action_sheet_test.dart
@@ -573,9 +573,16 @@ void main() {
 
         connection.prepare(json: {});
         await tapButton(tester);
-        await tester.pump(Duration.zero);
+        await tester.pump();
 
-        checkNoDialog(tester);
+        final (unsubscribeButton, cancelButton) = checkSuggestedActionDialog(tester,
+          expectedTitle: 'Unsubscribe from ${channel.name}?',
+          expectedMessage: 'Are you sure you want to unsubscribe?',
+          expectDestructiveActionButton: false,
+          expectedActionButtonText: 'Unsubscribe');
+        await tester.tap(find.byWidget(unsubscribeButton));
+        await tester.pump();
+        await tester.pump(Duration.zero);
 
         check(connection.lastRequest).isA<http.Request>()
           ..method.equals('DELETE')
diff --git a/test/widgets/all_channels_test.dart b/test/widgets/all_channels_test.dart
@@ -241,6 +241,24 @@ void main() {
       });
   });
 
+  testWidgets('Toggle "off" to unsubscribe, public channel', (tester) async {
+    final channel = eg.stream(inviteOnly: false);
+    final subscription = eg.subscription(channel);
+
+    await setupAllChannelsPage(tester, channels: [subscription]);
+
+    connection.prepare(json: {});
+    await tester.tap(find.byType(Toggle));
+    await tester.pump(Duration.zero);
+    checkNoDialog(tester);
+    check(connection.lastRequest).isA<http.Request>()
+      ..method.equals('DELETE')
+      ..url.path.equals('/api/v1/users/me/subscriptions')
+      ..bodyFields.deepEquals({
+        'subscriptions': jsonEncode([channel.name]),
+      });
+  });
+
   testWidgets('Toggle "off" to unsubscribe, but without resubscribe permission', (tester) async {
     final channel = eg.stream(
       inviteOnly: true, canSubscribeGroup: eg.groupSetting(members: []));
