refactor(urls): Remove isCloud9 from constants file #5717
Merged
Conversation
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
The isCloud9() function was causing issues in the constants file. The constants file should be a minimal module with as little external dependencies as possible. We had some strings that needed to resolve a url depending on c9 vs toolkit. Solution: Move the resolution of c9 vs toolkit docs to an external function. Update uses everywhere. Signed-off-by: nkomonen-amazon <[email protected]>
|
This pull request modifies code in src/ but no tests were added/updated. Confirm whether tests should be added or ensure the PR description explains why tests are not required. |
Contributor
What do you mean issues? Circular dependencies, etc? |
jpinkney-aws
reviewed
Oct 3, 2024
| } | ||
|
|
||
| function _getDocumentationUrl(urls: { cloud9: vscode.Uri; toolkit: vscode.Uri }): vscode.Uri { | ||
| return isCloud9() ? urls.cloud9 : urls.toolkit |
Contributor
There was a problem hiding this comment.
rather than having to do vscode.Uri.parse everywhere you could just have c9/toolkit be strings and do the parsing in here I think
Contributor
Author
There was a problem hiding this comment.
I was thinking that eventually I think we'll get rid of C9 and just directly use the variable in the constants file, so all these functions would be deleted
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We have some strings that need to resolve a url depending on c9 vs toolkit.
The isCloud9() function is causing issues in the constants file. Due to some sort of module import order, isCloud9() did not resolve appropriately when expected. I think we used the constants file before all the dependencies of the isCloud9() function were available
The constants file should be a minimal module with as little external dependencies as possible.
Solution:
Move the resolution of c9 vs toolkit docs to an external function. Update uses everywhere.
License: I confirm that my contribution is made under the terms of the Apache 2.0 license.