Skip to content

fix(ui): update trace gutters reactively #11057

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.

Sign up for GitHub

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

Draft
hi-ogawa wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −7
Draft

fix(ui): update trace gutters reactively #11057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions packages/ui/client/components/views/ViewEditor.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import {
activeTraceView,
getTraceEditorMarkersForFile,
getTraceEntryClass,
isTraceViewEnabled,
selectActiveTraceStep,
} from '~/composables/trace-view'
import { escapeHtml } from '~/utils/escape'
Expand Down Expand Up @@ -141,9 +140,7 @@ function codemirrorChanges() {
}

const TRACE_GUTTER_ID = 'trace-step-gutter'
const traceGutterConfigs = isTraceViewEnabled(props.file)
? [{ className: TRACE_GUTTER_ID, style: 'width: 14px' }]
: []
const traceGutterEnabled = computed(() => activeTraceView.value?.test.file.id === props.file.id)
let traceGutterLines: number[] = []

const traceEditorMarkersForFile = computed(() => {
Expand All @@ -166,6 +163,13 @@ function syncTraceMarkers() {
}
traceGutterLines = []

editor.setOption('gutters', [
'CodeMirror-linenumbers',
...(traceGutterEnabled.value
? [{ className: TRACE_GUTTER_ID, style: 'width: 14px' }]
: []),
])

const lineCount = editor.lineCount()
for (const marker of traceEditorMarkersForFile.value) {
const line = marker.line - 1
Expand Down Expand Up @@ -195,7 +199,7 @@ function syncTraceMarkers() {
}

watch(
[codemirrorRef, traceEditorMarkersForFile, loading],
[codemirrorRef, traceGutterEnabled, traceEditorMarkersForFile, loading],
() => {
syncTraceMarkers()
},
Expand Down Expand Up @@ -453,7 +457,7 @@ onBeforeUnmount(clearListeners)
:options="{
lineNumbers: true,
styleActiveLine: true,
gutters: ['CodeMirror-linenumbers', ...traceGutterConfigs],
gutters: ['CodeMirror-linenumbers'],
}"
:mode="ext"
data-testid="code-mirror"
Expand Down
6 changes: 5 additions & 1 deletion test/ui/test/trace.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,10 @@ async function testBasic(page: Page) {
await expect(activeLine).toContainText('Render simple')

// markers ordered by 'test finished' > 'Render simple' > 'Render another'
const traceEditorMarkers = page.getByTestId('editor').getByTestId('trace-editor-marker')
const editor = page.getByTestId('editor')
const traceEditorMarkers = editor.getByTestId('trace-editor-marker')
const traceGutter = editor.locator('.CodeMirror-gutter.trace-step-gutter')
await expect(traceGutter).toBeVisible()
await expect(traceEditorMarkers).toHaveCount(3)
await expect(traceEditorMarkers.nth(1)).toHaveAttribute('aria-current', 'step')
await expect(traceEditorMarkers.nth(2)).not.toHaveAttribute('aria-current', 'step')
Expand Down Expand Up @@ -242,6 +245,7 @@ async function testBasic(page: Page) {
// verify closing trace viewer doesn't immediately auto-open it again
await traceView.getByRole('button', { name: 'Close Trace Viewer' }).click()
await expect(traceView).toBeHidden()
await expect(traceGutter).toHaveCount(0)
}

async function testViewport(page: Page) {
Expand Down
Loading