realm state: Store emailAddressVisibility

Author: daleshort

src/__tests__/lib/exampleData.js

@@ -21,7 +21,7 @@ import { randString, randInt } from '../../utils/misc';
 import { makeUserId } from '../../api/idTypes';
 import type { InitialData } from '../../api/apiTypes';
 import { EventTypes, type UpdateMessageEvent } from '../../api/eventTypes';
-import { CreateWebPublicStreamPolicy } from '../../api/permissionsTypes';
+import { CreateWebPublicStreamPolicy, EmailAddressVisibility } from '../../api/permissionsTypes';
 import type {
   AccountSwitchAction,
   LoginSuccessAction,
@@ -785,7 +785,7 @@ export const action = Object.freeze({
       realm_digest_weekday: 2,
       realm_disallow_disposable_email_addresses: true,
       realm_edit_topic_policy: 3,
-      realm_email_address_visibility: 3,
+      realm_email_address_visibility: EmailAddressVisibility.Admins,
       realm_email_auth_enabled: true,
       realm_email_changes_disabled: true,
       realm_emails_restricted_to_domains: false,

src/api/initialDataTypes.js

@@ -19,6 +19,7 @@ import type {
 import type {
   CreatePublicOrPrivateStreamPolicyT,
   CreateWebPublicStreamPolicy,
+  EmailAddressVisibility,
 } from './permissionsTypes';
 
 /*
@@ -207,7 +208,7 @@ export type InitialDataRealm = $ReadOnly<{|
   // TODO(server-5.0): Added in feat. 75, replacing realm_allow_community_topic_editing
   realm_edit_topic_policy?: number,
 
-  realm_email_address_visibility: number,
+  realm_email_address_visibility: EmailAddressVisibility,
   realm_email_auth_enabled: boolean,
   realm_email_changes_disabled: boolean,
   realm_emails_restricted_to_domains: boolean,

src/api/permissionsTypes.js

@@ -95,3 +95,14 @@ export enum CreateWebPublicStreamPolicy {
   Nobody = 6,
   OwnerOnly = 7,
 }
+
+/**
+ * The policy for who in the organization has access to users' actual email
+ */
+export enum EmailAddressVisibility {
+  Everyone = 1,
+  Members = 2,
+  Admins = 3,
+  Nobody = 4,
+  Moderators = 5,
+}

src/realm/__tests__/realmReducer-test.js

@@ -15,6 +15,7 @@ import type { RealmDataForUpdate } from '../../api/realmDataTypes';
 import {
   CreatePublicOrPrivateStreamPolicy,
   CreateWebPublicStreamPolicy,
+  EmailAddressVisibility,
 } from '../../api/permissionsTypes';
 import { CustomProfileFieldType } from '../../api/modelTypes';
 import { EventTypes } from '../../api/eventTypes';
@@ -68,6 +69,7 @@ describe('realmReducer', () => {
         waitingPeriodThreshold: action.data.realm_waiting_period_threshold,
         allowEditHistory: action.data.realm_allow_edit_history,
         enableReadReceipts: action.data.realm_enable_read_receipts,
+        emailAddressVisibility: action.data.realm_email_address_visibility,
 
         //
         // InitialDataRealmUser
@@ -500,6 +502,31 @@ describe('realmReducer', () => {
         check(false, true);
         check(false, false);
       });
+
+      describe('emailAddressVisibility / email_address_visibility', () => {
+        const { Everyone, Members, Admins, Nobody, Moderators } = EmailAddressVisibility;
+        const check = mkCheck('emailAddressVisibility', 'email_address_visibility');
+        check(Everyone, Members);
+        check(Everyone, Admins);
+        check(Everyone, Nobody);
+        check(Everyone, Moderators);
+        check(Members, Everyone);
+        check(Members, Admins);
+        check(Members, Nobody);
+        check(Members, Moderators);
+        check(Admins, Everyone);
+        check(Admins, Members);
+        check(Admins, Nobody);
+        check(Admins, Moderators);
+        check(Nobody, Everyone);
+        check(Nobody, Admins);
+        check(Nobody, Members);
+        check(Nobody, Moderators);
+        check(Moderators, Everyone);
+        check(Moderators, Admins);
+        check(Moderators, Members);
+        check(Moderators, Nobody);
+      });
     });
   });
 });

src/realm/realmReducer.js

@@ -8,6 +8,7 @@ import type {
 import {
   CreatePublicOrPrivateStreamPolicy,
   CreateWebPublicStreamPolicy,
+  EmailAddressVisibility,
 } from '../api/permissionsTypes';
 import { EventTypes } from '../api/eventTypes';
 import {
@@ -54,6 +55,7 @@ const initialState = {
   waitingPeriodThreshold: 90,
   allowEditHistory: false,
   enableReadReceipts: false,
+  emailAddressVisibility: EmailAddressVisibility.Admins,
 
   //
   // InitialDataRealmUser
@@ -162,6 +164,7 @@ export default (
         waitingPeriodThreshold: action.data.realm_waiting_period_threshold,
         allowEditHistory: action.data.realm_allow_edit_history,
         enableReadReceipts: action.data.realm_enable_read_receipts ?? false,
+        emailAddressVisibility: action.data.realm_email_address_visibility,
 
         //
         // InitialDataRealmUser
@@ -265,6 +268,9 @@ export default (
             if (data.enable_read_receipts !== undefined) {
               result.enableReadReceipts = data.enable_read_receipts;
             }
+            if (data.email_address_visibility !== undefined) {
+              result.emailAddressVisibility = data.email_address_visibility;
+            }
 
             return result;
           }

src/reduxTypes.js

@@ -38,6 +38,7 @@ import type { PmConversationsState } from './pm-conversations/pmConversationsMod
 import type { UnreadState } from './unread/unreadModelTypes';
 import type { UserStatusesState } from './user-statuses/userStatusesCore';
 import type { ServerEmojiData } from './api/modelTypes';
+import type { EmailAddressVisibility } from './api/permissionsTypes';
 
 export type { MuteState } from './mute/muteModelTypes';
 export type { UserStatusesState } from './user-statuses/userStatusesCore';
@@ -307,6 +308,7 @@ export type RealmState = {|
   +waitingPeriodThreshold: number,
   +allowEditHistory: boolean,
   +enableReadReceipts: boolean,
+  +emailAddressVisibility: EmailAddressVisibility,
 
   //
   // InitialDataRealmUser

src/storage/__tests__/migrations-test.js

@@ -104,7 +104,7 @@ describe('migrations', () => {
   // What `base` becomes after all migrations.
   const endBase = {
     ...base52,
-    migrations: { version: 53 },
+    migrations: { version: 54 },
   };
 
   for (const [desc, before, after] of [
@@ -127,8 +127,8 @@ describe('migrations', () => {
     // redundant with this one, because none of the migration steps notice
     // whether any properties outside `storeKeys` are present or not.
     [
-      'check dropCache at 53',
-      { ...endBase, migrations: { version: 52 }, mute: [], nonsense: [1, 2, 3] },
+      'check dropCache at 54',
+      { ...endBase, migrations: { version: 53 }, mute: [], nonsense: [1, 2, 3] },
       endBase,
     ],
 

src/storage/migrations.js

@@ -463,6 +463,9 @@ const migrationsInner: {| [string]: (LessPartialState) => LessPartialState |} =
   // Add enableReadReceipts to state.realm.
   '53': dropCache,
 
+  // Add emailAddressVisibility to state.realm
+  '54': dropCache,
+
   // TIP: When adding a migration, consider just using `dropCache`.
   //   (See its jsdoc for guidance on when that's the right answer.)
 };