cli: Update UXState from config-ssh

greyscaled · greyscaled · commit a727c6b13078 · 2020-12-02T19:20:35.000Z
Context:

In optimizing the dashboard environment experiences, tracking whether a
user has run config-ssh locally enables personalized education about the
feature.
diff --git a/coder-sdk/users.go b/coder-sdk/users.go
@@ -46,6 +46,14 @@ func (c Client) Me(ctx context.Context) (*User, error) {
 	return c.UserByID(ctx, Me)
 }
 
+// MyUXState updates the authenticated user's UX State.
+func (c Client) MyUXState(ctx context.Context, uxsPartial map[string]interface{}) error {
+	if err := c.requestBody(ctx, http.MethodPut, "/api/private/users/me/ux-state", uxsPartial, nil); err != nil {
+		return err
+	}
+	return nil
+}
+
 // UserByID get the details of a user by their id.
 func (c Client) UserByID(ctx context.Context, id string) (*User, error) {
 	var u User
diff --git a/internal/cmd/configssh.go b/internal/cmd/configssh.go
@@ -135,6 +135,7 @@ func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []st
 			fmt.Printf("Your private ssh key was written to \"%s\"\n", privateKeyFilepath)
 		}
 
+		writeSSHUXState(ctx, client)
 		fmt.Printf("An auto-generated ssh config was written to \"%s\"\n", *configpath)
 		fmt.Println("You should now be able to ssh into your environment")
 		fmt.Printf("For example, try running\n\n\t$ ssh coder.%s\n\n", envs[0].Name)
@@ -215,3 +216,12 @@ func readStr(filename string) (string, error) {
 	}
 	return string(contents), nil
 }
+
+func writeSSHUXState(ctx context.Context, client *coder.Client) {
+	// Update UXState that coder config-ssh has been run by the currently
+	// authenticated user
+	err := client.MyUXState(ctx, map[string]interface{}{"cliSSHConfigured": true})
+	if err != nil {
+		fmt.Println("⚠ The Coder web client may not recognize that you've configured SSH.")
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -135,6 +135,7 @@ func configSSH(configpath string, remove bool) func(cmd *cobra.Command, _ []st`
`135`	`135`	`fmt.Printf("Your private ssh key was written to \"%s\"\n", privateKeyFilepath)`
`136`	`136`	`}`
`137`	`137`
	`138`	`+ writeSSHUXState(ctx, client)`
`138`	`139`	`fmt.Printf("An auto-generated ssh config was written to \"%s\"\n", *configpath)`
`139`	`140`	`fmt.Println("You should now be able to ssh into your environment")`
`140`	`141`	`fmt.Printf("For example, try running\n\n\t$ ssh coder.%s\n\n", envs[0].Name)`
`@@ -215,3 +216,12 @@ func readStr(filename string) (string, error) {`
`215`	`216`	`}`
`216`	`217`	`return string(contents), nil`
`217`	`218`	`}`
	`219`	`+`
	`220`	`+func writeSSHUXState(ctx context.Context, client *coder.Client) {`
	`221`	`+ // Update UXState that coder config-ssh has been run by the currently`
	`222`	`+ // authenticated user`
	`223`	`+ err := client.MyUXState(ctx, map[string]interface{}{"cliSSHConfigured": true})`
	`224`	`+ if err != nil {`
	`225`	`+ fmt.Println("⚠ The Coder web client may not recognize that you've configured SSH.")`
	`226`	`+ }`
	`227`	`+}`