Merge pull request #1294 from github/aeisenberg/db-name-github

Display nicer names for github-downloaded databases

Author: aeisenberg

extensions/ql-vscode/src/databaseFetcher.ts

@@ -51,6 +51,7 @@ export async function promptImportInternetDatabase(
     {},
     databaseManager,
     storagePath,
+    undefined,
     progress,
     token,
     cli
@@ -98,11 +99,13 @@ export async function promptImportGithubDatabase(
     throw new Error(`Invalid GitHub repository: ${githubRepo}`);
   }
 
-  const databaseUrl = await convertGithubNwoToDatabaseUrl(githubRepo, credentials, progress);
-  if (!databaseUrl) {
+  const result = await convertGithubNwoToDatabaseUrl(githubRepo, credentials, progress);
+  if (!result) {
     return;
   }
 
+  const { databaseUrl, name, owner } = result;
+
   const octokit = await credentials.getOctokit();
   /**
    * The 'token' property of the token object returned by `octokit.auth()`.
@@ -125,6 +128,7 @@ export async function promptImportGithubDatabase(
     { 'Accept': 'application/zip', 'Authorization': `Bearer ${octokitToken}` },
     databaseManager,
     storagePath,
+    `${owner}/${name}`,
     progress,
     token,
     cli
@@ -173,6 +177,7 @@ export async function promptImportLgtmDatabase(
         {},
         databaseManager,
         storagePath,
+        undefined,
         progress,
         token,
         cli
@@ -220,6 +225,7 @@ export async function importArchiveDatabase(
       {},
       databaseManager,
       storagePath,
+      undefined,
       progress,
       token,
       cli
@@ -247,6 +253,7 @@ export async function importArchiveDatabase(
  * @param requestHeaders Headers to send with the request
  * @param databaseManager the DatabaseManager
  * @param storagePath where to store the unzipped database.
+ * @param nameOverride a name for the database that overrides the default
  * @param progress callback to send progress messages to
  * @param token cancellation token
  */
@@ -255,6 +262,7 @@ async function databaseArchiveFetcher(
   requestHeaders: { [key: string]: string },
   databaseManager: DatabaseManager,
   storagePath: string,
+  nameOverride: string | undefined,
   progress: ProgressCallback,
   token: CancellationToken,
   cli?: CodeQLCliServer,
@@ -296,7 +304,7 @@ async function databaseArchiveFetcher(
     });
     await ensureZippedSourceLocation(dbPath);
 
-    const item = await databaseManager.openDatabase(progress, token, Uri.file(dbPath));
+    const item = await databaseManager.openDatabase(progress, token, Uri.file(dbPath), nameOverride);
     await databaseManager.setCurrentDatabaseItem(item);
     return item;
   } else {
@@ -409,7 +417,6 @@ async function fetchAndUnzip(
 
   await readAndUnzip(Uri.file(archivePath).toString(true), unzipPath, cli, progress);
 
-
   // remove archivePath eagerly since these archives can be large.
   await fs.remove(archivePath);
 }
@@ -517,7 +524,11 @@ function convertGitHubUrlToNwo(githubUrl: string): string | undefined {
 export async function convertGithubNwoToDatabaseUrl(
   githubRepo: string,
   credentials: Credentials,
-  progress: ProgressCallback): Promise<string | undefined> {
+  progress: ProgressCallback): Promise<{
+    databaseUrl: string,
+    owner: string,
+    name: string
+  } | undefined> {
   try {
     const nwo = convertGitHubUrlToNwo(githubRepo) || githubRepo;
     const [owner, repo] = nwo.split('/');
@@ -532,7 +543,11 @@ export async function convertGithubNwoToDatabaseUrl(
       return;
     }
 
-    return `https://api.github.com/repos/${owner}/${repo}/code-scanning/codeql/databases/${language}`;
+    return {
+      databaseUrl: `https://api.github.com/repos/${owner}/${repo}/code-scanning/codeql/databases/${language}`,
+      owner,
+      name: repo
+    };
 
   } catch (e) {
     void logger.log(`Error: ${getErrorMessage(e)}`);

extensions/ql-vscode/src/databases.ts

@@ -148,7 +148,7 @@ export async function findSourceArchive(
 }
 
 async function resolveDatabase(
-  databasePath: string
+  databasePath: string,
 ): Promise<DatabaseContents> {
 
   const name = path.basename(databasePath);
@@ -170,7 +170,9 @@ async function getDbSchemeFiles(dbDirectory: string): Promise<string[]> {
   return await glob('*.dbscheme', { cwd: dbDirectory });
 }
 
-async function resolveDatabaseContents(uri: vscode.Uri): Promise<DatabaseContents> {
+async function resolveDatabaseContents(
+  uri: vscode.Uri,
+): Promise<DatabaseContents> {
   if (uri.scheme !== 'file') {
     throw new Error(`Database URI scheme '${uri.scheme}' not supported; only 'file' URIs are supported.`);
   }
@@ -569,14 +571,15 @@ export class DatabaseManager extends DisposableObject {
     progress: ProgressCallback,
     token: vscode.CancellationToken,
     uri: vscode.Uri,
+    displayName?: string
   ): Promise<DatabaseItem> {
     const contents = await resolveDatabaseContents(uri);
     // Ignore the source archive for QLTest databases by default.
     const isQLTestDatabase = path.extname(uri.fsPath) === '.testproj';
     const fullOptions: FullDatabaseOptions = {
       ignoreSourceArchive: isQLTestDatabase,
-      // displayName is only set if a user explicitly renames a database
-      displayName: undefined,
+      // If a displayName is not passed in, the basename of folder containing the database is used.
+      displayName,
       dateAdded: Date.now(),
       language: await this.getPrimaryLanguage(uri.fsPath)
     };

extensions/ql-vscode/src/vscode-tests/no-workspace/databaseFetcher.test.ts

@@ -91,15 +91,17 @@ describe('databaseFetcher', function() {
       mockRequest.resolves(mockApiResponse);
       quickPickSpy.resolves('javascript');
       const githubRepo = 'github/codeql';
-      const dbUrl = await mod.convertGithubNwoToDatabaseUrl(
+      const { databaseUrl, name, owner } = await mod.convertGithubNwoToDatabaseUrl(
         githubRepo,
         credentials,
         progressSpy
       );
 
-      expect(dbUrl).to.equal(
+      expect(databaseUrl).to.equal(
         'https://api.github.com/repos/github/codeql/code-scanning/codeql/databases/javascript'
       );
+      expect(name).to.equal('codeql');
+      expect(owner).to.equal('github');
       expect(quickPickSpy.firstCall.args[0]).to.deep.equal([
         'csharp',
         'javascript',