From 22e5c536be83f1bb2d334a15370f7a0ffafdb397 Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Mon, 4 Oct 2021 13:47:33 +0800 Subject: [PATCH 1/2] Core: Support composing stories in both v6 and v7 modes --- lib/api/src/modules/refs.ts | 33 ++++++++++++++++-------- lib/api/src/modules/stories.ts | 14 +++++++---- lib/api/src/tests/refs.test.js | 42 ++++++++++++++++++++++++++++--- lib/api/src/tests/stories.test.js | 33 ++++++++++++++++++++++++ 4 files changed, 104 insertions(+), 18 deletions(-) diff --git a/lib/api/src/modules/refs.ts b/lib/api/src/modules/refs.ts index 12d11de96fa..8c3f133d0df 100644 --- a/lib/api/src/modules/refs.ts +++ b/lib/api/src/modules/refs.ts @@ -5,9 +5,11 @@ import { StoriesRaw, StoryInput, StoriesHash, + transformStoryIndexToStoriesHash, + StoryIndexStory, } from '../lib/stories'; -import { ModuleFn } from '../index'; +import { ModuleFn, StoryId } from '../index'; const { location, fetch } = global; @@ -19,6 +21,7 @@ type Versions = Record; export type SetRefData = Partial< Omit & { + v: number; stories?: StoriesRaw; } >; @@ -148,7 +151,7 @@ export const init: ModuleFn = ({ store, provider, singleStory }, { runCheck = tr // // then we fetch metadata if the above fetch succeeded - const loadedData: { error?: Error; stories?: StoriesRaw; loginUrl?: string } = {}; + const loadedData: { error?: Error; v?: number; stories?: StoriesRaw; loginUrl?: string } = {}; const query = version ? `?version=${version}` : ''; const credentials = isPublic ? 'omit' : 'include'; @@ -209,18 +212,28 @@ export const init: ModuleFn = ({ store, provider, singleStory }, { runCheck = tr return refs; }, - setRef: (id, { stories, ...rest }, ready = false) => { + setRef: (id, { stories, v, ...rest }, ready = false) => { if (singleStory) return; const { storyMapper = defaultStoryMapper } = provider.getConfig(); const ref = api.getRefs()[id]; - const after = stories - ? addRefIds( - transformStoriesRawToStoriesHash(map(stories, ref, { storyMapper }), { provider }), - ref - ) - : undefined; - api.updateRef(id, { stories: after, ...rest, ready }); + let storiesHash: StoriesHash; + + if (stories) { + if (v === 2) { + storiesHash = transformStoriesRawToStoriesHash(map(stories, ref, { storyMapper }), { + provider, + }); + } else if (v === 3) { + const index = (stories as unknown) as Record; + storiesHash = transformStoryIndexToStoriesHash({ v, stories: index }, { provider }); + } else { + throw new Error(`Composition: Unknown stories.json version: ${v}`); + } + storiesHash = addRefIds(storiesHash, ref); + } + + api.updateRef(id, { stories: storiesHash, ...rest, ready }); }, updateRef: (id, data) => { diff --git a/lib/api/src/modules/stories.ts b/lib/api/src/modules/stories.ts index 80ba2750c38..1e860ee9ac4 100644 --- a/lib/api/src/modules/stories.ts +++ b/lib/api/src/modules/stories.ts @@ -480,11 +480,15 @@ export const init: ModuleFn = ({ const { ref } = getEventMetadata(this, fullAPI); fullAPI.updateStory(id, { ...update, prepared: true }, ref); - if (!store.getState().hasCalledSetOptions) { - const { options } = update.parameters; - checkDeprecatedOptionParameters(options); - fullAPI.setOptions(options); - store.setState({ hasCalledSetOptions: true }); + if (!ref) { + if (!store.getState().hasCalledSetOptions) { + const { options } = update.parameters; + checkDeprecatedOptionParameters(options); + fullAPI.setOptions(options); + store.setState({ hasCalledSetOptions: true }); + } + } else { + fullAPI.updateRef(ref.id, { ready: true }); } }); diff --git a/lib/api/src/tests/refs.test.js b/lib/api/src/tests/refs.test.js index 28e499f86d9..b39cc2fb80b 100644 --- a/lib/api/src/tests/refs.test.js +++ b/lib/api/src/tests/refs.test.js @@ -260,11 +260,11 @@ describe('Refs API', () => { setupResponses( { ok: true, - response: async () => ({ stories: {} }), + response: async () => ({ v: 2, stories: {} }), }, { ok: true, - response: async () => ({ stories: {} }), + response: async () => ({ v: 3, stories: {} }), }, { ok: true, @@ -418,7 +418,7 @@ describe('Refs API', () => { }, { ok: true, - response: async () => ({ stories: {} }), + response: async () => ({ v: 2, stories: {} }), }, { ok: true, @@ -621,4 +621,40 @@ describe('Refs API', () => { `); }); }); + + it('errors on unknown version', async () => { + // given + const { api } = initRefs({ provider, store }, { runCheck: false }); + + setupResponses( + { + ok: true, + response: async () => ({ v: 2, stories: {} }), + }, + { + ok: true, + response: async () => ({ v: 4, stories: {} }), + }, + { + ok: true, + response: async () => { + throw new Error('not ok'); + }, + }, + { + ok: true, + response: async () => ({ + versions: {}, + }), + } + ); + + await expect( + api.checkRef({ + id: 'fake', + url: 'https://example.com', + title: 'Fake', + }) + ).rejects.toThrow('Composition: Unknown stories.json version: 4'); + }); }); diff --git a/lib/api/src/tests/stories.test.js b/lib/api/src/tests/stories.test.js index e7e0be7dacc..ed444f0f028 100644 --- a/lib/api/src/tests/stories.test.js +++ b/lib/api/src/tests/stories.test.js @@ -999,6 +999,7 @@ describe('stories API', () => { args: { c: 'd' }, }); }); + it('sets options the first time it is called', async () => { const navigate = jest.fn(); const store = createMockStore(); @@ -1026,6 +1027,38 @@ describe('stories API', () => { expect(fullAPI.setOptions).not.toHaveBeenCalled(); }); + + it('sets the ref to ready when it is an external story', async () => { + const navigate = jest.fn(); + const store = createMockStore(); + const fullAPI = Object.assign(new EventEmitter(), { + setStories: jest.fn(), + updateRef: jest.fn(), + }); + + const { api, init } = initStories({ store, navigate, provider, fullAPI }); + Object.assign(fullAPI, api); + + getEventMetadata.mockReturnValueOnce({ + sourceType: 'external', + ref: { id: 'refId', stories: { 'a--1': { args: { a: 'b' } } } }, + }); + await init(); + + fullAPI.emit(STORY_PREPARED, { + id: 'a--1', + }); + + expect(fullAPI.updateRef.mock.calls.length).toBe(2); + + expect(fullAPI.updateRef.mock.calls[0][1]).toEqual({ + stories: { 'a--1': { args: { a: 'b' }, prepared: true } }, + }); + + expect(fullAPI.updateRef.mock.calls[1][1]).toEqual({ + ready: true, + }); + }); }); describe('v2 SET_STORIES event', () => { From 202cb516166221ead6d97311f7e2ce4ab39f9532 Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Mon, 4 Oct 2021 22:19:49 +0800 Subject: [PATCH 2/2] Accept later versions of stories.json --- lib/api/src/modules/refs.ts | 6 +++--- lib/api/src/tests/refs.test.js | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/api/src/modules/refs.ts b/lib/api/src/modules/refs.ts index 8c3f133d0df..834e47112fb 100644 --- a/lib/api/src/modules/refs.ts +++ b/lib/api/src/modules/refs.ts @@ -224,11 +224,11 @@ export const init: ModuleFn = ({ store, provider, singleStory }, { runCheck = tr storiesHash = transformStoriesRawToStoriesHash(map(stories, ref, { storyMapper }), { provider, }); - } else if (v === 3) { + } else if (!v) { + throw new Error('Composition: Missing stories.json version'); + } else { const index = (stories as unknown) as Record; storiesHash = transformStoryIndexToStoriesHash({ v, stories: index }, { provider }); - } else { - throw new Error(`Composition: Unknown stories.json version: ${v}`); } storiesHash = addRefIds(storiesHash, ref); } diff --git a/lib/api/src/tests/refs.test.js b/lib/api/src/tests/refs.test.js index b39cc2fb80b..d4ff404ab5b 100644 --- a/lib/api/src/tests/refs.test.js +++ b/lib/api/src/tests/refs.test.js @@ -633,7 +633,7 @@ describe('Refs API', () => { }, { ok: true, - response: async () => ({ v: 4, stories: {} }), + response: async () => ({ stories: {} }), }, { ok: true, @@ -655,6 +655,6 @@ describe('Refs API', () => { url: 'https://example.com', title: 'Fake', }) - ).rejects.toThrow('Composition: Unknown stories.json version: 4'); + ).rejects.toThrow('Composition: Missing stories.json version'); }); });