@zzzen/pyright-internal 1.2.0-dev.20240128 → 1.2.0-dev.20240225

package/dist/tests/lsp/languageServer.js

@@ -0,0 +1,326 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+/*
+ * languageServer.ts
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT license.
+ *
+ * Test language server wrapper that lets us run the language server during a test.
+ */
+const node_1 = require("vscode-languageserver/node");
+const worker_threads_1 = require("worker_threads");
+const deferred_1 = require("../../common/deferred");
+const pathUtils_1 = require("../../common/pathUtils");
+const serviceProvider_1 = require("../../common/serviceProvider");
+const uri_1 = require("../../common/uri/uri");
+const fourSlashParser_1 = require("../harness/fourslash/fourSlashParser");
+const PyrightTestHost = __importStar(require("../harness/testHost"));
+const factory_1 = require("../harness/vfs/factory");
+const backgroundAnalysis_1 = require("../../backgroundAnalysis");
+const backgroundThreadBase_1 = require("../../backgroundThreadBase");
+const serviceProviderExtensions_1 = require("../../common/serviceProviderExtensions");
+const pyrightFileSystem_1 = require("../../pyrightFileSystem");
+const server_1 = require("../../server");
+const customLsp_1 = require("./customLsp");
+const languageServerTestUtils_1 = require("./languageServerTestUtils");
+const WORKER_STARTED = 'WORKER_STARTED';
+const WORKER_BACKGROUND_DATA = 'WORKER_BACKGROUND_DATA';
+function getCommonRoot(files) {
+    var _a;
+    let root = ((_a = files[0]) === null || _a === void 0 ? void 0 : _a.getPath()) || languageServerTestUtils_1.DEFAULT_WORKSPACE_ROOT;
+    for (let i = 1; i < files.length; i++) {
+        const file = files[i];
+        while (root.length > 0 && !file.pathStartsWith(root)) {
+            root = root.slice(0, root.lastIndexOf('/'));
+        }
+    }
+    return root;
+}
+class TestPyrightHost {
+    constructor(_host) {
+        this._host = _host;
+    }
+    useCaseSensitiveFileNames() {
+        return this._host.useCaseSensitiveFileNames();
+    }
+    getAccessibleFileSystemEntries(dirname) {
+        return this._host.getAccessibleFileSystemEntries(dirname);
+    }
+    directoryExists(path) {
+        return this._host.directoryExists(path);
+    }
+    fileExists(fileName) {
+        return this._host.fileExists(fileName);
+    }
+    getFileSize(path) {
+        return this._host.getFileSize(path);
+    }
+    readFile(path) {
+        return this._host.readFile(path);
+    }
+    getWorkspaceRoot() {
+        // The default workspace root is wrong. It should be based on where the bundle is running.
+        // That's where the typeshed fallback and other bundled files are located.
+        return (0, pathUtils_1.resolvePaths)(__dirname);
+    }
+    writeFile(path, contents) {
+        this._host.writeFile(path, contents);
+    }
+    listFiles(path, filter, options) {
+        return this._host.listFiles(path, filter, options);
+    }
+    log(text) {
+        this._host.log(text);
+    }
+}
+function createTestHost(testServerData) {
+    const scriptOutput = '';
+    const runScript = async (pythonPath, scriptPath, args, cwd, token) => {
+        return { stdout: scriptOutput, stderr: '', exitCode: 0 };
+    };
+    const options = new languageServerTestUtils_1.TestHostOptions({ version: testServerData.pythonVersion, runScript });
+    const projectRootPaths = testServerData.projectRoots.map((p) => (0, languageServerTestUtils_1.getFileLikePath)(p));
+    const testData = (0, fourSlashParser_1.parseTestData)(testServerData.projectRoots.length === 1 ? projectRootPaths[0] : languageServerTestUtils_1.DEFAULT_WORKSPACE_ROOT, testServerData.code, 'noname.py');
+    const commonRoot = getCommonRoot(testServerData.projectRoots);
+    // Make sure global variables from previous tests are cleared.
+    (0, factory_1.clearCache)();
+    // create a test file system using the test data.
+    const fs = (0, languageServerTestUtils_1.createFileSystem)(commonRoot, testData, new TestPyrightHost(PyrightTestHost.HOST));
+    return new languageServerTestUtils_1.TestHost(fs, fs, testData, projectRootPaths, options);
+}
+class TestServer extends server_1.PyrightServer {
+    constructor(connection, fs, _supportsBackgroundAnalysis) {
+        super(connection, fs);
+        this._supportsBackgroundAnalysis = _supportsBackgroundAnalysis;
+    }
+    test_onDidChangeWatchedFiles(params) {
+        this.onDidChangeWatchedFiles(params);
+    }
+    async updateSettingsForWorkspace(workspace, status, serverSettings) {
+        const result = await super.updateSettingsForWorkspace(workspace, status, serverSettings);
+        // LSP notification only allows synchronous callback. because of that, the one that sent the notification can't know
+        // when the work caused by the notification actually ended. To workaround that issue, we will send custom lsp to indicate
+        // something has been done.
+        customLsp_1.CustomLSP.sendNotification(this.connection, customLsp_1.CustomLSP.Notifications.TestSignal, {
+            uri: workspace.rootUri.toString(),
+            kind: customLsp_1.CustomLSP.TestSignalKinds.Initialization,
+        });
+        return result;
+    }
+    createBackgroundAnalysis(serviceId) {
+        if (this._supportsBackgroundAnalysis) {
+            return new backgroundAnalysis_1.BackgroundAnalysis(this.serverOptions.serviceProvider);
+        }
+        return undefined;
+    }
+}
+async function runServer(testServerData, reader, writer, connectionFactory) {
+    // Create connection back to the client first.
+    const connection = connectionFactory(reader, writer);
+    // Fixup the input data.
+    testServerData = {
+        ...testServerData,
+        projectRoots: testServerData.projectRoots.map((p) => uri_1.Uri.fromJsonObj(p)),
+        logFile: uri_1.Uri.fromJsonObj(testServerData.logFile),
+    };
+    try {
+        // Create a host so we can control the file system for the PyrightServer.
+        const disposables = [];
+        const host = createTestHost(testServerData);
+        const server = new TestServer(connection, host.fs, testServerData.backgroundAnalysis);
+        // Listen for the test messages from the client. These messages
+        // are how the test code queries the state of the server.
+        disposables.push(customLsp_1.CustomLSP.onRequest(connection, customLsp_1.CustomLSP.Requests.GetDiagnostics, async (params, token) => {
+            const filePath = uri_1.Uri.parse(params.uri, true);
+            const workspace = await server.getWorkspaceForFile(filePath);
+            workspace.service.test_program.analyze(undefined, token);
+            const file = workspace.service.test_program.getBoundSourceFile(filePath);
+            const diagnostics = (file === null || file === void 0 ? void 0 : file.getDiagnostics(workspace.service.test_program.configOptions)) || [];
+            return { diagnostics: (0, backgroundThreadBase_1.serialize)(diagnostics) };
+        }));
+        // Dispose the server and connection when terminating the server.
+        disposables.push(server);
+        disposables.push(connection);
+        return { disposables, connection };
+    }
+    catch (err) {
+        console.error(err);
+        return { disposables: [], connection };
+    }
+}
+class ListeningPortMessageWriter extends node_1.PortMessageWriter {
+    constructor(port) {
+        super(port);
+        this._callbacks = [];
+    }
+    async write(msg) {
+        await Promise.all(this._callbacks.map((c) => c(msg)));
+        return super.write(msg);
+    }
+    onPostMessage(callback) {
+        this._callbacks.push(callback);
+    }
+}
+/**
+ * Object that exists in the worker thread that starts and stops (and cleans up after) the main server.
+ */
+class ServerStateManager {
+    constructor(_connectionFactory) {
+        this._connectionFactory = _connectionFactory;
+        this._instances = [];
+        this._reader = new node_1.PortMessageReader(worker_threads_1.parentPort);
+        this._writer = new ListeningPortMessageWriter(worker_threads_1.parentPort);
+        this._shutdownId = null;
+        // Listen for shutdown response.
+        this._writer.onPostMessage(async (msg) => {
+            if (node_1.Message.isResponse(msg) && msg.id === this._shutdownId) {
+                await this._handleShutdown();
+            }
+        });
+    }
+    run() {
+        worker_threads_1.parentPort === null || worker_threads_1.parentPort === void 0 ? void 0 : worker_threads_1.parentPort.on('message', (message) => this._handleMessage(message));
+    }
+    _handleMessage(message) {
+        try {
+            // Debug output to help diagnose sync issues.
+            if (message && message.method === customLsp_1.CustomLSP.Notifications.TestStartServer) {
+                this._handleStart(message.params);
+            }
+            else if (node_1.Message.isRequest(message) && message.method === node_1.ShutdownRequest.method) {
+                this._shutdownId = message.id;
+            }
+        }
+        catch (err) {
+            console.error(err);
+        }
+    }
+    async _handleStart(options) {
+        var _a;
+        (0, languageServerTestUtils_1.logToDisk)(`Starting server for ${options.testName}`, options.logFile);
+        // Every time we start the server, remove all message handlers from our PortMessageReader.
+        // This prevents the old servers from responding to messages for new ones.
+        this._reader.dispose();
+        // Wait for the previous server to finish. This should be okay because the test
+        // client waits for the response message before sending anything else. Otherwise
+        // we'd receive the initialize message for the server and drop it before the server
+        // actually started.
+        if (this._pendingDispose) {
+            (0, languageServerTestUtils_1.logToDisk)(`Waiting for previous server ${(_a = this._currentOptions) === null || _a === void 0 ? void 0 : _a.testName} to finish for ${options.testName}`, options.logFile);
+            await this._pendingDispose.promise;
+            this._pendingDispose = undefined;
+        }
+        this._currentOptions = options;
+        // Set the worker data for the current test. Any background threads
+        // started after this point will pick up this value.
+        (0, worker_threads_1.setEnvironmentData)(WORKER_BACKGROUND_DATA, options);
+        // Create an instance of the server.
+        const { disposables, connection } = await runServer(options, this._reader, this._writer, this._connectionFactory);
+        this._instances.push({ disposables, connection });
+        // Enable this to help diagnose sync issues.
+        (0, languageServerTestUtils_1.logToDisk)(`Started server for ${options.testName}`, options.logFile);
+        // Respond back.
+        worker_threads_1.parentPort === null || worker_threads_1.parentPort === void 0 ? void 0 : worker_threads_1.parentPort.postMessage({
+            jsonrpc: '2.0',
+            method: customLsp_1.CustomLSP.Notifications.TestStartServerResponse,
+            params: options,
+        });
+    }
+    async _handleShutdown() {
+        var _a, _b, _c, _d, _e;
+        if (this._currentOptions) {
+            (0, languageServerTestUtils_1.logToDisk)(`Stopping ${(_a = this._currentOptions) === null || _a === void 0 ? void 0 : _a.testName}`, this._currentOptions.logFile);
+        }
+        this._shutdownId = null;
+        const instance = this._instances.pop();
+        if (instance) {
+            this._pendingDispose = (0, deferred_1.createDeferred)();
+            // Wait for our connection to finish first. Give it 10 tries.
+            // This is a bit of a hack but there are no good ways to cancel all running requests
+            // on shutdown.
+            let count = 0;
+            while (count < 10 && ((_c = (_b = instance.connection.console) === null || _b === void 0 ? void 0 : _b._rawConnection) === null || _c === void 0 ? void 0 : _c.hasPendingResponse())) {
+                await (0, languageServerTestUtils_1.sleep)(10);
+                count += 1;
+            }
+            this._pendingDispose.resolve();
+            instance.disposables.forEach((d) => {
+                d.dispose();
+            });
+            this._pendingDispose = undefined;
+            if (this._currentOptions) {
+                (0, languageServerTestUtils_1.logToDisk)(`Stopped ${(_d = this._currentOptions) === null || _d === void 0 ? void 0 : _d.testName}`, this._currentOptions.logFile);
+            }
+        }
+        else {
+            if (this._currentOptions) {
+                (0, languageServerTestUtils_1.logToDisk)(`Failed to stop ${(_e = this._currentOptions) === null || _e === void 0 ? void 0 : _e.testName}`, this._currentOptions.logFile);
+            }
+        }
+        if (global.gc) {
+            global.gc();
+        }
+    }
+}
+async function runTestBackgroundThread() {
+    let options = (0, worker_threads_1.getEnvironmentData)(WORKER_BACKGROUND_DATA);
+    // Normalize the options.
+    options = {
+        ...options,
+        projectRoots: options.projectRoots.map((p) => uri_1.Uri.fromJsonObj(p)),
+        logFile: uri_1.Uri.fromJsonObj(options.logFile),
+    };
+    try {
+        // Create a host on the background thread too so that it uses
+        // the host's file system. Has to be sync so that we don't
+        // drop any messages sent to the background thread.
+        const host = createTestHost(options);
+        const fs = new pyrightFileSystem_1.PyrightFileSystem(host.fs);
+        const serviceProvider = new serviceProvider_1.ServiceProvider();
+        serviceProvider.add(serviceProviderExtensions_1.ServiceKeys.fs, fs);
+        // run default background runner
+        const runner = new backgroundAnalysis_1.BackgroundAnalysisRunner(serviceProvider);
+        runner.start();
+    }
+    catch (e) {
+        console.error(`BackgroundThread crashed with ${e}`);
+    }
+}
+function run() {
+    // Start the background thread if this is not the first worker.
+    if ((0, worker_threads_1.getEnvironmentData)(WORKER_STARTED) === 'true') {
+        runTestBackgroundThread();
+    }
+    else {
+        (0, worker_threads_1.setEnvironmentData)(WORKER_STARTED, 'true');
+        // Start the server state manager.
+        const stateManager = new ServerStateManager((reader, writer) => (0, node_1.createConnection)(reader, writer, {}));
+        stateManager.run();
+    }
+}
+exports.run = run;
+//# sourceMappingURL=languageServer.js.map

package/dist/tests/lsp/languageServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"languageServer.js","sourceRoot":"","sources":["../../../../../../src/tests/lsp/languageServer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;GAMG;AACH,qDAWoC;AACpC,mDAAiG;AAEjG,oDAAiE;AACjE,sDAAyE;AACzE,kEAA+D;AAC/D,8CAA2C;AAC3C,0EAAqE;AACrE,qEAAuD;AACvD,oDAAoD;AAEpD,iEAAwF;AAExF,qEAAuD;AAEvD,sFAAqE;AAErE,+DAA4D;AAC5D,yCAA6C;AAE7C,2CAAwC;AACxC,uEAQmC;AAEnC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AACxC,MAAM,sBAAsB,GAAG,wBAAwB,CAAC;AAExD,SAAS,aAAa,CAAC,KAAY;;IAC/B,IAAI,IAAI,GAAG,CAAA,MAAA,KAAK,CAAC,CAAC,CAAC,0CAAE,OAAO,EAAE,KAAI,gDAAsB,CAAC;IACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;YAClD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;SAC/C;KACJ;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,eAAe;IACjB,YAAoB,KAA+B;QAA/B,UAAK,GAAL,KAAK,CAA0B;IAAG,CAAC;IACvD,yBAAyB;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC;IAClD,CAAC;IACD,8BAA8B,CAAC,OAAe;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IACD,eAAe,CAAC,IAAY;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACD,UAAU,CAAC,QAAgB;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IACD,WAAW,CAAC,IAAY;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IACD,QAAQ,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IACD,gBAAgB;QACZ,0FAA0F;QAC1F,0EAA0E;QAC1E,OAAO,IAAA,wBAAY,EAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IACD,SAAS,CAAC,IAAY,EAAE,QAAgB;QACpC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IACD,SAAS,CACL,IAAY,EACZ,MAA2B,EAC3B,OAAyD;QAEzD,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IACD,GAAG,CAAC,IAAY;QACZ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACJ;AAED,SAAS,cAAc,CAAC,cAAgD;IACpE,MAAM,YAAY,GAAG,EAAE,CAAC;IACxB,MAAM,SAAS,GAAG,KAAK,EACnB,UAA2B,EAC3B,UAAe,EACf,IAAc,EACd,GAAQ,EACR,KAAwB,EAC1B,EAAE;QACA,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAC7D,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,IAAI,yCAAe,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1F,MAAM,gBAAgB,GAAG,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,yCAAe,EAAC,CAAC,CAAC,CAAC,CAAC;IACpF,MAAM,QAAQ,GAAG,IAAA,+BAAa,EAC1B,cAAc,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gDAAsB,EACvF,cAAc,CAAC,IAAI,EACnB,WAAW,CACd,CAAC;IACF,MAAM,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IAE9D,8DAA8D;IAC9D,IAAA,oBAAU,GAAE,CAAC;IAEb,iDAAiD;IACjD,MAAM,EAAE,GAAG,IAAA,0CAAgB,EAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,eAAe,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;IAE7F,OAAO,IAAI,kCAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAW,SAAQ,sBAAa;IAClC,YACI,UAAsB,EACtB,EAAc,EACG,2BAAgD;QAEjE,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAFL,gCAA2B,GAA3B,2BAA2B,CAAqB;IAGrE,CAAC;IAED,4BAA4B,CAAC,MAAW;QACpC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IACQ,KAAK,CAAC,0BAA0B,CACrC,SAAoB,EACpB,MAA8B,EAC9B,cAA2C;QAE3C,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QAEzF,oHAAoH;QACpH,yHAAyH;QACzH,2BAA2B;QAC3B,qBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,qBAAS,CAAC,aAAa,CAAC,UAAU,EAAE;YAC5E,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;YACjC,IAAI,EAAE,qBAAS,CAAC,eAAe,CAAC,cAAc;SACjD,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;IAEQ,wBAAwB,CAAC,SAAiB;QAC/C,IAAI,IAAI,CAAC,2BAA2B,EAAE;YAClC,OAAO,IAAI,uCAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;SACrE;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AAED,KAAK,UAAU,SAAS,CACpB,cAAgD,EAChD,MAAqB,EACrB,MAAqB,EACrB,iBAA+E;IAE/E,8CAA8C;IAC9C,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErD,wBAAwB;IACxB,cAAc,GAAG;QACb,GAAG,cAAc;QACjB,YAAY,EAAE,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QACxE,OAAO,EAAE,SAAG,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC;KACnD,CAAC;IAEF,IAAI;QACA,yEAAyE;QACzE,MAAM,WAAW,GAAiB,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,cAAc,CAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAEtF,+DAA+D;QAC/D,yDAAyD;QACzD,WAAW,CAAC,IAAI,CACZ,qBAAS,CAAC,SAAS,CAAC,UAAU,EAAE,qBAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YACvF,MAAM,QAAQ,GAAG,SAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC7C,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;YAC7D,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACzD,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACzE,MAAM,WAAW,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,KAAI,EAAE,CAAC;YAC7F,OAAO,EAAE,WAAW,EAAE,IAAA,gCAAS,EAAC,WAAW,CAAC,EAAE,CAAC;QACnD,CAAC,CAAC,CACL,CAAC;QAEF,iEAAiE;QACjE,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7B,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;KACtC;IAAC,OAAO,GAAG,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC;KAC1C;AACL,CAAC;AAED,MAAM,0BAA2B,SAAQ,wBAAiB;IAEtD,YAAY,IAAiB;QACzB,KAAK,CAAC,IAAI,CAAC,CAAC;QAFR,eAAU,GAAwC,EAAE,CAAC;IAG7D,CAAC;IACQ,KAAK,CAAC,KAAK,CAAC,GAAY;QAC7B,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED,aAAa,CAAC,QAAyC;QACnD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,kBAAkB;IAOpB,YAA6B,kBAAgF;QAAhF,uBAAkB,GAAlB,kBAAkB,CAA8D;QANrG,eAAU,GAA4D,EAAE,CAAC;QAEzE,YAAO,GAAG,IAAI,wBAAiB,CAAC,2BAAW,CAAC,CAAC;QAC7C,YAAO,GAAG,IAAI,0BAA0B,CAAC,2BAAW,CAAC,CAAC;QAEtD,gBAAW,GAA2B,IAAI,CAAC;QAE/C,gCAAgC;QAChC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,EAAE,GAAY,EAAE,EAAE;YAC9C,IAAI,cAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;gBACxD,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;aAChC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,GAAG;QACC,2BAAU,aAAV,2BAAU,uBAAV,2BAAU,CAAE,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,CAAC;IAEO,cAAc,CAAC,OAAY;QAC/B,IAAI;YACA,6CAA6C;YAC7C,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,qBAAS,CAAC,aAAa,CAAC,eAAe,EAAE;gBACvE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;aACrC;iBAAM,IAAI,cAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,sBAAe,CAAC,MAAM,EAAE;gBAChF,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC;aACjC;SACJ;QAAC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACtB;IACL,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,OAAyC;;QAChE,IAAA,mCAAS,EAAC,uBAAuB,OAAO,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtE,0FAA0F;QAC1F,0EAA0E;QAC1E,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvB,+EAA+E;QAC/E,gFAAgF;QAChF,mFAAmF;QACnF,oBAAoB;QACpB,IAAI,IAAI,CAAC,eAAe,EAAE;YACtB,IAAA,mCAAS,EACL,+BAA+B,MAAA,IAAI,CAAC,eAAe,0CAAE,QAAQ,kBAAkB,OAAO,CAAC,QAAQ,EAAE,EACjG,OAAO,CAAC,OAAO,CAClB,CAAC;YACF,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SACpC;QACD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;QAE/B,mEAAmE;QACnE,oDAAoD;QACpD,IAAA,mCAAkB,EAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;QAEpD,oCAAoC;QACpC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,MAAM,SAAS,CAC/C,OAAO,EACP,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,kBAAkB,CAC1B,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;QAElD,4CAA4C;QAC5C,IAAA,mCAAS,EAAC,sBAAsB,OAAO,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAErE,gBAAgB;QAChB,2BAAU,aAAV,2BAAU,uBAAV,2BAAU,CAAE,WAAW,CAAC;YACpB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,qBAAS,CAAC,aAAa,CAAC,uBAAuB;YACvD,MAAM,EAAE,OAAO;SAClB,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,eAAe;;QACzB,IAAI,IAAI,CAAC,eAAe,EAAE;YACtB,IAAA,mCAAS,EAAC,YAAY,MAAA,IAAI,CAAC,eAAe,0CAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;SACzF;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QACvC,IAAI,QAAQ,EAAE;YACV,IAAI,CAAC,eAAe,GAAG,IAAA,yBAAc,GAAQ,CAAC;YAE9C,6DAA6D;YAC7D,oFAAoF;YACpF,eAAe;YACf,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,OAAO,KAAK,GAAG,EAAE,KAAI,MAAA,MAAC,QAAQ,CAAC,UAAkB,CAAC,OAAO,0CAAE,cAAc,0CAAE,kBAAkB,EAAE,CAAA,EAAE;gBAC7F,MAAM,IAAA,+BAAK,EAAC,EAAE,CAAC,CAAC;gBAChB,KAAK,IAAI,CAAC,CAAC;aACd;YACD,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;YAC/B,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC/B,CAAC,CAAC,OAAO,EAAE,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;YACjC,IAAI,IAAI,CAAC,eAAe,EAAE;gBACtB,IAAA,mCAAS,EAAC,WAAW,MAAA,IAAI,CAAC,eAAe,0CAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;aACxF;SACJ;aAAM;YACH,IAAI,IAAI,CAAC,eAAe,EAAE;gBACtB,IAAA,mCAAS,EAAC,kBAAkB,MAAA,IAAI,CAAC,eAAe,0CAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;aAC/F;SACJ;QACD,IAAI,MAAM,CAAC,EAAE,EAAE;YACX,MAAM,CAAC,EAAE,EAAE,CAAC;SACf;IACL,CAAC;CACJ;AAED,KAAK,UAAU,uBAAuB;IAClC,IAAI,OAAO,GAAG,IAAA,mCAAkB,EAAC,sBAAsB,CAAqC,CAAC;IAE7F,yBAAyB;IACzB,OAAO,GAAG;QACN,GAAG,OAAO;QACV,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QACjE,OAAO,EAAE,SAAG,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC;KAC5C,CAAC;IACF,IAAI;QACA,6DAA6D;QAC7D,0DAA0D;QAC1D,mDAAmD;QACnD,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,EAAE,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1C,MAAM,eAAe,GAAG,IAAI,iCAAe,EAAE,CAAC;QAC9C,eAAe,CAAC,GAAG,CAAC,uCAAW,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAExC,gCAAgC;QAChC,MAAM,MAAM,GAAG,IAAI,6CAAwB,CAAC,eAAe,CAAC,CAAC;QAC7D,MAAM,CAAC,KAAK,EAAE,CAAC;KAClB;IAAC,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,KAAK,CAAC,iCAAiC,CAAC,EAAE,CAAC,CAAC;KACvD;AACL,CAAC;AAED,SAAgB,GAAG;IACf,+DAA+D;IAC/D,IAAI,IAAA,mCAAkB,EAAC,cAAc,CAAC,KAAK,MAAM,EAAE;QAC/C,uBAAuB,EAAE,CAAC;KAC7B;SAAM;QACH,IAAA,mCAAkB,EAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAE3C,kCAAkC;QAClC,MAAM,YAAY,GAAG,IAAI,kBAAkB,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,uBAAgB,EAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACtG,YAAY,CAAC,GAAG,EAAE,CAAC;KACtB;AACL,CAAC;AAXD,kBAWC"}

package/dist/tests/lsp/languageServerTestUtils.d.ts

@@ -0,0 +1,100 @@
+import { ApplyWorkspaceEditParams, CancellationToken, ConfigurationItem, Disposable, InitializeParams, LogMessageParams, PublishDiagnosticsParams, Registration } from 'vscode-languageserver-protocol';
+import { Connection, Event, NotificationHandler, ProgressToken, ProgressType, ProtocolNotificationType } from 'vscode-languageserver/node';
+import { PythonPathResult } from '../../analyzer/pythonPathUtils';
+import { IPythonMode } from '../../analyzer/sourceFile';
+import { PythonPlatform } from '../../common/configOptions';
+import { Deferred } from '../../common/deferred';
+import { FileSystem } from '../../common/fileSystem';
+import { LimitedAccessHost } from '../../common/fullAccessHost';
+import { HostKind, ScriptOutput } from '../../common/host';
+import { PythonVersion } from '../../common/pythonVersion';
+import { Uri } from '../../common/uri/uri';
+import { FourSlashData } from '../harness/fourslash/fourSlashTypes';
+import * as host from '../harness/testHost';
+import * as vfs from '../harness/vfs/filesystem';
+import { CustomLSP } from './customLsp';
+export declare const DEFAULT_WORKSPACE_ROOT: string;
+export declare const ERROR_SCRIPT_OUTPUT = "Error: script failed to run";
+export declare const STALL_SCRIPT_OUTPUT = "Timeout: script never finished running";
+export interface PyrightServerInfo {
+    disposables: Disposable[];
+    registrations: Registration[];
+    logs: LogMessageParams[];
+    connection: Connection;
+    signals: Map<CustomLSP.TestSignalKinds, Deferred<boolean>>;
+    testName: string;
+    testData: FourSlashData;
+    projectRoots: Uri[];
+    progressReporters: string[];
+    progressReporterStatus: Map<string, number>;
+    progressParts: Map<string, TestProgressPart>;
+    telemetry: any[];
+    diagnostics: PublishDiagnosticsParams[];
+    diagnosticsEvent: Event<PublishDiagnosticsParams>;
+    workspaceEdits: ApplyWorkspaceEditParams[];
+    workspaceEditsEvent: Event<ApplyWorkspaceEditParams>;
+    getInitializeParams(): InitializeParams;
+    dispose(): Promise<void>;
+    convertPathToUri(path: string): Uri;
+}
+export declare class TestHostOptions {
+    version: PythonVersion;
+    platform: PythonPlatform;
+    searchPaths: Uri[];
+    runScript: (pythonPath: Uri | undefined, scriptPath: Uri, args: string[], cwd: Uri, token: CancellationToken) => Promise<ScriptOutput>;
+    constructor({ version, platform, searchPaths, runScript, }?: {
+        version?: PythonVersion | undefined;
+        platform?: PythonPlatform | undefined;
+        searchPaths?: Uri[] | undefined;
+        runScript?: ((pythonPath: Uri | undefined, scriptPath: Uri, args: string[], cwd: Uri, token: CancellationToken) => Promise<{
+            stdout: string;
+            stderr: string;
+        }>) | undefined;
+    });
+}
+export declare const logToDisk: (m: string, f: Uri) => void;
+export declare function logToDiskImpl(message: string, fileName: Uri): void;
+export declare function cleanupAfterAll(): Promise<void>;
+export declare function getFileLikePath(uri: Uri): string;
+export declare function createFileSystem(projectRoot: string, testData: FourSlashData, optionalHost?: host.TestHost): vfs.TestFileSystem;
+export declare function updateSettingsMap(info: PyrightServerInfo, settings: {
+    item: ConfigurationItem;
+    value: any;
+}[]): void;
+export declare function getParseResults(fileContents: string, isStubFile?: boolean, ipythonMode?: IPythonMode): import("../../parser/parser").ParseResults;
+export declare function waitForDiagnostics(info: PyrightServerInfo, timeout?: number): Promise<PublishDiagnosticsParams[]>;
+interface ProgressPart {
+}
+interface ProgressContext {
+    onProgress<P>(type: ProgressType<P>, token: string | number, handler: NotificationHandler<P>): Disposable;
+    sendNotification<P, RO>(type: ProtocolNotificationType<P, RO>, params?: P): void;
+}
+declare class TestProgressPart implements ProgressPart {
+    private readonly _context;
+    private readonly _token;
+    constructor(_context: ProgressContext, _token: ProgressToken, info: PyrightServerInfo, done: () => void);
+    sendCancel(): void;
+}
+export declare function runPyrightServer(projectRoots: string[] | string, code: string, callInitialize?: boolean, extraSettings?: {
+    item: ConfigurationItem;
+    value: any;
+}[], pythonVersion?: PythonVersion, backgroundAnalysis?: boolean): Promise<PyrightServerInfo>;
+export declare function initializeLanguageServer(info: PyrightServerInfo): Promise<import("vscode-languageserver-protocol").InitializeResult<any>>;
+export declare function sleep(timeout: number): Promise<number>;
+export declare function openFile(info: PyrightServerInfo, markerName: string, text?: string): void;
+export declare function hover(info: PyrightServerInfo, markerName: string): Promise<import("vscode-languageserver-types").Hover | null>;
+export declare function getInitializeParams(projectRoots: Uri[]): InitializeParams;
+export declare class TestHost extends LimitedAccessHost {
+    readonly fs: FileSystem;
+    readonly testFs: vfs.TestFileSystem;
+    readonly testData: FourSlashData;
+    readonly projectRoots: string[];
+    private readonly _options;
+    constructor(fs: FileSystem, testFs: vfs.TestFileSystem, testData: FourSlashData, projectRoots: string[], options?: TestHostOptions);
+    get kind(): HostKind;
+    getPythonVersion(pythonPath?: Uri, logInfo?: string[]): PythonVersion | undefined;
+    getPythonPlatform(logInfo?: string[]): PythonPlatform | undefined;
+    getPythonSearchPaths(pythonPath?: Uri, logInfo?: string[]): PythonPathResult;
+    runScript(pythonPath: Uri | undefined, scriptPath: Uri, args: string[], cwd: Uri, token: CancellationToken): Promise<ScriptOutput>;
+}
+export {};