allow setting remappings on lsp server init #13423
+128
−6
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -1085,6 +1085,13 @@ def open_file_and_wait_for_diagnostics( | |||||
| ) | ||||||
| return self.wait_for_diagnostics(solc_process) | ||||||
|
|
||||||
| def expect_report(self, published_diagnostics, uri): | ||||||
| for report in published_diagnostics: | ||||||
| if report['uri'] == uri: | ||||||
| return report | ||||||
| self.expect_true(False, f"expected ${uri} in published_diagnostics") | ||||||
| return None | ||||||
|
|
||||||
| def expect_true( | ||||||
| self, | ||||||
| actual, | ||||||
|
|
@@ -1534,6 +1541,70 @@ def test_custom_includes(self, solc: JsonRpcProcess) -> None: | |||||
| self.expect_equal(len(diagnostics), 1, "no diagnostics") | ||||||
| self.expect_diagnostic(diagnostics[0], code=2018, lineNo=5, startEndColumns=(4, 62)) | ||||||
|
|
||||||
| def test_remapping_wrong_paramateres(self, solc: JsonRpcProcess) -> None: | ||||||
|
There was a problem hiding this comment.
Suggested change
Also, something like |
||||||
| self.setup_lsp(solc, expose_project_root=False) | ||||||
| solc.send_notification( | ||||||
| 'workspace/didChangeConfiguration', { | ||||||
| 'settings': { | ||||||
| 'remappings': [ | ||||||
| { | ||||||
| 'context': False, | ||||||
| 'prefix': 1, | ||||||
| 'target': f"{self.project_root_dir}/other-include-dir/otherlib/" | ||||||
| } | ||||||
| ] | ||||||
| } | ||||||
| } | ||||||
| ) | ||||||
|
|
||||||
| response = solc.receive_message() | ||||||
| self.expect_equal(response["method"], "$/logTrace") | ||||||
|
|
||||||
| if not response["params"]["message"].startswith("Invalid JSON configuration passed."): | ||||||
| raise Exception("Expected JSON error.") | ||||||
|
|
||||||
| def test_remapping(self, solc: JsonRpcProcess) -> None: | ||||||
| self.setup_lsp(solc, expose_project_root=False) | ||||||
| solc.send_notification( | ||||||
| 'workspace/didChangeConfiguration', { | ||||||
| 'settings': { | ||||||
| 'remappings': [ | ||||||
| { | ||||||
| 'context': '', | ||||||
| 'prefix': '@other/', | ||||||
| 'target': f"{self.project_root_dir}/other-include-dir/otherlib/" | ||||||
| } | ||||||
| ] | ||||||
| } | ||||||
| } | ||||||
| ) | ||||||
|
|
||||||
| # test file | ||||||
| file_with_remapped_import_uri = 'file:///remapped-include.sol' | ||||||
|
There was a problem hiding this comment. It would be best to set this to something that would match the remapping if used in an import to show that these URIs are not remapped. |
||||||
| solc.send_message('textDocument/didOpen', { | ||||||
| 'textDocument': { | ||||||
| 'uri': file_with_remapped_import_uri, | ||||||
| 'languageId': 'Solidity', | ||||||
| 'version': 1, | ||||||
| 'text': ''.join([ | ||||||
| '// SPDX-License-Identifier: UNLICENSED\n', | ||||||
| 'pragma solidity >=0.8.0;\n', | ||||||
| 'import "@other/otherlib.sol";\n', | ||||||
| ]) | ||||||
| } | ||||||
| }) | ||||||
| published_diagnostics = self.wait_for_diagnostics(solc) | ||||||
| self.expect_equal(len(published_diagnostics), 2, "expected reports for two files") | ||||||
|
|
||||||
| report = self.expect_report(published_diagnostics, file_with_remapped_import_uri) | ||||||
| diagnostics = report['diagnostics'] | ||||||
| self.expect_equal(len(diagnostics), 0, "no diagnostics") | ||||||
|
|
||||||
| report = self.expect_report(published_diagnostics, f"{self.project_root_uri}/other-include-dir/otherlib/otherlib.sol") | ||||||
| diagnostics = report['diagnostics'] | ||||||
| self.expect_equal(len(diagnostics), 1, "no diagnostics") | ||||||
|
Comment on lines
+1601
to
+1605
There was a problem hiding this comment. I think that one of these |
||||||
| self.expect_diagnostic(diagnostics[0], code=2018, lineNo=5, startEndColumns=(4, 62)) | ||||||
|
|
||||||
| def test_custom_includes_with_full_project(self, solc: JsonRpcProcess) -> None: | ||||||
| """ | ||||||
| Tests loading all project files while having custom include directories configured. | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New type checking helpers were added and recently merged in this pull request, so these should be changed to use
isOfType<T>orisOfTypeIfExists<T>, whichever one is more appropriate.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd hold off a bit with using these helpers everywhere. I wanted to get them merged not to stall the asm import PR but in the end we may and up removing them (#13579 (comment)). Depends on what we end up with after #13579. I mean, it's fine to use them but for now I'd also not force that.