Enable saving of Studio access token #3235
There are no files selected for viewing
This file contains 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 |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ | |
| "featurize", | ||
| "hardlinks", | ||
| "Interactors", | ||
| "isat", | ||
| "isdir", | ||
| "isempty", | ||
| "isequal", | ||
|
|
||
This file contains 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 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 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 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 |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| import { commands, ExtensionContext, SecretStorage } from 'vscode' | ||
| import { validateTokenInput } from './inputBox' | ||
| import { STUDIO_ACCESS_TOKEN_KEY, isStudioAccessToken } from './token' | ||
| import { STUDIO_URL } from './webview/contract' | ||
| import { Resource } from '../resourceLocator' | ||
| import { ViewKey } from '../webview/constants' | ||
| import { MessageFromWebview, MessageFromWebviewType } from '../webview/contract' | ||
| import { BaseRepository } from '../webview/repository' | ||
| import { Logger } from '../common/logger' | ||
| import { getInput, getValidInput } from '../vscode/inputBox' | ||
| import { Title } from '../vscode/title' | ||
| import { openUrl } from '../vscode/external' | ||
| import { ContextKey, setContextValue } from '../vscode/context' | ||
| import { RegisteredCommands } from '../commands/external' | ||
| import { showInformation } from '../vscode/modal' | ||
|
|
||
| export class Connect extends BaseRepository<undefined> { | ||
| public readonly viewKey = ViewKey.CONNECT | ||
|
|
||
| private readonly secrets: SecretStorage | ||
|
There was a problem hiding this comment. [F] This seems like a better API to use instead of saving the token directly into the User's config. |
||
|
|
||
| constructor(context: ExtensionContext, webviewIcon: Resource) { | ||
mattseddon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| super('', webviewIcon) | ||
|
|
||
| this.secrets = context.secrets | ||
|
|
||
| this.dispose.track( | ||
| this.onDidReceivedWebviewMessage(message => | ||
| this.handleMessageFromWebview(message) | ||
| ) | ||
| ) | ||
|
|
||
| void this.setContext().then(() => this.deferred.resolve()) | ||
|
|
||
| this.dispose.track( | ||
| context.secrets.onDidChange(e => { | ||
| if (e.key !== STUDIO_ACCESS_TOKEN_KEY) { | ||
| return | ||
| } | ||
| return this.setContext() | ||
| }) | ||
| ) | ||
| } | ||
|
|
||
| public sendInitialWebviewData(): void {} | ||
|
|
||
| public removeStudioAccessToken() { | ||
| return this.removeSecret(STUDIO_ACCESS_TOKEN_KEY) | ||
| } | ||
|
|
||
| public async saveStudioAccessToken() { | ||
| const token = await getValidInput( | ||
| Title.ENTER_STUDIO_TOKEN, | ||
| validateTokenInput, | ||
| { password: true } | ||
| ) | ||
| if (!token) { | ||
| return | ||
| } | ||
|
|
||
| return this.storeSecret(STUDIO_ACCESS_TOKEN_KEY, token) | ||
|
There was a problem hiding this comment. Should we add some kind of message after the token is saved? Feels a little weird to me that I saved my token then everything related to Studio just disappears from my screen 🤔 There was a problem hiding this comment. Yes I will add a toast/modal There was a problem hiding this comment. This is what the flow looks like now: Screen.Recording.2023-02-16.at.4.33.03.pm.movThere was a problem hiding this comment. Let me know what you think. We can update in a follow up. There was a problem hiding this comment. Looks good! Makes things more clear on the connection and what you can do now that you're connected! |
||
| } | ||
|
|
||
| private handleMessageFromWebview(message: MessageFromWebview) { | ||
| switch (message.type) { | ||
| case MessageFromWebviewType.OPEN_STUDIO: | ||
| return this.openStudio() | ||
| case MessageFromWebviewType.OPEN_STUDIO_PROFILE: | ||
| return this.openStudioProfile() | ||
| case MessageFromWebviewType.SAVE_STUDIO_TOKEN: | ||
| return commands.executeCommand( | ||
| RegisteredCommands.ADD_STUDIO_ACCESS_TOKEN | ||
| ) | ||
| default: | ||
| Logger.error(`Unexpected message: ${JSON.stringify(message)}`) | ||
| } | ||
| } | ||
|
|
||
| private openStudio() { | ||
| return openUrl(STUDIO_URL) | ||
| } | ||
|
|
||
| private async openStudioProfile() { | ||
| const username = await getInput(Title.ENTER_STUDIO_USERNAME) | ||
| if (!username) { | ||
| return | ||
| } | ||
| return openUrl(`${STUDIO_URL}/user/${username}/profile`) | ||
| } | ||
|
|
||
| private async setContext() { | ||
| const storedToken = await this.getSecret(STUDIO_ACCESS_TOKEN_KEY) | ||
| if (isStudioAccessToken(storedToken)) { | ||
| if (this.deferred.state === 'resolved') { | ||
| void showInformation( | ||
| 'Studio is now connected. Use the "Share to Studio" command from an experiment\'s context menu to share experiments.' | ||
| ) | ||
| } | ||
| this.webview?.dispose() | ||
| return setContextValue(ContextKey.STUDIO_CONNECTED, true) | ||
| } | ||
|
|
||
| return setContextValue(ContextKey.STUDIO_CONNECTED, false) | ||
| } | ||
|
|
||
| private getSecret(key: string) { | ||
| const secrets = this.getSecrets() | ||
| return secrets.get(key) | ||
| } | ||
|
|
||
| private storeSecret(key: string, value: string) { | ||
| const secrets = this.getSecrets() | ||
| return secrets.store(key, value) | ||
| } | ||
|
|
||
| private removeSecret(key: string) { | ||
| const secrets = this.getSecrets() | ||
| return secrets.delete(key) | ||
| } | ||
|
|
||
| private getSecrets() { | ||
| return this.secrets | ||
| } | ||
| } | ||
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { validateTokenInput } from './inputBox' | ||
|
|
||
| describe('validateTokenInput', () => { | ||
| const mockedStudioAccessToken = | ||
| 'isat_1Z4T0zVHvq9Cu03XEe9Zjvx2vkBihfGPdY7FfmEMAagOXfQx' | ||
| it('should return the warning if the input is not valid', () => { | ||
| expect( | ||
| validateTokenInput(mockedStudioAccessToken.slice(0, -1)) | ||
| ).not.toBeNull() | ||
| expect( | ||
| validateTokenInput( | ||
| mockedStudioAccessToken.slice(1, mockedStudioAccessToken.length) | ||
| ) | ||
| ).not.toBeNull() | ||
| }) | ||
|
|
||
| it('should return null if the input is valid', () => { | ||
| expect(validateTokenInput(mockedStudioAccessToken)).toBeNull() | ||
| }) | ||
| }) |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { isStudioAccessToken } from './token' | ||
|
|
||
| export const validateTokenInput = (input: string | undefined) => { | ||
| if (!isStudioAccessToken(input)) { | ||
| return 'please enter a valid Studio access token' | ||
| } | ||
| return null | ||
| } |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { Connect } from '.' | ||
| import { RegisteredCommands } from '../commands/external' | ||
| import { InternalCommands } from '../commands/internal' | ||
|
|
||
| export const registerConnectCommands = ( | ||
| connect: Connect, | ||
| internalCommands: InternalCommands | ||
| ): void => { | ||
| internalCommands.registerExternalCommand( | ||
| RegisteredCommands.CONNECT_SHOW, | ||
| () => connect.showWebview() | ||
| ) | ||
|
|
||
| internalCommands.registerExternalCommand( | ||
| RegisteredCommands.ADD_STUDIO_ACCESS_TOKEN, | ||
| () => connect.saveStudioAccessToken() | ||
| ) | ||
|
|
||
| internalCommands.registerExternalCommand( | ||
| RegisteredCommands.REMOVE_STUDIO_ACCESS_TOKEN, | ||
| () => connect.removeStudioAccessToken() | ||
| ) | ||
| } |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| export const STUDIO_ACCESS_TOKEN_KEY = 'dvc.studioAccessToken' | ||
|
|
||
| export const isStudioAccessToken = (text?: string): boolean => { | ||
| if (!text) { | ||
| return false | ||
| } | ||
| return text.startsWith('isat_') && text.length >= 53 | ||
| } |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export const STUDIO_URL = 'https://studio.iterative.ai' |
This file contains 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 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
Oops, something went wrong.
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.
[F] We only show the tree view when there is no Studio token available in the secrets store. It can still be hidden by the user. We also give them the option to remove the token and save another one.