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

Core: Fix build-storybook sort bug in v6-mode #16724

Merged
merged 2 commits into from
Nov 19, 2021
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions lib/core-server/src/build-static.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ export async function buildStaticStandalone(options: CLIOptions & LoadOptions &
await extractStoriesJson(path.join(options.outputDir, 'stories.json'), stories, {
...directories,
storiesV2Compatibility: !features?.breakingChangesV7 && !features?.storyStoreV7,
storyStoreV7: features?.storyStoreV7,
});
}

Expand Down
1 change: 1 addition & 0 deletions lib/core-server/src/utils/StoryIndexGenerator.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const options = {
configDir: path.join(__dirname, '__mockdata__'),
workingDir: path.join(__dirname, '__mockdata__'),
storiesV2Compatibility: false,
storyStoreV7: true,
};

describe('StoryIndexGenerator', () => {
Expand Down
30 changes: 15 additions & 15 deletions lib/core-server/src/utils/StoryIndexGenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,6 @@ import { logger } from '@storybook/node-logger';
import { readCsfOrMdx, getStorySortParameter } from '@storybook/csf-tools';
import { ComponentTitle } from '@storybook/csf';

function sortExtractedStories(
stories: StoryIndex['stories'],
storySortParameter: any,
fileNameOrder: string[]
) {
const sortableStories = Object.values(stories);
sortStoriesV7(sortableStories, storySortParameter, fileNameOrder);
return sortableStories.reduce((acc, item) => {
acc[item.id] = item;
return acc;
}, {} as StoryIndex['stories']);
}

type SpecifierStoriesCache = Record<Path, StoryIndex['stories'] | false>;

export class StoryIndexGenerator {
Expand All @@ -47,6 +34,7 @@ export class StoryIndexGenerator {
workingDir: Path;
configDir: Path;
storiesV2Compatibility: boolean;
storyStoreV7: boolean;
}
) {
this.storyIndexEntries = new Map();
Expand Down Expand Up @@ -132,8 +120,20 @@ export class StoryIndexGenerator {
Object.assign(stories, subStories);
});

const storySortParameter = await this.getStorySortParameter();
return sortExtractedStories(stories, storySortParameter, this.storyFileNames());
const sortableStories = Object.values(stories);

// Skip sorting if we're in v6 mode because we don't have
// all the info we need here
if (this.options.storyStoreV7) {
const storySortParameter = await this.getStorySortParameter();
const fileNameOrder = this.storyFileNames();
sortStoriesV7(sortableStories, storySortParameter, fileNameOrder);
}

return sortableStories.reduce((acc, item) => {
acc[item.id] = item;
return acc;
}, {} as StoryIndex['stories']);
}

async getIndex() {
Expand Down
8 changes: 7 additions & 1 deletion lib/core-server/src/utils/stories-json.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ export const DEBOUNCE = 100;
export async function extractStoriesJson(
outputFile: string,
normalizedStories: NormalizedStoriesSpecifier[],
options: { configDir: string; workingDir: string; storiesV2Compatibility: boolean }
options: {
configDir: string;
workingDir: string;
storiesV2Compatibility: boolean;
storyStoreV7: boolean;
}
) {
const generator = new StoryIndexGenerator(normalizedStories, options);
await generator.initialize();
Expand All @@ -42,6 +47,7 @@ export async function useStoriesJson(
configDir: options.configDir,
workingDir,
storiesV2Compatibility: !features?.breakingChangesV7 && !features?.storyStoreV7,
storyStoreV7: features?.storyStoreV7,
});

// Wait until someone actually requests `stories.json` before we start generating/watching.
Expand Down
38 changes: 23 additions & 15 deletions lib/store/src/sortStories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Comparator, StorySortParameter, StorySortParameterV7 } from '@storybook
import { storySort } from './storySort';
import { Story, StoryIndexEntry, Path, Parameters } from './types';

export const sortStoriesV7 = (
const sortStoriesCommon = (
stories: StoryIndexEntry[],
storySortParameter: StorySortParameterV7,
fileNameOrder: Path[]
Expand All @@ -16,19 +16,7 @@ export const sortStoriesV7 = (
} else {
sortFn = storySort(storySortParameter);
}
try {
stable.inplace(stories, sortFn);
} catch (err) {
throw new Error(dedent`
Error sorting stories with sort parameter ${storySortParameter}:

> ${err.message}

Are you using a V6-style sort function in V7 mode?

More info: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#v7-style-story-sort
`);
}
stable.inplace(stories, sortFn);
} else {
stable.inplace(
stories,
Expand All @@ -38,6 +26,26 @@ export const sortStoriesV7 = (
return stories;
};

export const sortStoriesV7 = (
stories: StoryIndexEntry[],
storySortParameter: StorySortParameterV7,
fileNameOrder: Path[]
) => {
try {
return sortStoriesCommon(stories, storySortParameter, fileNameOrder);
} catch (err) {
throw new Error(dedent`
Error sorting stories with sort parameter ${storySortParameter}:

> ${err.message}

Are you using a V6-style sort function in V7 mode?

More info: https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#v7-style-story-sort
`);
}
};

const toIndexEntry = (story: any): StoryIndexEntry => {
const { id, title, name, parameters } = story;
return { id, title, name, importPath: parameters.fileName };
Expand All @@ -54,5 +62,5 @@ export const sortStoriesV6 = (
}

const storiesV7 = stories.map((s) => toIndexEntry(s[1]));
return sortStoriesV7(storiesV7, storySortParameter as StorySortParameterV7, fileNameOrder);
return sortStoriesCommon(storiesV7, storySortParameter as StorySortParameterV7, fileNameOrder);
};