fix(types): make result a strong type

As a way to make it more predictable what the possible states the
`result` in a given `Repository finished` log message can be, we can
wrap these into a type.

This requires a slight refactor where these are used to make sure that
Typescript is happy with the value being returned.

We can capture the common groups of errors (which are then present as a
`RepositoryResult`) and expose that to be used.

Author: jamietanna

lib/constants/error-messages.ts

@@ -2,6 +2,11 @@
 export const SYSTEM_INSUFFICIENT_DISK_SPACE = 'disk-space';
 export const SYSTEM_INSUFFICIENT_MEMORY = 'out-of-memory';
 
+export const SystemErrors = [
+  SYSTEM_INSUFFICIENT_DISK_SPACE,
+  SYSTEM_INSUFFICIENT_MEMORY,
+] as const;
+
 // Platform Error
 export const PLATFORM_AUTHENTICATION_ERROR = 'authentication-error';
 export const PLATFORM_BAD_CREDENTIALS = 'bad-credentials';
@@ -11,6 +16,17 @@ export const PLATFORM_NOT_FOUND = 'platform-not-found';
 export const PLATFORM_RATE_LIMIT_EXCEEDED = 'rate-limit-exceeded';
 export const PLATFORM_UNKNOWN_ERROR = 'platform-unknown-error';
 
+/** cause repo to be considered as disabled */
+export const PlatformErrors = [
+  PLATFORM_AUTHENTICATION_ERROR,
+  PLATFORM_BAD_CREDENTIALS,
+  PLATFORM_GPG_FAILED,
+  PLATFORM_INTEGRATION_UNAUTHORIZED,
+  PLATFORM_NOT_FOUND,
+  PLATFORM_RATE_LIMIT_EXCEEDED,
+  PLATFORM_UNKNOWN_ERROR,
+] as const;
+
 // Config Error
 export const CONFIG_VALIDATION = 'config-validation';
 export const CONFIG_PRESETS_INVALID = 'config-presets-invalid';
@@ -21,6 +37,18 @@ export const CONFIG_GIT_URL_UNAVAILABLE = 'config-git-url-unavailable';
 export const CONFIG_INHERIT_NOT_FOUND = 'config-inherit-not-found';
 export const CONFIG_INHERIT_PARSE_ERROR = 'config-inherit-parse-error';
 
+/** cause repo to be considered as disabled */
+export const ConfigErrors = [
+  CONFIG_VALIDATION,
+  CONFIG_PRESETS_INVALID,
+  CONFIG_SECRETS_EXPOSED,
+  CONFIG_SECRETS_INVALID,
+  CONFIG_VARIABLES_INVALID,
+  CONFIG_GIT_URL_UNAVAILABLE,
+  CONFIG_INHERIT_NOT_FOUND,
+  CONFIG_INHERIT_PARSE_ERROR,
+] as const;
+
 // Repository Errors - causes repo to be considered as disabled
 export const REPOSITORY_ACCESS_FORBIDDEN = 'forbidden';
 export const REPOSITORY_ARCHIVED = 'archived';
@@ -40,11 +68,38 @@ export const REPOSITORY_NO_PACKAGE_FILES = 'no-package-files';
 export const REPOSITORY_RENAMED = 'renamed';
 export const REPOSITORY_UNINITIATED = 'uninitiated';
 
+/** cause repo to be considered as disabled */
+export const RepositoryErrors = [
+  REPOSITORY_ACCESS_FORBIDDEN,
+  REPOSITORY_ARCHIVED,
+  REPOSITORY_BLOCKED,
+  REPOSITORY_CANNOT_FORK,
+  REPOSITORY_DISABLED,
+  REPOSITORY_CLOSED_ONBOARDING,
+  REPOSITORY_DISABLED_BY_CONFIG,
+  REPOSITORY_NO_CONFIG,
+  REPOSITORY_EMPTY,
+  REPOSITORY_FORK_MISSING,
+  REPOSITORY_FORK_MODE_FORKED,
+  REPOSITORY_FORKED,
+  REPOSITORY_MIRRORED,
+  REPOSITORY_NOT_FOUND,
+  REPOSITORY_NO_PACKAGE_FILES,
+  REPOSITORY_RENAMED,
+  REPOSITORY_UNINITIATED,
+] as const;
+
 // Temporary Error
 export const REPOSITORY_CHANGED = 'repository-changed';
 export const TEMPORARY_ERROR = 'temporary-error';
 export const NO_VULNERABILITY_ALERTS = 'no-vulnerability-alerts';
 
+export const TemporaryErrors = [
+  REPOSITORY_CHANGED,
+  TEMPORARY_ERROR,
+  NO_VULNERABILITY_ALERTS,
+] as const;
+
 // Manager Error
 export const MANAGER_LOCKFILE_ERROR = 'lockfile-error';
 export const FILE_ACCESS_VIOLATION_ERROR = 'file-access-violation-error';

lib/workers/repository/error.ts

@@ -40,11 +40,12 @@ import {
   raiseConfigWarningIssue,
   raiseCredentialsWarningIssue,
 } from './error-config';
+import type { RepositoryResult } from './result';
 
 export default async function handleError(
   config: RenovateConfig,
   err: Error,
-): Promise<string> {
+): Promise<RepositoryResult> {
   if (err.message === REPOSITORY_UNINITIATED) {
     logger.info('Repository is uninitiated - skipping');
     delete config.branchList;
@@ -55,15 +56,13 @@ export default async function handleError(
     delete config.branchList;
     return err.message;
   }
-  const disabledMessages = [
-    REPOSITORY_CLOSED_ONBOARDING,
-    REPOSITORY_DISABLED,
-    REPOSITORY_DISABLED_BY_CONFIG,
-    REPOSITORY_NO_CONFIG,
-  ];
-  if (disabledMessages.includes(err.message)) {
-    logger.info('Repository is disabled - skipping');
-    return err.message;
+  switch (err.message) {
+    case REPOSITORY_CLOSED_ONBOARDING:
+    case REPOSITORY_DISABLED:
+    case REPOSITORY_DISABLED_BY_CONFIG:
+    case REPOSITORY_NO_CONFIG:
+      logger.info('Repository is disabled - skipping');
+      return err.message;
   }
   if (err.message === REPOSITORY_ARCHIVED) {
     logger.info('Repository is archived - skipping');
@@ -159,15 +158,15 @@ export default async function handleError(
     );
     logger.info('External host error causing abort - skipping');
     delete config.branchList;
-    return err.message;
+    return EXTERNAL_HOST_ERROR;
   }
   if (
     err.message.includes('No space left on device') ||
     err.message === SYSTEM_INSUFFICIENT_DISK_SPACE
   ) {
     logger.error('Disk space error - skipping');
     delete config.branchList;
-    return err.message;
+    return SYSTEM_INSUFFICIENT_DISK_SPACE;
   }
   if (err.message === PLATFORM_RATE_LIMIT_EXCEEDED) {
     logger.warn('Rate limit exceeded - aborting');

lib/workers/repository/index.ts

@@ -42,7 +42,7 @@ import { OnboardingState } from './onboarding/common';
 import { ensureOnboardingPr } from './onboarding/pr';
 import { extractDependencies, updateRepo } from './process';
 import type { ExtractResult } from './process/extract-update';
-import type { ProcessResult } from './result';
+import type { ProcessResult, RepositoryResult } from './result';
 import { processResult } from './result';
 
 // istanbul ignore next
@@ -60,7 +60,7 @@ export async function renovateRepository(
       localDir: string;
       errorRes?: string;
     }> => {
-      let errorRes: string | undefined;
+      let errorRes: RepositoryResult | undefined;
       let config = GlobalConfig.set(
         applySecretsAndVariablesToConfig({
           config: repoConfig,

lib/workers/repository/result.ts

@@ -1,27 +1,21 @@
 import type { RenovateConfig } from '../../config/types';
 
+import type {
+  ConfigErrors,
+  EXTERNAL_HOST_ERROR,
+  MANAGER_LOCKFILE_ERROR,
+  PlatformErrors,
+  SystemErrors,
+  TemporaryErrors,
+  UNKNOWN_ERROR,
+} from '../../constants/error-messages';
 import {
   CONFIG_SECRETS_EXPOSED,
   CONFIG_VALIDATION,
   MISSING_API_CREDENTIALS,
-  REPOSITORY_ACCESS_FORBIDDEN,
-  REPOSITORY_ARCHIVED,
-  REPOSITORY_BLOCKED,
-  REPOSITORY_CANNOT_FORK,
-  REPOSITORY_CLOSED_ONBOARDING,
-  REPOSITORY_DISABLED,
-  REPOSITORY_DISABLED_BY_CONFIG,
-  REPOSITORY_EMPTY,
-  REPOSITORY_FORKED,
-  REPOSITORY_FORK_MISSING,
-  REPOSITORY_FORK_MODE_FORKED,
-  REPOSITORY_MIRRORED,
-  REPOSITORY_NOT_FOUND,
-  REPOSITORY_NO_CONFIG,
-  REPOSITORY_NO_PACKAGE_FILES,
-  REPOSITORY_RENAMED,
-  REPOSITORY_UNINITIATED,
+  RepositoryErrors,
 } from '../../constants/error-messages';
+
 import { logger } from '../../logger';
 
 export type ProcessStatus =
@@ -32,35 +26,34 @@ export type ProcessStatus =
   | 'unknown';
 
 export interface ProcessResult {
-  res: string;
+  res: RepositoryResult;
   status: ProcessStatus;
   enabled: boolean | undefined;
   onboarded: boolean | undefined;
 }
 
+/** a strong type for any repository result status that Renovate may report */
+export type RepositoryResult =
+  /** repository was processed successfully */
+  | 'done'
+  /** Renovate performed branch-based automerge on one branch during its run */
+  | 'automerged'
+  // common set of errors
+  | (typeof SystemErrors)[number]
+  | (typeof RepositoryErrors)[number]
+  | (typeof TemporaryErrors)[number]
+  | (typeof ConfigErrors)[number]
+  | (typeof PlatformErrors)[number]
+  // other errors
+  | typeof EXTERNAL_HOST_ERROR
+  | typeof MISSING_API_CREDENTIALS
+  | typeof MANAGER_LOCKFILE_ERROR
+  | typeof UNKNOWN_ERROR;
+
 export function processResult(
   config: RenovateConfig,
-  res: string,
+  res: RepositoryResult,
 ): ProcessResult {
-  const disabledStatuses = [
-    REPOSITORY_ACCESS_FORBIDDEN,
-    REPOSITORY_ARCHIVED,
-    REPOSITORY_BLOCKED,
-    REPOSITORY_CANNOT_FORK,
-    REPOSITORY_CLOSED_ONBOARDING,
-    REPOSITORY_DISABLED,
-    REPOSITORY_DISABLED_BY_CONFIG,
-    REPOSITORY_EMPTY,
-    REPOSITORY_FORK_MISSING,
-    REPOSITORY_FORK_MODE_FORKED,
-    REPOSITORY_FORKED,
-    REPOSITORY_MIRRORED,
-    REPOSITORY_NOT_FOUND,
-    REPOSITORY_NO_CONFIG,
-    REPOSITORY_NO_PACKAGE_FILES,
-    REPOSITORY_RENAMED,
-    REPOSITORY_UNINITIATED,
-  ];
   const enabledStatuses = [
     CONFIG_SECRETS_EXPOSED,
     CONFIG_VALIDATION,
@@ -70,7 +63,7 @@ export function processResult(
   let enabled: boolean | undefined;
   let onboarded: boolean | undefined;
   // istanbul ignore next
-  if (disabledStatuses.includes(res)) {
+  if (RepositoryErrors.includes(res as (typeof RepositoryErrors)[number])) {
     status = 'disabled';
     enabled = false;
   } else if (config.repoIsActivated) {