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

Fix lint warnings in PreviewWeb tests #18369

Merged
merged 2 commits into from May 31, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 22 additions & 11 deletions lib/preview-web/src/Preview.tsx
@@ -1,7 +1,18 @@
import dedent from 'ts-dedent';
import global from 'global';
import { SynchronousPromise } from 'synchronous-promise';
import Events from '@storybook/core-events';
import {
CONFIG_ERROR,
FORCE_REMOUNT,
FORCE_RE_RENDER,
GLOBALS_UPDATED,
RESET_STORY_ARGS,
SET_GLOBALS,
STORY_ARGS_UPDATED,
STORY_INDEX_INVALIDATED,
UPDATE_GLOBALS,
UPDATE_STORY_ARGS,
} from '@storybook/core-events';
import { logger } from '@storybook/client-logger';
import { addons, Channel } from '@storybook/addons';
import { AnyFramework, StoryId, ProjectAnnotations, Args, Globals } from '@storybook/csf';
Expand Down Expand Up @@ -80,13 +91,13 @@ export class Preview<TFramework extends AnyFramework> {
}

setupListeners() {
this.serverChannel?.on(Events.STORY_INDEX_INVALIDATED, this.onStoryIndexChanged.bind(this));
this.serverChannel?.on(STORY_INDEX_INVALIDATED, this.onStoryIndexChanged.bind(this));

this.channel.on(Events.UPDATE_GLOBALS, this.onUpdateGlobals.bind(this));
this.channel.on(Events.UPDATE_STORY_ARGS, this.onUpdateArgs.bind(this));
this.channel.on(Events.RESET_STORY_ARGS, this.onResetArgs.bind(this));
this.channel.on(Events.FORCE_RE_RENDER, this.onForceReRender.bind(this));
this.channel.on(Events.FORCE_REMOUNT, this.onForceRemount.bind(this));
this.channel.on(UPDATE_GLOBALS, this.onUpdateGlobals.bind(this));
this.channel.on(UPDATE_STORY_ARGS, this.onUpdateArgs.bind(this));
this.channel.on(RESET_STORY_ARGS, this.onResetArgs.bind(this));
this.channel.on(FORCE_RE_RENDER, this.onForceReRender.bind(this));
this.channel.on(FORCE_REMOUNT, this.onForceRemount.bind(this));
}

getProjectAnnotationsOrRenderError(
Expand Down Expand Up @@ -144,7 +155,7 @@ export class Preview<TFramework extends AnyFramework> {
}

emitGlobals() {
this.channel.emit(Events.SET_GLOBALS, {
this.channel.emit(SET_GLOBALS, {
globals: this.storyStore.globals.get() || {},
globalTypes: this.storyStore.projectAnnotations.globalTypes || {},
});
Expand Down Expand Up @@ -227,7 +238,7 @@ export class Preview<TFramework extends AnyFramework> {

await Promise.all(this.storyRenders.map((r) => r.rerender()));

this.channel.emit(Events.GLOBALS_UPDATED, {
this.channel.emit(GLOBALS_UPDATED, {
globals: this.storyStore.globals.get(),
initialGlobals: this.storyStore.globals.initialGlobals,
});
Expand All @@ -238,7 +249,7 @@ export class Preview<TFramework extends AnyFramework> {

await Promise.all(this.storyRenders.filter((r) => r.id === storyId).map((r) => r.rerender()));

this.channel.emit(Events.STORY_ARGS_UPDATED, {
this.channel.emit(STORY_ARGS_UPDATED, {
storyId,
args: this.storyStore.args.get(storyId),
});
Expand Down Expand Up @@ -344,6 +355,6 @@ export class Preview<TFramework extends AnyFramework> {
this.previewEntryError = err;
logger.error(reason);
logger.error(err);
this.channel.emit(Events.CONFIG_ERROR, err);
this.channel.emit(CONFIG_ERROR, err);
}
}
5 changes: 3 additions & 2 deletions lib/preview-web/src/PreviewWeb.integration.test.ts
Expand Up @@ -76,8 +76,9 @@ describe('PreviewWeb', () => {
const preview = new PreviewWeb();

const docsRoot = window.document.createElement('div');
// @ts-ignore
preview.view.prepareForDocs.mockReturnValue(docsRoot);
(
preview.view.prepareForDocs as any as jest.Mock<typeof preview.view.prepareForDocs>
).mockReturnValue(docsRoot);
componentOneExports.default.parameters.docs.container.mockImplementationOnce(() =>
React.createElement('div', {}, 'INSIDE')
);
Expand Down
21 changes: 14 additions & 7 deletions lib/preview-web/src/PreviewWeb.mockdata.ts
@@ -1,5 +1,12 @@
import { EventEmitter } from 'events';
import Events from '@storybook/core-events';
import {
DOCS_RENDERED,
STORY_ERRORED,
STORY_MISSING,
STORY_RENDERED,
STORY_RENDER_PHASE_CHANGED,
STORY_THREW_EXCEPTION,
} from '@storybook/core-events';
import { StoryIndex } from '@storybook/store';
import { RenderPhase } from './PreviewWeb';

Expand Down Expand Up @@ -99,15 +106,15 @@ export const waitForEvents = (
// the async parts, so we need to listen for the "done" events
export const waitForRender = () =>
waitForEvents([
Events.STORY_RENDERED,
Events.DOCS_RENDERED,
Events.STORY_THREW_EXCEPTION,
Events.STORY_ERRORED,
Events.STORY_MISSING,
STORY_RENDERED,
DOCS_RENDERED,
STORY_THREW_EXCEPTION,
STORY_ERRORED,
STORY_MISSING,
]);

export const waitForRenderPhase = (phase: RenderPhase) =>
waitForEvents([Events.STORY_RENDER_PHASE_CHANGED], ({ newPhase }) => newPhase === phase);
waitForEvents([STORY_RENDER_PHASE_CHANGED], ({ newPhase }) => newPhase === phase);

// A little trick to ensure that we always call the real `setTimeout` even when timers are mocked
const realSetTimeout = setTimeout;
Expand Down