Skip to content

Commit d0d12b7

Browse files
koesie10koesie10
authored
Merge pull request #3081 from github/koesie10/github-databases-directory
Move GitHub databases files to separate directory
2 parents 85d7b9b + 5e6b7d8 commit d0d12b7

File tree

9 files changed

+77
-70
lines changed

9 files changed

+77
-70
lines changed

extensions/ql-vscode/src/databases/github-database-api.ts renamed to extensions/ql-vscode/src/databases/github-databases/api.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { RequestError } from "@octokit/request-error";
22
import { Octokit } from "@octokit/rest";
33
import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods";
4-
import { showNeverAskAgainDialog } from "../common/vscode/dialog";
5-
import { GitHubDatabaseConfig } from "../config";
6-
import { Credentials } from "../common/authentication";
7-
import { AppOctokit } from "../common/octokit";
4+
import { showNeverAskAgainDialog } from "../../common/vscode/dialog";
5+
import { GitHubDatabaseConfig } from "../../config";
6+
import { Credentials } from "../../common/authentication";
7+
import { AppOctokit } from "../../common/octokit";
88

99
export type CodeqlDatabase =
1010
RestEndpointMethodTypes["codeScanning"]["listCodeqlDatabases"]["response"]["data"][number];

extensions/ql-vscode/src/databases/github-database-download.ts renamed to extensions/ql-vscode/src/databases/github-databases/download.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { window } from "vscode";
22
import { Octokit } from "@octokit/rest";
3-
import { showNeverAskAgainDialog } from "../common/vscode/dialog";
4-
import { getLanguageDisplayName } from "../common/query-language";
5-
import { downloadGitHubDatabaseFromUrl } from "./database-fetcher";
6-
import { withProgress } from "../common/vscode/progress";
7-
import { DatabaseManager } from "./local-databases";
8-
import { CodeQLCliServer } from "../codeql-cli/cli";
9-
import { AppCommandManager } from "../common/commands";
10-
import { GitHubDatabaseConfig } from "../config";
11-
import type { CodeqlDatabase } from "./github-database-api";
3+
import { showNeverAskAgainDialog } from "../../common/vscode/dialog";
4+
import { getLanguageDisplayName } from "../../common/query-language";
5+
import { downloadGitHubDatabaseFromUrl } from "../database-fetcher";
6+
import { withProgress } from "../../common/vscode/progress";
7+
import { DatabaseManager } from "../local-databases";
8+
import { CodeQLCliServer } from "../../codeql-cli/cli";
9+
import { AppCommandManager } from "../../common/commands";
10+
import { GitHubDatabaseConfig } from "../../config";
11+
import type { CodeqlDatabase } from "./api";
1212

1313
/**
1414
* Ask whether the user wants to download a database from GitHub.

extensions/ql-vscode/src/databases/github-database-module.ts renamed to extensions/ql-vscode/src/databases/github-databases/github-databases-module.ts

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
11
import { window } from "vscode";
2-
import { DisposableObject } from "../common/disposable-object";
3-
import { App } from "../common/app";
4-
import { findGitHubRepositoryForWorkspace } from "./github-repository-finder";
5-
import { redactableError } from "../common/errors";
6-
import { asError, assertNever, getErrorMessage } from "../common/helpers-pure";
2+
import { DisposableObject } from "../../common/disposable-object";
3+
import { App } from "../../common/app";
4+
import { findGitHubRepositoryForWorkspace } from "../github-repository-finder";
5+
import { redactableError } from "../../common/errors";
6+
import {
7+
asError,
8+
assertNever,
9+
getErrorMessage,
10+
} from "../../common/helpers-pure";
711
import {
812
askForGitHubDatabaseDownload,
913
downloadDatabaseFromGitHub,
10-
} from "./github-database-download";
11-
import { GitHubDatabaseConfig, GitHubDatabaseConfigListener } from "../config";
12-
import { DatabaseManager } from "./local-databases";
13-
import { CodeQLCliServer } from "../codeql-cli/cli";
14+
} from "./download";
1415
import {
15-
CodeqlDatabase,
16-
listDatabases,
17-
ListDatabasesResult,
18-
} from "./github-database-api";
16+
GitHubDatabaseConfig,
17+
GitHubDatabaseConfigListener,
18+
} from "../../config";
19+
import { DatabaseManager } from "../local-databases";
20+
import { CodeQLCliServer } from "../../codeql-cli/cli";
21+
import { CodeqlDatabase, listDatabases, ListDatabasesResult } from "./api";
1922
import {
2023
askForGitHubDatabaseUpdate,
2124
DatabaseUpdate,
2225
downloadDatabaseUpdateFromGitHub,
2326
isNewerDatabaseAvailable,
24-
} from "./github-database-updates";
27+
} from "./updates";
2528
import { Octokit } from "@octokit/rest";
2629

27-
export class GithubDatabaseModule extends DisposableObject {
30+
export class GitHubDatabasesModule extends DisposableObject {
2831
private readonly config: GitHubDatabaseConfig;
2932

3033
private constructor(
@@ -43,17 +46,17 @@ export class GithubDatabaseModule extends DisposableObject {
4346
databaseManager: DatabaseManager,
4447
databaseStoragePath: string,
4548
cliServer: CodeQLCliServer,
46-
): Promise<GithubDatabaseModule> {
47-
const githubDatabaseModule = new GithubDatabaseModule(
49+
): Promise<GitHubDatabasesModule> {
50+
const githubDatabasesModule = new GitHubDatabasesModule(
4851
app,
4952
databaseManager,
5053
databaseStoragePath,
5154
cliServer,
5255
);
53-
app.subscriptions.push(githubDatabaseModule);
56+
app.subscriptions.push(githubDatabasesModule);
5457

55-
await githubDatabaseModule.initialize();
56-
return githubDatabaseModule;
58+
await githubDatabasesModule.initialize();
59+
return githubDatabasesModule;
5760
}
5861

5962
private async initialize(): Promise<void> {

‎extensions/ql-vscode/src/databases/github-databases/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from "./github-databases-module";

extensions/ql-vscode/src/databases/github-database-updates.ts renamed to extensions/ql-vscode/src/databases/github-databases/updates.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
import { CodeqlDatabase } from "./github-database-api";
2-
import { DatabaseItem, DatabaseManager } from "./local-databases";
1+
import { CodeqlDatabase } from "./api";
2+
import { DatabaseItem, DatabaseManager } from "../local-databases";
33
import { Octokit } from "@octokit/rest";
4-
import { CodeQLCliServer } from "../codeql-cli/cli";
5-
import { AppCommandManager } from "../common/commands";
6-
import { getLanguageDisplayName } from "../common/query-language";
7-
import { showNeverAskAgainDialog } from "../common/vscode/dialog";
8-
import { downloadGitHubDatabaseFromUrl } from "./database-fetcher";
9-
import { withProgress } from "../common/vscode/progress";
4+
import { CodeQLCliServer } from "../../codeql-cli/cli";
5+
import { AppCommandManager } from "../../common/commands";
6+
import { getLanguageDisplayName } from "../../common/query-language";
7+
import { showNeverAskAgainDialog } from "../../common/vscode/dialog";
8+
import { downloadGitHubDatabaseFromUrl } from "../database-fetcher";
9+
import { withProgress } from "../../common/vscode/progress";
1010
import { window } from "vscode";
11-
import { GitHubDatabaseConfig } from "../config";
12-
import { joinLanguages, promptForDatabases } from "./github-database-download";
11+
import { GitHubDatabaseConfig } from "../../config";
12+
import { joinLanguages, promptForDatabases } from "./download";
1313

1414
export type DatabaseUpdate = {
1515
database: CodeqlDatabase;

‎extensions/ql-vscode/src/extension.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ import { QueriesModule } from "./queries-panel/queries-module";
137137
import { OpenReferencedFileCodeLensProvider } from "./local-queries/open-referenced-file-code-lens-provider";
138138
import { LanguageContextStore } from "./language-context-store";
139139
import { LanguageSelectionPanel } from "./language-selection-panel/language-selection-panel";
140-
import { GithubDatabaseModule } from "./databases/github-database-module";
140+
import { GitHubDatabasesModule } from "./databases/github-databases";
141141

142142
/**
143143
* extension.ts
@@ -871,7 +871,7 @@ async function activateWithInstalledDistribution(
871871
),
872872
);
873873

874-
await GithubDatabaseModule.initialize(
874+
await GitHubDatabasesModule.initialize(
875875
app,
876876
dbm,
877877
getContextStoragePath(ctx),

extensions/ql-vscode/test/vscode-tests/no-workspace/databases/github-database-api.test.ts renamed to extensions/ql-vscode/test/vscode-tests/no-workspace/databases/github-databases/api.test.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
import {
22
mockedObject,
33
mockedOctokitFunction,
4-
} from "../../utils/mocking.helpers";
5-
import { GitHubDatabaseConfig } from "../../../../src/config";
6-
import * as dialog from "../../../../src/common/vscode/dialog";
7-
import { listDatabases } from "../../../../src/databases/github-database-api";
8-
import { Credentials } from "../../../../src/common/authentication";
4+
} from "../../../utils/mocking.helpers";
5+
import { GitHubDatabaseConfig } from "../../../../../src/config";
6+
import * as dialog from "../../../../../src/common/vscode/dialog";
7+
import { listDatabases } from "../../../../../src/databases/github-databases/api";
8+
import { Credentials } from "../../../../../src/common/authentication";
99
import * as Octokit from "@octokit/rest";
10-
import { AppOctokit } from "../../../../src/common/octokit";
10+
import { AppOctokit } from "../../../../../src/common/octokit";
1111
import { RequestError } from "@octokit/request-error";
1212

1313
// Mock the AppOctokit constructor to ensure we aren't making any network requests
14-
jest.mock("../../../../src/common/octokit", () => ({
14+
jest.mock("../../../../../src/common/octokit", () => ({
1515
AppOctokit: jest.fn(),
1616
}));
1717
const appMockListCodeqlDatabases = mockedOctokitFunction<

extensions/ql-vscode/test/vscode-tests/no-workspace/databases/github-database-download.test.ts renamed to extensions/ql-vscode/test/vscode-tests/no-workspace/databases/github-databases/download.test.ts

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
import { faker } from "@faker-js/faker";
22
import { Octokit } from "@octokit/rest";
33
import { QuickPickItem, window } from "vscode";
4-
import { mockedObject, mockedQuickPickItem } from "../../utils/mocking.helpers";
4+
import {
5+
mockedObject,
6+
mockedQuickPickItem,
7+
} from "../../../utils/mocking.helpers";
58
import {
69
askForGitHubDatabaseDownload,
710
downloadDatabaseFromGitHub,
8-
} from "../../../../src/databases/github-database-download";
9-
import { DatabaseManager } from "../../../../src/databases/local-databases";
10-
import { GitHubDatabaseConfig } from "../../../../src/config";
11-
import { CodeQLCliServer } from "../../../../src/codeql-cli/cli";
12-
import { createMockCommandManager } from "../../../__mocks__/commandsMock";
13-
import * as databaseFetcher from "../../../../src/databases/database-fetcher";
14-
import * as dialog from "../../../../src/common/vscode/dialog";
15-
import { CodeqlDatabase } from "../../../../src/databases/github-database-api";
11+
} from "../../../../../src/databases/github-databases/download";
12+
import { DatabaseManager } from "../../../../../src/databases/local-databases";
13+
import { GitHubDatabaseConfig } from "../../../../../src/config";
14+
import { CodeQLCliServer } from "../../../../../src/codeql-cli/cli";
15+
import { createMockCommandManager } from "../../../../__mocks__/commandsMock";
16+
import * as databaseFetcher from "../../../../../src/databases/database-fetcher";
17+
import * as dialog from "../../../../../src/common/vscode/dialog";
18+
import { CodeqlDatabase } from "../../../../../src/databases/github-databases/api";
1619

1720
describe("askForGitHubDatabaseDownload", () => {
1821
const setDownload = jest.fn();

extensions/ql-vscode/test/vscode-tests/no-workspace/databases/github-database-updates.test.ts renamed to extensions/ql-vscode/test/vscode-tests/no-workspace/databases/github-databases/updates.test.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ import {
55
mockDatabaseItem,
66
mockedObject,
77
mockedQuickPickItem,
8-
} from "../../utils/mocking.helpers";
9-
import { CodeqlDatabase } from "../../../../src/databases/github-database-api";
10-
import { DatabaseManager } from "../../../../src/databases/local-databases";
11-
import { GitHubDatabaseConfig } from "../../../../src/config";
12-
import { CodeQLCliServer } from "../../../../src/codeql-cli/cli";
13-
import { createMockCommandManager } from "../../../__mocks__/commandsMock";
14-
import * as databaseFetcher from "../../../../src/databases/database-fetcher";
15-
import * as dialog from "../../../../src/common/vscode/dialog";
8+
} from "../../../utils/mocking.helpers";
9+
import { CodeqlDatabase } from "../../../../../src/databases/github-databases/api";
10+
import { DatabaseManager } from "../../../../../src/databases/local-databases";
11+
import { GitHubDatabaseConfig } from "../../../../../src/config";
12+
import { CodeQLCliServer } from "../../../../../src/codeql-cli/cli";
13+
import { createMockCommandManager } from "../../../../__mocks__/commandsMock";
14+
import * as databaseFetcher from "../../../../../src/databases/database-fetcher";
15+
import * as dialog from "../../../../../src/common/vscode/dialog";
1616
import {
1717
DatabaseUpdate,
1818
askForGitHubDatabaseUpdate,
1919
downloadDatabaseUpdateFromGitHub,
2020
isNewerDatabaseAvailable,
21-
} from "../../../../src/databases/github-database-updates";
21+
} from "../../../../../src/databases/github-databases/updates";
2222

2323
describe("isNewerDatabaseAvailable", () => {
2424
const owner = "github";

0 commit comments

Comments
 (0)