Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[nextjs] Add support for fallback point of sale #1367

Merged
merged 6 commits into from
Mar 8, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
LayoutServicePageState,
SiteInfo,
useSitecoreContext,
resolvePointOfSale,
} from '@sitecore-jss/sitecore-jss-nextjs';
import { useEffect } from 'react';
import config from 'temp/config';
Expand All @@ -29,9 +30,7 @@ const CdpPageView = (): JSX.Element => {
site: SiteInfo,
pageVariantId: string
) => {
const pointOfSale = site.pointOfSale
? site.pointOfSale[language] || site.pointOfSale[site.language]
: '';
const pointOfSale = resolvePointOfSale(site, language);
const engage = await init({
clientKey: process.env.NEXT_PUBLIC_CDP_CLIENT_KEY || '',
targetURL: process.env.NEXT_PUBLIC_CDP_TARGET_URL || '',
Expand Down
2 changes: 1 addition & 1 deletion packages/sitecore-jss-nextjs/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export {
useComponentProps,
} from './components/ComponentPropsContext';

export { handleEditorFastRefresh, getPublicUrl } from './utils';
export { handleEditorFastRefresh, getPublicUrl, resolvePointOfSale } from './utils';

export { Link, LinkProps } from './components/Link';
export { RichText, RichTextProps } from './components/RichText';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
} from '@sitecore-jss/sitecore-jss/personalize';
import { SiteResolver } from '@sitecore-jss/sitecore-jss/site';
import { debug, NativeDataFetcher } from '@sitecore-jss/sitecore-jss';
import { resolvePointOfSale } from '../utils';

export type PersonalizeMiddlewareConfig = {
/**
Expand Down Expand Up @@ -235,9 +236,7 @@ export class PersonalizeMiddleware {
// Execute targeted experience in CDP
const { ua } = userAgent(req);
const params = this.getExperienceParams(req);
const pointOfSale = site.pointOfSale
? site.pointOfSale[language] || site.pointOfSale[site.language]
: '';
const pointOfSale = resolvePointOfSale(site, language);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have POS resolver, in this case, it needs to be customizable, so can be provided in config

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SiteResolver is more complex than PosResolver needs to be. I believe it's better to keep point of sale resolution simple, but separate, so that it can be easily changed if the point of sale data format changes in future.
But yes, we need to have a way to override resolution in middleware.

const variantId = await this.cdpService.executeExperience(
personalizeInfo.contentId,
browserId,
Expand Down
62 changes: 61 additions & 1 deletion packages/sitecore-jss-nextjs/src/utils.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* eslint-disable no-unused-expressions */
import { expect } from 'chai';
import { getPublicUrl, getJssEditingSecret } from './utils';
import { SiteInfo } from './middleware';
import { getPublicUrl, getJssEditingSecret, resolvePointOfSale } from './utils';

describe('utils', () => {
describe('getPublicUrl', () => {
Expand Down Expand Up @@ -55,4 +56,63 @@ describe('utils', () => {
expect(result).to.equal(secret);
});
});

describe('resolvePointOfSale', () => {
it('should return empty when no point of sale present', () => {
const site: SiteInfo = {
name: 'no-pos',
hostName: 'www.nopos.com',
language: 'en',
};
const language = 'en';
const result = resolvePointOfSale(site, language);
expect(result).to.equal('');
});

it('should return pos for provided language', () => {
const myPoint = 'apos.com';
const site: SiteInfo = {
name: 'apos',
hostName: 'www.apos.com',
pointOfSale: {
en: myPoint,
},
language: 'de-DE',
};

const result = resolvePointOfSale(site, 'en');
expect(result).to.equal(myPoint);
});

it('should return pos for site language as first backup', () => {
const site: SiteInfo = {
name: 'apos',
hostName: 'www.apos.com',
pointOfSale: {
'de-DE': 'depos.com',
'es-ES': 'espos.com',
},
language: 'de-DE',
};

const result = resolvePointOfSale(site, 'en');
expect(result).to.equal('depos.com');
});

it('should use fallback value when other values missing', () => {
const site: SiteInfo = {
name: 'apos',
hostName: 'www.apos.com',
pointOfSale: {
'de-DE': 'depos.com',
'es-ES': 'espos.com',
'*': 'fallpos.com',
},
language: 'en-CA',
};

const result = resolvePointOfSale(site, 'en');
expect(result).to.equal('fallpos.com');
});
});
});
7 changes: 7 additions & 0 deletions packages/sitecore-jss-nextjs/src/utils.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import chalk from 'chalk';
import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/utils';
import { SiteInfo } from './middleware';

/**
* Get the publicUrl.
Expand Down Expand Up @@ -75,3 +76,9 @@ export const getJssEditingSecret = (): string => {
}
return secret;
};

export const resolvePointOfSale = (site: SiteInfo, language: string): string => {
return site.pointOfSale
? site.pointOfSale[language] || site.pointOfSale[site.language] || site.pointOfSale['*']
: '';
};