Create "support" stream type with topic-specific permissions #19434

analytics/management/commands/populate_analytics_db.py

@@ -117,11 +117,15 @@ def handle(self, *args: Any, **options: Any) -> None:
         administrators_user_group = NamedUserGroup.objects.get(
             name=SystemGroups.ADMINISTRATORS, realm=realm, is_system_group=True
         )
+        everyone_user_group = NamedUserGroup.objects.get(
+            name=SystemGroups.EVERYONE, realm=realm, is_system_group=True
+        )
         stream = Stream.objects.create(
             name="all",
             realm=realm,
             date_created=installation_time,
             can_remove_subscribers_group=administrators_user_group,
+            stream_topic_access_group=everyone_user_group,
         )
         recipient = Recipient.objects.create(type_id=stream.id, type=Recipient.STREAM)
         stream.recipient = recipient

analytics/tests/test_counts.py

@@ -107,6 +107,11 @@ def setUp(self) -> None:
             realm=self.default_realm,
             is_system_group=True,
         )
+        self.everyone_user_group = NamedUserGroup.objects.get(
+            name=SystemGroups.EVERYONE,
+            realm=self.default_realm,
+            is_system_group=True,
+        )
 
         # used to generate unique names in self.create_*
         self.name_counter = 100
@@ -153,6 +158,7 @@ def create_stream_with_recipient(self, **kwargs: Any) -> Tuple[Stream, Recipient
             "realm": self.default_realm,
             "date_created": self.TIME_LAST_HOUR,
             "can_remove_subscribers_group": self.administrators_user_group,
+            "stream_topic_access_group": self.everyone_user_group,
         }
         for key, value in defaults.items():
             kwargs[key] = kwargs.get(key, value)

api_docs/changelog.md

@@ -20,6 +20,16 @@ format used by the Zulip server that they are interacting with.
 
 ## Changes in Zulip 9.0
 
+**Feature level 263**
+
+* [`GET /streams`](/api/get-streams),
+  [`POST /users/me/subscriptions`](/api/subscribe),
+  [`PATCH /streams/{stream_id}`](/api/update-stream),
+  [`GET /events`](/api/get-events): Stream objects now
+  include the `stream_topic_access_group` integer,
+  which specifies the ID of the user group that has
+  access to all the topics in a stream.
+
 **Feature level 262**:
 
 * [`GET /users/{user_id}/status`](/api/get-user-status): Added a new

web/src/echo.js

@@ -232,6 +232,17 @@ export function try_deliver_locally(message_request, insert_new_messages) {
         return undefined;
     }
 
+    if (message_request.type === "stream") {
+        const stream = stream_data.get_sub_by_id(message_request.stream_id);
+        if (
+            stream &&
+            stream_data.is_support_stream(stream) &&
+            !stream_data.can_access_topics_in_stream(stream)
+        ) {
+            return undefined;
+        }
+    }
+
     const local_id_float = local_message.get_next_id_float();
 
     if (!local_id_float) {

web/src/settings_components.ts

@@ -493,6 +493,7 @@ export let can_remove_subscribers_group_widget: DropdownWidget | null = null;
 export let can_access_all_users_group_widget: DropdownWidget | null = null;
 export let can_mention_group_widget: DropdownWidget | null = null;
 export let new_group_can_mention_group_widget: DropdownWidget | null = null;
+export let stream_topic_access_group_widget: DropdownWidget | null = null;
 
 export function get_widget_for_dropdown_list_settings(
     property_name: string,
@@ -514,6 +515,8 @@ export function get_widget_for_dropdown_list_settings(
             return can_access_all_users_group_widget;
         case "can_mention_group":
             return can_mention_group_widget;
+        case "stream_topic_access_group":
+            return stream_topic_access_group_widget;
         default:
             blueslip.error("No dropdown list widget for property", {property_name});
             return null;
@@ -556,6 +559,10 @@ export function set_new_group_can_mention_group_widget(widget: DropdownWidget):
     new_group_can_mention_group_widget = widget;
 }
 
+export function set_stream_topic_access_group_widget(widget: DropdownWidget): void {
+    stream_topic_access_group_widget = widget;
+}
+
 export function set_dropdown_list_widget_setting_value(
     property_name: string,
     value: number | string,
@@ -858,6 +865,7 @@ export function check_property_changed(
         case "realm_create_multiuse_invite_group":
         case "can_mention_group":
         case "realm_can_access_all_users_group":
+        case "stream_topic_access_group":
             proposed_val = get_dropdown_list_widget_setting_value($elem);
             break;
         case "email_notifications_batching_period_seconds":

web/src/settings_org.js

@@ -501,6 +501,7 @@ export function discard_property_element_changes(elem, for_realm_default_setting
         case "realm_create_multiuse_invite_group":
         case "realm_can_access_all_users_group":
         case "can_mention_group":
+        case "stream_topic_access_group":
             settings_components.set_dropdown_list_widget_setting_value(
                 property_name,
                 property_value,

web/src/stream_create.js

@@ -268,6 +268,13 @@ function create_stream() {
     );
     data.can_remove_subscribers_group = can_remove_subscribers_group_id;
 
+    const stream_topic_access_group_id = Number.parseInt(
+        stream_settings_components.new_stream_stream_topic_access_group_widget.value(),
+        10,
+    );
+
+    data.stream_topic_access_group = stream_topic_access_group_id;
+
     loading.make_indicator($("#stream_creating_indicator"), {
         text: $t({defaultMessage: "Creating channel..."}),
     });
@@ -460,4 +467,5 @@ export function set_up_handlers() {
     });
 
     stream_settings_components.new_stream_can_remove_subscribers_group_widget.setup();
+    stream_settings_components.new_stream_stream_topic_access_group_widget.setup();
 }

web/src/stream_data.ts

@@ -436,6 +436,13 @@ export function update_can_remove_subscribers_group_id(
     sub.can_remove_subscribers_group = can_remove_subscribers_group_id;
 }
 
+export function update_stream_topic_access_group_id(
+    sub: StreamSubscription,
+    stream_topic_access_group_id: number,
+): void {
+    sub.stream_topic_access_group = stream_topic_access_group_id;
+}
+
 export function receives_notifications(
     stream_id: number,
     notification_name: keyof StreamSpecificNotificationSettings,
@@ -513,6 +520,15 @@ export function can_toggle_subscription(sub: StreamSubscription): boolean {
     );
 }
 
+export function is_support_stream(sub: StreamSubscription): boolean {
+    const stream_topic_access_group_id = sub.stream_topic_access_group;
+    const stream_topic_access_group = user_groups.get_user_group_from_id(
+        stream_topic_access_group_id,
+    );
+
+    return stream_topic_access_group.name !== "role:everyone";
+}
+
 export function can_access_stream_email(sub: StreamSubscription): boolean {
     return (
         (sub.subscribed || sub.is_web_public || (!current_user.is_guest && !sub.invite_only)) &&
@@ -630,6 +646,18 @@ export function can_post_messages_in_stream(stream: StreamSubscription): boolean
     return true;
 }
 
+export function can_access_topics_in_stream(stream: StreamSubscription): boolean {
+    if (current_user.is_admin) {
+        return true;
+    }
+
+    const group_allowed_to_access_topics = stream.stream_topic_access_group;
+    return user_groups.is_user_in_group(
+        group_allowed_to_access_topics,
+        people.my_current_user_id(),
+    );
+}
+
 export function is_subscribed_by_name(stream_name: string): boolean {
     const sub = get_sub(stream_name);
     return sub ? sub.subscribed : false;

web/src/stream_edit.js

@@ -231,6 +231,37 @@ function setup_dropdown(sub, slim_sub) {
         can_remove_subscribers_group_widget,
     );
     can_remove_subscribers_group_widget.setup();
+
+    const stream_topic_access_group_widget = new dropdown_widget.DropdownWidget({
+        widget_name: "stream_topic_access_group",
+        get_options: () =>
+            user_groups.get_realm_user_groups_for_dropdown_list_widget(
+                "stream_topic_access_group",
+                "stream",
+            ),
+        item_click_callback(event, dropdown) {
+            dropdown.hide();
+            event.preventDefault();
+            event.stopPropagation();
+            stream_topic_access_group_widget.render();
+            settings_components.save_discard_widget_status_handler(
+                $("#stream_permission_settings"),
+                false,
+                slim_sub,
+            );
+        },
+        $events_container: $("#subscription_overlay .subscription_settings"),
+        tippy_props: {
+            placement: "bottom-start",
+        },
+        default_id: sub.stream_topic_access_group,
+        unique_id_type: dropdown_widget.DataTypes.NUMBER,
+        on_mount_callback(dropdown) {
+            $(dropdown.popper).css("min-width", "300px");
+        },
+    });
+    settings_components.set_stream_topic_access_group_widget(stream_topic_access_group_widget);
+    stream_topic_access_group_widget.setup();
 }
 
 export function show_settings_for(node) {

web/src/stream_events.js

@@ -84,6 +84,9 @@ export function update_property(stream_id, property, value, other_values) {
             update_stream_setting(sub, value, property);
             stream_list.refresh_pinned_or_unpinned_stream(sub);
             break;
+        case "stream_topic_access_group":
+            stream_settings_ui.update_stream_topic_access_group_id(sub, value);
+            break;
         case "invite_only":
             stream_settings_ui.update_stream_privacy(sub, {
                 invite_only: value,

web/src/stream_settings_components.js

@@ -64,6 +64,7 @@ export function get_active_data() {
 }
 
 export let new_stream_can_remove_subscribers_group_widget = null;
+export let new_stream_stream_topic_access_group_widget = null;
 
 export function dropdown_setup() {
     new_stream_can_remove_subscribers_group_widget = new dropdown_widget.DropdownWidget({
@@ -90,6 +91,31 @@ export function dropdown_setup() {
         default_id: user_groups.get_user_group_from_name("role:administrators").id,
         unique_id_type: dropdown_widget.DataTypes.NUMBER,
     });
+
+    new_stream_stream_topic_access_group_widget = new dropdown_widget.DropdownWidget({
+        widget_name: "new_stream_stream_topic_access_group",
+        get_options: () =>
+            user_groups.get_realm_user_groups_for_dropdown_list_widget(
+                "stream_topic_access_group",
+                "stream",
+            ),
+        item_click_callback(event, dropdown) {
+            dropdown.hide();
+            event.preventDefault();
+            event.stopPropagation();
+            new_stream_stream_topic_access_group_widget.render();
+        },
+        $events_container: $("#subscription_overlay"),
+        tippy_props: {
+            placement: "bottom-start",
+        },
+        on_mount_callback(dropdown) {
+            $(dropdown.popper).css("min-width", "300px");
+        },
+        default_text: $t({defaultMessage: "No user groups"}),
+        default_id: user_groups.get_user_group_from_name("role:everyone").id,
+        unique_id_type: dropdown_widget.DataTypes.NUMBER,
+    });
 }
 
 /* For the given stream_row, remove the tick and replace by a spinner. */

web/src/stream_settings_ui.js

@@ -185,6 +185,12 @@ export function update_can_remove_subscribers_group_id(sub, new_value) {
     stream_edit_subscribers.rerender_subscribers_list(sub);
 }
 
+export function update_stream_topic_access_group_id(sub, new_value) {
+    stream_data.update_stream_topic_access_group_id(sub, new_value);
+    stream_ui_updates.update_setting_element(sub, "stream_topic_access_group");
+    stream_edit_subscribers.rerender_subscribers_list(sub);
+}
+
 export function update_is_default_stream() {
     const active_stream_id = stream_settings_components.get_active_data().id;
     if (active_stream_id) {

web/src/sub_store.ts

@@ -25,6 +25,7 @@ export type Stream = {
     stream_id: number;
     stream_post_policy: StreamPostPolicy;
     can_remove_subscribers_group: number;
+    stream_topic_access_group: number;
 };
 
 export type StreamSpecificNotificationSettings = {

web/templates/stream_settings/stream_creation_form.hbs

@@ -32,7 +32,8 @@
                         {{> stream_types
                           stream_post_policy=stream_post_policy_values.everyone.code
                           is_stream_edit=false
-                          can_remove_subscribers_setting_widget_name="new_stream_can_remove_subscribers_group" }}
+                          can_remove_subscribers_setting_widget_name="new_stream_can_remove_subscribers_group"
+                          stream_topic_access_setting_widget_name="new_stream_stream_topic_access_group" }}
                     </div>
                 </section>
                 <section class="block">

web/templates/stream_settings/stream_settings.hbs

@@ -72,7 +72,8 @@
                   is_business_type_org=../is_business_type_org
                   org_level_message_retention_setting=../org_level_message_retention_setting
                   is_stream_edit=true
-                  can_remove_subscribers_setting_widget_name="can_remove_subscribers_group" }}
+                  can_remove_subscribers_setting_widget_name="can_remove_subscribers_group"
+                  stream_topic_access_setting_widget_name="stream_topic_access_group" }}
             </div>
             {{/with}}
             <div class="stream_details_box">

web/templates/stream_settings/stream_types.hbs

@@ -44,6 +44,11 @@
   label=(t 'Who can unsubscribe others from this channel?')
   value_type="number"}}
 
+{{> ../dropdown_widget_with_label
+  widget_name=stream_topic_access_setting_widget_name
+  label=(t 'Who can see all the topics?')
+  value_type="number"}}
+
 {{#if (or is_owner is_stream_edit)}}
 <div>
     <div class="input-group inline-block message-retention-setting-group time-limit-setting">

web/tests/lib/events.js

@@ -54,6 +54,7 @@ exports.test_streams = {
         message_retention_days: null,
         stream_post_policy: 1,
         can_remove_subscribers_group: 2,
+        stream_topic_access_group: 14,
     },
     test: {
         name: "test",
@@ -70,6 +71,7 @@ exports.test_streams = {
         message_retention_days: null,
         stream_post_policy: 1,
         can_remove_subscribers_group: 2,
+        stream_topic_access_group: 14,
     },
 };