chore: Upgrade test runner (#18794)

PostHog · Nov 22, 2023 · d65a775 · d65a775
1 parent 5b44c3b
commit d65a775
Show file tree

Hide file tree

Showing 26 changed files with 762 additions and 789 deletions.
diff --git a/.github/workflows/storybook-chromatic.yml b/.github/workflows/storybook-chromatic.yml
@@ -144,6 +144,7 @@ jobs:
                   HOME: /root
                   # Update snapshots for PRs on the main repo, verify on forks, which don't have access to PostHog Bot
                   VARIANT: ${{ github.event.pull_request.head.repo.full_name == github.repository && 'update' || 'verify' }}
+                  STORYBOOK_SKIP_TAGS: 'test-skip,test-skip-${{ matrix.browser }}'
               run: |
                   pnpm test:visual-regression:stories:ci:$VARIANT --browsers ${{ matrix.browser }} --shard ${{ matrix.shard }}/$SHARD_COUNT
 

diff --git a/.storybook/decorators/withSnapshotsDisabled.tsx b/.storybook/decorators/withSnapshotsDisabled.tsx
diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx
@@ -8,7 +8,6 @@ import { getStorybookAppContext } from './app-context'
 import { withKea } from './decorators/withKea'
 import { withMockDate } from './decorators/withMockDate'
 import { defaultMocks } from '~/mocks/handlers'
-import { withSnapshotsDisabled } from './decorators/withSnapshotsDisabled'
 import { withFeatureFlags } from './decorators/withFeatureFlags'
 import { withTheme } from './decorators/withTheme'
 
@@ -79,7 +78,6 @@ export const parameters: Parameters = {
 
 // Setup storybook global decorators. See https://storybook.js.org/docs/react/writing-stories/decorators#global-decorators
 export const decorators: Meta['decorators'] = [
-    withSnapshotsDisabled,
     // Make sure the msw service worker is started, and reset the handlers to defaults.
     withKea,
     // Allow us to time travel to ensure our stories don't change over time.

diff --git a/.storybook/test-runner.ts b/.storybook/test-runner.ts
@@ -13,11 +13,6 @@ declare module '@storybook/types' {
         options?: any
         layout?: 'padded' | 'fullscreen' | 'centered'
         testOptions?: {
-            /**
-             * Whether the test should be a no-op (doesn't jest.skip as @storybook/test-runner doesn't allow that).
-             * @default false
-             */
-            skip?: boolean
             /**
              * Whether we should wait for all loading indicators to disappear before taking a snapshot.
              * @default true
@@ -71,19 +66,20 @@ module.exports = {
         jest.retryTimes(RETRY_TIMES, { logErrorsBeforeRetry: true })
         jest.setTimeout(JEST_TIMEOUT_MS)
     },
-    async postRender(page, context) {
+    async postVisit(page, context) {
         const browserContext = page.context()
         const storyContext = (await getStoryContext(page, context)) as StoryContext
-        const { skip = false, snapshotBrowsers = ['chromium'] } = storyContext.parameters?.testOptions ?? {}
+        const { snapshotBrowsers = ['chromium'] } = storyContext.parameters?.testOptions ?? {}
 
         browserContext.setDefaultTimeout(PLAYWRIGHT_TIMEOUT_MS)
-        if (!skip) {
-            const currentBrowser = browserContext.browser()!.browserType().name() as SupportedBrowserName
-            if (snapshotBrowsers.includes(currentBrowser)) {
-                await expectStoryToMatchSnapshot(page, context, storyContext, currentBrowser)
-            }
+        const currentBrowser = browserContext.browser()!.browserType().name() as SupportedBrowserName
+        if (snapshotBrowsers.includes(currentBrowser)) {
+            await expectStoryToMatchSnapshot(page, context, storyContext, currentBrowser)
         }
     },
+    tags: {
+        skip: ['test-skip'], // NOTE: This is overridden by the CI action storybook-chromatic.yml to include browser specific skipping
+    },
 } as TestRunnerConfig
 
 async function expectStoryToMatchSnapshot(

diff --git a/frontend/__snapshots__/scenes-app-notebooks--recordings-playlist.png b/frontend/__snapshots__/scenes-app-notebooks--recordings-playlist.png
diff --git a/frontend/src/lib/components/ActivityLog/ActivityLog.stories.tsx b/frontend/src/lib/components/ActivityLog/ActivityLog.stories.tsx
@@ -12,7 +12,7 @@ import { mswDecorator } from '~/mocks/browser'
 const meta: Meta<typeof ActivityLog> = {
     title: 'Components/ActivityLog',
     component: ActivityLog,
-    parameters: { testOptions: { skip: true } }, // FIXME: Currently disabled as the Timeout story is flaky
+    tags: ['test-skip'], // FIXME: Currently disabled as the Timeout story is flaky
     decorators: [
         mswDecorator({
             get: {

diff --git a/frontend/src/lib/components/Animation/Animation.stories.tsx b/frontend/src/lib/components/Animation/Animation.stories.tsx
@@ -12,7 +12,6 @@ const meta: Meta<typeof Animation> = {
                     'Animations are [LottieFiles.com](https://lottiefiles.com/) animations that we load asynchronously.',
             },
         },
-        testOptions: { skip: true }, // Animations aren't particularly snapshotable
     },
     argTypes: {
         size: {
@@ -25,7 +24,7 @@ const meta: Meta<typeof Animation> = {
             control: { type: 'radio' },
         },
     },
-    tags: ['autodocs'],
+    tags: ['autodocs', 'test-skip'], // Animations aren't particularly snapshotable
 }
 export default meta
 

diff --git a/frontend/src/lib/components/HedgehogBuddy/HedgehogBuddy.stories.tsx b/frontend/src/lib/components/HedgehogBuddy/HedgehogBuddy.stories.tsx
@@ -5,9 +5,7 @@ import { HedgehogBuddy } from './HedgehogBuddy'
 const meta: Meta<typeof HedgehogBuddy> = {
     title: 'Components/Hedgehog Buddy',
     component: HedgehogBuddy,
-    parameters: {
-        testOptions: { skip: true }, // Hedgehogs aren't particularly snapshotable
-    },
+    tags: ['test-skip'], // Hedgehogs aren't particularly snapshotable
 }
 export default meta
 

diff --git a/frontend/src/lib/components/Map/Map.stories.tsx b/frontend/src/lib/components/Map/Map.stories.tsx
@@ -7,18 +7,13 @@ const coordinates: [number, number] = [0.119167, 52.205276]
 const meta: Meta<typeof Map> = {
     title: 'Components/Map',
     component: Map,
-    tags: ['autodocs'],
+    tags: ['autodocs', 'test-skip'],
     // :TRICKY: We can't use markers in Storybook stories, as the Marker class is
     // not JSON-serializable (circular structure).
     args: {
         center: coordinates,
         className: 'h-60',
     },
-    parameters: {
-        testOptions: {
-            skip: true,
-        },
-    },
 }
 type Story = StoryObj<typeof Map>
 

diff --git a/frontend/src/lib/components/PropertyFilters/PropertyFilters.stories.tsx b/frontend/src/lib/components/PropertyFilters/PropertyFilters.stories.tsx
@@ -2,6 +2,7 @@ import { Meta } from '@storybook/react'
 import PropertyFiltersDisplay from 'lib/components/PropertyFilters/components/PropertyFiltersDisplay'
 import { PropertyFilters } from 'lib/components/PropertyFilters/PropertyFilters'
 
+import { useStorybookMocks } from '~/mocks/browser'
 import { AnyPropertyFilter, PropertyOperator } from '~/types'
 
 const meta: Meta<typeof PropertyFilters> = {
@@ -32,6 +33,11 @@ const propertyFilters = [
 ] as AnyPropertyFilter[]
 
 export function ComparingPropertyFilters(): JSX.Element {
+    useStorybookMocks({
+        get: {
+            '/api/event/values/': [],
+        },
+    })
     return (
         <>
             <h1>Pop-over enabled</h1>

diff --git a/frontend/src/lib/components/PropertyGroupFilters/PropertyGroupFilters.stories.tsx b/frontend/src/lib/components/PropertyGroupFilters/PropertyGroupFilters.stories.tsx
@@ -2,6 +2,7 @@ import { Meta } from '@storybook/react'
 import { useMountedLogic } from 'kea'
 import { useState } from 'react'
 
+import { useStorybookMocks } from '~/mocks/browser'
 import { cohortsModel } from '~/models/cohortsModel'
 import { AnyPropertyFilter, FilterLogicalOperator, FilterType, PropertyGroupFilter, PropertyOperator } from '~/types'
 
@@ -38,6 +39,11 @@ const taxonomicGroupTypes = [
 ]
 
 export function GroupPropertyFilters(): JSX.Element {
+    useStorybookMocks({
+        get: {
+            '/api/event/values/': [],
+        },
+    })
     useMountedLogic(cohortsModel)
 
     const [propertyGroupFilter, setPropertyGroupFilter] = useState<PropertyGroupFilter>({

diff --git a/frontend/src/lib/components/PropertyIcon.stories.tsx b/frontend/src/lib/components/PropertyIcon.stories.tsx
@@ -7,10 +7,7 @@ type Story = StoryObj<typeof PropertyIcon>
 const meta: Meta<typeof PropertyIcon> = {
     title: 'Lemon UI/Icons/Property Icon',
     component: PropertyIcon,
-    parameters: {
-        testOptions: { skip: true }, // There are too many icons, the snapshots are huge in table form
-    },
-    tags: ['autodocs'],
+    tags: ['autodocs', 'test-skip'], // There are too many icons, the snapshots are huge in table form
 }
 export default meta
 

diff --git a/frontend/src/lib/components/hedgehogs.stories.tsx b/frontend/src/lib/components/hedgehogs.stories.tsx
@@ -15,8 +15,8 @@ const allHedgehogs: HedgehogDefinition[] = Object.entries(hedgehogs).map(([key,
 
 const meta: Meta = {
     title: 'Lemon UI/Hog illustrations',
+    tags: ['test-skip', 'autodocs'], // Not valuable to take snapshots of these hedgehogs
     parameters: {
-        testOptions: { skip: true }, // Not valuable to take snapshots of these hedgehogs
         docs: {
             description: {
                 component: `
@@ -38,7 +38,6 @@ she will get to it dependant on work load.
             },
         },
     },
-    tags: ['autodocs'],
 }
 export default meta
 export function Library(): JSX.Element {

diff --git a/frontend/src/lib/lemon-ui/Popover/Popover.stories.tsx b/frontend/src/lib/lemon-ui/Popover/Popover.stories.tsx
@@ -7,12 +7,7 @@ type Story = StoryObj<typeof Popover>
 const meta: Meta<typeof Popover> = {
     title: 'Lemon UI/Popover',
     component: Popover,
-    parameters: {
-        testOptions: {
-            skip: true, // FIXME: This story needs a play test for the popup to show up in snapshots
-        },
-    },
-    tags: ['autodocs'],
+    tags: ['autodocs', 'test-skip'], // FIXME: This story needs a play test for the popup to show up in snapshots
 }
 export default meta
 

diff --git a/frontend/src/lib/lemon-ui/icons/icons.stories.tsx b/frontend/src/lib/lemon-ui/icons/icons.stories.tsx
@@ -105,7 +105,7 @@ const LibraryTemplate: StoryFn<{ letter?: string | null }> = ({ letter }) => {
 
 // This is for actual Storybook users
 export const Library: LibraryType = LibraryTemplate.bind({})
-Library.parameters = { testOptions: { skip: true } }
+Library.tags = ['autodocs', 'test-skip']
 
 // These are just for snapshots. As opposed to the full library, the stories below are segmented by the first letter
 // of the icon name, which greatly optimizes both the UX and storage aspects of diffing snapshots.

diff --git a/frontend/src/lib/utils/eventUsageLogic.ts b/frontend/src/lib/utils/eventUsageLogic.ts
@@ -173,9 +173,10 @@ function sanitizeFilterParams(filters: AnyPartialFilterType): Record<string, any
     const used_cohort_filter_ids = usedCohortFilterIds(filters.properties)
 
     for (const entity of entities) {
-        properties_local = properties_local.concat(flattenProperties(entity.properties || []))
+        const entityProperties = Array.isArray(entity.properties) ? entity.properties : []
+        properties_local = properties_local.concat(flattenProperties(entityProperties))
 
-        using_groups = using_groups || hasGroupProperties(entity.properties || [])
+        using_groups = using_groups || hasGroupProperties(entityProperties)
         if (entity.math_group_type_index != undefined) {
             aggregating_by_groups = true
         }

diff --git a/frontend/src/queries/nodes/DataNode/DataNode.stories.tsx b/frontend/src/queries/nodes/DataNode/DataNode.stories.tsx
@@ -11,10 +11,10 @@ type Story = StoryObj<typeof Query>
 const meta: Meta<typeof Query> = {
     title: 'Queries/DataNode',
     component: Query,
+    tags: ['test-skip'],
     parameters: {
         layout: 'fullscreen',
         viewMode: 'story',
-        testOptions: { skip: true },
     },
     decorators: [
         mswDecorator({

diff --git a/frontend/src/queries/nodes/DataTable/DataTable.stories.tsx b/frontend/src/queries/nodes/DataTable/DataTable.stories.tsx
@@ -11,10 +11,10 @@ type Story = StoryObj<typeof Query>
 const meta: Meta<typeof Query> = {
     title: 'Queries/DataTable',
     component: Query,
+    tags: ['test-skip'],
     parameters: {
         layout: 'fullscreen',
         viewMode: 'story',
-        testOptions: { skip: true },
     },
     decorators: [
         mswDecorator({

diff --git a/frontend/src/scenes/feedback/Feedback.stories.tsx b/frontend/src/scenes/feedback/Feedback.stories.tsx
@@ -12,11 +12,11 @@ import { userInterviewSchedulerLogic } from './userInterviewSchedulerLogic'
 
 const meta: Meta = {
     title: 'Scenes-App/Feedback',
+    tags: ['test-skip'], // FIXME: Use mockdate in this story
     parameters: {
         layout: 'fullscreen',
         testOptions: {
             excludeNavigationFromSnapshot: true,
-            skip: true, // FIXME: Use mockdate in this story
         },
         viewMode: 'story',
         // Might need to add a mockdate here, however when I do it breaks the page

diff --git a/frontend/src/scenes/insights/EmptyStates/EmptyStates.stories.tsx b/frontend/src/scenes/insights/EmptyStates/EmptyStates.stories.tsx
@@ -14,10 +14,10 @@ import funnelOneStep from './funnelOneStep.json'
 type Story = StoryObj<typeof App>
 const meta: Meta = {
     title: 'Scenes-App/Insights/Error states',
+    tags: ['test-skip'],
     parameters: {
         layout: 'fullscreen',
         viewMode: 'story',
-        testOptions: { skip: true }, // FIXME
     },
 }
 export default meta

diff --git a/frontend/src/scenes/insights/InsightTooltip/InsightTooltip.stories.tsx b/frontend/src/scenes/insights/InsightTooltip/InsightTooltip.stories.tsx
@@ -132,9 +132,7 @@ const meta: Meta<typeof InsightTooltip> = {
         renderSeries: (value) => value,
         groupTypeLabel: 'people',
     },
-    parameters: {
-        testOptions: { skip: true }, // FIXME: The InWrapper story fails at locator.screenshot() for some reason
-    },
+    tags: ['test-skip'], // FIXME: The InWrapper story fails at locator.screenshot() for some reason
 }
 export default meta
 

diff --git a/frontend/src/scenes/session-recordings/SessionsRecordings-player-success.stories.tsx b/frontend/src/scenes/session-recordings/SessionsRecordings-player-success.stories.tsx
@@ -14,12 +14,12 @@ import recordings from './__mocks__/recordings.json'
 
 const meta: Meta = {
     title: 'Scenes-App/Recordings',
+    tags: ['test-skip'], // TODO: Fix the flakey rendering due to player playback
     parameters: {
         layout: 'fullscreen',
         viewMode: 'story',
         mockDate: '2023-02-01',
         waitForSelector: '.PlayerFrame__content .replayer-wrapper iframe',
-        testOptions: { skip: true }, // TODO: Fix the flakey rendering due to player playback
     },
     decorators: [
         mswDecorator({

diff --git a/frontend/src/scenes/surveys/Surveys.stories.tsx b/frontend/src/scenes/surveys/Surveys.stories.tsx
@@ -245,11 +245,7 @@ export const SurveyView: StoryFn = () => {
     }, [])
     return <App />
 }
-SurveyView.parameters = {
-    testOptions: {
-        skip: true, // FIXME: Fix the mocked data so that survey results can actually load
-    },
-}
+SurveyView.tags = ['test-skip'] // FIXME: Fix the mocked data so that survey results can actually load
 
 export const SurveyTemplates: StoryFn = () => {
     useEffect(() => {

diff --git a/frontend/src/toolbar/Toolbar.stories.tsx b/frontend/src/toolbar/Toolbar.stories.tsx
@@ -20,10 +20,10 @@ const toolbarParams: ToolbarParams = {
 
 const meta: Meta = {
     title: 'Scenes-Other/Toolbar',
+    tags: ['test-skip'], // This story is not valuable to snapshot as is
     parameters: {
         layout: 'fullscreen',
         viewMode: 'story',
-        testOptions: { skip: true }, // This story is not valuable to snapshot as is
     },
 }
 export default meta

diff --git a/package.json b/package.json
@@ -76,7 +76,7 @@
         "@medv/finder": "^2.1.0",
         "@microlink/react-json-view": "^1.21.3",
         "@monaco-editor/react": "4.4.6",
-        "@posthog/icons": "0.4.10",
+        "@posthog/icons": "0.4.11",
         "@posthog/plugin-scaffold": "^1.4.4",
         "@react-hook/size": "^2.1.2",
         "@rrweb/types": "^2.0.0-alpha.11",
@@ -197,7 +197,7 @@
         "@storybook/csf": "^0.1.1",
         "@storybook/react": "^7.5.1",
         "@storybook/react-webpack5": "^7.5.1",
-        "@storybook/test-runner": "^0.13.0",
+        "@storybook/test-runner": "^0.15.2",
         "@storybook/theming": "^7.5.1",
         "@storybook/types": "^7.5.1",
         "@sucrase/jest-plugin": "^3.0.0",