Rename source to origin

Author: koesie10

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;
 }
 

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,
       {

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;
 }

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,

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 {

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;

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);
 

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;
 }

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;