coder · mtojek · Aug 2, 2023 · Jul 21, 2023 · Jul 21, 2023 · Jul 21, 2023
diff --git a/cli/testdata/coder_users_--help.golden b/cli/testdata/coder_users_--help.golden
@@ -5,14 +5,16 @@ Manage users
 Aliases: user
 
 [1mSubcommands[0m
-    activate    Update a user's status to 'active'. Active users can fully
-                interact with the platform
-    create      
-    list        
-    show        Show a single user. Use 'me' to indicate the currently
-                authenticated user.
-    suspend     Update a user's status to 'suspended'. A suspended user cannot
-                log into the platform
+    activate           Update a user's status to 'active'. Active users can
+                       fully interact with the platform
+    create             
+    list               
+    mark-as-dormant    Update a user's status to 'dormant'. Dormant users are
+                       not counted in the license plan
+    show               Show a single user. Use 'me' to indicate the currently
+                       authenticated user.
+    suspend            Update a user's status to 'suspended'. A suspended user
+                       cannot log into the platform
 
 ---
 Run `coder --help` for a list of global options.
diff --git a/cli/testdata/coder_users_list_--output_json.golden b/cli/testdata/coder_users_list_--output_json.golden
@@ -24,7 +24,7 @@
     "email": "testuser2@coder.com",
     "created_at": "[timestamp]",
     "last_seen_at": "[timestamp]",
-    "status": "active",
+    "status": "dormant",
     "organization_ids": [
       "[first org ID]"
     ],

diff --git a/cli/testdata/coder_users_mark-as-dormant_--help.golden b/cli/testdata/coder_users_mark-as-dormant_--help.golden
@@ -0,0 +1,15 @@
+Usage: coder users mark-as-dormant [flags] <username|user_id>
+
+Update a user's status to 'dormant'. Dormant users are not counted in the
+license plan
+
+Aliases: dormant
+
+[40m [0m[91;40m$ coder users mark-as-dormant example_user[0m[40m [0m
+
+[1mOptions[0m
+  -c, --column string-array (default: username,email,created_at,status)
+          Specify a column to filter in the table.
+
+---
+Run `coder --help` for a list of global options.
diff --git a/cli/users.go b/cli/users.go
@@ -18,6 +18,7 @@ func (r *RootCmd) users() *clibase.Cmd {
 			r.userList(),
 			r.userSingle(),
 			r.createUserStatusCommand(codersdk.UserStatusActive),
+			r.createUserStatusCommand(codersdk.UserStatusDormant),
 			r.createUserStatusCommand(codersdk.UserStatusSuspended),
 		},
 	}

diff --git a/cli/userstatus.go b/cli/userstatus.go
@@ -23,6 +23,11 @@ func (r *RootCmd) createUserStatusCommand(sdkStatus codersdk.UserStatus) *clibas
 		pastVerb = "activated"
 		aliases = []string{"active"}
 		short = "Update a user's status to 'active'. Active users can fully interact with the platform"
+	case codersdk.UserStatusDormant:
+		verb = "mark as dormant"
+		pastVerb = "marked as dormant"
+		aliases = []string{"dormant"}
+		short = "Update a user's status to 'dormant'. Dormant users are not counted in the license plan"
 	case codersdk.UserStatusSuspended:
 		verb = "suspend"
 		pastVerb = "suspended"
@@ -36,12 +41,12 @@ func (r *RootCmd) createUserStatusCommand(sdkStatus codersdk.UserStatus) *clibas
 
 	var columns []string
 	cmd := &clibase.Cmd{
-		Use:     fmt.Sprintf("%s <username|user_id>", verb),
+		Use:     fmt.Sprintf("%s <username|user_id>", strings.ReplaceAll(verb, " ", "-")),
 		Short:   short,
 		Aliases: aliases,
 		Long: formatExamples(
 			example{
-				Command: fmt.Sprintf("coder users %s example_user", verb),
+				Command: fmt.Sprintf("coder users %s example_user", strings.ReplaceAll(verb, " ", "-")),
 			},
 		),
 		Middleware: clibase.Chain(
@@ -75,8 +80,14 @@ func (r *RootCmd) createUserStatusCommand(sdkStatus codersdk.UserStatus) *clibas
 			}
 
 			// Prompt to confirm the action
+			var question string
+			if sdkStatus == codersdk.UserStatusDormant {
+				question = "Are you sure you want to mark this user as dormant?"
+			} else {
+				question = fmt.Sprintf("Are you sure you want to %s this user?", verb)
+			}
 			_, err = cliui.Prompt(inv, cliui.PromptOptions{
-				Text:      fmt.Sprintf("Are you sure you want to %s this user?", verb),
+				Text:      question,
 				IsConfirm: true,
 				Default:   cliui.ConfirmYes,
 			})

diff --git a/cli/userstatus_test.go b/cli/userstatus_test.go
@@ -14,14 +14,13 @@ import (
 
 func TestUserStatus(t *testing.T) {
 	t.Parallel()
-	client := coderdtest.New(t, nil)
-	admin := coderdtest.CreateFirstUser(t, client)
-	other, _ := coderdtest.CreateAnotherUser(t, client, admin.OrganizationID)
-	otherUser, err := other.User(context.Background(), codersdk.Me)
-	require.NoError(t, err, "fetch user")
 
 	t.Run("StatusSelf", func(t *testing.T) {
 		t.Parallel()
+
+		client := coderdtest.New(t, nil)
+		coderdtest.CreateFirstUser(t, client)
+
 		inv, root := clitest.New(t, "users", "suspend", "me")
 		clitest.SetupConfig(t, client, root)
 		// Yes to the prompt
@@ -34,13 +33,18 @@ func TestUserStatus(t *testing.T) {
 
 	t.Run("StatusOther", func(t *testing.T) {
 		t.Parallel()
-		require.Equal(t, codersdk.UserStatusActive, otherUser.Status, "start as active")
+
+		client := coderdtest.New(t, nil)
+		admin := coderdtest.CreateFirstUser(t, client)
+		other, _ := coderdtest.CreateAnotherUser(t, client, admin.OrganizationID)
+		otherUser, err := other.User(context.Background(), codersdk.Me)
+		require.NoError(t, err, "fetch user")
 
 		inv, root := clitest.New(t, "users", "suspend", otherUser.Username)
 		clitest.SetupConfig(t, client, root)
 		// Yes to the prompt
 		inv.Stdin = bytes.NewReader([]byte("yes\n"))
-		err := inv.Run()
+		err = inv.Run()
 		require.NoError(t, err, "suspend user")
 
 		// Check the user status
@@ -61,4 +65,39 @@ func TestUserStatus(t *testing.T) {
 		require.NoError(t, err, "fetch active user")
 		require.Equal(t, codersdk.UserStatusActive, otherUser.Status, "active user")
 	})
+
+	t.Run("StatusDormant", func(t *testing.T) {
+		t.Parallel()
+
+		client := coderdtest.New(t, nil)
+		admin := coderdtest.CreateFirstUser(t, client)
+		other, _ := coderdtest.CreateAnotherUser(t, client, admin.OrganizationID)
+		otherUser, err := other.User(context.Background(), codersdk.Me)
+		require.NoError(t, err, "fetch user")
+
+		inv, root := clitest.New(t, "users", "dormant", otherUser.Username)
+		clitest.SetupConfig(t, client, root)
+		// Yes to the prompt
+		inv.Stdin = bytes.NewReader([]byte("yes\n"))
+		err = inv.Run()
+		require.NoError(t, err, "mark as dormant")
+
+		// Check the user status
+		otherUser, err = client.User(context.Background(), otherUser.Username)
+		require.NoError(t, err, "fetch dormant user")
+		require.Equal(t, codersdk.UserStatusDormant, otherUser.Status, "marked as dormant")
+
+		// Set back to active. Try using a uuid as well
+		inv, root = clitest.New(t, "users", "activate", otherUser.ID.String())
+		clitest.SetupConfig(t, client, root)
+		// Yes to the prompt
+		inv.Stdin = bytes.NewReader([]byte("yes\n"))
+		err = inv.Run()
+		require.NoError(t, err, "suspend user")
+
+		// Check the user status
+		otherUser, err = client.User(context.Background(), otherUser.ID.String())
+		require.NoError(t, err, "fetch active user")
+		require.Equal(t, codersdk.UserStatusActive, otherUser.Status, "active user")
+	})
 }
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -717,6 +717,7 @@ func New(options *Options) *API {
 					r.Route("/status", func(r chi.Router) {
 						r.Put("/suspend", api.putSuspendUserAccount())
 						r.Put("/activate", api.putActivateUserAccount())
+						r.Put("/dormant", api.putDormantUserAccount())
 					})
 					r.Route("/password", func(r chi.Router) {
 						r.Put("/", api.putUserPassword)

diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -575,6 +575,14 @@ func createAnotherUserRetry(t *testing.T, client *codersdk.Client, organizationI
 		sessionToken = token.Key
 	}
 
+	if user.Status == codersdk.UserStatusDormant {
+		// Use admin client so that user's LastSeenAt is not updated.
+		// In general we need to refresh the user status, which should
+		// transition from "dormant" to "active".
+		user, err = client.User(context.Background(), user.Username)
+		require.NoError(t, err)
+	}
+
 	other := codersdk.New(client.URL)
 	other.SetSessionToken(sessionToken)
 	t.Cleanup(func() {

diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -3854,7 +3854,7 @@ func (q *FakeQuerier) InsertUser(_ context.Context, arg database.InsertUserParam
 		CreatedAt:      arg.CreatedAt,
 		UpdatedAt:      arg.UpdatedAt,
 		Username:       arg.Username,
-		Status:         database.UserStatusActive,
+		Status:         database.UserStatusDormant,
 		RBACRoles:      arg.RBACRoles,
 		LoginType:      arg.LoginType,
 	}

diff --git a/coderd/database/dbgen/dbgen.go b/coderd/database/dbgen/dbgen.go
@@ -224,6 +224,13 @@ func User(t testing.TB, db database.Store, orig database.User) database.User {
 	})
 	require.NoError(t, err, "insert user")
 
+	user, err = db.UpdateUserStatus(genCtx, database.UpdateUserStatusParams{
+		ID:        user.ID,
+		Status:    database.UserStatusActive,
+		UpdatedAt: database.Now(),
+	})
+	require.NoError(t, err, "insert user")
+
 	if !orig.LastSeenAt.IsZero() {
 		user, err = db.UpdateUserLastSeenAt(genCtx, database.UpdateUserLastSeenAtParams{
 			ID:         user.ID,

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000143_user_status_dormant.down.sql b/coderd/database/migrations/000143_user_status_dormant.down.sql
@@ -0,0 +1 @@
+-- It's not possible to drop enum values from enum types, so the UP has "IF NOT EXISTS"
diff --git a/coderd/database/migrations/000143_user_status_dormant.up.sql b/coderd/database/migrations/000143_user_status_dormant.up.sql
@@ -0,0 +1,2 @@
+ALTER TYPE user_status ADD VALUE IF NOT EXISTS 'dormant';
+COMMENT ON TYPE user_status IS 'Defines the user status: active, dormant, or suspended.';
diff --git a/coderd/database/migrations/000144_user_status_default_dormant.down.sql b/coderd/database/migrations/000144_user_status_default_dormant.down.sql
@@ -0,0 +1 @@
+ALTER TABLE users ALTER COLUMN status SET DEFAULT 'active'::user_status;
diff --git a/coderd/database/migrations/000144_user_status_default_dormant.up.sql b/coderd/database/migrations/000144_user_status_default_dormant.up.sql
@@ -0,0 +1 @@
+ALTER TABLE users ALTER COLUMN status SET DEFAULT 'dormant'::user_status;
diff --git a/coderd/database/models.go b/coderd/database/models.go
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		-- It's not possible to drop enum values from enum types, so the UP has "IF NOT EXISTS"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TYPE user_status ADD VALUE IF NOT EXISTS 'dormant';
		COMMENT ON TYPE user_status IS 'Defines the user status: active, dormant, or suspended.';
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE users ALTER COLUMN status SET DEFAULT 'active'::user_status;