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

TestBuild: Add tests and rename to camelCase #24911

Merged
merged 6 commits into from
Nov 20, 2023

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Nov 20, 2023

Addresses: #24890 (review) and #24890 (review)

What I did

  • change the property for normalizeStoriesEntry to camelCase.
  • extract & add tests for removeMDXEntries-functionality

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

I think the unit tests should suffice.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Comment on lines -28 to -70
const list = normalizeStories(entries, {
configDir: options.configDir,
workingDir: options.configDir,
default_files_pattern: '**/*.@(stories.@(js|jsx|mjs|ts|tsx))',
});
const result = (
await Promise.all(
list.map(async ({ directory, files, titlePrefix }) => {
const pattern = join(directory, files);
const absolutePattern = isAbsolute(pattern) ? pattern : join(options.configDir, pattern);
const absoluteDirectory = isAbsolute(directory)
? directory
: join(options.configDir, directory);

return {
files: (
await glob(slash(absolutePattern), {
...commonGlobOptions(absolutePattern),
follow: true,
})
).map((f) => relative(absoluteDirectory, f)),
directory,
titlePrefix,
};
})
)
).flatMap<StoriesEntry>((expanded, i) => {
const filteredEntries = expanded.files.filter((s) => !s.endsWith('.mdx'));
// only return the filtered entries when there is something to filter
// as webpack is faster with unexpanded globs
let items = [];
if (filteredEntries.length < expanded.files.length) {
items = filteredEntries.map((k) => ({
...expanded,
files: `**/${k}`,
}));
} else {
items = [list[i]];
}

return items;
});
return result;
Copy link
Member Author

Choose a reason for hiding this comment

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

Extracted into a separate file: code/lib/core-server/src/utils/remove-mdx-entries.ts

Comment on lines 232 to 273
test('expands to multiple entries', async () => {
const configDir = '/configDir/';
const list = createList(
[
{
entry: { files: '*.@(mdx|ts)', directory: '.', titlePrefix: 'foo' },
result: [
'/configDir/my-file.mdx',
'/configDir/my-file1.ts',
'/configDir/my-file2.ts',
'/configDir/my-file3.ts',
],
},
],
configDir
);
glob.mockImplementation(createGlobMock(list));

await expect(
removeMDXEntries(
Object.values(list).map((e) => e.entry),
{ configDir }
)
).resolves.toMatchInlineSnapshot(`
Array [
Object {
"directory": ".",
"files": "**/my-file1.ts",
"titlePrefix": "foo",
},
Object {
"directory": ".",
"files": "**/my-file2.ts",
"titlePrefix": "foo",
},
Object {
"directory": ".",
"files": "**/my-file3.ts",
"titlePrefix": "foo",
},
]
`);
Copy link
Member Author

Choose a reason for hiding this comment

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

@kasperpeulen If you wanted to improve the mechanism, by rewriting the files property to not include |mdx or mdx|; this test would break. But you can use this test to TDD that feature.

@ndelangen ndelangen merged commit 78921a5 into next Nov 20, 2023
60 checks passed
@ndelangen ndelangen deleted the norbert/testbuild-add-tests branch November 20, 2023 14:45
@github-actions github-actions bot mentioned this pull request Nov 20, 2023
36 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants