Skip to content

Fix flaky Windows tests: dispose file watchers and use retried cleanup #4415

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

Merged
cklin merged 1 commit into from
Jun 5, 2026
+28 −24
Merged

Fix flaky Windows tests: dispose file watchers and use retried cleanup #4415

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
1 change: 1 addition & 0 deletions extensions/ql-vscode/src/common/vscode/multi-file-system-watcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ class WatcherCollection extends DisposableObject {
*/
public addWatcher(pattern: GlobPattern, listener: (e: Uri) => void): void {
const watcher = workspace.createFileSystemWatcher(pattern);
this.push(watcher);
this.push(watcher.onDidCreate(listener));
this.push(watcher.onDidChange(listener));
this.push(watcher.onDidDelete(listener));
Expand Down
17 changes: 9 additions & 8 deletions ...s/ql-vscode/test/vscode-tests/minimal-workspace/common/vscode/file-path-discovery.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { EventEmitter, Uri, workspace } from "vscode";
import { FilePathDiscovery } from "../../../../../src/common/vscode/file-path-discovery";
import { basename, dirname, join } from "path";
import { mkdirSync, readFileSync, rmSync, writeFileSync } from "fs";
import { rm } from "fs/promises";
import { dirSync } from "tmp";
import { normalizePath } from "../../../../../src/common/files";
import { extLogger } from "../../../../../src/common/logging/vscode/loggers";
Expand Down Expand Up @@ -60,7 +61,6 @@ class TestFilePathDiscovery extends FilePathDiscovery<TestData> {

describe("FilePathDiscovery", () => {
let tmpDir: string;
let tmpDirRemoveCallback: (() => void) | undefined;

let workspaceFolder: WorkspaceFolder;
let workspacePath: string;
Expand All @@ -81,11 +81,7 @@ describe("FilePathDiscovery", () => {
let discovery: TestFilePathDiscovery;

beforeEach(() => {
const t = dirSync({
unsafeCleanup: true,
});
tmpDir = normalizePath(t.name);
tmpDirRemoveCallback = t.removeCallback;
tmpDir = normalizePath(dirSync().name);

workspaceFolder = {
uri: Uri.file(join(tmpDir, "workspace")),
Expand Down Expand Up @@ -117,9 +113,14 @@ describe("FilePathDiscovery", () => {
discovery = new TestFilePathDiscovery();
});

afterEach(() => {
tmpDirRemoveCallback?.();
afterEach(async () => {
discovery.dispose();
await rm(tmpDir, {
recursive: true,
force: true,
maxRetries: 10,
retryDelay: 200,
});
});

describe("initialRefresh", () => {
Expand Down
17 changes: 9 additions & 8 deletions ...sions/ql-vscode/test/vscode-tests/minimal-workspace/queries-panel/query-discovery.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { QueryDiscovery } from "../../../../src/queries-panel/query-discovery";
import { createMockApp } from "../../../__mocks__/appMock";
import { basename, dirname, join } from "path";
import { dirSync } from "tmp";
import { rm } from "fs/promises";
import {
FileTreeDirectory,
FileTreeLeaf,
Expand All @@ -15,7 +16,6 @@ import { LanguageContextStore } from "../../../../src/language-context-store";

describe("Query pack discovery", () => {
let tmpDir: string;
let tmpDirRemoveCallback: (() => void) | undefined;

let workspacePath: string;

Expand All @@ -29,11 +29,7 @@ describe("Query pack discovery", () => {
let discovery: QueryDiscovery;

beforeEach(() => {
const t = dirSync({
unsafeCleanup: true,
});
tmpDir = t.name;
tmpDirRemoveCallback = t.removeCallback;
tmpDir = dirSync().name;

const workspaceFolder = {
uri: Uri.file(join(tmpDir, "workspace")),
Expand All @@ -52,9 +48,14 @@ describe("Query pack discovery", () => {
discovery = new QueryDiscovery(app, queryPackDiscoverer, languageContext);
});

afterEach(() => {
tmpDirRemoveCallback?.();
afterEach(async () => {
discovery.dispose();
await rm(tmpDir, {
recursive: true,
force: true,
maxRetries: 10,
retryDelay: 200,
});
});

describe("buildQueryTree", () => {
Expand Down
17 changes: 9 additions & 8 deletions .../ql-vscode/test/vscode-tests/minimal-workspace/queries-panel/query-pack-discovery.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
import { Uri, workspace } from "vscode";
import { QueryPackDiscovery } from "../../../../src/queries-panel/query-pack-discovery";
import { dirSync } from "tmp";
import { rm } from "fs/promises";
import { dirname, join } from "path";
import { ensureDir, writeJSON } from "fs-extra";
import { QueryLanguage } from "../../../../src/common/query-language";

describe("Query pack discovery", () => {
let tmpDir: string;
let tmpDirRemoveCallback: (() => void) | undefined;

let workspacePath: string;

let discovery: QueryPackDiscovery;

beforeEach(() => {
const t = dirSync({
unsafeCleanup: true,
});
tmpDir = t.name;
tmpDirRemoveCallback = t.removeCallback;
tmpDir = dirSync().name;

const workspaceFolder = {
uri: Uri.file(join(tmpDir, "workspace")),
Expand All @@ -33,9 +29,14 @@ describe("Query pack discovery", () => {
discovery = new QueryPackDiscovery();
});

afterEach(() => {
tmpDirRemoveCallback?.();
afterEach(async () => {
discovery.dispose();
await rm(tmpDir, {
recursive: true,
force: true,
maxRetries: 10,
retryDelay: 200,
});
});

describe("findQueryPack", () => {
Expand Down
Loading