Rename source to origin

2023-11-14 10:04:05 +01:00
parent bca7ecb782
commit 5df9dfc78a
19 changed files with 98 additions and 98 deletions
--- a/extensions/ql-vscode/src/databases/config/db-config.ts
+++ b/extensions/ql-vscode/src/databases/config/db-config.ts
@@ -1,7 +1,7 @@
 // Contains models and consts for the data we want to store in the database config.
 // Changes to these models should be done carefully and account for backwards compatibility of data.

-import { DatabaseSource } from "../local-databases/database-source";
+import { DatabaseOrigin } from "../local-databases/database-origin";

 export const DB_CONFIG_VERSION = 1;

@@ -90,7 +90,7 @@ export interface LocalDatabase {
  name: string;
  dateAdded: number;
  language: string;
-  source: DatabaseSource;
+  origin: DatabaseOrigin;
  storagePath: string;
 }

--- a/extensions/ql-vscode/src/databases/database-fetcher.ts
+++ b/extensions/ql-vscode/src/databases/database-fetcher.ts
@@ -33,7 +33,7 @@ import { allowHttp } from "../config";
 import { showAndLogInformationMessage } from "../common/logging";
 import { AppOctokit } from "../common/octokit";
 import { getLanguageDisplayName } from "../common/query-language";
-import { DatabaseSource } from "./local-databases/database-source";
+import { DatabaseOrigin } from "./local-databases/database-origin";

 /**
 * Prompts a user to fetch a database from a remote location. Database is assumed to be an archive file.
@@ -296,7 +296,7 @@ export async function importArchiveDatabase(
 * @param databaseManager the DatabaseManager
 * @param storagePath where to store the unzipped database.
 * @param nameOverride a name for the database that overrides the default
- * @param source the source of the database
+ * @param origin the origin of the database
 * @param progress callback to send progress messages to
 * @param makeSelected make the new database selected in the databases panel (default: true)
 * @param addSourceArchiveFolder whether to add a workspace folder containing the source archive to the workspace
@@ -307,7 +307,7 @@ async function databaseArchiveFetcher(
  databaseManager: DatabaseManager,
  storagePath: string,
  nameOverride: string | undefined,
-  source: DatabaseSource,
+  origin: DatabaseOrigin,
  progress: ProgressCallback,
  cli?: CodeQLCliServer,
  makeSelected = true,
@@ -352,7 +352,7 @@ async function databaseArchiveFetcher(

    const item = await databaseManager.openDatabase(
      Uri.file(dbPath),
-      source,
+      origin,
      makeSelected,
      nameOverride,
      {
--- a/extensions/ql-vscode/src/databases/db-item.ts
+++ b/extensions/ql-vscode/src/databases/db-item.ts
@@ -1,6 +1,6 @@
 // This file contains models that are used to represent the databases.

-import { DatabaseSource } from "./local-databases/database-source";
+import { DatabaseOrigin } from "./local-databases/database-origin";

 export enum DbItemKind {
  RootLocal = "RootLocal",
@@ -40,7 +40,7 @@ export interface LocalDatabaseDbItem {
  databaseName: string;
  dateAdded: number;
  language: string;
-  source: DatabaseSource;
+  origin: DatabaseOrigin;
  storagePath: string;
  parentListName?: string;
 }
--- a/extensions/ql-vscode/src/databases/db-tree-creator.ts
+++ b/extensions/ql-vscode/src/databases/db-tree-creator.ts
@@ -197,7 +197,7 @@ function createLocalDb(
    databaseName: db.name,
    dateAdded: db.dateAdded,
    language: db.language,
-    source: db.source,
+    origin: db.origin,
    storagePath: db.storagePath,
    selected: !!selected,
    parentListName: listName,
--- a/extensions/ql-vscode/src/databases/local-databases/database-item-impl.ts
+++ b/extensions/ql-vscode/src/databases/local-databases/database-item-impl.ts
@@ -14,7 +14,7 @@ import { isLikelyDatabaseRoot } from "./db-contents-heuristics";
 import { stat } from "fs-extra";
 import { containsPath, pathsEqual } from "../../common/files";
 import { DatabaseContents } from "./database-contents";
-import { DatabaseSource } from "./database-source";
+import { DatabaseOrigin } from "./database-origin";

 export class DatabaseItemImpl implements DatabaseItem {
  // These are only public in the implementation, they are readonly in the interface
@@ -62,8 +62,8 @@ export class DatabaseItemImpl implements DatabaseItem {
    return this.options.dateAdded;
  }

-  public get source(): DatabaseSource | undefined {
-    return this.options.source;
+  public get origin(): DatabaseOrigin | undefined {
+    return this.options.origin;
  }

  public resolveSourceFile(uriStr: string | undefined): vscode.Uri {
--- a/extensions/ql-vscode/src/databases/local-databases/database-item.ts
+++ b/extensions/ql-vscode/src/databases/local-databases/database-item.ts
@@ -2,7 +2,7 @@ import vscode from "vscode";
 import * as cli from "../../codeql-cli/cli";
 import { DatabaseContents } from "./database-contents";
 import { DatabaseOptions } from "./database-options";
-import { DatabaseSource } from "./database-source";
+import { DatabaseOrigin } from "./database-origin";

 /** An item in the list of available databases */
 export interface DatabaseItem {
@@ -27,9 +27,9 @@ export interface DatabaseItem {
  readonly dateAdded: number | undefined;

  /**
-   * The source this database item was added from or undefined if unknown.
+   * The origin this database item was retrieved from or undefined if unknown.
   */
-  readonly source: DatabaseSource | undefined;
+  readonly origin: DatabaseOrigin | undefined;

  /** If the database is invalid, describes why. */
  readonly error: Error | undefined;
--- a/extensions/ql-vscode/src/databases/local-databases/database-manager.ts
+++ b/extensions/ql-vscode/src/databases/local-databases/database-manager.ts
@@ -34,7 +34,7 @@ import { DatabaseChangedEvent, DatabaseEventKind } from "./database-events";
 import { DatabaseResolver } from "./database-resolver";
 import { telemetryListener } from "../../common/vscode/telemetry";
 import { LanguageContextStore } from "../../language-context-store";
-import { DatabaseSource } from "./database-source";
+import { DatabaseOrigin } from "./database-origin";

 /**
 * The name of the key in the workspaceState dictionary in which we
@@ -132,7 +132,7 @@ export class DatabaseManager extends DisposableObject {
   */
  public async openDatabase(
    uri: vscode.Uri,
-    source: DatabaseSource | undefined,
+    origin: DatabaseOrigin | undefined,
    makeSelected = true,
    displayName?: string,
    {
@@ -142,7 +142,7 @@ export class DatabaseManager extends DisposableObject {
  ): Promise<DatabaseItem> {
    const databaseItem = await this.createDatabaseItem(
      uri,
-      source,
+      origin,
      displayName,
    );

@@ -195,7 +195,7 @@ export class DatabaseManager extends DisposableObject {
   */
  private async createDatabaseItem(
    uri: vscode.Uri,
-    source: DatabaseSource | undefined,
+    origin: DatabaseOrigin | undefined,
    displayName: string | undefined,
  ): Promise<DatabaseItemImpl> {
    const contents = await DatabaseResolver.resolveDatabaseContents(uri);
@@ -204,7 +204,7 @@ export class DatabaseManager extends DisposableObject {
      displayName,
      dateAdded: Date.now(),
      language: await this.getPrimaryLanguage(uri.fsPath),
-      source,
+      origin,
    };
    const databaseItem = new DatabaseItemImpl(uri, contents, fullOptions);

@@ -220,7 +220,7 @@ export class DatabaseManager extends DisposableObject {
   */
  public async createOrOpenDatabaseItem(
    uri: vscode.Uri,
-    source: DatabaseSource | undefined,
+    origin: DatabaseOrigin | undefined,
  ): Promise<DatabaseItem> {
    const existingItem = this.findDatabaseItem(uri);
    if (existingItem !== undefined) {
@@ -229,7 +229,7 @@ export class DatabaseManager extends DisposableObject {
    }

    // We don't add this to the list automatically, but the user can add it later.
-    return this.createDatabaseItem(uri, source, undefined);
+    return this.createDatabaseItem(uri, origin, undefined);
  }

  public async createSkeletonPacks(databaseItem: DatabaseItem) {
@@ -364,7 +364,7 @@ export class DatabaseManager extends DisposableObject {
    let displayName: string | undefined = undefined;
    let dateAdded = undefined;
    let language = undefined;
-    let source = undefined;
+    let origin = undefined;
    if (state.options) {
      if (typeof state.options.displayName === "string") {
        displayName = state.options.displayName;
@@ -373,7 +373,7 @@ export class DatabaseManager extends DisposableObject {
        dateAdded = state.options.dateAdded;
      }
      language = state.options.language;
-      source = state.options.source;
+      origin = state.options.origin;
    }

    const dbBaseUri = vscode.Uri.parse(state.uri, true);
@@ -386,7 +386,7 @@ export class DatabaseManager extends DisposableObject {
      displayName,
      dateAdded,
      language,
-      source,
+      origin,
    };
    const item = new DatabaseItemImpl(dbBaseUri, undefined, fullOptions);

--- a/extensions/ql-vscode/src/databases/local-databases/database-options.ts
+++ b/extensions/ql-vscode/src/databases/local-databases/database-options.ts
@@ -1,14 +1,14 @@
-import { DatabaseSource } from "./database-source";
+import { DatabaseOrigin } from "./database-origin";

 export interface DatabaseOptions {
  displayName?: string;
  dateAdded?: number | undefined;
  language?: string;
-  source?: DatabaseSource;
+  origin?: DatabaseOrigin;
 }

 export interface FullDatabaseOptions extends DatabaseOptions {
  dateAdded: number | undefined;
  language: string | undefined;
-  source: DatabaseSource | undefined;
+  origin: DatabaseOrigin | undefined;
 }
--- a/extensions/ql-vscode/src/databases/local-databases/database-origin.ts
+++ b/extensions/ql-vscode/src/databases/local-databases/database-origin.ts
@@ -0,0 +1,30 @@
+interface DatabaseOriginFolder {
+  type: "folder";
+}
+
+interface DatabaseOriginArchive {
+  type: "archive";
+  path: string;
+}
+
+interface DatabaseOriginGitHub {
+  type: "github";
+  repository: string;
+  commitOid: string | null;
+}
+
+interface DatabaseOriginInternet {
+  type: "url";
+  url: string;
+}
+
+interface DatabaseOriginDebugger {
+  type: "debugger";
+}
+
+export type DatabaseOrigin =
+  | DatabaseOriginFolder
+  | DatabaseOriginArchive
+  | DatabaseOriginGitHub
+  | DatabaseOriginInternet
+  | DatabaseOriginDebugger;
--- a/extensions/ql-vscode/src/databases/local-databases/database-source.ts
+++ b/extensions/ql-vscode/src/databases/local-databases/database-source.ts
@@ -1,30 +0,0 @@
-interface DatabaseSourceFolder {
-  type: "folder";
-}
-
-interface DatabaseSourceArchive {
-  type: "archive";
-  path: string;
-}
-
-interface DatabaseSourceGitHub {
-  type: "github";
-  repository: string;
-  commitOid: string | null;
-}
-
-interface DatabaseSourceInternet {
-  type: "url";
-  url: string;
-}
-
-interface DatabaseSourceDebugger {
-  type: "debugger";
-}
-
-export type DatabaseSource =
-  | DatabaseSourceFolder
-  | DatabaseSourceArchive
-  | DatabaseSourceGitHub
-  | DatabaseSourceInternet
-  | DatabaseSourceDebugger;
--- a/extensions/ql-vscode/src/query-testing/test-runner.ts
+++ b/extensions/ql-vscode/src/query-testing/test-runner.ts
@@ -103,7 +103,7 @@ export class TestRunner extends DisposableObject {
        try {
          const reopenedDatabase = await this.databaseManager.openDatabase(
            uri,
-            closedDatabase.source,
+            closedDatabase.origin,
            false,
          );
          await this.databaseManager.renameDatabaseItem(
--- a/extensions/ql-vscode/test/factories/databases/databases.ts
+++ b/extensions/ql-vscode/test/factories/databases/databases.ts
@@ -11,7 +11,7 @@ export function mockDbOptions(): FullDatabaseOptions {
  return {
    dateAdded: 123,
    language: "",
-    source: {
+    origin: {
      type: "folder",
    },
  };
--- a/extensions/ql-vscode/test/factories/db-config-factories.ts
+++ b/extensions/ql-vscode/test/factories/db-config-factories.ts
@@ -7,7 +7,7 @@ import {
  SelectedDbItem,
  DB_CONFIG_VERSION,
 } from "../../src/databases/config/db-config";
-import { DatabaseSource } from "../../src/databases/local-databases/database-source";
+import { DatabaseOrigin } from "../../src/databases/local-databases/database-origin";

 export function createDbConfig({
  remoteLists = [],
@@ -46,7 +46,7 @@ export function createLocalDbConfigItem({
  dateAdded = faker.date.past().getTime(),
  language = `language${faker.number.int()}`,
  storagePath = `storagePath${faker.number.int()}`,
-  source = {
+  origin = {
    type: "folder",
  },
 }: {
@@ -54,13 +54,13 @@ export function createLocalDbConfigItem({
  dateAdded?: number;
  language?: string;
  storagePath?: string;
-  source?: DatabaseSource;
+  origin?: DatabaseOrigin;
 } = {}): LocalDatabase {
  return {
    name,
    dateAdded,
    language,
    storagePath,
-    source,
+    origin,
  };
 }
--- a/extensions/ql-vscode/test/factories/db-item-factories.ts
+++ b/extensions/ql-vscode/test/factories/db-item-factories.ts
@@ -12,7 +12,7 @@ import {
  RootLocalDbItem,
  RootRemoteDbItem,
 } from "../../src/databases/db-item";
-import { DatabaseSource } from "../../src/databases/local-databases/database-source";
+import { DatabaseOrigin } from "../../src/databases/local-databases/database-origin";

 // Root Remote Db Items
 export function createRootRemoteDbItem({
@@ -125,7 +125,7 @@ export function createLocalDatabaseDbItem({
  language = `language${faker.number.int()}`,
  storagePath = `storagePath${faker.number.int()}`,
  selected = false,
-  source = {
+  origin = {
    type: "folder",
  },
 }: {
@@ -134,7 +134,7 @@ export function createLocalDatabaseDbItem({
  language?: string;
  storagePath?: string;
  selected?: boolean;
-  source?: DatabaseSource;
+  origin?: DatabaseOrigin;
 } = {}): LocalDatabaseDbItem {
  return {
    kind: DbItemKind.LocalDatabase,
@@ -143,7 +143,7 @@ export function createLocalDatabaseDbItem({
    dateAdded,
    language,
    storagePath,
-    source,
+    origin,
  };
 }

--- a/extensions/ql-vscode/test/unit-tests/databases/db-item-selection.test.ts
+++ b/extensions/ql-vscode/test/unit-tests/databases/db-item-selection.test.ts
@@ -57,7 +57,7 @@ describe("db item selection", () => {
      dateAdded: 1234,
      language: "javascript",
      storagePath: "/foo/bar",
-      source: {
+      origin: {
        type: "folder",
      },
      selected: true,
--- a/extensions/ql-vscode/test/unit-tests/databases/db-tree-creator.test.ts
+++ b/extensions/ql-vscode/test/unit-tests/databases/db-tree-creator.test.ts
@@ -337,7 +337,7 @@ describe("db tree creator", () => {
                dateAdded: 1668428293677,
                language: QueryLanguage.Cpp,
                storagePath: "/path/to/db1/",
-                source: {
+                origin: {
                  type: "folder",
                },
              },
@@ -346,7 +346,7 @@ describe("db tree creator", () => {
                dateAdded: 1668428472731,
                language: "cpp",
                storagePath: "/path/to/db2/",
-                source: {
+                origin: {
                  type: "folder",
                },
              },
@@ -360,7 +360,7 @@ describe("db tree creator", () => {
                dateAdded: 1668428472731,
                language: "ruby",
                storagePath: "/path/to/db3/",
-                source: {
+                origin: {
                  type: "folder",
                },
              },
@@ -389,7 +389,7 @@ describe("db tree creator", () => {
          databaseName: db.name,
          dateAdded: db.dateAdded,
          language: db.language,
-          source: db.source,
+          origin: db.origin,
          storagePath: db.storagePath,
          parentListName: dbConfig.databases.local.lists[0].name,
        })),
@@ -405,7 +405,7 @@ describe("db tree creator", () => {
          databaseName: db.name,
          dateAdded: db.dateAdded,
          language: db.language,
-          source: db.source,
+          origin: db.origin,
          storagePath: db.storagePath,
          parentListName: dbConfig.databases.local.lists[1].name,
        })),
@@ -420,7 +420,7 @@ describe("db tree creator", () => {
            dateAdded: 1668428293677,
            language: "csharp",
            storagePath: "/path/to/db1/",
-            source: {
+            origin: {
              type: "folder",
            },
          },
@@ -429,7 +429,7 @@ describe("db tree creator", () => {
            dateAdded: 1668428472731,
            language: "go",
            storagePath: "/path/to/db2/",
-            source: {
+            origin: {
              type: "folder",
            },
          },
@@ -451,7 +451,7 @@ describe("db tree creator", () => {
        databaseName: dbConfig.databases.local.databases[0].name,
        dateAdded: dbConfig.databases.local.databases[0].dateAdded,
        language: dbConfig.databases.local.databases[0].language,
-        source: dbConfig.databases.local.databases[0].source,
+        origin: dbConfig.databases.local.databases[0].origin,
        storagePath: dbConfig.databases.local.databases[0].storagePath,
      });
      expect(localDatabaseNodes[1]).toEqual({
@@ -460,7 +460,7 @@ describe("db tree creator", () => {
        databaseName: dbConfig.databases.local.databases[1].name,
        dateAdded: dbConfig.databases.local.databases[1].dateAdded,
        language: dbConfig.databases.local.databases[1].language,
-        source: dbConfig.databases.local.databases[1].source,
+        origin: dbConfig.databases.local.databases[1].origin,
        storagePath: dbConfig.databases.local.databases[1].storagePath,
      });
    });
--- a/extensions/ql-vscode/test/vscode-tests/minimal-workspace/databases/db-panel-rendering.test.ts
+++ b/extensions/ql-vscode/test/vscode-tests/minimal-workspace/databases/db-panel-rendering.test.ts
@@ -186,7 +186,7 @@ describe("db panel rendering nodes", () => {
                dateAdded: 1668428293677,
                language: QueryLanguage.Cpp,
                storagePath: "/path/to/db1/",
-                source: {
+                origin: {
                  type: "folder",
                },
              },
@@ -195,7 +195,7 @@ describe("db panel rendering nodes", () => {
                dateAdded: 1668428472731,
                language: QueryLanguage.Cpp,
                storagePath: "/path/to/db2/",
-                source: {
+                origin: {
                  type: "folder",
                },
              },
@@ -209,7 +209,7 @@ describe("db panel rendering nodes", () => {
                dateAdded: 1668428472731,
                language: "ruby",
                storagePath: "/path/to/db3/",
-                source: {
+                origin: {
                  type: "folder",
                },
              },
@@ -247,7 +247,7 @@ describe("db panel rendering nodes", () => {
          language: QueryLanguage.Cpp,
          storagePath: "/path/to/db1/",
          selected: false,
-          source: {
+          origin: {
            type: "folder",
          },
        },
@@ -258,7 +258,7 @@ describe("db panel rendering nodes", () => {
          language: QueryLanguage.Cpp,
          storagePath: "/path/to/db2/",
          selected: false,
-          source: {
+          origin: {
            type: "folder",
          },
        },
@@ -271,7 +271,7 @@ describe("db panel rendering nodes", () => {
          language: "ruby",
          storagePath: "/path/to/db3/",
          selected: false,
-          source: {
+          origin: {
            type: "folder",
          },
        },
@@ -286,7 +286,7 @@ describe("db panel rendering nodes", () => {
            dateAdded: 1668428293677,
            language: "csharp",
            storagePath: "/path/to/db1/",
-            source: {
+            origin: {
              type: "folder",
            },
          },
@@ -295,7 +295,7 @@ describe("db panel rendering nodes", () => {
            dateAdded: 1668428472731,
            language: "go",
            storagePath: "/path/to/db2/",
-            source: {
+            origin: {
              type: "folder",
            },
          },
@@ -330,7 +330,7 @@ describe("db panel rendering nodes", () => {
        language: "csharp",
        storagePath: "/path/to/db1/",
        selected: false,
-        source: {
+        origin: {
          type: "folder",
        },
      });
@@ -341,7 +341,7 @@ describe("db panel rendering nodes", () => {
        language: "go",
        storagePath: "/path/to/db2/",
        selected: false,
-        source: {
+        origin: {
          type: "folder",
        },
      });
--- a/extensions/ql-vscode/test/vscode-tests/minimal-workspace/local-queries/local-databases.test.ts
+++ b/extensions/ql-vscode/test/vscode-tests/minimal-workspace/local-queries/local-databases.test.ts
@@ -597,7 +597,7 @@ describe("local databases", () => {
      const options: FullDatabaseOptions = {
        dateAdded: 123,
        language,
-        source: {
+        origin: {
          type: "folder",
        },
      };
@@ -723,7 +723,7 @@ describe("local databases", () => {
    it("should resolve the database contents", async () => {
      await databaseManager.openDatabase(
        mockDbItem.databaseUri,
-        mockDbItem.source,
+        mockDbItem.origin,
      );

      expect(resolveDatabaseContentsSpy).toBeCalledTimes(2);
@@ -732,7 +732,7 @@ describe("local databases", () => {
    it("should set the database as the currently selected one", async () => {
      await databaseManager.openDatabase(
        mockDbItem.databaseUri,
-        mockDbItem.source,
+        mockDbItem.origin,
      );

      expect(setCurrentDatabaseItemSpy).toBeCalledTimes(1);
@@ -741,7 +741,7 @@ describe("local databases", () => {
    it("should add database source archive folder", async () => {
      await databaseManager.openDatabase(
        mockDbItem.databaseUri,
-        mockDbItem.source,
+        mockDbItem.origin,
      );

      expect(addDatabaseSourceArchiveFolderSpy).toBeCalledTimes(1);
@@ -758,7 +758,7 @@ describe("local databases", () => {

          await databaseManager.openDatabase(
            mockDbItem.databaseUri,
-            mockDbItem.source,
+            mockDbItem.origin,
            makeSelected,
            nameOverride,
            { isTutorialDatabase },
@@ -774,7 +774,7 @@ describe("local databases", () => {

          await databaseManager.openDatabase(
            mockDbItem.databaseUri,
-            mockDbItem.source,
+            mockDbItem.origin,
          );

          expect(createSkeletonPacksSpy).toBeCalledTimes(1);
@@ -788,7 +788,7 @@ describe("local databases", () => {

        await databaseManager.openDatabase(
          mockDbItem.databaseUri,
-          mockDbItem.source,
+          mockDbItem.origin,
        );
        expect(createSkeletonPacksSpy).toBeCalledTimes(0);
      });
--- a/extensions/ql-vscode/test/vscode-tests/no-workspace/query-testing/test-runner.test.ts
+++ b/extensions/ql-vscode/test/vscode-tests/no-workspace/query-testing/test-runner.test.ts
@@ -41,7 +41,7 @@ describe("test-runner", () => {
    undefined,
    mockedObject<FullDatabaseOptions>({
      displayName: "custom display name",
-      source: { type: "folder" },
+      origin: { type: "folder" },
    }),
  );
  const postTestDatabaseItem = new DatabaseItemImpl(
@@ -49,7 +49,7 @@ describe("test-runner", () => {
    undefined,
    mockedObject<FullDatabaseOptions>({
      displayName: "default name",
-      source: { type: "folder" },
+      origin: { type: "folder" },
    }),
  );

@@ -166,7 +166,7 @@ describe("test-runner", () => {
    expect(openDatabaseSpy).toBeCalledTimes(1);
    expect(openDatabaseSpy).toBeCalledWith(
      preTestDatabaseItem.databaseUri,
-      preTestDatabaseItem.source,
+      preTestDatabaseItem.origin,
      false,
    );