[move-analyzer] Support document symbol PSL

.github/workflows/ci-pre-land.yml

@@ -212,6 +212,8 @@ jobs:
       - prepare
     steps:
       - uses: actions/[email protected]
+      - name: install rust toolchain
+        uses: actions-rs/toolchain@v1
       - name: Use Node.js 14
         uses: actions/[email protected]
         with:
@@ -257,7 +259,7 @@ jobs:
           gem install awesome_bot
           # Don't look in git or target dirs. Don't check png, bib, tex, js, or shell files
           # We allow links to be redirects, allow duplicates, and we also allow Too Many Requests (429) errors
-          find . -not \( -path "./.git*" -prune \) -not \( -path "./target" -prune \) -type f -not -name "*.png" -not -name "*.sh" -not -name "*.bib" -not -name "*.tex" -not -name "*.js" | while read arg; do awesome_bot --allow-redirect --allow-dupe --allow 429 --skip-save-results $arg; done
+          find . -not \( -path "./.git*" -prune \) -not \( -path "./target" -prune \) -type f -not -name "*.png" -not -name "*.sh" -not -name "*.bib" -not -name "*.tex" -not -name "*.js" -not -name "package-lock.json" | while read arg; do awesome_bot --allow-redirect --allow-dupe --allow 429 --skip-save-results $arg; done
 
   build-move-cli-docker-image:
     name: Build Docker image for the Move CLI

language/move-analyzer/Cargo.toml

@@ -16,6 +16,7 @@ im = "15.1.0"
 lsp-server = "0.5.1"
 lsp-types = "0.90.1"
 petgraph = "0.5.1"
+serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0.64"
 tempfile = "3.2.0"
 url = "2.2.2"

language/move-analyzer/editors/code/.eslintrc.json

@@ -110,7 +110,7 @@
         "max-len": [
             "warn",
             {
-                "code": 100,
+                "code": 120,
                 "ignoreUrls": true
             }
         ],
@@ -206,10 +206,15 @@
         ],
         "@typescript-eslint/strict-boolean-expressions": "warn",
         "@typescript-eslint/switch-exhaustiveness-check": "warn",
-        "@typescript-eslint/type-annotation-spacing": "warn",
         "@typescript-eslint/unified-signatures": "warn",
 
         // The following are eslint-plugin-tsdoc rules:
-        "tsdoc/syntax": "warn"
+        "tsdoc/syntax": "warn",
+
+        "@typescript-eslint/no-unsafe-return": "off",
+        "@typescript-eslint/type-annotation-spacing": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/restrict-template-expressions": "off"
     }
 }

language/move-analyzer/editors/code/.gitignore

@@ -7,3 +7,5 @@ out
 .vscode-test
 # VS Code extension package (VSIX) archive
 *.vsix
+# Yarn cache directory
+yarn.lock

language/move-analyzer/editors/code/package.json

@@ -85,12 +85,14 @@
 		}
 	},
 	"scripts": {
-		"compile": "tsc -p ./",
+		"compile": "tsc -p ./ && cd ../../ && cargo build",
 		"watch": "tsc -watch -p ./",
 		"lint": "tsfmt --verify && eslint . --ext ts --max-warnings 0",
 		"fix": "tsfmt --replace && eslint . --ext ts --fix",
-		"pretest": "npm run compile && npm run lint",
+		"copy-tests-files": "copyfiles \"tests/**/*.move\" \"tests/**/*.exp\" \"tests/**/*.toml\" \"tests/**/*.code-workspace\" out",
+		"pretest": "npm run compile && npm run lint && npm run copy-tests-files",
 		"test": "node ./out/tests/runTests.js",
+		"dev": "npm run pretest && mode=dev node ./out/tests/runTests.js",
 		"vscode:prepublish": "npm run pretest",
 		"package": "vsce package -o move-analyzer.vsix",
 		"publish": "npm run pretest && npm run test && vsce publish"
@@ -110,15 +112,16 @@
 		"@types/vscode": "^1.58.2",
 		"@typescript-eslint/eslint-plugin": "^4.33.0",
 		"@typescript-eslint/parser": "^4.33.0",
-		"@vscode/test-electron": "^1.6.1",
+		"@vscode/test-electron": "^2.0.0",
 		"eslint": "^7.32.0",
 		"eslint-plugin-tsdoc": "^0.2.14",
 		"glob": "^7.1.7",
 		"mocha": "^9.1.1",
 		"typescript": "^4.4.4",
 		"typescript-formatter": "^7.2.2",
 		"vsce": "^2.5.1",
-		"vscode-test": "^1.6.1"
+		"vscode-test": "^1.6.1",
+		"copyfiles": "2.4.1"
 	},
 	"__metadata": {
 		"id": "71e74fc8-23c2-47b7-8594-ed00192d96a6",

language/move-analyzer/editors/code/src/commands/index.ts

@@ -0,0 +1 @@
+export * from './lsp_command';

language/move-analyzer/editors/code/src/commands/lsp_command.ts

@@ -0,0 +1,17 @@
+
+import * as lc from 'vscode-languageclient';
+import type { Context } from '../context';
+
+/**
+ * An LSP command textDocument/documentSymbol
+ */
+export async function textDocumentDocumentSymbol(context: Readonly<Context>, params: lc.DocumentSymbolParams)
+    : Promise<Array<lc.SymbolInformation> | Array<lc.DocumentSymbol> | null> {
+    const client = context.getClient();
+    if (client === undefined) {
+        return Promise.reject(new Error('No language client connected.'));
+    }
+
+    // Send the request to the language client.
+    return client.sendRequest(lc.DocumentSymbolRequest.type, params);
+}

language/move-analyzer/editors/code/src/configuration.ts

@@ -4,6 +4,7 @@
 
 import * as os from 'os';
 import * as vscode from 'vscode';
+import * as Path from 'path';
 
 /**
  * User-defined configuration values, such as those specified in VS Code settings.
@@ -36,6 +37,6 @@ export class Configuration {
         if (path.startsWith('~/')) {
             return os.homedir() + path.slice('~'.length);
         }
-        return path;
+        return Path.resolve(path);
     }
 }

language/move-analyzer/editors/code/src/context.ts

@@ -10,10 +10,15 @@ import { sync as commandExistsSync } from 'command-exists';
 
 /** Information passed along to each VS Code command defined by this extension. */
 export class Context {
+    private _client: lc.LanguageClient | undefined;
+
     private constructor(
         private readonly extensionContext: Readonly<vscode.ExtensionContext>,
         readonly configuration: Readonly<Configuration>,
-    ) { }
+        client: lc.LanguageClient | undefined = undefined,
+    ) {
+        this._client = client;
+    }
 
     static create(
         extensionContext: Readonly<vscode.ExtensionContext>,
@@ -39,12 +44,14 @@ export class Context {
      */
     registerCommand(
         name: Readonly<string>,
-        command: (context: Readonly<Context>) => Promise<void>,
+        command: (context: Readonly<Context>, ...args: Array<any>) => any,
     ): void {
-        const disposable = vscode.commands.registerCommand(`move-analyzer.${name}`, async () => {
-            const com = await command(this);
-            return com;
+        const disposable = vscode.commands.registerCommand(`move-analyzer.${name}`, async (...args: Array<any>)
+            : Promise<any> => {
+            const ret = await command(this, ...args);
+            return ret;
         });
+
         this.extensionContext.subscriptions.push(disposable);
     }
 
@@ -60,7 +67,7 @@ export class Context {
      * To read more about the messages sent and responses received by this client, such as
      * "initialize," read [the Language Server Protocol specification](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#initialize).
      **/
-    startClient(): void {
+    async startClient(): Promise<void> {
         const executable: lc.Executable = {
             command: this.configuration.serverPath,
         };
@@ -92,5 +99,16 @@ export class Context {
         log.info('Starting client...');
         const disposable = client.start();
         this.extensionContext.subscriptions.push(disposable);
+        this._client = client;
+        await this._client.onReady();
+    }
+
+    /**
+     * Returns the client that this extension interacts with.
+     *
+     * @returns lc.LanguageClient
+     */
+    getClient(): lc.LanguageClient | undefined {
+        return this._client;
     }
-}
+} // Context

language/move-analyzer/editors/code/src/main.ts

@@ -6,8 +6,11 @@ import { Configuration } from './configuration';
 import { Context } from './context';
 import { Extension } from './extension';
 import { log } from './log';
+
 import * as childProcess from 'child_process';
 import * as vscode from 'vscode';
+import * as commands from './commands';
+
 
 /**
  * An extension command that displays the version of the server that this extension
@@ -41,7 +44,7 @@ async function serverVersion(context: Readonly<Context>): Promise<void> {
  * Activation events for this extension are listed in its `package.json` file, under the key
  * `"activationEvents"`.
  */
-export function activate(extensionContext: Readonly<vscode.ExtensionContext>): void {
+export async function activate(extensionContext: Readonly<vscode.ExtensionContext>): Promise<void> {
     const extension = new Extension();
     log.info(`${extension.identifier} version ${extension.version}`);
 
@@ -63,5 +66,6 @@ export function activate(extensionContext: Readonly<vscode.ExtensionContext>): v
     context.registerCommand('serverVersion', serverVersion);
 
     // All other utilities provided by this extension occur via the language server.
-    context.startClient();
+    await context.startClient();
+    context.registerCommand('textDocumentDocumentSymbol', commands.textDocumentDocumentSymbol);
 }

language/move-analyzer/editors/code/tests/index.ts

@@ -14,6 +14,14 @@ import * as path from 'path';
 /* eslint-disable */
 // deno-lint-ignore require-await
 export async function run(): Promise<void> {
+    // dev mode
+    const mode = process.env['mode'] || 'test';
+    if (mode === 'dev') {
+        return new Promise((resolve) => {
+            setTimeout(resolve, 1000 * 60 * 15); // 15分钟休息一下
+        });
+    }
+
     /* eslint-disable */
     const suite = new Mocha({
         ui: 'tdd',

language/move-analyzer/editors/code/tests/lsp-demo/Move.toml

@@ -0,0 +1,9 @@
+[package]
+name = "Symbols"
+version = "0.0.1"
+
+[dependencies]
+MoveStdlib = { local = "../../../../../../move-stdlib/", addr_subst = { "std" = "0x1" } }
+
+[addresses]
+Symbols = "0xCAFE"

language/move-analyzer/editors/code/tests/lsp-demo/lsp-demo.code-workspace

@@ -0,0 +1,10 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {
+		"move-analyzer.server.path": "../../../../target/debug/move-analyzer"
+	}
+}

language/move-analyzer/editors/code/tests/lsp-demo/sources/M1.move

@@ -0,0 +1,18 @@
+module Symbols::M1 {
+
+    const SOME_CONST: u64 = 42;
+
+    struct SomeOtherStruct has drop {
+        some_field: u64,
+    }
+
+    public fun some_other_struct(v: u64): SomeOtherStruct {
+        SomeOtherStruct { some_field: v }
+    }
+
+    #[test]
+    #[expected_failure]
+    fun this_is_a_test() {
+        1/0;
+    }
+}

language/move-analyzer/editors/code/tests/lsp.test.ts

@@ -0,0 +1,52 @@
+import * as assert from 'assert';
+import * as Mocha from 'mocha';
+import * as path from 'path';
+import * as vscode from 'vscode';
+import * as lc from 'vscode-languageclient';
+
+Mocha.suite('LSP', () => {
+    Mocha.test('textDocument/documentSymbol', async () => {
+        const ext = vscode.extensions.getExtension('move.move-analyzer');
+        assert.ok(ext);
+
+        await ext.activate();
+
+        // 1. get workdir
+        const workDir = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath ?? '';
+
+        // 2. open doc
+        const docs = await vscode.workspace.openTextDocument(path.join(workDir, 'sources/M1.move'));
+        await vscode.window.showTextDocument(docs);
+
+        // 3. execute command
+        const params: lc.DocumentSymbolParams = {
+            textDocument: {
+                uri: docs.uri.toString(),
+            },
+        };
+
+        const syms: Array<lc.DocumentSymbol> | undefined = await
+            vscode.commands.executeCommand(
+                'move-analyzer.textDocumentDocumentSymbol', params,
+            );
+
+        assert.ok(syms);
+        assert.deepStrictEqual(syms[0]?.kind, lc.SymbolKind.Module);
+        assert.deepStrictEqual(syms[0].name, 'M1');
+
+        assert.ok(syms[0].children);
+        assert.deepStrictEqual(syms[0]?.children[0]?.kind, lc.SymbolKind.Constant);
+        assert.deepStrictEqual(syms[0]?.children[0].name, 'SOME_CONST');
+        assert.deepStrictEqual(syms[0]?.children[1]?.kind, lc.SymbolKind.Struct);
+        assert.deepStrictEqual(syms[0]?.children[1].name, 'SomeOtherStruct');
+        assert.ok(syms[0].children[1].children);
+        assert.deepStrictEqual(syms[0]?.children[1]?.children[0]?.kind, lc.SymbolKind.Field);
+        assert.deepStrictEqual(syms[0]?.children[1]?.children[0]?.name, 'some_field');
+        assert.deepStrictEqual(syms[0]?.children[1].name, 'SomeOtherStruct');
+        assert.deepStrictEqual(syms[0]?.children[2]?.kind, lc.SymbolKind.Function);
+        assert.deepStrictEqual(syms[0]?.children[2].name, 'some_other_struct');
+        assert.deepStrictEqual(syms[0]?.children[3]?.kind, lc.SymbolKind.Function);
+        assert.deepStrictEqual(syms[0]?.children[3].name, 'this_is_a_test');
+        assert.deepStrictEqual(syms[0]?.children[3]?.detail, '["test", "expected_failure"]');
+    });
+});

language/move-analyzer/editors/code/tests/runTests.ts

@@ -10,7 +10,8 @@
  */
 
 import * as path from 'path';
-import { runTests } from '@vscode/test-electron';
+import * as cp from 'child_process';
+import { runTests, downloadAndUnzipVSCode, resolveCliArgsFromVSCodeExecutablePath } from '@vscode/test-electron';
 
 /**
  * Launches a VS Code instance to run tests.
@@ -28,8 +29,26 @@ async function main(): Promise<void> {
         // program that is considered to be the "test suite" for the extension.
         const extensionTestsPath = path.resolve(__dirname, 'index.js');
 
+        // The workspace
+        const testWorkspacePath = path.resolve(__dirname, './lsp-demo/lsp-demo.code-workspace');
+
+        // Install vscode and depends extension
+        const vscodeVersion = '1.64.0';
+        const vscodeExecutablePath = await downloadAndUnzipVSCode(vscodeVersion);
+        const [cli, ...args] = resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath);
+        const newCli = cli ?? 'code';
+        cp.spawnSync(newCli, [...args, '--install-extension', 'damirka.move-syntax', '--force'], {
+            encoding: 'utf-8',
+            stdio: 'inherit',
+        });
+
         // Download VS Code, unzip it, and run the "test suite" program.
-        await runTests({ extensionDevelopmentPath, extensionTestsPath });
+        await runTests({
+            vscodeExecutablePath: vscodeExecutablePath,
+            extensionDevelopmentPath,
+            extensionTestsPath,
+            launchArgs: [testWorkspacePath],
+        });
     } catch (_err: unknown) {
         console.error('Failed to run tests');
         process.exit(1);