@zzzen/pyright-internal 1.2.0-dev.20230416 → 1.2.0-dev.20230430

package/dist/tests/harness/fourslash/testState.js

@@ -37,7 +37,6 @@ const vscode_languageserver_1 = require("vscode-languageserver");
 const parseTreeUtils_1 = require("../../../analyzer/parseTreeUtils");
 const service_1 = require("../../../analyzer/service");
 const commandResult_1 = require("../../../commands/commandResult");
-const collectionUtils_1 = require("../../../common/collectionUtils");
 const configOptions_1 = require("../../../common/configOptions");
 const console_1 = require("../../../common/console");
 const core_1 = require("../../../common/core");
@@ -45,8 +44,13 @@ const debug = __importStar(require("../../../common/debug"));
 const pathUtils_1 = require("../../../common/pathUtils");
 const positionUtils_1 = require("../../../common/positionUtils");
 const textRange_1 = require("../../../common/textRange");
+const callHierarchyProvider_1 = require("../../../languageService/callHierarchyProvider");
 const definitionProvider_1 = require("../../../languageService/definitionProvider");
+const documentHighlightProvider_1 = require("../../../languageService/documentHighlightProvider");
 const hoverProvider_1 = require("../../../languageService/hoverProvider");
+const navigationUtils_1 = require("../../../languageService/navigationUtils");
+const referencesProvider_1 = require("../../../languageService/referencesProvider");
+const signatureHelpProvider_1 = require("../../../languageService/signatureHelpProvider");
 const tokenizer_1 = require("../../../parser/tokenizer");
 const pyrightFileSystem_1 = require("../../../pyrightFileSystem");
 const workspaceFactory_1 = require("../../../workspaceFactory");
@@ -259,12 +263,12 @@ class TestState {
         if (this.testData.rangesByText) {
             return this.testData.rangesByText;
         }
-        const result = this.createMultiMap(this.getRanges(), (r) => this._rangeText(r));
+        const result = this.createMultiMap(this.getRanges(), (r) => this.rangeText(r));
         this.testData.rangesByText = result;
         return result;
     }
     getFilteredRanges(predicate) {
-        return this.getRanges().filter((r) => { var _a; return predicate(r.marker, (_a = r.marker) === null || _a === void 0 ? void 0 : _a.data, this._rangeText(r)); });
+        return this.getRanges().filter((r) => { var _a; return predicate(r.marker, (_a = r.marker) === null || _a === void 0 ? void 0 : _a.data, this.rangeText(r)); });
     }
     getRangeByMarkerName(markerName) {
         const marker = this.getMarkerByName(markerName);
@@ -287,7 +291,7 @@ class TestState {
         const fileToOpen = this._findFile(indexOrName);
         fileToOpen.fileName = (0, pathUtils_1.normalizeSlashes)(fileToOpen.fileName);
         this.activeFile = fileToOpen;
-        this.program.setFileOpened(this.activeFile.fileName, 1, [{ text: fileToOpen.content }]);
+        this.program.setFileOpened(this.activeFile.fileName, 1, fileToOpen.content);
     }
     openFiles(indexOrNames) {
         for (const indexOrName of indexOrNames) {
@@ -574,7 +578,8 @@ class TestState {
                 continue;
             }
             const rangePos = this.convertOffsetsToRange(range.fileName, range.pos, range.end);
-            const actual = (0, hoverProvider_1.convertHoverResults)(kind, this.program.getHoverForPosition(range.fileName, rangePos.start, kind, vscode_languageserver_1.CancellationToken.None));
+            const provider = new hoverProvider_1.HoverProvider(this.program, range.fileName, rangePos.start, kind, false, vscode_languageserver_1.CancellationToken.None);
+            const actual = provider.getHover();
             // if expected is null then there should be nothing shown on hover
             if (expected === null) {
                 assert_1.default.equal(actual, undefined);
@@ -616,7 +621,7 @@ class TestState {
         }
     }
     verifyRangeIs(expectedText, includeWhiteSpace) {
-        this._verifyTextMatches(this._rangeText(this._getOnlyRange()), !!includeWhiteSpace, expectedText);
+        this._verifyTextMatches(this.rangeText(this._getOnlyRange()), !!includeWhiteSpace, expectedText);
     }
     async verifyCompletion(verifyMode, docFormat, map, abbrMap) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
@@ -713,6 +718,7 @@ class TestState {
         }
     }
     verifySignature(docFormat, map) {
+        var _a, _b;
         this.analyze();
         for (const marker of this.getMarkers()) {
             const fileName = marker.fileName;
@@ -722,7 +728,10 @@ class TestState {
             }
             const expected = map[name];
             const position = this.convertOffsetToPosition(fileName, marker.position);
-            const actual = this.program.getSignatureHelpForPosition(fileName, position, docFormat, vscode_languageserver_1.CancellationToken.None);
+            const actual = new signatureHelpProvider_1.SignatureHelpProvider(this.program, fileName, position, docFormat, 
+            /*hasSignatureLabelOffsetCapability*/ true, 
+            /*hasActiveParameterCapability*/ true, 
+            /*context*/ undefined, vscode_languageserver_1.CancellationToken.None).getSignatureHelp();
             if (expected.noSig) {
                 assert_1.default.equal(actual, undefined);
                 continue;
@@ -737,7 +746,7 @@ class TestState {
                 assert_1.default.ok(sig.parameters);
                 const actualParameters = [];
                 sig.parameters.forEach((p) => {
-                    actualParameters.push(sig.label.substring(p.startOffset, p.endOffset));
+                    actualParameters.push((0, core_1.isString)(p.label) ? p.label : sig.label.substring(p.label[0], p.label[1]));
                 });
                 assert_1.default.deepEqual(actualParameters, expectedSig.parameters);
                 if (expectedSig.documentation === undefined) {
@@ -752,7 +761,9 @@ class TestState {
             });
             assert_1.default.deepEqual(actual.signatures.map((sig) => sig.activeParameter), expected.activeParameters);
             if (expected.callHasParameters !== undefined) {
-                assert_1.default.equal(actual.callHasParameters, expected.callHasParameters);
+                const isActive = (sig) => { var _a; return !expected.callHasParameters && !((_a = sig.parameters) === null || _a === void 0 ? void 0 : _a.length); };
+                const activeSignature = (_b = (_a = expected.signatures) === null || _a === void 0 ? void 0 : _a.findIndex(isActive)) !== null && _b !== void 0 ? _b : undefined;
+                assert_1.default.equal(actual.activeSignature, activeSignature);
             }
         }
     }
@@ -767,16 +778,16 @@ class TestState {
             }
             const expected = map[name].references;
             const position = this.convertOffsetToPosition(fileName, marker.position);
-            const actual = [];
-            this.program.reportReferencesForPosition(fileName, position, true, (locs) => (0, collectionUtils_1.appendArray)(actual, locs), vscode_languageserver_1.CancellationToken.None);
+            const actual = new referencesProvider_1.ReferencesProvider(this.program, vscode_languageserver_1.CancellationToken.None).reportReferences(fileName, position, 
+            /* includeDeclaration */ true);
             assert_1.default.strictEqual((_a = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _a !== void 0 ? _a : 0, expected.length, `${name} has failed`);
-            for (const r of expected) {
+            for (const r of (0, navigationUtils_1.convertDocumentRangesToLocation)(this.program.fileSystem, expected)) {
                 assert_1.default.equal(actual === null || actual === void 0 ? void 0 : actual.filter((d) => this._deepEqual(d, r)).length, 1);
             }
         }
     }
     verifyShowCallHierarchyGetIncomingCalls(map) {
-        var _a;
+        var _a, _b, _c;
         this.analyze();
         for (const marker of this.getMarkers()) {
             const fileName = marker.fileName;
@@ -784,14 +795,45 @@ class TestState {
             if (!(name in map)) {
                 continue;
             }
-            const expected = map[name].references;
+            const expectedFilePath = map[name].items.map((x) => x.filePath);
+            const expectedRange = map[name].items.map((x) => x.range);
+            const expectedName = map[name].items.map((x) => x.name);
             const position = this.convertOffsetToPosition(fileName, marker.position);
-            const actual = this.program.getIncomingCallsForPosition(fileName, position, vscode_languageserver_1.CancellationToken.None);
-            assert_1.default.strictEqual((_a = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _a !== void 0 ? _a : 0, expected.length, `${name} has failed`);
+            const actual = new callHierarchyProvider_1.CallHierarchyProvider(this.program, fileName, position, vscode_languageserver_1.CancellationToken.None).getIncomingCalls();
+            assert_1.default.strictEqual((_a = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _a !== void 0 ? _a : 0, expectedFilePath.length, `${name} has failed`);
+            assert_1.default.strictEqual((_b = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _b !== void 0 ? _b : 0, expectedRange.length, `${name} has failed`);
+            assert_1.default.strictEqual((_c = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _c !== void 0 ? _c : 0, expectedName.length, `${name} has failed`);
             if (actual) {
                 for (const a of actual) {
-                    assert_1.default.equal(expected === null || expected === void 0 ? void 0 : expected.filter((e) => this._deepEqual(a.from.range, e.range)).length, 1);
-                    assert_1.default.equal(expected === null || expected === void 0 ? void 0 : expected.filter((e) => this._deepEqual(a.from.uri, e.path)).length, 1);
+                    assert_1.default.strictEqual(expectedRange === null || expectedRange === void 0 ? void 0 : expectedRange.filter((e) => this._deepEqual(a.from.range, e)).length, 1);
+                    assert_1.default.strictEqual(expectedName === null || expectedName === void 0 ? void 0 : expectedName.filter((e) => this._deepEqual(a.from.name, e)).length, 1);
+                    assert_1.default.ok((expectedFilePath === null || expectedFilePath === void 0 ? void 0 : expectedFilePath.filter((e) => this._deepEqual(a.from.uri, (0, pathUtils_1.convertPathToUri)(this.program.fileSystem, e))).length) >= 1);
+                }
+            }
+        }
+    }
+    verifyShowCallHierarchyGetOutgoingCalls(map) {
+        var _a, _b, _c;
+        this.analyze();
+        for (const marker of this.getMarkers()) {
+            const fileName = marker.fileName;
+            const name = this.getMarkerName(marker);
+            if (!(name in map)) {
+                continue;
+            }
+            const expectedFilePath = map[name].items.map((x) => x.filePath);
+            const expectedRange = map[name].items.map((x) => x.range);
+            const expectedName = map[name].items.map((x) => x.name);
+            const position = this.convertOffsetToPosition(fileName, marker.position);
+            const actual = new callHierarchyProvider_1.CallHierarchyProvider(this.program, fileName, position, vscode_languageserver_1.CancellationToken.None).getOutgoingCalls();
+            assert_1.default.strictEqual((_a = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _a !== void 0 ? _a : 0, expectedFilePath.length, `${name} has failed`);
+            assert_1.default.strictEqual((_b = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _b !== void 0 ? _b : 0, expectedRange.length, `${name} has failed`);
+            assert_1.default.strictEqual((_c = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _c !== void 0 ? _c : 0, expectedName.length, `${name} has failed`);
+            if (actual) {
+                for (const a of actual) {
+                    assert_1.default.strictEqual(expectedRange === null || expectedRange === void 0 ? void 0 : expectedRange.filter((e) => this._deepEqual(a.to.range, e)).length, 1);
+                    assert_1.default.strictEqual(expectedName === null || expectedName === void 0 ? void 0 : expectedName.filter((e) => this._deepEqual(a.to.name, e)).length, 1);
+                    assert_1.default.ok((expectedFilePath === null || expectedFilePath === void 0 ? void 0 : expectedFilePath.filter((e) => this._deepEqual(a.to.uri, (0, pathUtils_1.convertPathToUri)(this.program.fileSystem, e))).length) >= 1);
                 }
             }
         }
@@ -817,7 +859,7 @@ class TestState {
             const fileName = marker.fileName;
             const expected = map[name].references;
             const position = this.convertOffsetToPosition(fileName, marker.position);
-            const actual = this.program.getDocumentHighlight(fileName, position, vscode_languageserver_1.CancellationToken.None);
+            const actual = new documentHighlightProvider_1.DocumentHighlightProvider(this.program, fileName, position, vscode_languageserver_1.CancellationToken.None).getDocumentHighlight();
             assert_1.default.equal((_a = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _a !== void 0 ? _a : 0, expected.length);
             for (const r of expected) {
                 const match = actual === null || actual === void 0 ? void 0 : actual.filter((h) => this._deepEqual(h.range, r.range));
@@ -842,11 +884,11 @@ class TestState {
             if (!this.program.getSourceFileInfo(fileName)) {
                 const file = this.testData.files.find((v) => v.fileName === fileName);
                 if (file) {
-                    this.program.setFileOpened(fileName, file.version, [{ text: file.content }]);
+                    this.program.setFileOpened(fileName, file.version, file.content);
                 }
             }
             const position = this.convertOffsetToPosition(fileName, marker.position);
-            const actual = this.program.getDefinitionsForPosition(fileName, position, filter, vscode_languageserver_1.CancellationToken.None);
+            const actual = new definitionProvider_1.DefinitionProvider(this.program, fileName, position, filter, vscode_languageserver_1.CancellationToken.None).getDefinitions();
             assert_1.default.equal((_a = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _a !== void 0 ? _a : 0, expected.length, `No definitions found for marker "${name}"`);
             for (const r of expected) {
                 assert_1.default.equal(actual === null || actual === void 0 ? void 0 : actual.filter((d) => this._deepEqual(d, r)).length, 1, `No match found for ${JSON.stringify(r)} from marker ${name}`);
@@ -864,7 +906,7 @@ class TestState {
             }
             const expected = map[name].definitions;
             const position = this.convertOffsetToPosition(fileName, marker.position);
-            const actual = this.program.getTypeDefinitionsForPosition(fileName, position, vscode_languageserver_1.CancellationToken.None);
+            const actual = new definitionProvider_1.TypeDefinitionProvider(this.program, fileName, position, vscode_languageserver_1.CancellationToken.None).getDefinitions();
             assert_1.default.strictEqual((_a = actual === null || actual === void 0 ? void 0 : actual.length) !== null && _a !== void 0 ? _a : 0, expected.length, name);
             for (const r of expected) {
                 assert_1.default.strictEqual(actual === null || actual === void 0 ? void 0 : actual.filter((d) => this._deepEqual(d, r)).length, 1, name);
@@ -897,6 +939,86 @@ class TestState {
     resetCancelled() {
         this._cancellationToken.resetCancelled();
     }
+    convertPositionToOffset(fileName, position) {
+        const lines = this._getTextRangeCollection(fileName);
+        return (0, positionUtils_1.convertPositionToOffset)(position, lines);
+    }
+    convertOffsetToPosition(fileName, offset) {
+        const lines = this._getTextRangeCollection(fileName);
+        return (0, positionUtils_1.convertOffsetToPosition)(offset, lines);
+    }
+    analyze() {
+        while (this.program.analyze()) {
+            // Continue to call analyze until it completes. Since we're not
+            // specifying a timeout, it should complete the first time.
+        }
+    }
+    getFileContent(fileName) {
+        const files = this.testData.files.filter((f) => (0, pathUtils_1.comparePaths)(f.fileName, fileName, this.testFS.ignoreCase) === 0 /* EqualTo */);
+        return files[0].content;
+    }
+    convertOffsetsToRange(fileName, startOffset, endOffset) {
+        const lines = this._getTextRangeCollection(fileName);
+        return {
+            start: (0, positionUtils_1.convertOffsetToPosition)(startOffset, lines),
+            end: (0, positionUtils_1.convertOffsetToPosition)(endOffset, lines),
+        };
+    }
+    raiseError(message) {
+        throw new Error(this._messageAtLastKnownMarker(message));
+    }
+    createMultiMap(values, getKey) {
+        const map = new Map();
+        map.add = multiMapAdd;
+        map.remove = multiMapRemove;
+        if (values && getKey) {
+            for (const value of values) {
+                map.add(getKey(value), value);
+            }
+        }
+        return map;
+        function multiMapAdd(key, value) {
+            let values = this.get(key);
+            if (values) {
+                values.push(value);
+            }
+            else {
+                this.set(key, (values = [value]));
+            }
+            return values;
+        }
+        function multiMapRemove(key, value) {
+            const values = this.get(key);
+            if (values) {
+                values.forEach((v, i, arr) => {
+                    if (v === value) {
+                        arr.splice(i, 1);
+                    }
+                });
+                if (!values.length) {
+                    this.delete(key);
+                }
+            }
+        }
+    }
+    rangeText({ fileName, pos, end }) {
+        return this.getFileContent(fileName).slice(pos, end);
+    }
+    verifyCompletionItem(expected, actual) {
+        var _a, _b, _c;
+        assert_1.default.strictEqual(actual.label, expected.label);
+        assert_1.default.strictEqual(actual.detail, expected.detail);
+        assert_1.default.strictEqual(actual.kind, expected.kind);
+        assert_1.default.strictEqual(actual.insertText, expected.insertionText);
+        this._verifyEdit(actual.textEdit, expected.textEdit);
+        this._verifyEdits(actual.additionalTextEdits, expected.additionalTextEdits);
+        if (expected.detailDescription !== undefined) {
+            assert_1.default.strictEqual((_a = actual.labelDetails) === null || _a === void 0 ? void 0 : _a.description, expected.detailDescription);
+        }
+        if (expected.commitCharacters !== undefined) {
+            expect(expected.commitCharacters.sort()).toEqual((_c = (_b = actual.commitCharacters) === null || _b === void 0 ? void 0 : _b.sort()) !== null && _c !== void 0 ? _c : []);
+        }
+    }
     _convertGlobalOptionsToConfigOptions(projectRoot, mountPaths) {
         const configOptions = new configOptions_1.ConfigOptions(projectRoot);
         // add more global options as we need them
@@ -928,25 +1050,6 @@ class TestState {
         }
         return configOptions;
     }
-    getFileContent(fileName) {
-        const files = this.testData.files.filter((f) => (0, pathUtils_1.comparePaths)(f.fileName, fileName, this.testFS.ignoreCase) === 0 /* EqualTo */);
-        return files[0].content;
-    }
-    convertPositionToOffset(fileName, position) {
-        const lines = this._getTextRangeCollection(fileName);
-        return (0, positionUtils_1.convertPositionToOffset)(position, lines);
-    }
-    convertOffsetToPosition(fileName, offset) {
-        const lines = this._getTextRangeCollection(fileName);
-        return (0, positionUtils_1.convertOffsetToPosition)(offset, lines);
-    }
-    convertOffsetsToRange(fileName, startOffset, endOffset) {
-        const lines = this._getTextRangeCollection(fileName);
-        return {
-            start: (0, positionUtils_1.convertOffsetToPosition)(startOffset, lines),
-            end: (0, positionUtils_1.convertOffsetToPosition)(endOffset, lines),
-        };
-    }
     _getParseResult(fileName) {
         const file = this.program.getBoundSourceFile(fileName);
         return file.getParseResults();
@@ -960,9 +1063,6 @@ class TestState {
         const tokenizer = new tokenizer_1.Tokenizer();
         return tokenizer.tokenize(fileContents).lines;
     }
-    raiseError(message) {
-        throw new Error(this._messageAtLastKnownMarker(message));
-    }
     _messageAtLastKnownMarker(message) {
         const locationDescription = this.lastKnownMarker
             ? this.lastKnownMarker
@@ -990,43 +1090,6 @@ class TestState {
     _removeWhitespace(text) {
         return text.replace(/\s/g, '');
     }
-    createMultiMap(values, getKey) {
-        const map = new Map();
-        map.add = multiMapAdd;
-        map.remove = multiMapRemove;
-        if (values && getKey) {
-            for (const value of values) {
-                map.add(getKey(value), value);
-            }
-        }
-        return map;
-        function multiMapAdd(key, value) {
-            let values = this.get(key);
-            if (values) {
-                values.push(value);
-            }
-            else {
-                this.set(key, (values = [value]));
-            }
-            return values;
-        }
-        function multiMapRemove(key, value) {
-            const values = this.get(key);
-            if (values) {
-                values.forEach((v, i, arr) => {
-                    if (v === value) {
-                        arr.splice(i, 1);
-                    }
-                });
-                if (!values.length) {
-                    this.delete(key);
-                }
-            }
-        }
-    }
-    _rangeText({ fileName, pos, end }) {
-        return this.getFileContent(fileName).slice(pos, end);
-    }
     _getOnlyRange() {
         const ranges = this.getRanges();
         if (ranges.length !== 1) {
@@ -1144,12 +1207,6 @@ class TestState {
         // If inside the edit, return -1 to mark as invalid
         return position <= editStart ? position : position < editEnd ? -1 : position + length - +(editEnd - editStart);
     }
-    analyze() {
-        while (this.program.analyze()) {
-            // Continue to call analyze until it completes. Since we're not
-            // specifying a timeout, it should complete the first time.
-        }
-    }
     _getDiagnosticsPerFile() {
         const sourceFiles = this._files.map((f) => this.program.getSourceFile(f));
         const results = sourceFiles.map((sourceFile, index) => {
@@ -1257,21 +1314,6 @@ class TestState {
             this.raiseError(`doesn't contain expected result: ${(0, utils_1.stringify)(extra)}, actual: ${(0, utils_1.stringify)(left)}`);
         }
     }
-    verifyCompletionItem(expected, actual) {
-        var _a, _b, _c;
-        assert_1.default.strictEqual(actual.label, expected.label);
-        assert_1.default.strictEqual(actual.detail, expected.detail);
-        assert_1.default.strictEqual(actual.kind, expected.kind);
-        assert_1.default.strictEqual(actual.insertText, expected.insertionText);
-        this._verifyEdit(actual.textEdit, expected.textEdit);
-        this._verifyEdits(actual.additionalTextEdits, expected.additionalTextEdits);
-        if (expected.detailDescription !== undefined) {
-            assert_1.default.strictEqual((_a = actual.labelDetails) === null || _a === void 0 ? void 0 : _a.description, expected.detailDescription);
-        }
-        if (expected.commitCharacters !== undefined) {
-            expect(expected.commitCharacters.sort()).toEqual((_c = (_b = actual.commitCharacters) === null || _b === void 0 ? void 0 : _b.sort()) !== null && _c !== void 0 ? _c : []);
-        }
-    }
 }
 exports.TestState = TestState;
 function parseAndGetTestState(code, projectRoot = '/', anonymousFileName = 'unnamedFile.py', testFS) {