jingram/subscription win back banner: Adds Subscription Win-Back Banner (#2014)

* Move utility functions to shared file and update unit tests

Remove freemium dir from test-unit script

* Messaging support for the subscription win-back banner

* Create win-back banner component and supporting files

Include supporting svg

* Wire up mock transport

* Generate types

* Wire up integration test for win-back banner on NTP

* Update button styles

* Update new-tab readme

* Add entry point for Subscription Win-back banner

* Resolve Unknown property `composes`

* Resolve Unexpected unknown property "composes"  property-no-unknown

* Fix unit test issue

* Patch: Update test-int-snapshots-update in injected/package.json

* Use accentBrand colors for MacOS button

* Update test to pass the correct query param value

Author: jsoningram

.stylelintrc.json

@@ -4,8 +4,14 @@
     "ignoreFiles": ["build/**/*.css", "Sources/**/*.css", "docs/**/*.css", "special-pages/pages/**/*/dist/*.css"],
     "rules": {
         "csstree/validator": {
-            "ignoreProperties": ["text-wrap", "view-transition-name"]
+            "ignoreProperties": ["text-wrap", "view-transition-name", "composes"]
         },
+        "property-no-unknown": [
+            true,
+            {
+                "ignoreProperties": ["composes"]
+            }
+        ],
         "alpha-value-notation": null,
         "at-rule-empty-line-before": null,
         "color-function-notation": null,

injected/package.json

@@ -15,7 +15,7 @@
     "test-int": "playwright test --grep-invert '@screenshots'",
     "test-int-x": "xvfb-run --server-args='-screen 0 1024x768x24' npm run test-int",
     "test-int-snapshots": "playwright test --grep '@screenshots'",
-    "test-int-snapshots-update": "playwright test --grep '@screenshots' --update-snapshots --last-failed",
+    "test-int-snapshots-update": "playwright test --grep '@screenshots' --update-snapshots --last-failed --pass-with-no-tests",
     "test": "npm run test-unit && npm run test-int && npm run playwright",
     "serve": "http-server -c-1 --port 3220 integration-test/test-pages",
     "playwright": "playwright test --grep-invert '@screenshots'",

special-pages/package.json

@@ -10,7 +10,7 @@
     "build": "node index.mjs",
     "build.dev": "npm run build -- --env development",
     "lint-fix": "cd ../ && npm run lint-fix",
-    "test-unit": "node --test \"unit-test/*\" \"pages/history/unit-tests/*\" \"pages/duckplayer/unit-tests/*\" \"pages/new-tab/app/freemium-pir-banner/unit-tests/*\" \"pages/new-tab/app/omnibar/unit-tests/*\"",
+    "test-unit": "node --test \"unit-test/*\" \"pages/history/unit-tests/*\" \"pages/duckplayer/unit-tests/*\" \"pages/new-tab/app/omnibar/unit-tests/*\"",
     "test-int": "playwright test --grep-invert '@screenshots'",
     "test-int-x": "npm run test-int",
     "test-int-snapshots": "playwright test --grep '@screenshots'",

special-pages/pages/new-tab/app/components/Examples.jsx

@@ -7,6 +7,7 @@ import { otherRMFExamples, RMFExamples } from '../remote-messaging-framework/com
 import { updateNotificationExamples } from '../update-notification/components/UpdateNotification.examples.js';
 import { activityExamples } from '../activity/components/Activity.examples.js';
 import { protectionsHeadingExamples } from '../protections/components/ProtectionsHeading.examples.js';
+import { subscriptionWinBackBannerExamples } from '../subscription-winback-banner/components/SubscriptionWinBackBanner.examples.js';
 
 /** @type {Record<string, {factory: () => import("preact").ComponentChild}>} */
 export const mainExamples = {
@@ -15,6 +16,7 @@ export const mainExamples = {
     ...nextStepsExamples,
     ...privacyStatsExamples,
     ...RMFExamples,
+    ...subscriptionWinBackBannerExamples,
 };
 
 export const otherExamples = {

special-pages/pages/new-tab/app/entry-points/subscriptionWinBackBanner.js

@@ -0,0 +1,14 @@
+import { h } from 'preact';
+import { Centered } from '../components/Layout.js';
+import { SubscriptionWinBackBannerConsumer } from '../subscription-winback-banner/components/SubscriptionWinBackBanner.js';
+import { SubscriptionWinBackBannerProvider } from '../subscription-winback-banner/SubscriptionWinBackBannerProvider.js';
+
+export function factory() {
+    return (
+        <Centered data-entry-point="subscriptionWinBackBanner">
+            <SubscriptionWinBackBannerProvider>
+                <SubscriptionWinBackBannerConsumer />
+            </SubscriptionWinBackBannerProvider>
+        </Centered>
+    );
+}

special-pages/pages/new-tab/app/freemium-pir-banner/components/FreemiumPIRBanner.js

@@ -5,7 +5,7 @@ import { DismissButton } from '../../components/DismissButton';
 import styles from './FreemiumPIRBanner.module.css';
 import { FreemiumPIRBannerContext } from '../FreemiumPIRBannerProvider';
 import { useContext } from 'preact/hooks';
-import { convertMarkdownToHTMLForStrongTags } from '../freemiumPIRBanner.utils';
+import { convertMarkdownToHTMLForStrongTags } from '../../../../../shared/utils';
 
 /**
  * @typedef { import("../../../types/new-tab").FreemiumPIRBannerMessage} FreemiumPIRBannerMessage

special-pages/pages/new-tab/app/freemium-pir-banner/freemiumPIRBanner.utils.js

@@ -7,6 +7,7 @@ import { updateNotificationExamples } from './update-notification/mocks/update-n
 import { variants as nextSteps } from './next-steps/nextsteps.data.js';
 import { customizerData, customizerMockTransport } from './customizer/mocks.js';
 import { freemiumPIRDataExamples } from './freemium-pir-banner/mocks/freemiumPIRBanner.data.js';
+import { subscriptionWinBackBannerDataExamples } from './subscription-winback-banner/mocks/subscriptionWinBackBanner.data.js';
 import { activityMockTransport } from './activity/mocks/activity.mock-transport.js';
 import { protectionsMockTransport } from './protections/mocks/protections.mock-transport.js';
 import { omnibarMockTransport } from './omnibar/mocks/omnibar.mock-transport.js';
@@ -95,6 +96,7 @@ export function mockTransport() {
     const rmfSubscriptions = new Map();
     const freemiumPIRBannerSubscriptions = new Map();
     const nextStepsSubscriptions = new Map();
+    const subscriptionWinBackBannerSubscriptions = new Map();
 
     function clearRmf() {
         const listeners = rmfSubscriptions.get('rmf_onDataUpdate') || [];
@@ -163,6 +165,14 @@ export function mockTransport() {
                     console.log('ignoring freemiumPIRBanner_dismiss', msg.params);
                     return;
                 }
+                case 'winBackOffer_action': {
+                    console.log('ignoring winBackOffer_action', msg.params);
+                    return;
+                }
+                case 'winBackOffer_dismiss': {
+                    console.log('ignoring winBackOffer_dismiss', msg.params);
+                    return;
+                }
                 case 'favorites_setConfig': {
                     if (!msg.params) throw new Error('unreachable');
 
@@ -256,6 +266,24 @@ export function mockTransport() {
                     }
                     return () => {};
                 }
+                case 'winBackOffer_onDataUpdate': {
+                    // store the callback for later (eg: dismiss)
+                    const prev = subscriptionWinBackBannerSubscriptions.get('winBackOffer_onDataUpdate') || [];
+                    const next = [...prev];
+                    next.push(cb);
+                    subscriptionWinBackBannerSubscriptions.set('winBackOffer_onDataUpdate', next);
+
+                    const subscriptionWinBackBannerParam = url.searchParams.get('winback');
+
+                    if (
+                        subscriptionWinBackBannerParam !== null &&
+                        subscriptionWinBackBannerParam in subscriptionWinBackBannerDataExamples
+                    ) {
+                        const message = subscriptionWinBackBannerDataExamples[subscriptionWinBackBannerParam];
+                        cb(message);
+                    }
+                    return () => {};
+                }
                 case 'nextSteps_onDataUpdate': {
                     const prev = nextStepsSubscriptions.get('nextSteps_onDataUpdate') || [];
                     const next = [...prev];
@@ -471,6 +499,18 @@ export function mockTransport() {
 
                     return Promise.resolve(freemiumPIRBannerMessage);
                 }
+                case 'winBackOffer_getData': {
+                    /** @type {import('../types/new-tab.ts').SubscriptionWinBackBannerData} */
+                    let subscriptionWinBackBannerMessage = { content: null };
+
+                    const subscriptionWinBackBannerParam = url.searchParams.get('winback');
+
+                    if (subscriptionWinBackBannerParam && subscriptionWinBackBannerParam in subscriptionWinBackBannerDataExamples) {
+                        subscriptionWinBackBannerMessage = subscriptionWinBackBannerDataExamples[subscriptionWinBackBannerParam];
+                    }
+
+                    return Promise.resolve(subscriptionWinBackBannerMessage);
+                }
                 case 'favorites_getData': {
                     const param = url.searchParams.get('favorites');
                     let data;
@@ -514,6 +554,7 @@ export function initialSetup(url) {
         { id: 'updateNotification' },
         { id: 'rmf' },
         { id: 'freemiumPIRBanner' },
+        { id: 'subscriptionWinBackBanner' },
         { id: 'nextSteps' },
         { id: 'favorites' },
     ];

special-pages/pages/new-tab/app/mock-transport.js

@@ -0,0 +1,96 @@
+import { createContext, h } from 'preact';
+import { useCallback, useEffect, useReducer, useRef } from 'preact/hooks';
+import { useMessaging } from '../types.js';
+import { SubscriptionWinBackBannerService } from './subscriptionWinBackBanner.service.js';
+import { reducer, useDataSubscription, useInitialData } from '../service.hooks.js';
+
+/**
+ * @typedef {import('../../types/new-tab.js').SubscriptionWinBackBannerData} SubscriptionWinBackBannerData
+ * @typedef {import('../service.hooks.js').State<SubscriptionWinBackBannerData, undefined>} State
+ * @typedef {import('../service.hooks.js').Events<SubscriptionWinBackBannerData, undefined>} Events
+ */
+
+/**
+ * These are the values exposed to consumers.
+ */
+export const SubscriptionWinBackBannerContext = createContext({
+    /** @type {State} */
+    state: { status: 'idle', data: null, config: null },
+    /** @type {(id: string) => void} */
+    dismiss: (id) => {
+        throw new Error('must implement dismiss' + id);
+    },
+    /** @type {(id: string) => void} */
+    action: (id) => {
+        throw new Error('must implement action' + id);
+    },
+});
+
+export const SubscriptionWinBackBannerDispatchContext = createContext(/** @type {import("preact/hooks").Dispatch<Events>} */ ({}));
+
+/**
+ * A data provider that will use `SubscriptionWinBackBannerService` to fetch data, subscribe
+ * to updates and modify state.
+ *
+ * @param {Object} props
+ * @param {import("preact").ComponentChild} props.children
+ */
+export function SubscriptionWinBackBannerProvider(props) {
+    const initial = /** @type {State} */ ({
+        status: 'idle',
+        data: null,
+        config: null,
+    });
+
+    // const [state, dispatch] = useReducer(withLog('SubscriptionWinBackBannerProvider', reducer), initial)
+    const [state, dispatch] = useReducer(reducer, initial);
+
+    // create an instance of `SubscriptionWinBackBannerService` for the lifespan of this component.
+    const service = useService();
+
+    // get initial data
+    useInitialData({ dispatch, service });
+
+    // subscribe to data updates
+    useDataSubscription({ dispatch, service });
+
+    // todo(valerie): implement onDismiss in the service
+    const dismiss = useCallback(
+        (id) => {
+            console.log('onDismiss');
+            service.current?.dismiss(id);
+        },
+        [service],
+    );
+
+    const action = useCallback(
+        (id) => {
+            service.current?.action(id);
+        },
+        [service],
+    );
+
+    return (
+        <SubscriptionWinBackBannerContext.Provider value={{ state, dismiss, action }}>
+            <SubscriptionWinBackBannerDispatchContext.Provider value={dispatch}>
+                {props.children}
+            </SubscriptionWinBackBannerDispatchContext.Provider>
+        </SubscriptionWinBackBannerContext.Provider>
+    );
+}
+
+/**
+ * @return {import("preact").RefObject<SubscriptionWinBackBannerService>}
+ */
+export function useService() {
+    const service = useRef(/** @type {SubscriptionWinBackBannerService|null} */ (null));
+    const ntp = useMessaging();
+    useEffect(() => {
+        const stats = new SubscriptionWinBackBannerService(ntp);
+        service.current = stats;
+        return () => {
+            stats.destroy();
+        };
+    }, [ntp]);
+    return service;
+}

special-pages/pages/new-tab/app/subscription-winback-banner/SubscriptionWinBackBannerProvider.js

@@ -0,0 +1,18 @@
+import { h } from 'preact';
+import { noop } from '../../utils.js';
+import { SubscriptionWinBackBanner } from './SubscriptionWinBackBanner.js';
+import { subscriptionWinBackBannerDataExamples } from '../mocks/subscriptionWinBackBanner.data.js';
+
+/** @type {Record<string, {factory: () => import("preact").ComponentChild}>} */
+
+export const subscriptionWinBackBannerExamples = {
+    'subscriptionWinBackBanner.winback_last_day': {
+        factory: () => (
+            <SubscriptionWinBackBanner
+                message={subscriptionWinBackBannerDataExamples.winback_last_day.content}
+                dismiss={noop('winBackOffer_dismiss')}
+                action={noop('winBackOffer_action')}
+            />
+        ),
+    },
+};