refactor: Extract ssh logic from auth service #5670
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| { | ||
| "securityUpdateSuccessMessage": "Updated password.", | ||
| "sshRegenerateSuccessMessage": "SSH Key regenerated successfully." | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| import { getUserSSHKey, regenerateUserSSHKey } from "api/api" | ||
| import { GitSSHKey } from "api/typesGenerated" | ||
| import { displaySuccess } from "components/GlobalSnackbar/utils" | ||
| import { createMachine, assign } from "xstate" | ||
| import { i18n } from "i18n" | ||
|
|
||
| const { t } = i18n | ||
|
|
||
| interface Context { | ||
| sshKey?: GitSSHKey | ||
| getSSHKeyError?: unknown | ||
| regenerateSSHKeyError?: unknown | ||
| } | ||
|
|
||
| type Events = | ||
| | { type: "REGENERATE_SSH_KEY" } | ||
| | { type: "CONFIRM_REGENERATE_SSH_KEY" } | ||
| | { type: "CANCEL_REGENERATE_SSH_KEY" } | ||
|
|
||
| export const sshKeyMachine = createMachine( | ||
| { | ||
| id: "sshKeyState", | ||
| predictableActionArguments: true, | ||
| schema: { | ||
| context: {} as Context, | ||
| events: {} as Events, | ||
| services: {} as { | ||
| getSSHKey: { | ||
| data: GitSSHKey | ||
| } | ||
| regenerateSSHKey: { | ||
| data: GitSSHKey | ||
| } | ||
| }, | ||
| }, | ||
| tsTypes: {} as import("./sshKeyXService.typegen").Typegen0, | ||
| initial: "gettingSSHKey", | ||
| states: { | ||
| gettingSSHKey: { | ||
| entry: "clearGetSSHKeyError", | ||
| invoke: { | ||
| src: "getSSHKey", | ||
| onDone: [ | ||
| { | ||
| actions: "assignSSHKey", | ||
| target: "loaded", | ||
| }, | ||
| ], | ||
| onError: [ | ||
| { | ||
| actions: "assignGetSSHKeyError", | ||
| target: "notLoaded", | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| notLoaded: { | ||
| type: "final", | ||
|
There was a problem hiding this comment. Thinking about our conversation about simplifying XState machines by having less granularity: instead of making a separate error, There was a problem hiding this comment. In this case we store this because we want to display the error. There was a problem hiding this comment. Oh, I didn't see the separate loading state - makes sense! |
||
| }, | ||
| loaded: { | ||
| on: { | ||
| REGENERATE_SSH_KEY: { | ||
| target: "confirmSSHKeyRegenerate", | ||
| }, | ||
| }, | ||
| }, | ||
| confirmSSHKeyRegenerate: { | ||
| on: { | ||
| CANCEL_REGENERATE_SSH_KEY: { | ||
| target: "loaded", | ||
| }, | ||
| CONFIRM_REGENERATE_SSH_KEY: { | ||
| target: "regeneratingSSHKey", | ||
| }, | ||
| }, | ||
| }, | ||
| regeneratingSSHKey: { | ||
| entry: "clearRegenerateSSHKeyError", | ||
| invoke: { | ||
| src: "regenerateSSHKey", | ||
| onDone: [ | ||
| { | ||
| actions: ["assignSSHKey", "notifySuccessSSHKeyRegenerated"], | ||
| target: "loaded", | ||
| }, | ||
| ], | ||
| onError: [ | ||
| { | ||
| actions: "assignRegenerateSSHKeyError", | ||
| target: "loaded", | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| services: { | ||
| getSSHKey: () => getUserSSHKey(), | ||
| regenerateSSHKey: () => regenerateUserSSHKey(), | ||
| }, | ||
| actions: { | ||
| assignSSHKey: assign({ | ||
| sshKey: (_, { data }) => data, | ||
| }), | ||
| assignGetSSHKeyError: assign({ | ||
| getSSHKeyError: (_, { data }) => data, | ||
| }), | ||
| clearGetSSHKeyError: assign({ | ||
| getSSHKeyError: (_) => undefined, | ||
| }), | ||
| assignRegenerateSSHKeyError: assign({ | ||
| regenerateSSHKeyError: (_, { data }) => data, | ||
| }), | ||
| clearRegenerateSSHKeyError: assign({ | ||
| regenerateSSHKeyError: (_) => undefined, | ||
| }), | ||
| notifySuccessSSHKeyRegenerated: () => { | ||
| displaySuccess( | ||
| t("sshRegenerateSuccessMessage", { ns: "userSettingsPage" }), | ||
| ) | ||
| }, | ||
| }, | ||
| }, | ||
| ) | ||
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.
Sometimes we're making variables for sshState keys and sometimes we aren't - can we choose one and be consistent?
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.
The matches function only return true or false. Unfortunately, xstate v4 does not have a way to bind a context type with a specific state so, sometimes, we have to check the state with match and pass the value in the context. Buuut, after these minor refactoring, I think we can remove some xstate machines and use just use fetch directly.