@adobe/alloy 2.34.2-beta.2 → 2.35.0-beta.4

package/src/components/PushNotifications/helpers/getPushSubscriptionDetails.js

@@ -46,8 +46,7 @@ const getPushSubscriptionDetails = async ({ vapidPublicKey, window }) => {
     throw new Error("Push notifications are not supported in this browser.");
   }
 
-  /** @type {object} */
-  const notification = window.Notification;
+  const notification = /** @type {typeof Notification} */ (window.Notification);
   if (notification.permission !== "granted") {
     throw new Error(
       "The user has not given permission to send push notifications.",
@@ -92,15 +91,18 @@ const getPushSubscriptionDetails = async ({ vapidPublicKey, window }) => {
         subscriptionOptions,
       );
 
+    const p256dhKey = subscription.getKey("p256dh");
+    const authKey = subscription.getKey("auth");
+
     return {
       endpoint: subscription.endpoint,
       keys: {
-        p256dh: bytesToBase64(new Uint8Array(subscription.getKey("p256dh")), {
-          urlSafe: true,
-        }),
-        auth: bytesToBase64(new Uint8Array(subscription.getKey("auth")), {
-          urlSafe: true,
-        }),
+        p256dh: p256dhKey
+          ? bytesToBase64(new Uint8Array(p256dhKey), { urlSafe: true })
+          : null,
+        auth: authKey
+          ? bytesToBase64(new Uint8Array(authKey), { urlSafe: true })
+          : null,
       },
     };
   } catch (e) {

package/src/components/PushNotifications/helpers/readFromIndexedDb.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-/** @import { ServiceWorkerLogger } from '../types.js' */
+/** @import { ServiceWorkerLogger, PushServiceWorkerConfig } from '../types.js' */
 
 import {
   getFromIndexedDbStore,
@@ -20,7 +20,7 @@ import { DB_NAME, DB_VERSION, STORE_NAME, INDEX_KEY } from "./constants.js";
 
 /**
  * @param {ServiceWorkerLogger} logger
- * @returns {Promise<Object|undefined>}
+ * @returns {Promise<PushServiceWorkerConfig|undefined>}
  * @throws {Error}
  */
 export default async (logger) => {
@@ -46,5 +46,6 @@ export default async (logger) => {
     return existingConfigData;
   } catch (error) {
     logger.error("Failed to read data from IndexedDB", { error });
+    throw error;
   }
 };

package/src/components/PushNotifications/helpers/saveToIndexedDb.js

@@ -11,6 +11,7 @@ governing permissions and limitations under the License.
 */
 
 /** @import { Logger } from '@adobe/alloy-core/core/types.js' */
+/** @import { PushServiceWorkerConfig } from '../types.js' */
 
 import {
   openIndexedDb,
@@ -21,10 +22,10 @@ import {
 import { DB_NAME, DB_VERSION, STORE_NAME, INDEX_KEY } from "./constants.js";
 
 /**
- * @param {Object} data
+ * @param {Partial<PushServiceWorkerConfig>} data
  * @param {Logger} logger
  *
- * @returns {Promise<void>}
+ * @returns {Promise<boolean>} Whether the data was successfully saved.
  */
 export default async function saveToIndexedDB(data, logger) {
   try {
@@ -58,7 +59,11 @@ export default async function saveToIndexedDB(data, logger) {
       "Successfully saved web SDK config to IndexedDB",
       updatedConfigData,
     );
+
+    return true;
   } catch (error) {
     logger.error("Failed to save config to IndexedDB", { error });
+
+    return false;
   }
 }

package/src/components/PushNotifications/helpers/serviceWorkerPushListener.js

@@ -14,7 +14,53 @@ governing permissions and limitations under the License.
 /// <reference lib="webworker" />
 
 /** @import {  PushNotificationData  } from '../types.js' */
-/** @import { ServiceWorkerLogger } from '../types.js' */
+/** @import { ServiceWorkerLogger, PushServiceWorkerConfig } from '../types.js' */
+
+import ecidNamespace from "@adobe/alloy-core/constants/ecidNamespace.js";
+
+/**
+ * Determines whether a notification targeted at a specific identity should be
+ * shown on this browser. When the payload contains an `identity` with the ECID
+ * namespace, the notification is only shown if the ECID in the payload matches
+ * the ECID stored in IndexedDB for this browser. When there is no identity, or
+ * the namespace is not ECID, the notification is always shown.
+ *
+ * @param {Object} options
+ * @param {PushNotificationData["web"]} options.webData
+ * @param {(logger: ServiceWorkerLogger) => Promise<PushServiceWorkerConfig|undefined>} options.readFromIndexedDb
+ * @param {ServiceWorkerLogger} options.logger
+ * @returns {Promise<boolean>}
+ */
+const shouldShowNotification = async ({
+  webData,
+  readFromIndexedDb,
+  logger,
+}) => {
+  const { identity } = webData;
+
+  if (!identity || identity.namespace?.toUpperCase() !== ecidNamespace) {
+    return true;
+  }
+
+  let storedConfig;
+  try {
+    storedConfig = await readFromIndexedDb(logger);
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    logger.error(`Unable to read the stored ECID for this browser. ${message}`);
+    return true;
+  }
+  const storedEcid = storedConfig?.ecid;
+
+  if (identity.id !== storedEcid) {
+    logger.info(
+      "Suppressing push notification: payload ECID does not match the ECID stored for this browser.",
+    );
+    return false;
+  }
+
+  return true;
+};
 
 /**
  * @async
@@ -24,9 +70,10 @@ governing permissions and limitations under the License.
  * @param {ServiceWorkerGlobalScope} options.sw
  * @param {PushEvent} options.event
  * @param {ServiceWorkerLogger} options.logger
+ * @param {(logger: ServiceWorkerLogger) => Promise<PushServiceWorkerConfig|undefined>} options.readFromIndexedDb
  * @returns {Promise<void>}
  */
-export default async ({ sw, event, logger }) => {
+export default async ({ sw, event, logger, readFromIndexedDb }) => {
   if (!event.data) {
     return;
   }
@@ -45,6 +92,15 @@ export default async ({ sw, event, logger }) => {
     return;
   }
 
+  const showNotification = await shouldShowNotification({
+    webData,
+    readFromIndexedDb,
+    logger,
+  });
+  if (!showNotification) {
+    return;
+  }
+
   /** @type {Record<string, unknown>} */
   const notificationOptions = {
     data: webData,

package/src/components/PushNotifications/index.js

@@ -21,6 +21,10 @@ import { sanitizeOrgIdForCookieName } from "@adobe/alloy-core/utils";
 import makeSendPushSubscriptionRequest from "./request/makeSendPushSubscriptionRequest.js";
 import saveToIndexedDb from "./helpers/saveToIndexedDb.js";
 
+/**
+ * @param {{ orgId?: string, pushNotifications?: { vapidPublicKey?: string, appId?: string, trackingDatasetId?: string } }} config
+ * @returns {boolean}
+ */
 const isComponentConfigured = ({
   orgId,
   pushNotifications: { vapidPublicKey, appId, trackingDatasetId } = {
@@ -28,7 +32,7 @@ const isComponentConfigured = ({
     appId: undefined,
     trackingDatasetId: undefined,
   },
-}) => orgId && vapidPublicKey && appId && trackingDatasetId;
+}) => Boolean(orgId && vapidPublicKey && appId && trackingDatasetId);
 
 /**
  * @function
@@ -86,11 +90,8 @@ const createPushNotifications = ({
 
           const {
             orgId,
-            pushNotifications: { vapidPublicKey, appId } = {
-              vapidPublicKey: undefined,
-              appId: undefined,
-            },
-          } = config || {};
+            pushNotifications: { vapidPublicKey, appId },
+          } = config;
 
           const storage = platformServices.storage.createNamespacedStorage(
             `${sanitizeOrgIdForCookieName(orgId)}.pushNotifications.`,

package/src/components/PushNotifications/request/makeSendPushSubscriptionRequest.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-/** @import { Storage } from '@adobe/alloy-core/utils/types.js' */
+/** @import { Storage } from '@adobe/alloy-core/services' */
 /** @import { EventManager, Logger } from '@adobe/alloy-core/core/types.js' */
 /** @import { IdentityManager } from '@adobe/alloy-core/core/identity/types.js' */
 /** @import { ConsentManager } from '@adobe/alloy-core/core/consent/types.js' */
@@ -42,6 +42,7 @@ const SUBSCRIPTION_DETAILS = "subscriptionDetails";
  * @param {EdgeRequestExecutor} options.sendEdgeNetworkRequest
  * @param {ConsentManager} options.consent
  * @param {Window} options.window
+ * @param {typeof getPushSubscriptionDetailsDefault} [options.getPushSubscriptionDetails]
  *
  * @returns {Promise<void>}
  */
@@ -59,6 +60,14 @@ export default async ({
   await identity.awaitIdentity();
   const ecid = identity.getEcidFromCookie();
 
+  if (!ecid) {
+    logger.info(
+      "No ECID is available. Not sending push subscription details to the server.",
+    );
+
+    return;
+  }
+
   const pushSubscriptionDetails = await getPushSubscriptionDetails({
     vapidPublicKey,
     window,
@@ -71,7 +80,7 @@ export default async ({
   const cacheValue = `${ecid}${serializedPushSubscriptionDetails}`;
   const storedValue = await storage.getItem(SUBSCRIPTION_DETAILS);
 
-  if (cacheValue === storedValue) {
+  if (storedValue && cacheValue === storedValue) {
     logger.info(
       "Subscription details have not changed. Not sending to the server.",
     );
@@ -79,8 +88,6 @@ export default async ({
     return;
   }
 
-  storage.setItem(SUBSCRIPTION_DETAILS, cacheValue);
-
   const payload = await createSendPushSubscriptionPayload({
     eventManager,
     ecid,
@@ -95,5 +102,13 @@ export default async ({
   await consent.awaitConsent();
   await sendEdgeNetworkRequest({ request });
 
-  await saveToIndexedDb({ ecid }, logger);
+  const savedToIndexedDb = await saveToIndexedDb({ ecid }, logger);
+
+  // Only cache the subscription details once the ECID has been persisted, so
+  // that a failed send or a failed IndexedDB write does not short-circuit the
+  // dedupe check on the next call. This lets a subsequent sendPushSubscription
+  // self-heal instead of getting stuck with a cached subscription but no ECID.
+  if (savedToIndexedDb) {
+    storage.setItem(SUBSCRIPTION_DETAILS, cacheValue);
+  }
 };

package/src/components/PushNotifications/request/makeSendServiceWorkerTrackingData.js

@@ -12,14 +12,16 @@ governing permissions and limitations under the License.
 
 /** @import { ServiceWorkerLogger } from '../types.js' */
 /** @import { TrackingDataPayload   } from '../types.js' */
+/** @import { PushServiceWorkerConfig } from '../types.js' */
+/** @import { XdmTrackingContext } from '../types.js' */
 
 /**
  * @param {Object} dependencies
- * @param {(logger: ServiceWorkerLogger) => Promise<Object>} dependencies.readFromIndexedDb
+ * @param {(logger: ServiceWorkerLogger) => Promise<PushServiceWorkerConfig>} dependencies.readFromIndexedDb
  * @param {() => string} dependencies.uuidv4
  * @param {ServiceWorkerLogger} dependencies.logger
  * @param {(url: string, options: object) => Promise<Response>} dependencies.fetch
- * @returns {(options: { xdm: Object, actionLabel?: string, applicationLaunches?: number }) => Promise<boolean>}
+ * @returns {(options: { xdm: XdmTrackingContext, actionLabel?: string, applicationLaunches?: number }) => Promise<boolean>}
  */
 export const createMakeSendServiceWorkerTrackingData = ({
   readFromIndexedDb,
@@ -31,7 +33,7 @@ export const createMakeSendServiceWorkerTrackingData = ({
    * @async
    * @function
    * @param {Object} options
-   * @param {Object} options.xdm
+   * @param {XdmTrackingContext} options.xdm
    * @param {string} [options.actionLabel]
    * @param {number} [options.applicationLaunches=0]
    *
@@ -50,6 +52,7 @@ export const createMakeSendServiceWorkerTrackingData = ({
       };
     }
 
+    /** @type {{ name: keyof PushServiceWorkerConfig, errorField: string }[]} */
     const requiredFields = [
       { name: "browser", errorField: "Browser" },
       { name: "ecid", errorField: "ECID" },
@@ -82,19 +85,24 @@ export const createMakeSendServiceWorkerTrackingData = ({
 
       const url = `https://${edgeDomain}/${edgeBasePath}/v1/interact?configId=${datastreamId}&requestId=${uuidv4()}`;
 
+      // The requiredFields loop above guarantees these are defined strings.
+      const validEcid = /** @type {string} */ (ecid);
+      const validBrowser = /** @type {string} */ (browser);
+      const validDatasetId = /** @type {string} */ (datasetId);
+
       /** @type {TrackingDataPayload} */
       const payload = {
         events: [
           {
             xdm: {
               identityMap: {
-                ECID: [{ id: ecid }],
+                ECID: [{ id: validEcid }],
               },
               timestamp: new Date().toISOString(),
               pushNotificationTracking: {
                 ...customActionData,
                 pushProviderMessageID: uuidv4(),
-                pushProvider: browser.toLowerCase(),
+                pushProvider: validBrowser.toLowerCase(),
               },
               application: {
                 launches: {
@@ -121,7 +129,7 @@ export const createMakeSendServiceWorkerTrackingData = ({
             },
             meta: {
               collect: {
-                datasetId,
+                datasetId: validDatasetId,
               },
             },
           },

package/src/components/PushNotifications/types.js

@@ -56,6 +56,9 @@ governing permissions and limitations under the License.
  * @property {string} web.title
  * @property {string} web.body
  * @property {string|null} web.media
+ * @property {Object} [web.identity]
+ * @property {string} [web.identity.id]
+ * @property {string} [web.identity.namespace]
  * @property {Object} web.interaction
  * @property {string} web.interaction.type
  * @property {string|null} web.interaction.uri
@@ -101,4 +104,16 @@ governing permissions and limitations under the License.
  * @property {(...args: any[]) => void} error
  */
 
+/**
+ * @typedef {Object} PushServiceWorkerConfig
+ * @property {string} [ecid]
+ * @property {string} [browser]
+ * @property {string} [edgeDomain]
+ * @property {string} [edgeBasePath]
+ * @property {string} [datastreamId]
+ * @property {string} [datasetId]
+ * @property {string} [id]
+ * @property {number} [timestamp]
+ */
+
 export const Types = {};

package/src/createEventListeners.js

@@ -50,6 +50,7 @@ const createEventListeners = ({ platform, sw }) => {
           event,
           sw,
           logger: platform.logger,
+          readFromIndexedDb,
         });
       },
       /**