Skip to content

CMS-47490 Refactor getPreviewUtils to improve URL handling #183

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 2, 2025
+160 −12
Merged

CMS-47490 Refactor getPreviewUtils to improve URL handling #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed623ff
CMS-47490 Refactor getPreviewUtils to improve URL handling
TRomesh Dec 1, 2025
b2a5db4
CMS-47490 Update test to handle changes in src method
TRomesh Dec 1, 2025
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
157 changes: 151 additions & 6 deletions packages/optimizely-cms-sdk/src/react/__test__/assetsUtils.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,16 @@ describe('getPreviewUtils', () => {
};

describe('src()', () => {
it('should return empty string when not in preview mode', () => {
it('should return item.Url when not in preview mode', () => {
const utils = getPreviewUtils({ __typename: 'TestPage' });
const result = utils.src(mockImageAsset);

expect(result).toBe('');
expect(result).toBe(
'https://assets.local-cms.com/0a2f4b27-4f15-4bb9-ba14-d69b49ae5b85/cmp_73d48db0-2abe-4a33-91f5-94d0ac5e85e5.jpg'
);
});

it('should append preview token to item URL', () => {
it('should append preview token to item.Url in preview mode', () => {
const utils = getPreviewUtils({
__typename: 'TestPage',
__context: { edit: true, preview_token: 'test-token-123' },
Expand All @@ -85,7 +87,75 @@ describe('getPreviewUtils', () => {
);
});

it('should append preview token to string URL', () => {
it('should use url.default when item.Url is null', () => {
const assetWithDefaultUrl: InferredContentReference = {
url: {
type: null,
default: 'https://example.com/default-image.jpg',
hierarchical: null,
internal: null,
graph: null,
base: null,
},
item: {
__typename: 'cmp_PublicImageAsset' as const,
Url: null,
Title: 'Test Image',
AltText: 'Test alt text',
Description: 'Test description',
Renditions: [],
FocalPoint: null,
Tags: [],
},
};

const utils = getPreviewUtils({ __typename: 'TestPage' });
const result = utils.src(assetWithDefaultUrl);

expect(result).toBe('https://example.com/default-image.jpg');
});

it('should append preview token to url.default in preview mode', () => {
const assetWithDefaultUrl: InferredContentReference = {
url: {
type: null,
default: 'https://example.com/default-image.jpg',
hierarchical: null,
internal: null,
graph: null,
base: null,
},
item: {
__typename: 'cmp_PublicImageAsset' as const,
Url: null,
Title: 'Test Image',
AltText: 'Test alt text',
Description: 'Test description',
Renditions: [],
FocalPoint: null,
Tags: [],
},
};

const utils = getPreviewUtils({
__typename: 'TestPage',
__context: { edit: true, preview_token: 'test-token-456' },
});
const result = utils.src(assetWithDefaultUrl);

expect(result).toBe(
'https://example.com/default-image.jpg?preview_token=test-token-456'
);
});

it('should handle string URL input', () => {
const utils = getPreviewUtils({ __typename: 'TestPage' });
const result = utils.src('https://example.com/image.jpg');

expect(result).toBe('https://example.com/image.jpg');
});

it('should append preview token to string URL in preview mode', () => {
const utils = getPreviewUtils({
__typename: 'TestPage',
__context: { edit: true, preview_token: 'test-token-123' },
Expand All @@ -97,12 +167,87 @@ describe('getPreviewUtils', () => {
);
});

it('should return empty string for string URL when not in preview mode', () => {
it('should return empty string for null input', () => {
const utils = getPreviewUtils({ __typename: 'TestPage' });
const result = utils.src('https://example.com/image.jpg');
const result = utils.src(null);

expect(result).toBe('');
});

it('should return empty string for undefined input', () => {
const utils = getPreviewUtils({ __typename: 'TestPage' });
const result = utils.src(undefined);

expect(result).toBe('');
});

it('should return empty string when asset has no URL', () => {
const assetWithoutUrl: InferredContentReference = {
url: {
type: null,
default: null,
hierarchical: null,
internal: null,
graph: null,
base: null,
},
item: {
__typename: 'cmp_PublicImageAsset' as const,
Url: null,
Title: 'Test Image',
AltText: 'Test alt text',
Description: 'Test description',
Renditions: [],
FocalPoint: null,
Tags: [],
},
};

const utils = getPreviewUtils({ __typename: 'TestPage' });
const result = utils.src(assetWithoutUrl);

expect(result).toBe('');
});

it('should handle URLs with existing query parameters', () => {
const utils = getPreviewUtils({
__typename: 'TestPage',
__context: { edit: true, preview_token: 'test-token-123' },
});
const result = utils.src('https://example.com/image.jpg?width=500');

expect(result).toBe(
'https://example.com/image.jpg?width=500&preview_token=test-token-123'
);
});

it('should prefer url.default over item.Url when both exist', () => {
const assetWithBothUrls: InferredContentReference = {
url: {
type: null,
default: 'https://example.com/default-url.jpg',
hierarchical: null,
internal: null,
graph: null,
base: null,
},
item: {
__typename: 'cmp_PublicImageAsset' as const,
Url: 'https://example.com/item-url.jpg',
Title: 'Test Image',
AltText: 'Test alt text',
Description: 'Test description',
Renditions: [],
FocalPoint: null,
Tags: [],
},
};

const utils = getPreviewUtils({ __typename: 'TestPage' });
const result = utils.src(assetWithBothUrls);

expect(result).toBe('https://example.com/default-url.jpg');
});
});

describe('getSrcset()', () => {
Expand Down
12 changes: 8 additions & 4 deletions packages/optimizely-cms-sdk/src/react/server.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,13 +343,17 @@ export function getPreviewUtils(opti: OptimizelyComponentProps['opti']) {
src(input: InferredContentReference | string | null | undefined): string {
const previewToken = opti.__context?.preview_token;

// if input is a ContentReference
if (typeof input === 'object' && previewToken && input?.item?.Url) {
return appendToken(input?.item?.Url, previewToken);
// if input is an object with a URL
if (typeof input === 'object' && input) {
// if dam asset is selected the default URL is in input.url.default will be null
const url = input.url?.default ?? input.item?.Url;
if (url) {
return appendToken(url, previewToken);
}
}

// if input is a string URL
if (typeof input === 'string' && previewToken) {
if (typeof input === 'string') {
return appendToken(input, previewToken);
}

Expand Down
2 changes: 1 addition & 1 deletion packages/optimizely-cms-sdk/src/util/preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* @returns The URL with the preview token appended as a query parameter.
*/
export const appendToken = (url: string, previewToken?: string): string => {
if (!previewToken) return url;
if (!previewToken || previewToken.trim() === '') return url;
const separator = url.includes('?') ? '&' : '?';
return `${url}${separator}preview_token=${previewToken}`;
};
1 change: 0 additions & 1 deletion samples/nextjs-template/src/app/globals.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,6 @@ a:hover span.animate {
.about-us .about-us-image {
position: relative;
width: 100%;
padding-top: 56.25%;
}

.about-us .about-us-image img {
Expand Down