This PR officially introduces another user account status -dormant. Users who have not logged in yet to the Coder platform will be marked as dormant, and will not be included in the license seat calculations.

Low-level changes:

database: definedormant user status
coderd: modify business logic to automatically switch user account to active once they log in
coderd: adjust login&password worfklow to activate a dormant account
coderd: tweakExtractAPIKeyMW to switch a "dormant" account to "active"
coderd: fix unit tests that use active accounts by default
site: add "Learn more" menu item to navigate to docs
cli: support "dormant" accounts
cli: refresh testdata (scaletest commands were stale)
docs: describe user statuses

Testing:

GitHub login using custom Github App for testing purposes
OpenID using custom Auth0 domain and@coder.com Google account

Notes:

I didn't touch SCIM API as I'm not sure if this is something we should touch? SCIM supports only active/inactive state.

Next steps:

Configure a periodic job to mark inactive accounts (90 days) as dormant

mtojek added2 commits

July 21, 2023 13:45

WIP

30b71d0

generated

0091738

mtojek self-assigned this

Jul 21, 2023

mtojek mentioned this pull request

Jul 21, 2023

chore: update nix flake to include sqlc v1.19.0#8645

Merged

mtojekand others added26 commits

July 21, 2023 12:32

make gen

6771255

Dormant API

57547ae

WIP

f699e6f

make gen

3376a0f

userauth

4fbc5d9

fix: lint

67c4e96

UsersFilter.tsx

daa025f

Site UI changes

b86f636

make fmt

05cd577

Merge branch 'main' into 8128-new-user-state-dormant

7d4ad5c

CLI changes

738441b

CLI fix

3ff2962

UI fixes

08b9cbb

FIXME pubsub

a3b3f65

Add learn more link2

e63f7a8

Merge branch 'main' into 8128-new-user-state-dormant

d6d9dac

Merge branch 'main' into 8128-new-user-state-dormant

1454cb0

Fix: migrations

b7a870e

dump.sql

d90ea27

FIXME

83b8f63

CLI tests

1553871

oss

6a959d6

next fixes

f7d3061

Unit test: dormant to active after login

4a530ae

More tests

c359d9f

Merge branch 'main' into 8128-new-user-state-dormant

5b4e76f

Write unit test for job

e145b74

mtojek marked this pull request as ready for review

August 2, 2023 10:10

mtojek requested a review fromjohnstcn

August 2, 2023 10:10

mtojek added2 commits

August 2, 2023 12:38

Fix

187e866

info

82b791a

johnstcn reviewed

Aug 2, 2023

View reviewed changes

coderd/dormancy/dormantusersjob.go OutdatedShow resolvedHide resolved

johnstcn reviewed

Aug 2, 2023

View reviewed changes

coderd/dormancy/dormantusersjob.go OutdatedShow resolvedHide resolved

johnstcn reviewed

Aug 2, 2023

View reviewed changes

coderd/dormancy/dormantusersjob.goShow resolvedHide resolved

johnstcn reviewed

Aug 2, 2023

View reviewed changes

coderd/dormancy/dormantusersjob.goShow resolvedHide resolved

johnstcn reviewed

Aug 2, 2023

View reviewed changes

coderd/dormancy/dormantusersjob_test.go OutdatedShow resolvedHide resolved

johnstcn reviewed

Aug 2, 2023

View reviewed changes

coderd/dormancy/dormantusersjob_test.goShow resolvedHide resolved

mtojek added2 commits

August 2, 2023 12:55

Address PR feedback

4545cb6

t.Helper

85d6fae

johnstcn reviewed

Aug 2, 2023

View reviewed changes

coderd/dormancy/dormantusersjob_test.go Outdated

Comment on lines 48 to 63

		require.Eventually(t, func() bool {
		rows, err = db.GetUsers(ctx, database.GetUsersParams{})
		if err != nil {
		return false
		}

		var c int
		for _, row := range rows {
		if row.Status == database.UserStatusDormant {
		c++
		}
		}
		// 6 users in total, 3 dormant
		return len(rows) == 6 && c == 3
		}, testutil.WaitShort, testutil.IntervalMedium)

Copy link

Member

johnstcnAug 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggestion: if you allow passing in atick chan time.Time andupdated chan int intoCheckInactiveUsersWithOptions you can then conceivably remove thisrequire.Eventually - you write a time totick, and read the number of updated users fromupdated