Expose IdeConnection and getConsoleTypes to the client #863
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
Fixes deephaven#862 Client can now start a session like: ``` const connection = new IdeConnection({ websocketUrl: 'wss://localhost:10000/api' }); const consoleTypes = await connection.getConsoleTypes(); const session = await connection.startSession(consoleTypes[0]); ```
niloc132
reviewed
Jul 21, 2021
Member
niloc132
left a comment
niloc132
left a comment
There was a problem hiding this comment.
ConsoleAddress should be explicitly marked as a jstype (though not that instance of the class, let's make a new one for this purpose?), otherwise the compiler can change what names it expects that field to have, and if we were to remove any case where we instantiate it from gwt/java, this code path would stop working entirely.
Also, can you update the examples to use this pattern instead? It seems to make a lot more sense in general to work this way.
And didn't we discuss putting this in IdeClient or some other "worker" level type, rather than making it part of how you connect to the actual ide session? this would make app mode easier, by letting scopes potentially be different.
- Fix up IdeConnection constructor - now it takes two params, one for the URL, then another for connection options - Change up IdeClient to use new connection options - Delete the unused classes ConsoleAddress and JsWorkspaceData - Update some of the examples with new usage. For the examples that have code snippets written in Groovy, I didn't change anything
niloc132
reviewed
Jul 23, 2021
Member
niloc132
left a comment
niloc132
left a comment
There was a problem hiding this comment.
this update got console.html and simple.html, but the index.html lists console.html, table_viewport.html, table_filter.html, table_sort.html (and format, but that doesnt use server). This doesn't include simple, which is too simple to matter for most people, but glad to have that fixed too.
web/client-ide/src/main/java/io/deephaven/ide/client/IdeConnectionOptions.java
Outdated
Show resolved
Hide resolved
web/client-ide/src/main/java/io/deephaven/ide/client/IdeConnection.java
Outdated
Show resolved
Hide resolved
Member
Author
|
I added another ticket for converting the examples from Groovy (#904) |
niloc132
reviewed
Jul 26, 2021
web/client-ide/src/main/java/io/deephaven/ide/client/IdeConnection.java
Outdated
Show resolved
Hide resolved
web/client-ide/src/main/java/io/deephaven/ide/client/IdeConnectionOptions.java
Show resolved
Hide resolved
Tested with the following code snippets. Ensured the auth token was read/decoded properly when it was passed in.
// Options unset
var c = new dh.IdeConnection('http://localhost:10000')
// Options object set, no auth token set
var options = new dh.IdeConnectionOptions();
var c = new dh.IdeConnection('http://localhost:10000', options);
// Options object set, auth token set
var options = new dh.IdeConnectionOptions();
options.authToken = '1234';
var c = new dh.IdeConnection('http://localhost:10000', options);
// Property map passed in with auth token set
var c = new dh.IdeConnection('http://localhost:10000', { authToken: '1234' });
niloc132
approved these changes
Jul 27, 2021
jmao-denver
pushed a commit
to jmao-denver/deephaven-core
that referenced
this pull request
Apr 11, 2022
Fixes deephaven#862 Client can now start a session like: ``` const connection = new IdeConnection( 'http://localhost:10000'); const consoleTypes = await connection.getConsoleTypes(); const session = await connection.startSession(consoleTypes[0]); ``` * Clean up based on Colin's review - Fix up IdeConnection constructor - now it takes two params, one for the URL, then another for connection options - Change up IdeClient to use new connection options - Delete the unused classes ConsoleAddress and JsWorkspaceData - Update some of the examples with new usage. For the examples that have code snippets written in Groovy, I didn't change anything Tested with the following code snippets. Ensured the auth token was read/decoded properly when it was passed in. // Options unset var c = new dh.IdeConnection('http://localhost:10000') // Options object set, no auth token set var options = new dh.IdeConnectionOptions(); var c = new dh.IdeConnection('http://localhost:10000', options); // Options object set, auth token set var options = new dh.IdeConnectionOptions(); options.authToken = '1234'; var c = new dh.IdeConnection('http://localhost:10000', options); // Property map passed in with auth token set var c = new dh.IdeConnection('http://localhost:10000', { authToken: '1234' });
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.
Fixes #862
Client can now start a session like: