Fix redudant types

BrunoQuaresma · BrunoQuaresma · commit d753f0e32f4d · 2023-07-27T13:45:43.000Z
diff --git a/site/.eslintrc.yaml b/site/.eslintrc.yaml
@@ -75,8 +75,6 @@ rules:
   "@typescript-eslint/restrict-template-expressions": "off"
   # TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
   "@typescript-eslint/unbound-method": "off"
-  # TODO: Investigate whether to enable this rule & fix and/or disable all its complaints
-  "@typescript-eslint/no-redundant-type-constituents": "off"
   # We're disabling the `no-namespace` rule to use a pattern of defining an interface,
   # and then defining functions that operate on that data via namespace. This is helpful for
   # dealing with immutable objects. This is a common pattern that shows up in some other
diff --git a/site/src/api/errors.ts b/site/src/api/errors.ts
@@ -59,7 +59,7 @@ export const mapApiErrorToFieldErrors = (
  * @returns error's message if ApiError or Error, else defaultMessage
  */
 export const getErrorMessage = (
-  error: Error | ApiError | unknown,
+  error: unknown,
   defaultMessage: string,
 ): string =>
   isApiError(error)
@@ -74,19 +74,15 @@ export const getErrorMessage = (
  * @returns a combined validation error message if the error is an ApiError
  * and contains validation messages for different form fields.
  */
-export const getValidationErrorMessage = (
-  error: Error | ApiError | unknown,
-): string => {
+export const getValidationErrorMessage = (error: unknown): string => {
   const validationErrors =
     isApiError(error) && error.response.data.validations
       ? error.response.data.validations
       : []
   return validationErrors.map((error) => error.detail).join("\n")
 }
 
-export const getErrorDetail = (
-  error: Error | ApiError | unknown,
-): string | undefined | null =>
+export const getErrorDetail = (error: unknown): string | undefined | null =>
   isApiError(error)
     ? error.response.data.detail
     : error instanceof Error
diff --git a/site/src/components/DeploySettingsLayout/Option.tsx b/site/src/components/DeploySettingsLayout/Option.tsx
@@ -1,5 +1,5 @@
 import { makeStyles } from "@mui/styles"
-import { PropsWithChildren, FC, ReactNode } from "react"
+import { PropsWithChildren, FC } from "react"
 import { MONOSPACE_FONT_FAMILY } from "theme/constants"
 import { DisabledBadge, EnabledBadge } from "./Badges"
 
@@ -19,9 +19,7 @@ const NotSet: FC = () => {
   return <span className={styles.optionValue}>Not set</span>
 }
 
-export const OptionValue: FC<{ children?: ReactNode | unknown }> = ({
-  children,
-}) => {
+export const OptionValue: FC<{ children?: unknown }> = ({ children }) => {
   const styles = useStyles()
 
   if (typeof children === "boolean") {
diff --git a/site/src/components/DeploySettingsLayout/Options.test.tsx b/site/src/components/DeploySettingsLayout/Options.test.tsx
@@ -13,7 +13,7 @@ const defaultOption: DeploymentOption = {
 describe("optionValue", () => {
   it.each<{
     option: DeploymentOption
-    expected: string | string[] | unknown
+    expected: unknown
   }>([
     {
       option: {
diff --git a/site/src/components/DeploySettingsLayout/OptionsTable.tsx b/site/src/components/DeploySettingsLayout/OptionsTable.tsx
@@ -62,9 +62,7 @@ const OptionsTable: FC<{
 }
 
 // optionValue is a helper function to format the value of a specific deployment options
-export function optionValue(
-  option: DeploymentOption,
-): string[] | string | unknown {
+export function optionValue(option: DeploymentOption) {
   switch (option.name) {
     case "Max Token Lifetime":
     case "Session Duration":
diff --git a/site/src/components/SettingsAccountForm/SettingsAccountForm.tsx b/site/src/components/SettingsAccountForm/SettingsAccountForm.tsx
@@ -31,7 +31,7 @@ export interface AccountFormProps {
   isLoading: boolean
   initialValues: AccountFormValues
   onSubmit: (values: AccountFormValues) => void
-  updateProfileError?: Error | unknown
+  updateProfileError?: unknown
   // initialTouched is only used for testing the error state of the form.
   initialTouched?: FormikTouched<AccountFormValues>
 }
diff --git a/site/src/components/Workspace/Workspace.tsx b/site/src/components/Workspace/Workspace.tsx
@@ -64,7 +64,7 @@ export interface WorkspaceProps {
   canChangeVersions: boolean
   hideSSHButton?: boolean
   hideVSCodeDesktopButton?: boolean
-  workspaceErrors: Partial<Record<WorkspaceErrors, Error | unknown>>
+  workspaceErrors: Partial<Record<WorkspaceErrors, unknown>>
   buildInfo?: TypesGen.BuildInfoResponse
   sshPrefix?: string
   template?: TypesGen.Template
diff --git a/site/src/components/WorkspacesTable/WorkspacesTable.tsx b/site/src/components/WorkspacesTable/WorkspacesTable.tsx
@@ -19,7 +19,7 @@ export interface WorkspacesTableProps {
   workspaces?: Workspace[]
   isUsingFilter: boolean
   onUpdateWorkspace: (workspace: Workspace) => void
-  error?: Error | unknown
+  error?: unknown
 }
 
 export const WorkspacesTable: FC<WorkspacesTableProps> = ({
diff --git a/site/src/components/WorkspacesTable/WorkspacesTableBody.tsx b/site/src/components/WorkspacesTable/WorkspacesTableBody.tsx
@@ -14,7 +14,7 @@ interface TableBodyProps {
   workspaces?: Workspace[]
   isUsingFilter: boolean
   onUpdateWorkspace: (workspace: Workspace) => void
-  error?: Error | unknown
+  error?: unknown
 }
 
 export const WorkspacesTableBody: FC<
diff --git a/site/src/contexts/ProxyContext.tsx b/site/src/contexts/ProxyContext.tsx
@@ -46,7 +46,7 @@ export interface ProxyContextValue {
   // isFetched is true when the 'proxies' api call is complete.
   isFetched: boolean
   isLoading: boolean
-  error?: Error | unknown
+  error?: unknown
   // proxyLatencies is a map of proxy id to latency report. If the proxyLatencies[proxy.id] is undefined
   // then the latency has not been fetched yet. Calculations happen async for each proxy in the list.
   // Refer to the returned report for a given proxy for more information.
diff --git a/site/src/pages/AuditPage/AuditPageView.tsx b/site/src/pages/AuditPage/AuditPageView.tsx
@@ -37,7 +37,7 @@ export interface AuditPageViewProps {
   onPageChange: (page: number) => void
   isNonInitialPage: boolean
   isAuditLogVisible: boolean
-  error?: Error | unknown
+  error?: unknown
   filterProps: ComponentProps<typeof AuditFilter>
 }
 
diff --git a/site/src/pages/CreateTokenPage/CreateTokenForm.tsx b/site/src/pages/CreateTokenPage/CreateTokenForm.tsx
@@ -25,8 +25,8 @@ import { Stack } from "components/Stack/Stack"
 interface CreateTokenFormProps {
   form: FormikContextType<CreateTokenData>
   maxTokenLifetime?: number
-  formError: Error | unknown
-  setFormError: (arg0: Error | unknown) => void
+  formError: unknown
+  setFormError: (arg0: unknown) => void
   isCreating: boolean
   creationFailed: boolean
 }
diff --git a/site/src/pages/CreateTokenPage/CreateTokenPage.tsx b/site/src/pages/CreateTokenPage/CreateTokenPage.tsx
@@ -43,7 +43,7 @@ export const CreateTokenPage: FC = () => {
     queryFn: getTokenConfig,
   })
 
-  const [formError, setFormError] = useState<unknown | undefined>(undefined)
+  const [formError, setFormError] = useState<unknown>(undefined)
 
   const onCreateSuccess = () => {
     displaySuccess(t("createToken.createSuccess"))
diff --git a/site/src/pages/GroupsPage/CreateGroupPageView.tsx b/site/src/pages/GroupsPage/CreateGroupPageView.tsx
@@ -16,7 +16,7 @@ const validationSchema = Yup.object({
 
 export type CreateGroupPageViewProps = {
   onSubmit: (data: CreateGroupRequest) => void
-  formErrors: unknown | undefined
+  formErrors?: unknown
   isLoading: boolean
 }
 
diff --git a/site/src/pages/UserSettingsPage/SSHKeysPage/SSHKeysPageView.tsx b/site/src/pages/UserSettingsPage/SSHKeysPage/SSHKeysPageView.tsx
@@ -15,8 +15,8 @@ export const Language = {
 export interface SSHKeysPageViewProps {
   isLoading: boolean
   hasLoaded: boolean
-  getSSHKeyError?: Error | unknown
-  regenerateSSHKeyError?: Error | unknown
+  getSSHKeyError?: unknown
+  regenerateSSHKeyError?: unknown
   sshKey?: GitSSHKey
   onRegenerateClick: () => void
 }
diff --git a/site/src/pages/UserSettingsPage/TokensPage/TokensPageView.tsx b/site/src/pages/UserSettingsPage/TokensPage/TokensPageView.tsx
@@ -28,11 +28,11 @@ const lastUsedOrNever = (lastUsed: string) => {
 
 export interface TokensPageViewProps {
   tokens?: APIKeyWithOwner[]
-  getTokensError?: Error | unknown
+  getTokensError?: unknown
   isLoading: boolean
   hasLoaded: boolean
   onDelete: (token: APIKeyWithOwner) => void
-  deleteTokenError?: Error | unknown
+  deleteTokenError?: unknown
 }
 
 export const TokensPageView: FC<
diff --git a/site/src/pages/UserSettingsPage/WorkspaceProxyPage/WorkspaceProxyView.tsx b/site/src/pages/UserSettingsPage/WorkspaceProxyPage/WorkspaceProxyView.tsx
@@ -17,11 +17,11 @@ import { ErrorAlert } from "components/Alert/ErrorAlert"
 export interface WorkspaceProxyViewProps {
   proxies?: Region[]
   proxyLatencies?: Record<string, ProxyLatencyReport>
-  getWorkspaceProxiesError?: Error | unknown
+  getWorkspaceProxiesError?: unknown
   isLoading: boolean
   hasLoaded: boolean
   preferredProxy?: Region
-  selectProxyError?: Error | unknown
+  selectProxyError?: unknown
 }
 
 export const WorkspaceProxyView: FC<
diff --git a/site/src/xServices/appearance/appearanceXService.ts b/site/src/xServices/appearance/appearanceXService.ts
@@ -5,8 +5,8 @@ import { AppearanceConfig } from "../../api/typesGenerated"
 
 export type AppearanceContext = {
   appearance?: AppearanceConfig
-  getAppearanceError?: Error | unknown
-  setAppearanceError?: Error | unknown
+  getAppearanceError?: unknown
+  setAppearanceError?: unknown
   preview: boolean
 }
 
diff --git a/site/src/xServices/auth/authMethodsXService.ts b/site/src/xServices/auth/authMethodsXService.ts
@@ -4,7 +4,7 @@ import * as API from "api/api"
 
 export interface AuthMethodsContext {
   authMethods?: TypeGen.AuthMethods
-  error?: Error | unknown
+  error?: unknown
 }
 
 export const authMethodsXService = createMachine(
diff --git a/site/src/xServices/auth/authXService.ts b/site/src/xServices/auth/authXService.ts
@@ -181,8 +181,8 @@ const signOut = async () => {
   } as UnauthenticatedData
 }
 export interface AuthContext {
-  error?: Error | unknown
-  updateProfileError?: Error | unknown
+  error?: unknown
+  updateProfileError?: unknown
   data?: AuthData
 }
 
diff --git a/site/src/xServices/buildInfo/buildInfoXService.ts b/site/src/xServices/buildInfo/buildInfoXService.ts
@@ -3,7 +3,7 @@ import * as API from "../../api/api"
 import * as TypesGen from "../../api/typesGenerated"
 
 export interface BuildInfoContext {
-  getBuildInfoError?: Error | unknown
+  getBuildInfoError?: unknown
   buildInfo?: TypesGen.BuildInfoResponse
 }
 
diff --git a/site/src/xServices/createWorkspace/createWorkspaceXService.ts b/site/src/xServices/createWorkspace/createWorkspaceXService.ts
@@ -25,7 +25,7 @@ type CreateWorkspaceContext = {
   templateName: string
   mode: CreateWorkspaceMode
   defaultName: string
-  error?: Error | unknown
+  error?: unknown
   // Form
   template?: Template
   parameters?: TemplateVersionParameter[]
diff --git a/site/src/xServices/entitlements/entitlementsXService.ts b/site/src/xServices/entitlements/entitlementsXService.ts
@@ -4,7 +4,7 @@ import { Entitlements } from "../../api/typesGenerated"
 
 export type EntitlementsContext = {
   entitlements?: Entitlements
-  getEntitlementsError?: Error | unknown
+  getEntitlementsError?: unknown
 }
 
 export const entitlementsMachine = createMachine(
diff --git a/site/src/xServices/experiments/experimentsMachine.ts b/site/src/xServices/experiments/experimentsMachine.ts
@@ -4,7 +4,7 @@ import { createMachine, assign } from "xstate"
 
 export interface ExperimentsContext {
   experiments?: Experiment[]
-  getExperimentsError?: Error | unknown
+  getExperimentsError?: unknown
 }
 
 export const experimentsMachine = createMachine(
diff --git a/site/src/xServices/quotas/quotasXService.ts b/site/src/xServices/quotas/quotasXService.ts
@@ -5,7 +5,7 @@ import { WorkspaceQuota } from "../../api/typesGenerated"
 export type QuotaContext = {
   username: string
   quota?: WorkspaceQuota
-  getQuotaError?: Error | unknown
+  getQuotaError?: unknown
 }
 
 export const quotaMachine = createMachine(
diff --git a/site/src/xServices/roles/siteRolesXService.ts b/site/src/xServices/roles/siteRolesXService.ts
@@ -10,7 +10,7 @@ export const Language = {
 type SiteRolesContext = {
   hasPermission: boolean
   roles?: TypesGen.AssignableRoles[]
-  getRolesError: Error | unknown
+  getRolesError: unknown
 }
 
 export const siteRolesMachine = createMachine(
diff --git a/site/src/xServices/template/templateVariablesXService.ts b/site/src/xServices/template/templateVariablesXService.ts
@@ -24,8 +24,8 @@ type TemplateVariablesContext = {
   createTemplateVersionRequest?: CreateTemplateVersionRequest
   newTemplateVersion?: TemplateVersion
 
-  getTemplateDataError?: Error | unknown
-  updateTemplateError?: Error | unknown
+  getTemplateDataError?: unknown
+  updateTemplateError?: unknown
 
   jobError?: TemplateVersion["job"]["error"]
 }
diff --git a/site/src/xServices/templateVersion/templateVersionXService.ts b/site/src/xServices/templateVersion/templateVersionXService.ts
@@ -18,7 +18,7 @@ export interface TemplateVersionMachineContext {
   template?: Template
   currentVersion?: TemplateVersion
   currentFiles?: TemplateVersionFiles
-  error?: Error | unknown
+  error?: unknown
   // Get file diffs
   previousVersion?: TemplateVersion
   previousFiles?: TemplateVersionFiles
diff --git a/site/src/xServices/templates/templatesXService.ts b/site/src/xServices/templates/templatesXService.ts
@@ -8,7 +8,7 @@ export interface TemplatesContext {
   permissions: Permissions
   templates?: TypesGen.Template[]
   examples?: TypesGen.TemplateExample[]
-  error?: Error | unknown
+  error?: unknown
 }
 
 export const templatesMachine = createMachine(
diff --git a/site/src/xServices/terminal/terminalXService.ts b/site/src/xServices/terminal/terminalXService.ts
@@ -4,14 +4,14 @@ import * as Types from "../../api/types"
 import * as TypesGen from "../../api/typesGenerated"
 
 export interface TerminalContext {
-  workspaceError?: Error | unknown
+  workspaceError?: unknown
   workspace?: TypesGen.Workspace
   workspaceAgent?: TypesGen.WorkspaceAgent
-  workspaceAgentError?: Error | unknown
+  workspaceAgentError?: unknown
   websocket?: WebSocket
-  websocketError?: Error | unknown
+  websocketError?: unknown
   websocketURL?: string
-  websocketURLError?: Error | unknown
+  websocketURLError?: unknown
 
   // Assigned by connecting!
   // The workspace agent is entirely optional.  If the agent is omitted the
diff --git a/site/src/xServices/updateCheck/updateCheckXService.ts b/site/src/xServices/updateCheck/updateCheckXService.ts
@@ -6,7 +6,7 @@ import { checks, Permissions } from "xServices/auth/authXService"
 export interface UpdateCheckContext {
   permissions: Permissions
   updateCheck?: UpdateCheckResponse
-  error?: Error | unknown
+  error?: unknown
 }
 
 export type UpdateCheckEvent = { type: "DISMISS" }
diff --git a/site/src/xServices/users/usersXService.ts b/site/src/xServices/users/usersXService.ts
@@ -35,26 +35,26 @@ export interface UsersContext {
   // Get users
   users?: TypesGen.User[]
   filter: string
-  getUsersError?: Error | unknown
+  getUsersError?: unknown
   // Suspend user
   userIdToSuspend?: TypesGen.User["id"]
   usernameToSuspend?: TypesGen.User["username"]
-  suspendUserError?: Error | unknown
+  suspendUserError?: unknown
   // Delete user
   userIdToDelete?: TypesGen.User["id"]
   usernameToDelete?: TypesGen.User["username"]
-  deleteUserError?: Error | unknown
+  deleteUserError?: unknown
   // Activate user
   userIdToActivate?: TypesGen.User["id"]
   usernameToActivate?: TypesGen.User["username"]
-  activateUserError?: Error | unknown
+  activateUserError?: unknown
   // Reset user password
   userIdToResetPassword?: TypesGen.User["id"]
-  resetUserPasswordError?: Error | unknown
+  resetUserPasswordError?: unknown
   newUserPassword?: string
   // Update user roles
   userIdToUpdateRoles?: TypesGen.User["id"]
-  updateUserRolesError?: Error | unknown
+  updateUserRolesError?: unknown
   paginationContext: PaginationContext
   paginationRef: PaginationMachineRef
   count: number
diff --git a/site/src/xServices/workspace/workspaceXService.ts b/site/src/xServices/workspace/workspaceXService.ts
@@ -59,12 +59,12 @@ export interface WorkspaceContext {
   build?: TypesGen.WorkspaceBuild
   // Builds
   builds?: TypesGen.WorkspaceBuild[]
-  getBuildsError?: Error | unknown
+  getBuildsError?: unknown
   missedParameters?: TypesGen.TemplateVersionParameter[]
   // error creating a new WorkspaceBuild
-  buildError?: Error | unknown
+  buildError?: unknown
   cancellationMessage?: Types.Message
-  cancellationError?: Error | unknown
+  cancellationError?: unknown
   // debug
   createBuildLogLevel?: TypesGen.CreateWorkspaceBuildRequest["log_level"]
   // SSH Config
@@ -92,7 +92,7 @@ export type WorkspaceEvent =
       checkRefresh?: boolean
       data?: TypesGen.ServerSentEvent["data"]
     }
-  | { type: "EVENT_SOURCE_ERROR"; error: Error | unknown }
+  | { type: "EVENT_SOURCE_ERROR"; error: unknown }
   | { type: "INCREASE_DEADLINE"; hours: number }
   | { type: "DECREASE_DEADLINE"; hours: number }
   | { type: "RETRY_BUILD" }
diff --git a/site/src/xServices/workspaceBuild/workspaceBuildXService.ts b/site/src/xServices/workspaceBuild/workspaceBuildXService.ts
diff --git a/site/src/xServices/workspaceSchedule/workspaceScheduleXService.ts b/site/src/xServices/workspaceSchedule/workspaceScheduleXService.ts

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ const defaultOption: DeploymentOption = {`
`13`	`13`	`describe("optionValue", () => {`
`14`	`14`	`it.each<{`
`15`	`15`	`option: DeploymentOption`
`16`		`- expected: string \| string[] \| unknown`
	`16`	`+ expected: unknown`
`17`	`17`	`}>([`
`18`	`18`	`{`
`19`	`19`	`option: {`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ export interface AccountFormProps {`
`31`	`31`	`isLoading: boolean`
`32`	`32`	`initialValues: AccountFormValues`
`33`	`33`	`onSubmit: (values: AccountFormValues) => void`
`34`		`- updateProfileError?: Error \| unknown`
	`34`	`+ updateProfileError?: unknown`
`35`	`35`	`// initialTouched is only used for testing the error state of the form.`
`36`	`36`	`initialTouched?: FormikTouched<AccountFormValues>`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export interface WorkspacesTableProps {`
`19`	`19`	`workspaces?: Workspace[]`
`20`	`20`	`isUsingFilter: boolean`
`21`	`21`	`onUpdateWorkspace: (workspace: Workspace) => void`
`22`		`- error?: Error \| unknown`
	`22`	`+ error?: unknown`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`export const WorkspacesTable: FC<WorkspacesTableProps> = ({`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ interface TableBodyProps {`
`14`	`14`	`workspaces?: Workspace[]`
`15`	`15`	`isUsingFilter: boolean`
`16`	`16`	`onUpdateWorkspace: (workspace: Workspace) => void`
`17`		`- error?: Error \| unknown`
	`17`	`+ error?: unknown`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`export const WorkspacesTableBody: FC<`