Return raw query completions as CompletionItem[]

Author: takemyoxygen

packages/language-server/src/connection.ts

@@ -1,10 +1,10 @@
-import { NSDatabase, IConnectionDriver, IConnection, MConnectionExplorer, ContextValue, InternalID, IQueryOptions, IRawCompletionItem } from '@sqltools/types';
+import { NSDatabase, IConnectionDriver, IConnection, MConnectionExplorer, ContextValue, InternalID, IQueryOptions } from '@sqltools/types';
 import decorateLSException from '@sqltools/util/decorators/ls-decorate-exception';
 import { getConnectionId } from '@sqltools/util/connection';
 import ConfigRO from '@sqltools/util/config-manager';
 import generateId from '@sqltools/util/internal-id';
 import LSContext from './context';
-import { IConnection as LSIconnection } from 'vscode-languageserver';
+import { IConnection as LSIconnection, CompletionItem } from 'vscode-languageserver';
 import DriverNotInstalledError from './exception/driver-not-installed';
 import { createLogger } from '@sqltools/log/src';
 
@@ -178,7 +178,7 @@ export default class Connection {
     return this.conn.getStaticCompletions();
   }
 
-  public getCompletionsForRawQuery(text: string, currentOffset: number): Promise<IRawCompletionItem[] | null> {
+  public getCompletionsForRawQuery(text: string, currentOffset: number): Promise<CompletionItem[] | null> {
     if (typeof this.conn.getCompletionsForRawQuery !== 'function') return Promise.resolve(null);
     return this.conn.getCompletionsForRawQuery(text, currentOffset);
   }

packages/plugins/intellisense/language-server.ts

@@ -52,7 +52,7 @@ export default class IntellisensePlugin<T extends ILanguageServer> implements IL
     }
   }
 
-  private getDatabasesCompletions = async ({ currentWord, conn, suggestDatabases }: { conn: Connection; currentWord: string; suggestDatabases: any }) => {
+  private getDatabasesCompletions = async ({ currentWord, conn, suggestDatabases }: { conn: Connection; currentWord: string; suggestDatabases: any }): Promise<CompletionItem[]> => {
     const prefix = (suggestDatabases.prependQuestionMark ? "? " : "") + (suggestDatabases.prependFrom ? "FROM " : "");
     const suffix = suggestDatabases.appendDot ? "." : "";
 
@@ -70,7 +70,7 @@ export default class IntellisensePlugin<T extends ILanguageServer> implements IL
     return [];
   }
 
-  private getTableCompletions = async ({ currentWord, conn, suggestTables }: { conn: Connection; currentWord: string; suggestTables: any }) => {
+  private getTableCompletions = async ({ currentWord, conn, suggestTables }: { conn: Connection; currentWord: string; suggestTables: any }): Promise<CompletionItem[]> => {
     const prefix = (suggestTables.prependQuestionMark ? "? " : "") + (suggestTables.prependFrom ? "FROM " : "");
     const database = suggestTables.identifierChain && suggestTables.identifierChain[0].name;
     const suffix = suggestTables.appendDot ? "." : "";
@@ -89,7 +89,7 @@ export default class IntellisensePlugin<T extends ILanguageServer> implements IL
     return [];
   }
 
-  private getColumnCompletions = async ({ currentWord, conn, suggestColumns }: { conn: Connection; currentWord: string; suggestColumns: any }) => {
+  private getColumnCompletions = async ({ currentWord, conn, suggestColumns }: { conn: Connection; currentWord: string; suggestColumns: any }): Promise<CompletionItem[]> => {
     const tables = suggestColumns.tables
       .map(table => table.identifierChain.map(id => id.name || id.cte))
       .map((t: [string]) => (<NSDatabase.ITable>{ label: t.pop(), database: t.pop() }));
@@ -107,7 +107,7 @@ export default class IntellisensePlugin<T extends ILanguageServer> implements IL
     return [];
   }
 
-  private getCompletionsFromHueAst = async ({ currentWord, conn, text, currentOffset }: { currentWord: string; conn: Connection | null; text: string; currentOffset: number }) => {
+  private getCompletionsFromHueAst = async ({ currentWord, conn, text, currentOffset }: { currentWord: string; conn: Connection | null; text: string; currentOffset: number }): Promise<CompletionItem[]> => {
     let completionsMap = {
       query: [],
       tables: [],
@@ -166,7 +166,7 @@ export default class IntellisensePlugin<T extends ILanguageServer> implements IL
       .concat(completionsMap.tables)
       .concat(completionsMap.dbs)
       .concat(completionsMap.query);
-    
+
     return completions;
   }
 
@@ -182,13 +182,12 @@ export default class IntellisensePlugin<T extends ILanguageServer> implements IL
       // First try to get completions from connection's getCompletionsForRawQuery method
       const connectionCompletions = await conn.getCompletionsForRawQuery(text, currentOffset);
       if (connectionCompletions !== null) {
-        log.debug('using connection completions, count: %d', connectionCompletions.length);
+        log.debug('Got completions from raw the query, count: %d', connectionCompletions.length);
         return connectionCompletions;
       }
-      
 
       // Fallback to hue AST-based completions
-      log.debug('falling back to hue AST completions');
+      log.debug('Using completions based on hue SQL parser');
       const completions = await this.getCompletionsFromHueAst({ currentWord, conn, text, currentOffset });
       log.debug('total completions %d', completions.length);
       return completions;

packages/types/index.d.ts

@@ -1,5 +1,5 @@
 import { ErrorHandler as LanguageClientErrorHandler, LanguageClient } from 'vscode-languageclient';
-import { IConnection as LSIConnection, TextDocuments } from 'vscode-languageserver';
+import { IConnection as LSIConnection, TextDocuments, CompletionItem } from 'vscode-languageserver';
 import { RequestType, RequestType0 } from 'vscode-languageserver-protocol';
 
 export declare namespace NodeJS {
@@ -207,7 +207,7 @@ export interface IConnection<DriverOptions = any> {
    * @memberof IConnection
    */
   ssh?: 'Enabled' | 'Disabled';
-  
+
   /**
    * SSH connection options. Required when ssh is 'Enabled'
    * @type {object}
@@ -220,30 +220,30 @@ export interface IConnection<DriverOptions = any> {
      * @memberof IConnection.sshOptions
      */
     host: string;
-    
+
     /**
      * SSH port
      * @type {number}
      * @default 22
      * @memberof IConnection.sshOptions
      */
     port: number;
-    
+
     /**
      * SSH username
      * @type {string}
      * @memberof IConnection.sshOptions
      */
     username: string;
-    
+
     /**
      * SSH password. You can use option askForPassword to prompt password before connect
      * @type {string}
      * @default null
      * @memberof IConnection.sshOptions
      */
     password?: string;
-    
+
     /**
      * Path to private key file
      * @type {string}
@@ -284,10 +284,6 @@ export interface IQueryOptions {
 export interface IConnectionDriverConstructor {
   new(credentials: IConnection<any>, getWorkspaceFolders?: LSIConnection['workspace']['getWorkspaceFolders']): IConnectionDriver;
 }
-export interface IRawCompletionItem {
-  // TODO add more fields or maybe reuse existing types
-  label: string;
-}
 export interface IConnectionDriver {
   connection: any;
   credentials: IConnection<any>;
@@ -315,7 +311,7 @@ export interface IConnectionDriver {
       port: number;
     }
   ): Promise<{ port: number }>;
-  getCompletionsForRawQuery?(text: string, currentOffset: number): Promise<IRawCompletionItem[]>;
+  getCompletionsForRawQuery?(text: string, currentOffset: number): Promise<CompletionItem[]>;
 }
 
 export declare enum ContextValue {
@@ -752,13 +748,13 @@ export interface ISettings {
    */
   useNodeRuntime?: null | boolean | string;
 
-    /**
-   * Disable node runtime detection notifications.
-   * @default false
-   * @type {boolean}
-   * @memberof ISettings
-   */
-    disableNodeDetectNotifications?: boolean;
+  /**
+ * Disable node runtime detection notifications.
+ * @default false
+ * @type {boolean}
+ * @memberof ISettings
+ */
+  disableNodeDetectNotifications?: boolean;
 
   /**
    * Columns sort order