[Search jobs]: Add logs to the search jobs UI (#56745)

* Add telemetry events for the search jobs UI * Add search job usage pings aggregation * Connect search jobs usage handler * Fix telemetry service props drilling * usagestats: correctly unmarshal errors in GetWeeklySearchFormViews * Fix client mocks and stories * Fix updatecheck tests
sourcegraph · Sep 22, 2023 · 1e25781 · 1e25781
1 parent 42976e3
commit 1e25781
Show file tree

Hide file tree

Showing 22 changed files with 485 additions and 35 deletions.
diff --git a/client/branded/src/search-ui/results/progress/StreamingProgress.story.tsx b/client/branded/src/search-ui/results/progress/StreamingProgress.story.tsx
@@ -1,6 +1,7 @@
 import type { Meta, Story } from '@storybook/react'
 import { spy } from 'sinon'
 
+import { NOOP_TELEMETRY_SERVICE } from '@sourcegraph/shared/src/telemetry/telemetryService'
 import { H2 } from '@sourcegraph/wildcard'
 import { BrandedStory } from '@sourcegraph/wildcard/src/stories'
 
@@ -33,6 +34,7 @@ const render = () => (
                     skipped: [],
                 }}
                 state="loading"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
             />
         </div>
@@ -48,6 +50,7 @@ const render = () => (
                     trace: 'https://sourcegraph.test:3443/-/debug/jaeger/trace/abcdefg',
                 }}
                 state="loading"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
                 showTrace={true}
             />
@@ -64,6 +67,7 @@ const render = () => (
                     skipped: [],
                 }}
                 state="loading"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
             />
         </div>
@@ -79,6 +83,7 @@ const render = () => (
                     skipped: [],
                 }}
                 state="complete"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
             />
         </div>
@@ -95,6 +100,7 @@ const render = () => (
                     trace: 'https://sourcegraph.test:3443/-/debug/jaeger/trace/abcdefg',
                 }}
                 state="complete"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
                 showTrace={true}
             />
@@ -132,6 +138,7 @@ const render = () => (
                     ],
                 }}
                 state="complete"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
             />
         </div>
@@ -168,6 +175,7 @@ const render = () => (
                     ],
                 }}
                 state="loading"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
             />
         </div>
@@ -214,6 +222,7 @@ const render = () => (
                     ],
                 }}
                 state="complete"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
             />
         </div>
@@ -262,6 +271,7 @@ const render = () => (
                 }}
                 state="complete"
                 onSearchAgain={onSearchAgain}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 showTrace={true}
             />
         </div>
@@ -308,6 +318,7 @@ const render = () => (
                     ],
                 }}
                 state="loading"
+                telemetryService={NOOP_TELEMETRY_SERVICE}
                 onSearchAgain={onSearchAgain}
             />
         </div>

diff --git a/client/branded/src/search-ui/results/progress/StreamingProgress.tsx b/client/branded/src/search-ui/results/progress/StreamingProgress.tsx
@@ -4,14 +4,15 @@ import { mdiClipboardPulseOutline } from '@mdi/js'
 import classNames from 'classnames'
 
 import type { Progress, StreamingResultsState } from '@sourcegraph/shared/src/search/stream'
+import { TelemetryProps } from '@sourcegraph/shared/src/telemetry/telemetryService'
 import { Icon, Link } from '@sourcegraph/wildcard'
 
 import { StreamingProgressCount } from './StreamingProgressCount'
 import { StreamingProgressSkippedButton } from './StreamingProgressSkippedButton'
 
 import styles from './StreamingProgressCount.module.scss'
 
-export interface StreamingProgressProps {
+export interface StreamingProgressProps extends TelemetryProps {
     query: string
     state: StreamingResultsState
     progress: Progress
@@ -27,6 +28,7 @@ export const StreamingProgress: React.FunctionComponent<React.PropsWithChildren<
     showTrace,
     onSearchAgain,
     isSearchJobsEnabled,
+    telemetryService,
 }) => {
     const isLoading = state === 'loading'
 
@@ -39,6 +41,7 @@ export const StreamingProgress: React.FunctionComponent<React.PropsWithChildren<
                     progress={progress}
                     isSearchJobsEnabled={isSearchJobsEnabled}
                     onSearchAgain={onSearchAgain}
+                    telemetryService={telemetryService}
                 />
             )}
             <TraceLink showTrace={showTrace} trace={progress.trace} />

diff --git a/client/branded/src/search-ui/results/progress/StreamingProgressSkippedButton.test.tsx b/client/branded/src/search-ui/results/progress/StreamingProgressSkippedButton.test.tsx
@@ -3,6 +3,7 @@ import userEvent from '@testing-library/user-event'
 import sinon from 'sinon'
 
 import type { Progress } from '@sourcegraph/shared/src/search/stream'
+import { NOOP_TELEMETRY_SERVICE } from '@sourcegraph/shared/src/telemetry/telemetryService'
 import { renderWithBrandedContext } from '@sourcegraph/wildcard/src/testing'
 
 import { StreamingProgressSkippedButton } from './StreamingProgressSkippedButton'
@@ -49,7 +50,12 @@ describe('StreamingProgressSkippedButton', () => {
         }
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedButton query="" progress={progress} onSearchAgain={sinon.spy()} />
+            <StreamingProgressSkippedButton
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={sinon.spy()}
+            />
         )
         expect(screen.getByTestId('streaming-progress-skipped')).toBeInTheDocument()
         expect(screen.queryByTestId('streaming-progress-skipped')).not.toHaveClass('outline-danger')
@@ -95,7 +101,12 @@ describe('StreamingProgressSkippedButton', () => {
         }
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedButton query="" progress={progress} onSearchAgain={sinon.spy()} />
+            <StreamingProgressSkippedButton
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={sinon.spy()}
+            />
         )
         expect(screen.getByTestId('streaming-progress-skipped')).toHaveClass('btnOutline btnDanger')
         expect(screen.queryByTestId('streaming-progress-skipped')).not.toHaveClass('btnOutline btnSecondary')
@@ -131,7 +142,12 @@ describe('StreamingProgressSkippedButton', () => {
         }
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedButton query="" progress={progress} onSearchAgain={sinon.spy()} />
+            <StreamingProgressSkippedButton
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={sinon.spy()}
+            />
         )
 
         const button = screen.getByTestId('streaming-progress-skipped')
@@ -179,7 +195,12 @@ describe('StreamingProgressSkippedButton', () => {
         const onSearchAgain = sinon.spy()
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedButton query="" progress={progress} onSearchAgain={onSearchAgain} />
+            <StreamingProgressSkippedButton
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={onSearchAgain}
+            />
         )
         const toggleButton = screen.getByTestId('streaming-progress-skipped')
 

diff --git a/client/branded/src/search-ui/results/progress/StreamingProgressSkippedButton.tsx b/client/branded/src/search-ui/results/progress/StreamingProgressSkippedButton.tsx
@@ -3,22 +3,23 @@ import { useCallback, useMemo, useState, FC } from 'react'
 import { mdiAlertCircle, mdiChevronDown, mdiInformationOutline } from '@mdi/js'
 
 import { Progress } from '@sourcegraph/shared/src/search/stream'
+import { TelemetryProps } from '@sourcegraph/shared/src/telemetry/telemetryService'
 import { Button, Popover, PopoverContent, PopoverTrigger, Position, Icon } from '@sourcegraph/wildcard'
 
 import { CountContent, getProgressText } from './StreamingProgressCount'
 import { StreamingProgressSkippedPopover } from './StreamingProgressSkippedPopover'
 
 import styles from './StreamingProgressSkippedButton.module.scss'
 
-interface StreamingProgressSkippedButtonProps {
+interface StreamingProgressSkippedButtonProps extends TelemetryProps {
     query: string
     progress: Progress
     isSearchJobsEnabled?: boolean
     onSearchAgain: (additionalFilters: string[]) => void
 }
 
 export const StreamingProgressSkippedButton: FC<StreamingProgressSkippedButtonProps> = props => {
-    const { query, progress, isSearchJobsEnabled, onSearchAgain } = props
+    const { query, progress, isSearchJobsEnabled, onSearchAgain, telemetryService } = props
     const [isOpen, setIsOpen] = useState(false)
 
     const skippedWithWarningOrError = useMemo(
@@ -66,6 +67,7 @@ export const StreamingProgressSkippedButton: FC<StreamingProgressSkippedButtonPr
                     progress={progress}
                     isSearchJobsEnabled={isSearchJobsEnabled}
                     onSearchAgain={onSearchAgainWithPopupClose}
+                    telemetryService={telemetryService}
                 />
             </PopoverContent>
         </Popover>

diff --git a/client/branded/src/search-ui/results/progress/StreamingProgressSkippedPopover.story.tsx b/client/branded/src/search-ui/results/progress/StreamingProgressSkippedPopover.story.tsx
@@ -1,6 +1,7 @@
 import type { Meta, Story } from '@storybook/react'
 
 import type { Progress } from '@sourcegraph/shared/src/search/stream'
+import { NOOP_TELEMETRY_SERVICE } from '@sourcegraph/shared/src/telemetry/telemetryService'
 import { BrandedStory } from '@sourcegraph/wildcard/src/stories'
 
 import { StreamingProgressSkippedPopover } from './StreamingProgressSkippedPopover'
@@ -67,7 +68,14 @@ export const Popover: Story = () => {
 
     return (
         <BrandedStory>
-            {() => <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={() => {}} />}
+            {() => (
+                <StreamingProgressSkippedPopover
+                    query=""
+                    progress={progress}
+                    telemetryService={NOOP_TELEMETRY_SERVICE}
+                    onSearchAgain={() => {}}
+                />
+            )}
         </BrandedStory>
     )
 }
@@ -103,7 +111,14 @@ export const ShouldCloseAllInfo: Story = () => {
 
     return (
         <BrandedStory>
-            {() => <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={() => {}} />}
+            {() => (
+                <StreamingProgressSkippedPopover
+                    query=""
+                    progress={progress}
+                    telemetryService={NOOP_TELEMETRY_SERVICE}
+                    onSearchAgain={() => {}}
+                />
+            )}
         </BrandedStory>
     )
 }
@@ -131,7 +146,14 @@ export const ShouldOpenOneInfo: Story = () => {
 
     return (
         <BrandedStory>
-            {() => <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={() => {}} />}
+            {() => (
+                <StreamingProgressSkippedPopover
+                    query=""
+                    progress={progress}
+                    telemetryService={NOOP_TELEMETRY_SERVICE}
+                    onSearchAgain={() => {}}
+                />
+            )}
         </BrandedStory>
     )
 }

diff --git a/client/branded/src/search-ui/results/progress/StreamingProgressSkippedPopover.test.tsx b/client/branded/src/search-ui/results/progress/StreamingProgressSkippedPopover.test.tsx
@@ -3,6 +3,7 @@ import userEvent from '@testing-library/user-event'
 import sinon from 'sinon'
 
 import type { Progress } from '@sourcegraph/shared/src/search/stream'
+import { NOOP_TELEMETRY_SERVICE } from '@sourcegraph/shared/src/telemetry/telemetryService'
 import { assertAriaDisabled, assertAriaEnabled } from '@sourcegraph/testing'
 import { renderWithBrandedContext } from '@sourcegraph/wildcard/src/testing'
 
@@ -67,7 +68,12 @@ describe('StreamingProgressSkippedPopover', () => {
         }
         expect(
             renderWithBrandedContext(
-                <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={sinon.spy()} />
+                <StreamingProgressSkippedPopover
+                    query=""
+                    progress={progress}
+                    telemetryService={NOOP_TELEMETRY_SERVICE}
+                    onSearchAgain={sinon.spy()}
+                />
             ).asFragment()
         ).toMatchSnapshot()
     })
@@ -88,7 +94,12 @@ describe('StreamingProgressSkippedPopover', () => {
         }
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={sinon.spy()} />
+            <StreamingProgressSkippedPopover
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={sinon.spy()}
+            />
         )
         expect(screen.queryByTestId('popover-form')).not.toBeInTheDocument()
     })
@@ -113,7 +124,12 @@ describe('StreamingProgressSkippedPopover', () => {
         }
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={sinon.spy()} />
+            <StreamingProgressSkippedPopover
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={sinon.spy()}
+            />
         )
         const form = screen.getByTestId('popover-form')
         const searchAgainButton = within(form).getByRole('button')
@@ -161,7 +177,12 @@ describe('StreamingProgressSkippedPopover', () => {
         }
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={sinon.spy()} />
+            <StreamingProgressSkippedPopover
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={sinon.spy()}
+            />
         )
 
         const checkboxes = screen.getAllByTestId(/^streaming-progress-skipped-suggest-check/)
@@ -214,7 +235,12 @@ describe('StreamingProgressSkippedPopover', () => {
         }
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={sinon.spy()} />
+            <StreamingProgressSkippedPopover
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={sinon.spy()}
+            />
         )
 
         const checkboxes = screen.getAllByTestId(/^streaming-progress-skipped-suggest-check/)
@@ -271,7 +297,12 @@ describe('StreamingProgressSkippedPopover', () => {
         const searchAgain = sinon.spy()
 
         renderWithBrandedContext(
-            <StreamingProgressSkippedPopover query="" progress={progress} onSearchAgain={searchAgain} />
+            <StreamingProgressSkippedPopover
+                query=""
+                progress={progress}
+                telemetryService={NOOP_TELEMETRY_SERVICE}
+                onSearchAgain={searchAgain}
+            />
         )
 
         const checkboxes = screen.getAllByTestId(/^streaming-progress-skipped-suggest-check/)