added deleted label

coder · Kira-Pilot · Dec 2, 2022 · Nov 23, 2022 · Nov 23, 2022 · Nov 23, 2022
commit d5eb06a13867370ef8f729cf9ebf88af8948a636
diff --git a/coderd/audit.go b/coderd/audit.go
@@ -199,10 +199,40 @@ func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogs
 		Diff:             diff,
 		StatusCode:       dblog.StatusCode,
 		AdditionalFields: dblog.AdditionalFields,
-		Description:      auditLogDescription(dblog),
 		User:             user,
+		Description:      auditLogDescription(dblog),
 		ResourceLink:     api.auditLogResourceLink(ctx, dblog),
+		IsDeleted:        api.auditLogIsResourceDeleted(ctx, dblog),
+	}
+}
+
+func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
+	str := fmt.Sprintf("{user} %s",
+		codersdk.AuditAction(alog.Action).FriendlyString(),
+	)
+
+	// Strings for starting/stopping workspace builds follow the below format:
+	// "{user} started build for workspace {target}"
+	// where target is a workspace instead of a workspace build
+	// passed in on the FE via AuditLog.AdditionalFields rather than derived in request.go:35
+	if alog.ResourceType == database.ResourceTypeWorkspaceBuild && alog.Action != database.AuditActionDelete {
+		str += " build for"
+	}
+
+	// We don't display the name (target) for git ssh keys. It's fairly long and doesn't
+	// make too much sense to display.
+	if alog.ResourceType == database.ResourceTypeGitSshKey {
+		str += fmt.Sprintf(" the %s",
+			codersdk.ResourceType(alog.ResourceType).FriendlyString())
+		return str
 	}
+
+	str += fmt.Sprintf(" %s",
+		codersdk.ResourceType(alog.ResourceType).FriendlyString())
+
+	str += " {target}"
+
+	return str
 }
 
 type AdditionalFields struct {
@@ -216,19 +246,19 @@ func (api *API) auditLogIsResourceDeleted(ctx context.Context, alog database.Get
 	case database.ResourceTypeTemplate:
 		template, err := api.Database.GetTemplateByID(ctx, alog.ResourceID)
 		if err != nil {
-			api.Logger.Error(ctx, "could not get template", slog.Error(err))
+			api.Logger.Error(ctx, "could not fetch template", slog.Error(err))
 		}
 		return template.Deleted
 	case database.ResourceTypeUser:
 		user, err := api.Database.GetUserByID(ctx, alog.ResourceID)
 		if err != nil {
-			api.Logger.Error(ctx, "could not get user", slog.Error(err))
+			api.Logger.Error(ctx, "could not fetch user", slog.Error(err))
 		}
 		return user.Deleted
 	case database.ResourceTypeWorkspace:
 		workspace, err := api.Database.GetWorkspaceByID(ctx, alog.ResourceID)
 		if err != nil {
-			api.Logger.Error(ctx, "could not get workspace", slog.Error(err))
+			api.Logger.Error(ctx, "could not fetch workspace", slog.Error(err))
 		}
 		return workspace.Deleted
 	case database.ResourceTypeWorkspaceBuild:
@@ -245,7 +275,7 @@ func (api *API) auditLogIsResourceDeleted(ctx context.Context, alog database.Get
 		// We use workspace as a proxy for workspace build here
 		workspace, err := api.Database.GetWorkspaceByID(ctx, uuid.MustParse(additionalFields.WorkspaceID))
 		if err != nil {
-			api.Logger.Error(ctx, "could not get workspace", slog.Error(err))
+			api.Logger.Error(ctx, "could not fetch workspace", slog.Error(err))
 		}
 		return workspace.Deleted
 	default:
@@ -254,29 +284,21 @@ func (api *API) auditLogIsResourceDeleted(ctx context.Context, alog database.Get
 }
 
 func (api *API) auditLogResourceLink(ctx context.Context, alog database.GetAuditLogsOffsetRow) string {
+	if api.auditLogIsResourceDeleted(ctx, alog) {
+		return ""
+	}
+
 	switch alog.ResourceType {
 	case database.ResourceTypeTemplate:
-		if api.auditLogIsResourceDeleted(ctx, alog) {
-			return ""
-		}
 		return fmt.Sprintf("/templates/%s",
 			alog.ResourceTarget)
 	case database.ResourceTypeUser:
-		if api.auditLogIsResourceDeleted(ctx, alog) {
-			return ""
-		}
 		return fmt.Sprintf("/users?filter=%s",
 			alog.ResourceTarget)
 	case database.ResourceTypeWorkspace:
-		if api.auditLogIsResourceDeleted(ctx, alog) {
-			return ""
-		}
 		return fmt.Sprintf("/@%s/%s",
 			alog.UserUsername.String, alog.ResourceTarget)
 	case database.ResourceTypeWorkspaceBuild:
-		if api.auditLogIsResourceDeleted(ctx, alog) {
-			return ""
-		}
 		additionalFieldsBytes := []byte(alog.AdditionalFields)
 		var additionalFields AdditionalFields
 		err := json.Unmarshal(additionalFieldsBytes, &additionalFields)
@@ -290,35 +312,6 @@ func (api *API) auditLogResourceLink(ctx context.Context, alog database.GetAudit
 	}
 }
 
-func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
-	str := fmt.Sprintf("{user} %s",
-		codersdk.AuditAction(alog.Action).FriendlyString(),
-	)
-
-	// Strings for starting/stopping workspace builds follow the below format:
-	// "{user} started build for workspace {target}"
-	// where target is a workspace instead of a workspace build
-	// passed in on the FE via AuditLog.AdditionalFields rather than derived in request.go:35
-	if alog.ResourceType == database.ResourceTypeWorkspaceBuild && alog.Action != database.AuditActionDelete {
-		str += " build for"
-	}
-
-	// We don't display the name (target) for git ssh keys. It's fairly long and doesn't
-	// make too much sense to display.
-	if alog.ResourceType == database.ResourceTypeGitSshKey {
-		str += fmt.Sprintf(" the %s",
-			codersdk.ResourceType(alog.ResourceType).FriendlyString())
-		return str
-	}
-
-	str += fmt.Sprintf(" %s",
-		codersdk.ResourceType(alog.ResourceType).FriendlyString())
-
-	str += " {target}"
-
-	return str
-}
-
 // auditSearchQuery takes a query string and returns the auditLog filter.
 // It also can return the list of validation errors to return to the api.
 func auditSearchQuery(query string) (database.GetAuditLogsOffsetParams, []codersdk.ValidationError) {

diff --git a/codersdk/audit.go b/codersdk/audit.go
@@ -105,6 +105,7 @@ type AuditLog struct {
 	AdditionalFields json.RawMessage `json:"additional_fields"`
 	Description      string          `json:"description"`
 	ResourceLink     string          `json:"resource_link"`
+	IsDeleted        bool            `json:"is_deleted"`
 
 	User *User `json:"user"`
 }

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -68,6 +68,7 @@ export interface AuditLog {
   readonly additional_fields: Record<string, string>
   readonly description: string
   readonly resource_link: string
+  readonly is_deleted: boolean
   readonly user?: User
 }
 

diff --git a/site/src/components/AuditLogRow/AuditLogDescription.tsx b/site/src/components/AuditLogRow/AuditLogDescription.tsx
@@ -2,10 +2,15 @@ import { FC } from "react"
 import { AuditLog } from "api/typesGenerated"
 import { Link as RouterLink } from "react-router-dom"
 import Link from "@material-ui/core/Link"
+import { makeStyles } from "@material-ui/core/styles"
+import i18next from "i18next"
 
 export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
   auditLog,
 }): JSX.Element => {
+  const classes = useStyles()
+  const { t } = i18next
+
   let target = auditLog.resource_target.trim()
 
   // audit logs with a resource_type of workspace build use workspace name as a target
@@ -41,6 +46,18 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
       ) : (
         <strong>{target}</strong>
       )}
+      {auditLog.is_deleted && (
+        <span className={classes.deletedLabel}>
+          <> {t("auditLog:table.logRow.deletedLabel")}</>
+        </span>
+      )}
     </span>
   )
 }
+
+const useStyles = makeStyles((theme) => ({
+  deletedLabel: {
+    ...theme.typography.caption,
+    color: theme.palette.text.secondary,
+  },
+}))
diff --git a/site/src/i18n/en/auditLog.json b/site/src/i18n/en/auditLog.json
@@ -8,6 +8,7 @@
     "emptyPage": "No audit logs available on this page",
     "noLogs": "No audit logs available",
     "logRow": {
+      "deletedLabel": "(deleted)",
       "ip": "IP: ",
       "os": "OS: ",
       "browser": "Browser: ",