feat(email-settings): add caption detail for email notif setting

linked-dependencies/matrix-react-sdk/src/components/views/settings/Notifications.tsx

@@ -697,6 +697,19 @@ export default class Notifications extends React.PureComponent<IProps, IState> {
                     key={e.address}
                     value={!!this.state.pushers?.some((p) => p.kind === "email" && p.pushkey === e.address)}
                     label={_t("settings|notifications|enable_email_notifications", { email: e.address })}
+                    /** :TCHAP: email-notification-setting-caption*/
+                    caption={_t(
+                        "settings|notifications|enable_notifications_email_detail",
+                        {},
+                        {
+                            a: (sub) => (
+                                <AccessibleButton kind="link_inline" onClick={() => {window.open("https://aide.tchap.beta.gouv.fr/fr/article/notification-par-email-draft-6k7k89/","_blank")}}>
+                                    {sub}
+                                </AccessibleButton>
+                            ),
+                        }
+                    )}
+                    /** end :TCHAP: email-notification-setting-caption */ 
                     onChange={this.onEmailNotificationsChanged.bind(this, e.address)}
                     disabled={this.state.phase === Phase.Persisting}
                 />

modules/tchap-translations/tchap_translations.json

@@ -749,5 +749,9 @@
     "onboarding|download_app": {
         "en": "Download mobile app",
         "fr": "Télécharger l'application mobile"
+    },
+    "settings|notifications|enable_notifications_email_detail": {
+        "en": "Receive an e-mail if at least one message is unread during 72h. <a> Learn more </a>",
+        "fr": "Recevez un e-mail si au moins un message reste non lu pendant 72h. <a>En savoir plus</a>"
     }
 }

patches/subtree-modifications.json

@@ -5,5 +5,11 @@
             "src/hooks/useUserOnboardingContext.ts",
             "src/hooks/useUserOnboardingTasks.ts"
         ]
+    },
+    "email-notification-setting-caption": {
+        "issue": "https://github.com/tchapgouv/tchap-web-v4/issues/988",
+        "files": [
+            "src/components/views/settings/Notifications.tsx"
+        ]
     }
 }

test/unit-tests/tchap/components/views/settings/Notifications-test.tsx

@@ -0,0 +1,252 @@
+import React from "react";
+import {
+    ConditionKind,
+    IPushRules,
+    IThreepid,
+    LOCAL_NOTIFICATION_SETTINGS_PREFIX,
+    MatrixEvent,
+    PushRuleActionName,
+    ThreepidMedium,
+    TweakName,
+} from "matrix-js-sdk/src/matrix";
+import { fireEvent, render, screen } from "@testing-library/react";
+
+import Notifications from "~matrix-react-sdk/src/components/views/settings/Notifications";
+import {
+    clearAllModals,
+    getMockClientWithEventEmitter,
+    mockClientMethodsUser,
+} from "~matrix-react-sdk/test/test-utils";
+import SdkConfig from "~matrix-react-sdk/src/SdkConfig";
+import { MatrixClientPeg } from "~matrix-react-sdk/src/MatrixClientPeg";
+
+// don't pollute test output with error logs from mock rejections
+jest.mock("matrix-js-sdk/src/logger");
+
+// Avoid indirectly importing any eagerly created stores that would require extra setup
+// jest.mock("~matrix-react-sdk/src/Notifier");
+
+const flushPromises = async () => await new Promise((resolve) => window.setTimeout(resolve));
+
+const pushRules: IPushRules = {
+    global: {
+        underride: [
+            {
+                conditions: [{ kind: ConditionKind.EventMatch, key: "type", pattern: "m.call.invite" }],
+                actions: [
+                    PushRuleActionName.Notify,
+                    { set_tweak: TweakName.Sound, value: "ring" },
+                    { set_tweak: TweakName.Highlight, value: false },
+                ],
+                rule_id: ".m.rule.call",
+                default: true,
+                enabled: true,
+            },
+            {
+                conditions: [
+                    { kind: ConditionKind.EventMatch, key: "type", pattern: "im.vector.modular.widgets" },
+                    { kind: ConditionKind.EventMatch, key: "content.type", pattern: "jitsi" },
+                    { kind: ConditionKind.EventMatch, key: "state_key", pattern: "*" },
+                ],
+                actions: [PushRuleActionName.Notify, { set_tweak: TweakName.Highlight, value: false }],
+                rule_id: ".im.vector.jitsi",
+                default: true,
+                enabled: true,
+            },
+        ],
+        sender: [],
+        room: [
+            {
+                actions: [PushRuleActionName.DontNotify],
+                rule_id: "!zJPyWqpMorfCcWObge:matrix.org",
+                default: false,
+                enabled: true,
+            },
+        ],
+        content: [
+            {
+                actions: [
+                    PushRuleActionName.Notify,
+                    { set_tweak: TweakName.Sound, value: "default" },
+                    { set_tweak: TweakName.Highlight },
+                ],
+                pattern: "kadev1",
+                rule_id: ".m.rule.contains_user_name",
+                default: true,
+                enabled: true,
+            },
+        ],
+        override: [
+            {
+                conditions: [],
+                actions: [PushRuleActionName.DontNotify],
+                rule_id: ".m.rule.master",
+                default: true,
+                enabled: false,
+            },
+            {
+                conditions: [{ kind: ConditionKind.EventMatch, key: "content.msgtype", pattern: "m.notice" }],
+                actions: [PushRuleActionName.DontNotify],
+                rule_id: ".m.rule.suppress_notices",
+                default: true,
+                enabled: true,
+            },
+            {
+                conditions: [
+                    { kind: ConditionKind.EventMatch, key: "type", pattern: "m.room.member" },
+                    { kind: ConditionKind.EventMatch, key: "content.membership", pattern: "invite" },
+                    { kind: ConditionKind.EventMatch, key: "state_key", pattern: "@kadev1:matrix.org" },
+                ],
+                actions: [
+                    PushRuleActionName.Notify,
+                    { set_tweak: TweakName.Sound, value: "default" },
+                    { set_tweak: TweakName.Highlight, value: false },
+                ],
+                rule_id: ".m.rule.invite_for_me",
+                default: true,
+                enabled: true,
+            },
+            {
+                conditions: [{ kind: ConditionKind.EventMatch, key: "type", pattern: "m.room.member" }],
+                actions: [PushRuleActionName.DontNotify],
+                rule_id: ".m.rule.member_event",
+                default: true,
+                enabled: true,
+            },
+            {
+                conditions: [{ kind: "contains_display_name" }],
+                actions: [
+                    PushRuleActionName.Notify,
+                    { set_tweak: TweakName.Sound, value: "default" },
+                    { set_tweak: TweakName.Highlight },
+                ],
+                rule_id: ".m.rule.contains_display_name",
+                default: true,
+                enabled: true,
+            },
+            {
+                conditions: [
+                    { kind: ConditionKind.EventMatch, key: "content.body", pattern: "@room" },
+                    { kind: "sender_notification_permission", key: "room" },
+                ],
+                actions: [PushRuleActionName.Notify, { set_tweak: TweakName.Highlight, value: true }],
+                rule_id: ".m.rule.roomnotif",
+                default: true,
+                enabled: true,
+            },
+            {
+                conditions: [
+                    { kind: ConditionKind.EventMatch, key: "type", pattern: "m.room.tombstone" },
+                    { kind: ConditionKind.EventMatch, key: "state_key", pattern: "" },
+                ],
+                actions: [PushRuleActionName.Notify, { set_tweak: TweakName.Highlight, value: true }],
+                rule_id: ".m.rule.tombstone",
+                default: true,
+                enabled: true,
+            },
+            {
+                conditions: [{ kind: ConditionKind.EventMatch, key: "type", pattern: "m.reaction" }],
+                actions: [PushRuleActionName.DontNotify],
+                rule_id: ".m.rule.reaction",
+                default: true,
+                enabled: true,
+            },
+        ],
+    },
+    device: {},
+} as IPushRules;
+
+describe("<Notifications />", () => {
+    const featureName: string = "feature_email_notification";
+    const homeserverName: string = "my.home.server";
+
+    const getComponent = () => render(<Notifications />);
+
+    // get component, wait for async data and force a render
+    const getComponentAndWait = async () => {
+        const component = getComponent();
+        await flushPromises();
+        return component;
+    };
+
+    // Mock client with notification settings
+    const mockClient = getMockClientWithEventEmitter({
+        ...mockClientMethodsUser(),
+        getPushRules: jest.fn(),
+        getPushers: jest.fn(),
+        getThreePids: jest.fn(),
+        setPusher: jest.fn(),
+        removePusher: jest.fn(),
+        setPushRuleEnabled: jest.fn(),
+        setPushRuleActions: jest.fn(),
+        getRooms: jest.fn().mockReturnValue([]),
+        getAccountData: jest.fn().mockImplementation((eventType) => {
+            if (eventType.startsWith(LOCAL_NOTIFICATION_SETTINGS_PREFIX.name)) {
+                return new MatrixEvent({
+                    type: eventType,
+                    content: {
+                        is_silenced: false,
+                    },
+                });
+            }
+        }),
+        setAccountData: jest.fn(),
+        sendReadReceipt: jest.fn(),
+        supportsThreads: jest.fn().mockReturnValue(true),
+        isInitialSyncComplete: jest.fn().mockReturnValue(false),
+        addPushRule: jest.fn().mockResolvedValue({}),
+        deletePushRule: jest.fn().mockResolvedValue({}),
+    });
+
+    // Set the home servername used later to match with the config
+    jest.spyOn(MatrixClientPeg, "getHomeserverName").mockReturnValue(homeserverName);
+
+    const testEmail = "[email protected]";
+
+    beforeEach(async () => {
+        // activate email notification in the config, otherwise the section won't appear
+        const config: ConfigOptions = {
+            tchap_features: {
+                [featureName]: [homeserverName],
+            },
+        };
+        SdkConfig.put(config);
+
+        // Mock the email so that the section can be activated
+        mockClient.getThreePids.mockResolvedValue({
+            threepids: [
+                // should render switch bc pushKey and address match
+                {
+                    medium: ThreepidMedium.Email,
+                    address: testEmail,
+                } as unknown as IThreepid,
+            ],
+        });
+
+        mockClient.getPushRules.mockClear().mockResolvedValue(pushRules);
+        mockClient.getPushers.mockClear().mockResolvedValue({ pushers: [] });
+        mockClient.setPusher.mockReset().mockResolvedValue({});
+        mockClient.pushRules = pushRules;
+
+        await clearAllModals();
+    });
+
+    describe("email switches", () => {
+        it("display well the caption when email notification is activated", async () => {
+            await getComponentAndWait();
+
+            fireEvent.click(screen.getByTestId("notif-master-switch"));
+
+            await flushPromises();
+
+            const emailToggle = screen.getByTestId("notif-email-switch").querySelector('div[role="switch"]')!;
+            fireEvent.click(emailToggle);
+
+            expect(
+                screen.findByText(
+                    "Recevez un e-mail si au moins un message reste non lu pendant 72h. <a>En savoir plus</a>",
+                ),
+            );
+        });
+    });
+});