Rewrite code for language services to use protobufjs library and remo… by igormkdd · Pull Request #123 · vmware/vrealize-developer-tools

igormkdd · 2023-03-07T14:41:37Z

Description

Rewrite code for language services to use protobufjs library and remove "mvn collect" plugin dependency
Fix startup issues and fix minor bugs
Update autocompletion to work without the plugin, and to directly get the data from vRO

Checklist

Lint and unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)
I have tested against live vRO/vRA, if applicable
My changes have been rebased and squashed to the minimal number of relevant commits
My changes have a descriptive commit message with a short title, including a Fixed #XXX - or Closed #XXX - prefix to auto-close the issue

Testing

Release Notes

Screenshot

Related issues and PRs

…ve plugin dependency + fix startup and minor bugs + update autocompletion Signed-off-by: Igor Janevski <ijanevski@vmware.com>

codecov · 2023-03-07T14:47:17Z

Codecov Report

Merging #123 (8330e4d) into master (1560082) will increase coverage by 4.21%.
The diff coverage is 61.29%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #123      +/-   ##
==========================================
+ Coverage   50.00%   54.21%   +4.21%     
==========================================
  Files          40       40              
  Lines         790      806      +16     
  Branches      116      117       +1     
==========================================
+ Hits          395      437      +42     
+ Misses        356      331      -25     
+ Partials       39       38       -1

vmwclabot · 2023-03-10T13:57:12Z

@igormkdd, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 26c4b6e must be signed by ijanevski@vmware.com

Signed-off-by: Igor Janevski <ijanevski@vmware.com>

vmwclabot · 2023-03-15T15:42:20Z

@igormkdd, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 26c4b6e must be signed by ijanevski@vmware.com

ivo-kotev

Please check the comments.
We will need for sure some MD file that can explain how the collection is working so this can be supported later on.

ivo-kotev · 2023-03-22T08:48:21Z

extension/src/client/constants.ts

    Vra = "com.vmware.pscoe.vra:vra-package",
-    VraNg = "com.vmware.pscoe.vra-ng:vra-ng-package"
+    VraNg = "com.vmware.pscoe.vra-ng:vra-ng-package",
+    Polyglot = "com.vmware.pscoe.polyglot:polyglot-project"


If we are listing all supported, we are missing vrops, vcd, vrli - basically all supported are defined here: https://github.com/vmware/build-tools-for-vmware-aria/tree/main/maven/base-package

ivo-kotev · 2023-03-22T08:54:17Z

packages/node/vro-language-server/src/server/feature/CompletionProvider.ts

        const lineContent = document.getLineContentUntil(position)

-        this.logger.debug(`Trying to provide auto completion for line '${lineContent}'`)
+        this.logger.info(`Trying to provide auto completion for line '${lineContent}'`)


Do we need to have this logged for all users?

ivo-kotev · 2023-03-22T08:58:17Z

packages/node/vro-language-server/src/server/request/collection/WorkspaceCollection.ts

        this.getModulesForCollection(workspaceFolder, undefined, modules)
        if (modules.length === 0) {
-            this.logger.debug("Skipping workspace collection as there are no JS action modules in the project")
+            this.logger.info("Skipping workspace collection as there are no JS action modules in the project")


Do we need this level of logging in Info mode?

ivo-kotev · 2023-03-22T09:00:38Z

packages/node/vro-language-server/src/server/request/collection/WorkspaceCollection.ts

 export class WorkspaceCollection {
    private readonly logger = Logger.get("WorkspaceCollection")
-    private readonly debounceTriggerCollection = _.debounce(this.triggerCollectionAndRefresh, 10000)
+    private readonly debounceTriggerCollection = _.debounce(this.triggerCollectionAndRefresh, 1000)


Can we move these timeout and sleep configurations to a constants file?

ivo-kotev · 2023-03-22T10:37:25Z

packages/node/vrdt-common/src/types/hint.ts

+    returnType?: string
+}
+
+export interface HintPlugin {


is this about the vRDT version? or for backward compatibility?

ivo-kotev · 2023-03-22T10:42:56Z

packages/node/vro-language-server/src/server/request/collection/ServerCollection.ts

-        }
+            })
+            .catch(error => {
+                this.logger.info("Could not connect to vRO. Collecting offline hints collection...")


What does it mean "Collecting offline hints collection..." it's going to use the data that is already cached locally? If yes - maybe rephrase a bit the message?

ivo-kotev · 2023-03-22T10:45:01Z

packages/node/vro-language-server/src/server/request/collection/ServerCollection.ts

-            if (fs.existsSync(vpkFilePath)) {
-                fs.unlinkSync(vpkFilePath)
-            }
+            const parsedLink = link[0].substring(9).toString()


can we expect cases with less links? count=0? And maybe add a comment what is specific for this link0?

ivo-kotev · 2023-03-22T10:46:48Z

packages/node/vro-language-server/src/server/request/collection/WorkspaceCollection.ts

-        const command = `mvn o11n-hint:collect -DoutputHintDirectory="${outputDir}" -pl ${modules.join(",")} -e`
-        const cmdOptions = { cwd: workspaceFolder.uri.fsPath }
+        const fullPath = path.join(workspaceFolder.uri.fsPath, modules.join(","))
+        const modulesPath = path.join(fullPath, "src/main/resources")


I guess this should work for both JS and TS projects, the path for TS projects is only src/?

ivo-kotev · 2023-03-22T10:48:50Z

packages/node/vro-language-server/src/server/request/collection/WorkspaceCollection.ts

+            metadata: {
+                timestamp: Date.now(),
+                serverName: "",
+                serverVersion: "0.0.1",


Is it going to be useful to cache the server name and version as well? Or we are not using this information?

ivo-kotev · 2023-03-22T10:51:07Z

wiki/Source-Code-Organization.md

-   **`packages/node/vro-language-server`** - A Node.js implementation of the [Language Server Protocol (LSP)](https://github.com/Microsoft/language-server-protocol). It analyses type information received from the vRO server and maintains semantic knowledge about a vRO solution implemented in JavaScript. Depends on vRO Hint Plugin that is part of the [vRealize Build Tools](https://flings.vmware.com/vrealize-build-tools) fling. _No longer maintained, still remains for compatibility._
-   **`packages/node/vro-language-server/protocol`** - A set of [Protocol Buffer](https://developers.google.com/protocol-buffers/) message definitions that are used by the vRO language server and the vRO Hint plug-in as a serialization format for communication and storage purposes. _No longer maintained, still remains for compatibility._
+-   **`packages/node/vro-language-server`** - A Node.js implementation of the [Language Server Protocol (LSP)](https://github.com/Microsoft/language-server-protocol). It analyses type information received from the vRO server and maintains semantic knowledge about a vRO solution implemented in JavaScript. The updated version is operational with vRO 8, but not with the vRO 7 anymore. The plugin is not needed for fetching the data from the vRO, but rather only a connection to it is required and a valid maven profile. Moreover, local js files are also analyzed.
+-   **`packages/node/vro-language-server/protocol`** - A set of [Protocol Buffer](https://developers.google.com/protocol-buffers/) message definitions that are used by the vRO language server as a serialization format for communication and storage purposes.


I think we need to add a bit more documentation on how this is working, maybe a separate md file that explains the communication flow and the components/files involved in this communication.

Also - is this going to work for vRO servers that are using vRA authentication? I think currently all operations for vRDT support only basic auth, which makes most of the things unusable in vra 8.8+ without additional vro configuration?

vmwclabot · 2023-03-30T16:50:24Z

@igormkdd, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 26c4b6e must be signed by ijanevski@vmware.com
Commit 83f75b7 must be signed by ijanevski@vmware.com

…-by: Igor Janevski <ijanevski@vmware.com> Signed-off-by: Igor Janevski <ijanevski@vmware.com>

vmwclabot · 2023-04-03T05:42:48Z

@igormkdd, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 26c4b6e must be signed by ijanevski@vmware.com
Commit 83f75b7 must be signed by ijanevski@vmware.com

…evski <ijanevski@vmware.com> Signed-off-by: Igor Janevski <ijanevski@vmware.com>

vmwclabot · 2023-04-03T07:58:17Z

@igormkdd, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 26c4b6e must be signed by ijanevski@vmware.com
Commit 83f75b7 must be signed by ijanevski@vmware.com

…complete

vmwclabot · 2023-04-10T07:12:49Z

@igormkdd, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 26c4b6e must be signed by ijanevski@vmware.com
Commit 83f75b7 must be signed by ijanevski@vmware.com
Commit 8330e4d has a no-reply/unreachable author email address: 52649421+igormkdd@users.noreply.github.com

Rewrite code for language services to use protobufjs library and remo…

61b6699

…ve plugin dependency + fix startup and minor bugs + update autocompletion Signed-off-by: Igor Janevski <ijanevski@vmware.com>

igormkdd requested a review from a team as a code owner March 7, 2023 14:41

Fix issue with paths on Windows + fix issue with old vro data

26c4b6e

vmwclabot added the dco-required label Mar 10, 2023

Add tests + update md files + perform small code refactoring

8affe6c

Signed-off-by: Igor Janevski <ijanevski@vmware.com>

ivo-kotev requested changes Mar 22, 2023

View reviewed changes

Add token auth support

83f75b7

Add support for token authentication and token generation. Signed-off…

1270ccc

…-by: Igor Janevski <ijanevski@vmware.com> Signed-off-by: Igor Janevski <ijanevski@vmware.com>

Set debug for logger for completion provider. Signed-off-by: Igor Jan…

d2464ca

…evski <ijanevski@vmware.com> Signed-off-by: Igor Janevski <ijanevski@vmware.com>

ivo-kotev approved these changes Apr 7, 2023

View reviewed changes

Merge branch 'master' into feature/IAC-701-vscode-vro-javascript-auto…

8330e4d

…complete

igormkdd merged commit 0b7cf16 into master Apr 10, 2023

igormkdd deleted the feature/IAC-701-vscode-vro-javascript-autocomplete branch April 10, 2023 08:10

Conversation

igormkdd commented Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Testing

Release Notes

Screenshot

Related issues and PRs

Uh oh!

codecov bot commented Mar 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

vmwclabot commented Mar 10, 2023

Uh oh!

vmwclabot commented Mar 15, 2023

Uh oh!

ivo-kotev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vmwclabot commented Mar 30, 2023

Uh oh!

vmwclabot commented Apr 3, 2023

Uh oh!

vmwclabot commented Apr 3, 2023

Uh oh!

vmwclabot commented Apr 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

igormkdd commented Mar 7, 2023 •

edited

Loading

codecov bot commented Mar 7, 2023 •

edited

Loading