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.

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

feat: implement CSM transformation to encoded strings for GraphQL [TOL-1706] #473

Merged
merged 5 commits into from
Jan 2, 2024
Merged

feat: implement CSM transformation to encoded strings for GraphQL [TOL-1706] #473

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
709e836
feat: implement content source maps
YvesRijckaert Dec 14, 2023
cd886a7
refactor: extract types to separate file
YvesRijckaert Dec 20, 2023
d30cec3
refactor: fix dependencies and update to function
YvesRijckaert Jan 2, 2024
63357fc
feat: handling EU domain
YvesRijckaert Jan 2, 2024
81cac1e
refactor: mappings type in csm.spec.ts
YvesRijckaert Jan 2, 2024
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
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ cypress/reports
cypress.env.json
backstage_docs
vite.config.d.ts

.nx

# Logs
logs
Expand Down
3 changes: 3 additions & 0 deletions packages/live-preview-sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,14 @@
"dependencies": {
"@contentful/rich-text-types": "^16.2.0",
"@contentful/visual-sdk": "^1.0.0-alpha.34",
"@vercel/stega": "^0.1.0",
"graphql-tag": "^2.12.6",
"json-pointer": "^0.6.2",
"lodash.isequal": "^4.5.0"
},
"devDependencies": {
"@testing-library/react": "14.1.2",
"@types/json-pointer": "^1.0.34",
"@types/lodash.isequal": "^4.5.6",
"@types/node": "^20.1.0",
"@types/react": "^18.0.27",
Expand Down
365 changes: 365 additions & 0 deletions packages/live-preview-sdk/src/__tests__/csm.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,365 @@
import { describe, test, expect } from 'vitest';
import { encodeSourceMap } from '../csm';
import { vercelStegaDecode } from '@vercel/stega';

type Mappings = {
[key: string]:
| {
YvesRijckaert marked this conversation as resolved.
Show resolved Hide resolved
origin: string;
href: string;
}
| {
[nestedKey: string]: {
origin: string;
href: string;
};
}
| undefined;
};

type EncodedResponse =
| {
[key: string]: string;
}
| Array<{ [key: string]: string }>;

function testEncodingDecoding(encodedResponse: EncodedResponse, mappings: Mappings) {
if (Array.isArray(encodedResponse)) {
encodedResponse.forEach((item, index) => {
const itemMappings = mappings[index];
if (!itemMappings) {
return;
}
for (const [key, expectedValue] of Object.entries(itemMappings)) {
const encodedValue = item[key];
const decodedValue = vercelStegaDecode(encodedValue);
expect(decodedValue).toEqual(expectedValue);
}
});
} else {
for (const [key, expectedValue] of Object.entries(mappings)) {
const encodedValue = encodedResponse[key];
const decodedValue = vercelStegaDecode(encodedValue);
expect(decodedValue).toEqual(expectedValue);
}
}
}

describe('Content Source Maps', () => {
describe('GraphQL', () => {
test('basic example', () => {
const graphQLResponse = {
data: {
post: {
title: 'Title of the post',
subtitle: 'Subtitle of the post',
},
},
extensions: {
contentSourceMaps: {
version: 1.0,
spaces: ['foo'],
environments: ['master'],
fields: ['title', 'subtitle'],
locales: ['en-US'],
entries: [{ space: 0, environment: 0, id: 'a1b2c3' }],
assets: [],
mappings: {
'/post/title': {
source: {
entry: 0,
field: 0,
locale: 0,
},
},
'/post/subtitle': {
source: {
entry: 0,
field: 1,
locale: 0,
},
},
},
},
},
};
const encodedGraphQLResponse = encodeSourceMap(graphQLResponse);
testEncodingDecoding(encodedGraphQLResponse.data.post, {
title: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=title&focusedLocale=en-US',
},
subtitle: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=subtitle&focusedLocale=en-US',
},
});
});

test('handles EU domain', () => {
const graphQLResponse = {
data: {
post: {
title: 'Title of the post',
subtitle: 'Subtitle of the post',
},
},
extensions: {
contentSourceMaps: {
version: 1.0,
spaces: ['foo'],
environments: ['master'],
fields: ['title', 'subtitle'],
locales: ['en-US'],
entries: [{ space: 0, environment: 0, id: 'a1b2c3' }],
assets: [],
mappings: {
'/post/title': {
source: {
entry: 0,
field: 0,
locale: 0,
},
},
'/post/subtitle': {
source: {
entry: 0,
field: 1,
locale: 0,
},
},
},
},
},
};
const encodedGraphQLResponse = encodeSourceMap(
graphQLResponse,
'https://app.eu.contentful.com'
);
testEncodingDecoding(encodedGraphQLResponse.data.post, {
title: {
origin: 'contentful.com',
href: 'https://app.eu.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=title&focusedLocale=en-US',
},
subtitle: {
origin: 'contentful.com',
href: 'https://app.eu.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=subtitle&focusedLocale=en-US',
},
});
});

test('collections', () => {
const graphQLResponse = {
data: {
postCollection: {
items: [
{
title: 'Title of the post',
},
{
title: 'Title of the post 2',
},
{
title: 'Title of the post 3',
},
],
},
},
extensions: {
contentSourceMaps: {
version: 1.0,
spaces: ['foo'],
environments: ['master'],
fields: ['title'],
locales: ['en-US'],
entries: [
{ space: 0, environment: 0, id: 'a1b2c3' },
{ space: 0, environment: 0, id: 'd4e5f6' },
{ space: 0, environment: 0, id: 'g7h8i9' },
],
assets: [],
mappings: {
'/postCollection/items/0/title': {
source: {
entry: 0,
field: 0,
locale: 0,
},
},
'/postCollection/items/1/title': {
source: {
entry: 1,
field: 0,
locale: 0,
},
},
'/postCollection/items/2/title': {
source: {
entry: 2,
field: 0,
locale: 0,
},
},
},
},
},
};
const encodedGraphQLResponse = encodeSourceMap(graphQLResponse);
testEncodingDecoding(encodedGraphQLResponse.data.postCollection.items, {
0: {
title: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=title&focusedLocale=en-US',
},
},
1: {
title: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/d4e5f6/?focusedField=title&focusedLocale=en-US',
},
},
2: {
title: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/g7h8i9/?focusedField=title&focusedLocale=en-US',
},
},
});
});

test('aliasing with multiple locales', () => {
const graphQLResponse = {
data: {
postCollection: {
items: [
{
akanTitle: 'Lorem',
aghemTitle: 'Ipsum',
spanishTitle: 'Dolor',
},
],
},
},
extensions: {
contentSourceMaps: {
version: 1.0,
spaces: ['foo'],
environments: ['master'],
fields: ['title'],
locales: ['ak', 'agq', 'es'],
entries: [{ space: 0, environment: 0, id: 'a1b2c3' }],
assets: [],
mappings: {
'/postCollection/items/0/akanTitle': {
source: {
entry: 0,
field: 0,
locale: 0,
},
},
'/postCollection/items/0/aghemTitle': {
source: {
entry: 0,
field: 0,
locale: 1,
},
},
'/postCollection/items/0/spanishTitle': {
source: {
entry: 0,
field: 0,
locale: 2,
},
},
},
},
},
};
const encodedGraphQLResponse = encodeSourceMap(graphQLResponse);
testEncodingDecoding(encodedGraphQLResponse.data.postCollection.items[0], {
akanTitle: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=title&focusedLocale=ak',
},
aghemTitle: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=title&focusedLocale=agq',
},
spanishTitle: {
origin: 'contentful.com',
href: 'https://app.contentful.com/spaces/foo/environments/master/entries/a1b2c3/?focusedField=title&focusedLocale=es',
},
});
});

test('does not encode dates', () => {
const graphQLResponse = {
data: {
post: {
date: '2023-12-13T00:00:00.000+01:00',
},
},
extensions: {
contentSourceMaps: {
version: 1.0,
spaces: ['foo'],
environments: ['master'],
fields: ['date'],
locales: ['en-US'],
entries: [{ space: 0, environment: 0, id: 'a1b2c3' }],
assets: [],
mappings: {
'/post/date': {
source: {
entry: 0,
field: 0,
locale: 0,
},
},
},
},
},
};
const encodedGraphQLResponse = encodeSourceMap(graphQLResponse);

testEncodingDecoding(encodedGraphQLResponse.data.post, {
date: undefined,
});
});

test('does not encode URLs', () => {
const graphQLResponse = {
data: {
post: {
url: 'https://test.com',
},
},
extensions: {
contentSourceMaps: {
version: 1.0,
spaces: ['foo'],
environments: ['master'],
fields: ['url'],
locales: ['en-US'],
entries: [{ space: 0, environment: 0, id: 'a1b2c3' }],
assets: [],
mappings: {
'/post/url': {
source: {
entry: 0,
field: 0,
locale: 0,
},
},
},
},
},
};
const encodedGraphQLResponse = encodeSourceMap(graphQLResponse);

testEncodingDecoding(encodedGraphQLResponse.data.post, {
url: undefined,
});
});
});
});
Loading