EditStreamCard: Offer all four stream-privacy settings #5389

chrisbobbe · 2022-05-24T21:57:23Z

With the web-public option

omitted if the server hasn't opted into web-public streams
disabled if it's currently unset and the user doesn't have permission to set it

When disabled, it's unselectable; on trying to select it, it gives you an informative alert.

I'll mark this as a draft for now and aim to do a demo with Greg in the office today.

(edit: added Fixes: line)

Fixes: #5250

gnprice

Thanks @chrisbobbe! This code looks great; glad this is all getting close to complete. Small comments below.

gnprice · 2022-05-24T22:55:54Z

src/streams/EditStreamScreen.js

+      } catch (errorIllTyped) {
+        const error: mixed = errorIllTyped; // https://github.com/facebook/flow/issues/2470
+        if (error instanceof ApiError) {
+          showErrorAlert(
+            _('Cannot apply requested settings'),
+            // E.g., "Must be an organization or stream administrator", with
+            // code UNAUTHORIZED_PRINCIPAL, when trying to change an
+            // existing stream's privacy setting when unauthorized.
+
+            // TODO: File an issue for the server to be more specific. What
+            //   part(s) of the request didn't pass authorization:
+            //   stream-name change? privacy-setting change? Help the user
+            //   make a successful request if possible.
+            error.message,
+          );
+        }
+      }


When catching an error and it turns out not to be of a type we anticipated, rethrow the error (so that it's as if we hadn't caught it.) For example:

Suggested change

} catch (errorIllTyped) {

const error: mixed = errorIllTyped; // https://github.com/facebook/flow/issues/2470

if (error instanceof ApiError) {

showErrorAlert(

_('Cannot apply requested settings'),

// E.g., "Must be an organization or stream administrator", with

// code UNAUTHORIZED_PRINCIPAL, when trying to change an

// existing stream's privacy setting when unauthorized.

// TODO: File an issue for the server to be more specific. What

// part(s) of the request didn't pass authorization:

// stream-name change? privacy-setting change? Help the user

// make a successful request if possible.

error.message,

);

}

}

} catch (errorIllTyped) {

const error: mixed = errorIllTyped; // https://github.com/facebook/flow/issues/2470

if (error instanceof ApiError) {

showErrorAlert(

_('Cannot apply requested settings'),

// E.g., "Must be an organization or stream administrator", with

// code UNAUTHORIZED_PRINCIPAL, when trying to change an

// existing stream's privacy setting when unauthorized.

// TODO: File an issue for the server to be more specific. What

// part(s) of the request didn't pass authorization:

// stream-name change? privacy-setting change? Help the user

// make a successful request if possible.

error.message,

);

} else {

throw error;

}

}

Style guide entry here: https://github.com/zulip/zulip-mobile/blob/main/docs/style.md#catch-specific

In this context, I expect that just means the unhandled promise rejection will propagate up to a UI event callback; nothing will crash, but I believe we'll get a Sentry event, which is helpful if it happens.

gnprice · 2022-05-24T22:56:57Z

src/streams/EditStreamScreen.js

+            // TODO: File an issue for the server to be more specific. What
+            //   part(s) of the request didn't pass authorization:
+            //   stream-name change? privacy-setting change? Help the user
+            //   make a successful request if possible.


As discussed in the office: I agree this would be an improvement, but I think it's past the point of diminishing returns compared to other parts of the app we can be working on improving.

gnprice · 2022-05-24T23:04:08Z

src/streams/EditStreamCard.js

+  return useMemo(
+    () =>
+      [
+        webPublicStreamsEnabled && enableSpectatorAccess
+          ? {
+              key: 'web-public',
+              title: 'Web-public',


nit: Can make the contents here a couple of levels less deeply indented like so:

Suggested change

return useMemo(

() =>

[

webPublicStreamsEnabled && enableSpectatorAccess

? {

key: 'web-public',

title: 'Web-public',

const webPublicStreamsActuallyEnabled = webPublicStreamsEnabled && enableSpectatorAccess;

return useMemo(

() =>

[

webPublicStreamsActuallyEnabled && {

key: 'web-public',

title: 'Web-public',

Hmm, I guess this one runs into Flow trouble because the type on Array#filter(Boolean) isn't specific enough to say that it filters out false. From flowlib/core.js (gotten by jump-to-definition on the filter call):

filter(callbackfn: typeof Boolean): Array<$NonMaybeType<T>>;

I think I still like putting the one-line "nothing here" case first, though, akin to an early return. Like this:

Suggested change

return useMemo(

() =>

[

webPublicStreamsEnabled && enableSpectatorAccess

? {

key: 'web-public',

title: 'Web-public',

return useMemo(

() =>

[

!(webPublicStreamsEnabled && enableSpectatorAccess)

? undefined

: {

key: 'web-public',

title: 'Web-public',

Hmm, I guess this one runs into Flow trouble because the type on Array#filter(Boolean) isn't specific enough to say that it filters out false.

Oh, hmm, yeah.

gnprice · 2022-05-24T23:04:27Z

src/streams/EditStreamCard.js

+              disabledIfNotInitialValue: !canCreateWebPublicStreams
+                ? {
+                    title: 'Insufficient permission',


Similarly:

Suggested change

disabledIfNotInitialValue: !canCreateWebPublicStreams

? {

title: 'Insufficient permission',

disabledIfNotInitialValue: !canCreateWebPublicStreams && {

title: 'Insufficient permission',

gnprice · 2022-05-24T23:15:53Z

src/streams/EditStreamCard.js

+        .map(
+          (x: {|
+            key: Privacy,
+            title: LocalizableText,
+            subtitle?: LocalizableText,
+            disabledIfNotInitialValue?:
+              | {|
+                  +title: LocalizableText,
+                  +message?: LocalizableText,
+                  +learnMoreUrl?: URL,
+                |}
+              | false,
+          |}) => {
+            const { disabledIfNotInitialValue, ...rest } = x; // eslint-disable-line no-unused-vars


Simpler version:

Suggested change

.map(

(x: {|

key: Privacy,

title: LocalizableText,

subtitle?: LocalizableText,

disabledIfNotInitialValue?:

| {|

+title: LocalizableText,

+message?: LocalizableText,

+learnMoreUrl?: URL,

|}

| false,

|}) => {

const { disabledIfNotInitialValue, ...rest } = x; // eslint-disable-line no-unused-vars

.map(x => {

const { disabledIfNotInitialValue = false, ...rest } = x;

gnprice · 2022-05-24T23:18:01Z

src/streams/EditStreamCard.js

+          title: 'Private, shared history',
+          subtitle:
+            'Must be invited by a subscriber; new subscribers can view complete message history; hidden from non-administrator users',


These strings are meant to match what's on web, right? Probably a comment somewhere here briefly pointing at the corresponding web code for comparison would be helpful.

…ribers

This is NFC, because we'd return false when role is undefined anyway. But this makes that easier to verify, and also gives a reason why it's the correct behavior.

… API And move the Privacy type definition here. The translation is about to get much more complicated: `Privacy` will have four branches, corresponding to the four stream-access policy settings: - web-public - public - private, shared history - private, protected history , and those will be communicated to the server with up to three properties: - is_private (same meaning as Stream.invite_only) - is_web_public - history_public_to_subscribers .

chrisbobbe · 2022-05-25T02:19:43Z

Thanks for the review! Revision pushed, with an additional feature, as discussed in the office: catching you before you leave the form without submitting changes, in case you meant to submit but forgot.

gnprice

Thanks for the revision! Comments below.

gnprice · 2022-05-25T03:37:30Z

src/streams/EditStreamCard.js

+        result = await props.onComplete({
+          name: initialValues.name !== name ? name : undefined,
+          description: initialValues.description !== description ? description : undefined,
+          privacy: initialValues.privacy !== privacy ? privacy : undefined,


stream settings: Improve how we decide if the user has changed a value Compare against the initial values from when the form was initialized, rather than against the current, live-updated stream, as we were doing before.

Does this logic actually work as stated? This initialValues comes from a prop, and on EditStreamScreen the prop comes from the stream's data in Redux. So it looks like this should also end up comparing to the current values in Redux, not the values the component started with.

I think something like this should do it (untested):

export default function EditStreamCard(props: Props): Node { - const { navigation, initialValues, isNewStream } = props; + const { navigation, isNewStream } = props; + const initialValues = React.useRef(props.initialValues).current;

Oh goodness, yeah, thanks for catching this. initialValues doesn't have the right name for what we're passing for it, I think: it shouldn't have that name if its contents can change to be different from the initial values.

How about using a ref in EditStreamScreen and keeping the initialValues name?

initialValues doesn't have the right name for what we're passing for it, I think: it shouldn't have that name if its contents can change to be different from the initial values.

Yeah, I agree.

How about using a ref in EditStreamScreen and keeping the initialValues name?

Sure, that'd work.

gnprice · 2022-05-25T03:40:08Z

src/streams/EditStreamScreen.js

-          privacy: stream.invite_only ? 'private' : 'public',
+          privacy: streamPropsToPrivacy(stream),


EditStreamScreen [nfc]: Use streamPropsToPrivacy to convert initial value This will save quite a bit of duplication; see previous commit.

I don't understand the last reference. The previous commit is:
181bf22 EditStreamCard [nfc]: Use params object for PropsCreateStream, too

Ah, maybe you meant to refer to this one?
d2d63b5 streamsActions: Have updateExistingStream translate Privacy value for API

The translation is about to get much more complicated: `Privacy` will have four branches, corresponding to the four stream-access policy settings:

(The actual change seems good, though.)

Yep! Thanks for catching this.

gnprice · 2022-05-25T03:48:30Z

src/streams/streamsActions.js

+    // Only send is_web_public if the server will recognize it.
+    // TODO(server-5.0): Remove conditional.
+    if (getZulipFeatureLevel(state) >= 98) {
+      updates.is_web_public = streamProps.is_web_public;
+    }


Hmm, I think I liked the previous revision's version of this better:

-+ // Only send is_web_public if the server will recognize it. Will it? It -+ // should, if we've let the user switch a stream from web-public to not -+ // or vice versa. -+ // TODO(server-2.1): Remove conditional. -+ if (initialPrivacy === 'web-public' || newData.privacy === 'web-public') { + updates.is_web_public = streamProps.is_web_public; + }

IIUC, the case where the behavior would differ is where we think the server isn't new enough to recognize the option, but nevertheless for some reason we've allowed the user to say they want to change it. In that case it seems like it's better to go ahead and make the request, and let the server return an error that we'll show the user, rather than silently drop that part of the user's request.

(That and also the converse case: where the server is new enough but the user didn't change to or from web-public, the old logic would leave this property out and the new will include it. That case seems fine either way.)

Hmm, I think I liked the previous revision's version of this better

Ah, I thought you might. 😅

With this function no longer receiving an "initial" privacy value—

streamsActions [nfc]: Have updateExistingStream only take changed values

—it can no longer identify when the privacy is being switched away from web-public. (It can still tell if it's being switched to web-public, though.) To cover the away-from-web-public case without upsetting old servers, it might be enough to just omit is_web_public when switching to any of the three other options? We would still be passing is_private for those three options, which should satisfy the requirement I observed that you have to pass at least one of is_private, is_web_public. I'd want to test manually that things still work. What do you think?

streamsActions [nfc]: Have updateExistingStream only take changed values

This commit helps focus updateExistingStream on translating a caller's requested updates for the API, rather than doing that and also helping the caller figure out what those requested updates are.

With this function no longer receiving an "initial" privacy value—

streamsActions [nfc]: Have updateExistingStream only take changed values

—it can no longer identify when the privacy is being switched away from web-public. (It can still tell if it's being switched to web-public, though.)

Hmm, I see.

To cover the away-from-web-public case without upsetting old servers, it might be enough to just omit is_web_public when switching to any of the three other options?

That doesn't work if you're switching from web-public to simply public, though, right?

OK, given that, this logic is fine.

Basically the concern above means that there's a possible error case we won't catch, and where things silently won't work. But that case only arises if something's already gone wrong that was outside our control: you're on a server that half-supports web-public streams, and I think in fact a server admin has to have gone and manually set a stream web-public in the database (because before this feature-level threshold, there is no way for a client to set it.) Outside our control, and also unlikely -- it's probable that there don't exist any Zulip servers where that situation exists at all.

It's good to catch even situations like that, when we can do so while writing the code in a natural way. But it's OK if we don't always catch them, and it isn't worth contorting the code to handle them.

…mCard This is NFC because EditStreamCard has already been using a snapshot of initialValues that it makes on its first render. But since the prop is named `initialValues`, we shouldn't be passing something that changes to be different from the initial values. This will help with an upcoming change; see Greg's comment at zulip#5389 (comment)

Compare against the initial values from when the form was initialized, rather than against the current, live-updated stream, as we were doing before.

…alue This will save quite a bit of duplication; see the recent commit where we defined this function.

And bring it up through SelectableOptionsScreen and InputRowRadioButtons.

This removes the last instance of "Update" as a user-facing message, so we remove that from messages_en.json. "Save" is already there, so no need to add it.

…ervice

chrisbobbe · 2022-05-25T20:47:17Z

Thanks for the review! Revision pushed.

gnprice · 2022-05-25T21:42:57Z

Thanks! Looks good -- merging.

chrisbobbe · 2022-05-25T22:09:54Z

Thanks!

chrisbobbe added P1 high-priority server release goal Things we should try to coordinate with a major Zulip Server release. labels May 24, 2022

chrisbobbe requested a review from gnprice May 24, 2022 21:57

chrisbobbe force-pushed the pr-web-public-streams branch from 7fe7d78 to d480523 Compare May 24, 2022 22:09

gnprice reviewed May 24, 2022

View reviewed changes

chrisbobbe added 6 commits May 24, 2022 16:57

api types [nfc]: Note quirk in updateStream's history_public_to_subsc…

edea2ef

…ribers

permissionSelectors [nfc]: Make role-void check explicit

b50bcbf

This is NFC, because we'd return false when role is undefined anyway. But this makes that easier to verify, and also gives a reason why it's the correct behavior.

info [nfc]: s/learnMoreURL/learnMoreUrl/

d1296f7

streamsActions [nfc]: Use early-return style for bail-if-no-change

59cf27c

streamsActions [nfc]: Have updateExistingStream only take changed values

8f707fb

chrisbobbe force-pushed the pr-web-public-streams branch from d480523 to dc57b1b Compare May 25, 2022 02:18

gnprice reviewed May 25, 2022

View reviewed changes

chrisbobbe added 12 commits May 25, 2022 12:51

stream settings: Improve how we decide if the user has changed a value

36eb2cb

Compare against the initial values from when the form was initialized, rather than against the current, live-updated stream, as we were doing before.

EditStreamCard [nfc]: Use params object for PropsCreateStream, too

a23bdae

EditStreamScreen [nfc]: Use streamPropsToPrivacy to convert initial v…

e3cdcbf

…alue This will save quite a bit of duplication; see the recent commit where we defined this function.

SelectableOptionRow: Add disabled prop and functionality

a65e08b

And bring it up through SelectableOptionsScreen and InputRowRadioButtons.

EditStreamScreen: Handle error from updateExistingStream

e24b891

EditStreamCard: Use "Save" instead of "Update" for button text

7aac57f

This removes the last instance of "Update" as a user-facing message, so we remove that from messages_en.json. "Save" is already there, so no need to add it.

EditStreamCard: Offer all four stream-privacy settings

62dfc08

CreateStreamScreen: Rethrow unknown error in handleComplete

286712d

stream settings: Remind user if they have unsubmitted changes

402c026

EditStreamCard [nfc]: Move navigate-back dispatch here

50411dd

EditStreamCard: Use simple navigation.goBack() instead of NavigationS…

bc6d9e6

…ervice

chrisbobbe force-pushed the pr-web-public-streams branch from dc57b1b to bc6d9e6 Compare May 25, 2022 20:47

chrisbobbe marked this pull request as ready for review May 25, 2022 20:47

gnprice merged commit bc6d9e6 into zulip:main May 25, 2022

chrisbobbe deleted the pr-web-public-streams branch May 25, 2022 22:09

This was referenced May 25, 2022

Set a stream web-public, in stream settings #5250

Closed

Edit stream access policy settings. #5304

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EditStreamCard: Offer all four stream-privacy settings #5389

EditStreamCard: Offer all four stream-privacy settings #5389

chrisbobbe commented May 24, 2022 •

edited

Loading

gnprice left a comment

gnprice May 24, 2022

gnprice May 24, 2022

gnprice May 24, 2022

gnprice May 24, 2022

chrisbobbe May 25, 2022

gnprice May 24, 2022

gnprice May 24, 2022

gnprice May 24, 2022

chrisbobbe commented May 25, 2022 •

edited

Loading

gnprice left a comment

gnprice May 25, 2022

chrisbobbe May 25, 2022 •

edited

Loading

chrisbobbe May 25, 2022

gnprice May 25, 2022

gnprice May 25, 2022

gnprice May 25, 2022

chrisbobbe May 25, 2022

gnprice May 25, 2022

chrisbobbe May 25, 2022 •

edited

Loading

chrisbobbe May 25, 2022

gnprice May 25, 2022

gnprice May 25, 2022

chrisbobbe commented May 25, 2022

gnprice commented May 25, 2022

chrisbobbe commented May 25, 2022

		privacy: stream.invite_only ? 'private' : 'public',
		privacy: streamPropsToPrivacy(stream),

EditStreamCard: Offer all four stream-privacy settings #5389

EditStreamCard: Offer all four stream-privacy settings #5389

Conversation

chrisbobbe commented May 24, 2022 • edited Loading

gnprice left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisbobbe commented May 25, 2022 • edited Loading

gnprice left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisbobbe May 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisbobbe May 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisbobbe commented May 25, 2022

gnprice commented May 25, 2022

chrisbobbe commented May 25, 2022

chrisbobbe commented May 24, 2022 •

edited

Loading

chrisbobbe commented May 25, 2022 •

edited

Loading

chrisbobbe May 25, 2022 •

edited

Loading

chrisbobbe May 25, 2022 •

edited

Loading