@sitecore-content-sdk/nextjs 1.3.0-canary.9 → 1.4.0-canary.2

package/dist/esm/middleware/personalize-middleware.js

@@ -1,232 +1,236 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { PersonalizeService, getPersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from '@sitecore-content-sdk/core/personalize';
-import { debug } from '@sitecore-content-sdk/core';
-import { MiddlewareBase, REWRITE_HEADER_NAME } from './middleware';
-import { CloudSDK } from '@sitecore-cloudsdk/core/server';
-import { personalize } from '@sitecore-cloudsdk/personalize/server';
-/**
- * Middleware / handler to support Sitecore Personalize
- */
-export class PersonalizeMiddleware extends MiddlewareBase {
-    /**
-     * @param {PersonalizeMiddlewareConfig} [config] Personalize middleware config
-     */
-    constructor(config) {
-        var _a;
-        super(config);
-        this.config = config;
-        this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
-            if (!this.config.enabled) {
-                debug.personalize('skipped (personalize middleware is disabled globally)');
-                return res;
-            }
-            try {
-                const pathname = req.nextUrl.pathname;
-                const language = this.getLanguage(req, res);
-                const hostname = this.getHostHeader(req) || this.defaultHostname;
-                const startTimestamp = Date.now();
-                const cdpTimeout = this.config.cdpTimeout;
-                debug.personalize('personalize middleware start: %o', {
-                    pathname,
-                    language,
-                    hostname,
-                    headers: this.extractDebugHeaders(req.headers),
-                });
-                if (this.disabled(req, res)) {
-                    debug.personalize('skipped (personalize middleware is disabled)');
-                    return res;
-                }
-                if (res.redirected || // Don't attempt to personalize a redirect
-                    this.isPreview(req) // No need to personalize for preview (layout data is already prepared for preview)
-                ) {
-                    debug.personalize('skipped (%s)', res.redirected ? 'redirected' : 'preview');
-                    return res;
-                }
-                const site = this.getSite(req, res);
-                // Get personalization info from Experience Edge
-                const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
-                if (!personalizeInfo) {
-                    // Likely an invalid route / language
-                    debug.personalize('skipped (personalize info not found)');
-                    return res;
-                }
-                if (personalizeInfo.variantIds.length === 0) {
-                    debug.personalize('skipped (no personalization configured)');
-                    return res;
-                }
-                if (this.isPrefetch(req)) {
-                    debug.personalize('skipped (prefetch)');
-                    // Personalized, but this is a prefetch request.
-                    // In this case, don't execute a personalize request; otherwise, the metrics for component A/B experiments would be inaccurate.
-                    // Disable preflight caching to force revalidation on client-side navigation (personalization WILL be influenced).
-                    // Note the reason we don't move this any earlier in the middleware is that we would then be sacrificing performance for non-personalized pages.
-                    res.headers.set('x-middleware-cache', 'no-cache');
-                    res.headers.set('Cache-Control', 'no-store, must-revalidate');
-                    return res;
-                }
-                yield this.initPersonalizeServer({
-                    hostname,
-                    siteName: site.name,
-                    request: req,
-                    response: res,
-                });
-                const params = this.getExperienceParams(req);
-                const executions = this.getPersonalizeExecutions(personalizeInfo, language);
-                const identifiedVariantIds = [];
-                yield Promise.all(executions.map((execution) => this.personalize({
-                    friendlyId: execution.friendlyId,
-                    variantIds: execution.variantIds,
-                    params,
-                    language,
-                    timeout: cdpTimeout,
-                }, req).then((personalization) => {
-                    const variantId = personalization.variantId;
-                    if (variantId) {
-                        if (!execution.variantIds.includes(variantId)) {
-                            debug.personalize('invalid variant %s', variantId);
-                        }
-                        else {
-                            identifiedVariantIds.push(variantId);
-                        }
-                    }
-                })));
-                if (identifiedVariantIds.length === 0) {
-                    debug.personalize('skipped (no variant(s) identified)');
-                    return res;
-                }
-                // Path can be rewritten by previously executed middleware
-                const basePath = (res === null || res === void 0 ? void 0 : res.headers.get(REWRITE_HEADER_NAME)) || pathname;
-                // Rewrite to persononalized path
-                const rewritePath = getPersonalizedRewrite(basePath, identifiedVariantIds);
-                const response = this.rewrite(rewritePath, req, res);
-                // Disable preflight caching to force revalidation on client-side navigation (personalization MAY be influenced).
-                // See https://github.com/vercel/next.js/pull/32767
-                response.headers.set('x-middleware-cache', 'no-cache');
-                debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
-                    rewritePath,
-                    headers: this.extractDebugHeaders(response.headers),
-                });
-                return response;
-            }
-            catch (error) {
-                console.log('Personalize middleware failed:');
-                console.log(error);
-                return res;
-            }
-        });
-        const graphQLOptions = {
-            api: {
-                edge: {
-                    contextId: this.config.contextId,
-                    clientContextId: this.config.clientContextId,
-                    edgeUrl: this.config.edgeUrl,
-                },
-            },
-        };
-        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
-        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
-        this.personalizeService =
-            (_a = this.config.personalizeService) !== null && _a !== void 0 ? _a : new PersonalizeService({
-                clientFactory: this.getClientFactory(graphQLOptions),
-                timeout: this.config.edgeTimeout,
-                scope: this.config.scope,
-                fetch: fetch,
-            });
-    }
-    getExperienceParams(req) {
-        const extraParams = this.config.getExtraUtmParams ? this.config.getExtraUtmParams(req) : {};
-        const utm = Object.assign({ campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined, content: req.nextUrl.searchParams.get('utm_content') || undefined, medium: req.nextUrl.searchParams.get('utm_medium') || undefined, source: req.nextUrl.searchParams.get('utm_source') || undefined }, extraParams);
-        return {
-            // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
-            // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
-            // used as a fallback
-            referrer: req.headers.get('referer') || req.referrer,
-            utm,
-        };
-    }
-    disabled(req, res) {
-        // ignore files
-        return req.nextUrl.pathname.includes('.') || super.disabled(req, res);
-    }
-    initPersonalizeServer(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ hostname, siteName, request, response, }) {
-            yield CloudSDK(request, response, {
-                sitecoreEdgeUrl: this.config.edgeUrl,
-                sitecoreEdgeContextId: this.config.contextId,
-                siteName,
-                cookieDomain: hostname,
-                enableServerCookie: true,
-            })
-                .addPersonalize({ enablePersonalizeCookie: true })
-                .initialize();
-        });
-    }
-    personalize(_a, request_1) {
-        return __awaiter(this, arguments, void 0, function* ({ params, friendlyId, language, timeout, variantIds, }, request) {
-            var _b;
-            debug.personalize('executing experience for %s %o', friendlyId, params);
-            return (yield personalize(request, {
-                channel: this.config.channel || 'WEB',
-                currency: (_b = this.config.currency) !== null && _b !== void 0 ? _b : 'USD',
-                friendlyId,
-                params,
-                language,
-                pageVariantIds: variantIds,
-            }, { timeout }));
-        });
-    }
-    /**
-     * Aggregates personalize executions based on the provided route personalize information and language
-     * @param {PersonalizeInfo} personalizeInfo the route personalize information
-     * @param {string} language the language
-     * @returns An array of personalize executions
-     */
-    getPersonalizeExecutions(personalizeInfo, language) {
-        if (personalizeInfo.variantIds.length === 0) {
-            return [];
-        }
-        const results = [];
-        return personalizeInfo.variantIds.reduce((results, variantId) => {
-            if (variantId.includes('_')) {
-                // Component-level personalization in format "<ComponentID>_<VariantID>"
-                const componentId = variantId.split('_')[0];
-                const friendlyId = CdpHelper.getComponentFriendlyId(personalizeInfo.pageId, componentId, language, this.config.scope);
-                const execution = results.find((x) => x.friendlyId === friendlyId);
-                if (execution) {
-                    execution.variantIds.push(variantId);
-                }
-                else {
-                    // The default/control variant (format "<ComponentID>_default") is also a valid value returned by the execution
-                    const defaultVariant = `${componentId}${DEFAULT_VARIANT}`;
-                    results.push({
-                        friendlyId,
-                        variantIds: [defaultVariant, variantId],
-                    });
-                }
-            }
-            else {
-                // Embedded (page-level) personalization in format "<VariantID>"
-                const friendlyId = CdpHelper.getPageFriendlyId(personalizeInfo.pageId, language, this.config.scope);
-                const execution = results.find((x) => x.friendlyId === friendlyId);
-                if (execution) {
-                    execution.variantIds.push(variantId);
-                }
-                else {
-                    results.push({
-                        friendlyId,
-                        variantIds: [variantId],
-                    });
-                }
-            }
-            return results;
-        }, results);
-    }
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { PersonalizeService, getPersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from '@sitecore-content-sdk/core/personalize';
+import { debug } from '@sitecore-content-sdk/core';
+import { MiddlewareBase, REWRITE_HEADER_NAME } from './middleware';
+import { CloudSDK } from '@sitecore-cloudsdk/core/server';
+import { personalize } from '@sitecore-cloudsdk/personalize/server';
+/**
+ * Middleware / handler to support Sitecore Personalize
+ * @public
+ */
+export class PersonalizeMiddleware extends MiddlewareBase {
+    /**
+     * @param {PersonalizeMiddlewareConfig} [config] Personalize middleware config
+     */
+    constructor(config) {
+        var _a;
+        super(config);
+        this.config = config;
+        this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            // Skip if service wasn't initialized (no edge config)
+            if (!this.personalizeService) {
+                debug.personalize('skipped (personalize service not configured - edge config required)');
+                return res;
+            }
+            if (!this.config.enabled) {
+                debug.personalize('skipped (personalize middleware is disabled globally)');
+                return res;
+            }
+            try {
+                const pathname = req.nextUrl.pathname;
+                const language = this.getLanguage(req, res);
+                const hostname = this.getHostHeader(req) || this.defaultHostname;
+                const startTimestamp = Date.now();
+                const cdpTimeout = this.config.cdpTimeout;
+                const geo = this.config.extractGeoDataCb
+                    ? yield this.config.extractGeoDataCb(req)
+                    : undefined;
+                debug.personalize('personalize middleware start: %o', Object.assign(Object.assign({ pathname,
+                    language,
+                    hostname }, (geo && { geo })), { headers: this.extractDebugHeaders(req.headers) }));
+                if (this.disabled(req, res)) {
+                    debug.personalize('skipped (personalize middleware is disabled)');
+                    return res;
+                }
+                if (res.redirected || // Don't attempt to personalize a redirect
+                    this.isPreview(req) // No need to personalize for preview (layout data is already prepared for preview)
+                ) {
+                    debug.personalize('skipped (%s)', res.redirected ? 'redirected' : 'preview');
+                    return res;
+                }
+                const site = this.getSite(req, res);
+                // Get personalization info from Experience Edge
+                const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
+                if (!personalizeInfo) {
+                    // Likely an invalid route / language
+                    debug.personalize('skipped (personalize info not found)');
+                    return res;
+                }
+                if (personalizeInfo.variantIds.length === 0) {
+                    debug.personalize('skipped (no personalization configured)');
+                    return res;
+                }
+                if (this.isPrefetch(req)) {
+                    debug.personalize('skipped (prefetch)');
+                    // Personalized, but this is a prefetch request.
+                    // In this case, don't execute a personalize request; otherwise, the metrics for component A/B experiments would be inaccurate.
+                    // Disable preflight caching to force revalidation on client-side navigation (personalization WILL be influenced).
+                    // Note the reason we don't move this any earlier in the middleware is that we would then be sacrificing performance for non-personalized pages.
+                    res.headers.set('x-middleware-cache', 'no-cache');
+                    res.headers.set('Cache-Control', 'no-store, must-revalidate');
+                    return res;
+                }
+                yield this.initPersonalizeServer({
+                    hostname,
+                    siteName: site.name,
+                    request: req,
+                    response: res,
+                });
+                const params = this.getExperienceParams(req);
+                const executions = this.getPersonalizeExecutions(personalizeInfo, language);
+                const identifiedVariantIds = [];
+                yield Promise.all(executions.map((execution) => this.personalize(Object.assign({ friendlyId: execution.friendlyId, variantIds: execution.variantIds, params,
+                    language, timeout: cdpTimeout }, (geo && { geo })), req).then((personalization) => {
+                    const variantId = personalization.variantId;
+                    if (variantId) {
+                        if (!execution.variantIds.includes(variantId)) {
+                            debug.personalize('invalid variant %s', variantId);
+                        }
+                        else {
+                            identifiedVariantIds.push(variantId);
+                        }
+                    }
+                })));
+                if (identifiedVariantIds.length === 0) {
+                    debug.personalize('skipped (no variant(s) identified)');
+                    return res;
+                }
+                // Path can be rewritten by previously executed middleware
+                const basePath = (res === null || res === void 0 ? void 0 : res.headers.get(REWRITE_HEADER_NAME)) || pathname;
+                // Rewrite to persononalized path
+                const rewritePath = getPersonalizedRewrite(basePath, identifiedVariantIds);
+                const response = this.rewrite(rewritePath, req, res);
+                // Disable preflight caching to force revalidation on client-side navigation (personalization MAY be influenced).
+                // See https://github.com/vercel/next.js/pull/32767
+                response.headers.set('x-middleware-cache', 'no-cache');
+                debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
+                    rewritePath,
+                    headers: this.extractDebugHeaders(response.headers),
+                });
+                return response;
+            }
+            catch (error) {
+                console.log('Personalize middleware failed:');
+                console.log(error);
+                return res;
+            }
+        });
+        // Validate edge config is present - personalize requires Edge platform
+        if (!this.config.contextId && !this.config.clientContextId) {
+            console.warn('[PersonalizeMiddleware] Personalize middleware requires Edge configuration (contextId/clientContextId). ' +
+                'Personalize features will be disabled. This is expected in local container development.');
+            // Set to null to indicate service is disabled
+            this.personalizeService = null;
+            return;
+        }
+        const graphQLOptions = {
+            api: {
+                edge: {
+                    contextId: this.config.contextId,
+                    clientContextId: this.config.clientContextId,
+                    edgeUrl: this.config.edgeUrl,
+                },
+            },
+        };
+        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
+        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
+        this.personalizeService =
+            (_a = this.config.personalizeService) !== null && _a !== void 0 ? _a : new PersonalizeService({
+                clientFactory: this.getClientFactory(graphQLOptions),
+                timeout: this.config.edgeTimeout,
+                scope: this.config.scope,
+                fetch: fetch,
+            });
+    }
+    getExperienceParams(req) {
+        const extraParams = this.config.getExtraUtmParams ? this.config.getExtraUtmParams(req) : {};
+        const utm = Object.assign({ campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined, content: req.nextUrl.searchParams.get('utm_content') || undefined, medium: req.nextUrl.searchParams.get('utm_medium') || undefined, source: req.nextUrl.searchParams.get('utm_source') || undefined }, extraParams);
+        return {
+            // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
+            // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
+            // used as a fallback
+            referrer: req.headers.get('referer') || req.referrer,
+            utm,
+        };
+    }
+    disabled(req, res) {
+        // ignore files
+        return req.nextUrl.pathname.includes('.') || super.disabled(req, res);
+    }
+    initPersonalizeServer(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ hostname, siteName, request, response, }) {
+            yield CloudSDK(request, response, {
+                sitecoreEdgeUrl: this.config.edgeUrl,
+                sitecoreEdgeContextId: this.config.contextId,
+                siteName,
+                cookieDomain: hostname,
+                enableServerCookie: true,
+            })
+                .addPersonalize({ enablePersonalizeCookie: true })
+                .initialize();
+        });
+    }
+    personalize(_a, request_1) {
+        return __awaiter(this, arguments, void 0, function* ({ params, friendlyId, language, timeout, variantIds, geo, }, request) {
+            var _b;
+            debug.personalize('executing experience for %s %o', friendlyId, params);
+            return (yield personalize(request, Object.assign({ channel: this.config.channel || 'WEB', currency: (_b = this.config.currency) !== null && _b !== void 0 ? _b : 'USD', friendlyId,
+                params,
+                language, pageVariantIds: variantIds }, (geo && { geo })), { timeout }));
+        });
+    }
+    /**
+     * Aggregates personalize executions based on the provided route personalize information and language
+     * @param {PersonalizeInfo} personalizeInfo the route personalize information
+     * @param {string} language the language
+     * @returns An array of personalize executions
+     */
+    getPersonalizeExecutions(personalizeInfo, language) {
+        if (personalizeInfo.variantIds.length === 0) {
+            return [];
+        }
+        const results = [];
+        return personalizeInfo.variantIds.reduce((results, variantId) => {
+            if (variantId.includes('_')) {
+                // Component-level personalization in format "<ComponentID>_<VariantID>"
+                const componentId = variantId.split('_')[0];
+                const friendlyId = CdpHelper.getComponentFriendlyId(personalizeInfo.pageId, componentId, language, this.config.scope);
+                const execution = results.find((x) => x.friendlyId === friendlyId);
+                if (execution) {
+                    execution.variantIds.push(variantId);
+                }
+                else {
+                    // The default/control variant (format "<ComponentID>_default") is also a valid value returned by the execution
+                    const defaultVariant = `${componentId}${DEFAULT_VARIANT}`;
+                    results.push({
+                        friendlyId,
+                        variantIds: [defaultVariant, variantId],
+                    });
+                }
+            }
+            else {
+                // Embedded (page-level) personalization in format "<VariantID>"
+                const friendlyId = CdpHelper.getPageFriendlyId(personalizeInfo.pageId, language, this.config.scope);
+                const execution = results.find((x) => x.friendlyId === friendlyId);
+                if (execution) {
+                    execution.variantIds.push(variantId);
+                }
+                else {
+                    results.push({
+                        friendlyId,
+                        variantIds: [variantId],
+                    });
+                }
+            }
+            return results;
+        }, results);
+    }
+}