Skip to content

Fix flaky query history reveal test via stable TreeItem ids #4468

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

Open
cklin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix flaky query history reveal test via stable TreeItem ids #4468

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
37 changes: 36 additions & 1 deletion extensions/ql-vscode/src/query-history/history-tree-data-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { env, EventEmitter, ThemeColor, ThemeIcon, TreeItem } from "vscode";
import { DisposableObject } from "../common/disposable-object";
import { assertNever } from "../common/helpers-pure";
import type { QueryHistoryInfo } from "./query-history-info";
import { getLanguage } from "./query-history-info";
import { getLanguage, getQueryId } from "./query-history-info";
import { QueryStatus } from "./query-status";
import type { HistoryItemLabelProvider } from "./history-item-label-provider";
import type { LanguageContextStore } from "../language-context-store";
Expand All @@ -17,6 +17,25 @@ export enum SortOrder {
CountDesc = "CountDesc",
}

/**
* Computes a stable, unique id for a query history item, suitable for use as a
* `TreeItem.id`. `getQueryId` alone is not unique because a multi-query run
* produces several local-query items that share the same `initialInfo.id`; for
* those we also include the (per-result) output base name.
*/
function getTreeItemId(element: QueryHistoryInfo): string {
switch (element.t) {
case "local":
return `local:${element.initialInfo.id}:${
element.completedQuery?.query.outputBaseName ?? ""
}`;
Comment on lines +29 to +31

@cklin cklin Jul 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

My understanding is that outputBaseName was introduced the same time as multi-query support, so there cannot be any legacy multi-query entry without outputBaseName.

Comment on lines +29 to +31

@cklin cklin Jul 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is mainly a test flakiness fix, and I don't think the behavior nuance is important enough to justify having its own tests.

case "variant-analysis":
return `variant-analysis:${getQueryId(element)}`;
default:
assertNever(element);
}
}

/**
* Tree data provider for the query history view.
*/
Expand Down Expand Up @@ -54,6 +73,22 @@ export class HistoryTreeDataProvider
async getTreeItem(element: QueryHistoryInfo): Promise<TreeItem> {
const treeItem = new TreeItem(this.labelProvider.getLabel(element));

// Give the tree item a stable, unique id. Without this, VS Code identifies
// tree nodes by their label plus their position in the list. When multiple
// history items share the same label, that positional identity is ambiguous
// and makes `treeView.reveal` resolve to the wrong item (or fail outright)
// when the list is re-sorted or refreshed. The default label format includes
// the start time, so labels are effectively unique in practice and users are
// unlikely to hit this; it mainly affects tests (and any user who customises
// the label format to something non-unique).
//
// `getQueryId` is not guaranteed to be unique: a multi-query run produces
// several local-query items that share the same `initialInfo.id`. Those
// items differ by their output base name, so we include it to keep the id
// unique (VS Code de-duplicates nodes that share an id, which would break
// reveal/selection for all but one of them).
treeItem.id = getTreeItemId(element);

treeItem.command = {
title: "Query History Item",
command: "codeQLQueryHistory.itemClicked",
Expand Down