refactor: request one-time passcode -> request password reset

coder · DanielleMaywood · Oct 22, 2024 · Oct 22, 2024 · Oct 22, 2024 · Oct 22, 2024
commit a258f68ee63e25d15bf3350df7584d657e89c599
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/audit.go b/coderd/audit.go
@@ -277,9 +277,9 @@ func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
 
 	// NOTE: WriteString always returns a nil error, so we never check it
 
-	// Requesting a one-time passcode can be performed by anyone that knows the email
+	// Requesting a password reset can be performed by anyone that knows the email
 	// of a user so saying the user performed this action might be slightly misleading.
-	if alog.AuditLog.Action != database.AuditActionRequestOneTimePasscode {
+	if alog.AuditLog.Action != database.AuditActionRequestPasswordReset {
 		_, _ = b.WriteString("{user} ")
 	}
 
@@ -305,7 +305,7 @@ func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
 		return b.String()
 	}
 
-	if alog.AuditLog.Action == database.AuditActionRequestOneTimePasscode {
+	if alog.AuditLog.Action == database.AuditActionRequestPasswordReset {
 		_, _ = b.WriteString(" for")
 	} else {
 		_, _ = b.WriteString(" ")

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000268_add_audit_action_forgot_password.up.sql b/coderd/database/migrations/000268_add_audit_action_forgot_password.up.sql
diff --git a/...add_audit_action_forgot_password.down.sql → ...it_action_request_password_reset.down.sql b/...add_audit_action_forgot_password.down.sql → ...it_action_request_password_reset.down.sql
diff --git a/coderd/database/migrations/000268_add_audit_action_request_password_reset.up.sql b/coderd/database/migrations/000268_add_audit_action_request_password_reset.up.sql
@@ -0,0 +1,2 @@
+ALTER TYPE audit_action
+  ADD VALUE IF NOT EXISTS 'request_password_reset';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/userauth.go b/coderd/userauth.go
@@ -220,7 +220,7 @@ func (api *API) postRequestOneTimePasscode(rw http.ResponseWriter, r *http.Reque
 			Audit:   *auditor,
 			Log:     api.Logger,
 			Request: r,
-			Action:  database.AuditActionRequestOneTimePasscode,
+			Action:  database.AuditActionRequestPasswordReset,
 		})
 	)
 	defer commitAudit()

diff --git a/codersdk/audit.go b/codersdk/audit.go
@@ -86,15 +86,15 @@ func (r ResourceType) FriendlyString() string {
 type AuditAction string
 
 const (
-	AuditActionCreate                 AuditAction = "create"
-	AuditActionWrite                  AuditAction = "write"
-	AuditActionDelete                 AuditAction = "delete"
-	AuditActionStart                  AuditAction = "start"
-	AuditActionStop                   AuditAction = "stop"
-	AuditActionLogin                  AuditAction = "login"
-	AuditActionLogout                 AuditAction = "logout"
-	AuditActionRegister               AuditAction = "register"
-	AuditActionRequestOneTimePasscode AuditAction = "request_one_time_passcode"
+	AuditActionCreate               AuditAction = "create"
+	AuditActionWrite                AuditAction = "write"
+	AuditActionDelete               AuditAction = "delete"
+	AuditActionStart                AuditAction = "start"
+	AuditActionStop                 AuditAction = "stop"
+	AuditActionLogin                AuditAction = "login"
+	AuditActionLogout               AuditAction = "logout"
+	AuditActionRegister             AuditAction = "register"
+	AuditActionRequestPasswordReset AuditAction = "request_password_reset"
 )
 
 func (a AuditAction) Friendly() string {
@@ -115,8 +115,8 @@ func (a AuditAction) Friendly() string {
 		return "logged out"
 	case AuditActionRegister:
 		return "registered"
-	case AuditActionRequestOneTimePasscode:
-		return "one time passcode requested"
+	case AuditActionRequestPasswordReset:
+		return "password reset requested"
 	default:
 		return "unknown"
 	}

diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -2604,8 +2604,8 @@ export const MockAuditLogRequestOneTimePasscode: TypesGen.AuditLog = {
 	...MockAuditLog,
 	resource_type: "user",
 	resource_target: "member",
-	action: "request_one_time_passcode",
-	description: "one time passcode requested for {target}",
+	action: "request_password_reset",
+	description: "password reset requested for {target}",
 	diff: {
 		hashed_password: {
 			old: "",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TYPE audit_action
		ADD VALUE IF NOT EXISTS 'request_password_reset';