14049170525

Committed 25 Mar 2025 01:13AM UTC coverage: 72.481% (+0.06%) from 72.421%

Build Type

push

github

Committed by scottheng96

Commit Message

removed ununsed imports and comments

Run Details

2812 of 4713 branches covered (59.66%)

Branch coverage included in aggregate %.

10131 of 13144 relevant lines covered (77.08%)

47.17 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.25

/src/app/modules/core/core.errors.ts

import { setErrorCode } from '../datadog/datadog.utils'

/**
 * Global Error Code Registry
 *
 * - [10xxxx] FormSG Errors
 * - [11xxxx] Auth Errors
 * - [12xxxx] Database Errors
 * - [13xxxx] Payment Errors
 * - [14xxxx] Communication Channel Errors
 * - [15xxxx] Verification Errors
 * - [19xxxx] Other Errors
 * Group in general categories for easy datadog queries
 * Group in sub groups for easy allocation, identification with screaming snake case prefix of the module
 */
export enum ErrorCodes {
  // [10xxxx] FormSG Errors ----------------------------------------------------
  // [100000 - 100099] General Form Errors (/modules/form)
  FORM_PRIVATE_FORM = 100000,
  FORM_NOT_FOUND = 100001,
  FORM_DELETED = 100002,
  FORM_FORBIDDEN_FORM = 100003,
  FORM_TRANSFER_OWNERSHIP = 100004,
  FORM_LOGIC_NOT_FOUND = 100005,
  FORM_AUTH_TYPE_MISMATCH = 100006,
  FORM_AUTH_NO_ESRVC_ID = 100007,
  FORM_RESPONDENT_NOT_WHITELISTED = 100008,
  FORM_RESPONDENT_SINGLE_SUBMISSION_VALIDATION_FAILED = 100009,
  FORM_UNEXPECTED_WHITELIST_SETTING_NOT_FOUND = 100010,
  FORM_INVALID_RESPONSE_MODE = 100011,
  // [100100 - 100199] Admin Form Errors (/modules/form/admin-form)
  ADMIN_FORM_INVALID_FILE_TYPE = 100100,
  ADMIN_FORM_EDIT_FIELD = 100101,
  ADMIN_FORM_FIELD_NOT_FOUND = 100102,
  ADMIN_FORM_INVALID_COLLABORATOR = 100103,
  ADMIN_FORM_PAYMENT_CHANNEL_NOT_FOUND = 100104,
  ADMIN_FORM_GOGOV = 100105,
  ADMIN_FORM_GOGOV_VALIDATION = 100106,
  ADMIN_FORM_GOGOV_ALREADY_EXIST = 100107,
  ADMIN_FORM_GOGOV_REQUEST_LIMIT = 100108,
  ADMIN_FORM_GOGOV_BAD_GATEWAY = 100109,
  ADMIN_FORM_GOGOV_SERVER = 100110,
  ADMIN_FORM_INVALID_APPROVAL_FIELD_TYPE = 100111,
  ADMIN_FORM_MODEL_RESPONSE_INVALID_SYNTAX = 100112,
  ADMIN_FORM_MODEL_RESPONSE_INVALID_SCHEMA_FORMAT = 100113,
  ADMIN_FORM_MODEL_RESPONSE_FAILURE = 100114,
  ADMIN_FORM_MODEL_GET_CLIENT_FAILURE = 100115,
  // [100200 - 100299] Submission Errors (/modules/submission)
  SUBMISSION_CONFLICT = 100200,
  SUBMISSION_NOT_FOUND = 100201,
  SUBMISSION_PENDING_NOT_FOUND = 100202,
  SUBMISSION_INVALID_TYPE = 100203,
  SUBMISSION_INVALID_ENCODING = 100204,
  SUBMISSION_PROCESSING = 100205,
  SUBMISSION_VALIDATE_FIELD = 100206,
  SUBMISSION_VALIDATE_FIELD_V3 = 100702,
  SUBMISSION_SEND_EMAIL_CONFIRMATION = 100207,
  SUBMISSION_WRONG_RESPONSE_MODE = 100208,
  SUBMISSION_ATTACHMENT_TOO_LARGE = 100209,
  SUBMISSION_INVALID_FILE_EXTENSION = 100210,
  SUBMISSION_FAILED = 100211,
  SUBMISSION_INVALID_FIELD_ID = 100212,
  SUBMISSION_ATTACHMENT_SIZE_LIMIT_EXCEEDED = 100213,
  SUBMISSION_FEATURE_DISABLED = 100214,
  SUBMISSION_INVALID_FILE_KEY = 100215,
  SUBMISSION_VIRUS_SCAN_FAILED = 100216,
  SUBMISSION_JSON_PARSE_FAILED = 100217,
  SUBMISSION_DOWNLOAD_CLEAN_FILE_FAILED = 100218,
  SUBMISSION_PARSE_VIRUS_SCANNER_LAMBDA_PAYLOAD = 100219,
  SUBMISSION_MALICIOUS_FILE_DETECTED = 100220,
  SUBMISSION_INVALID_WORKFLOW_TYPE = 100221,
  SUBMISSION_ATTACHMENT_UPLOAD = 100222,
  SUBMISSION_EXPECTED_RESPONSE_NOT_FOUND = 100224,
  SUBMISSION_SAVE_FAILURE = 100225,
  // Email Submission Errors (email mode deprecated soon)
  EMAIL_SUBMISSION_HASH = 100223,
  // [100300 - 100399] Receiver Errors (/modules/submission/receiver)
  RECEIVER_INITIALISE_MULTIPART_RECEIVER = 100301,
  RECEIVER_MULTIPART_CONTENT_LIMIT = 100302,
  RECEIVER_MULTIPART_CONTENT_PARSING = 100303,
  RECEIVER_MULTIPART_ERROR = 100304,
  // [100400 - 100499] Encrypt Submission Errors (/modules/submission/encrypt-submission)
  ENCRYPT_FORMSG_REQ_BODY_EXISTS = 100400,
  ENCRYPT_ENCRYPTED_PAYLOAD_EXISTS = 100401,
  // [100500 - 100599] Feedback Errors (/modules/feedback)
  FEEDBACK_INVALID_SUBMISSION_ID = 100500,
  FEEDBACK_DUPLICATE_SUBMISSION = 100501,
  // [100600 - 100699] Admin Feedback Errors (/modules/admin-feedback)
  ADMIN_FEEDBACK_MISSING = 100600,
  // [100700 - 100799] Workspace Errors (/modules/workspace)
  WORKSPACE_NOT_FOUND = 100700,
  WORKSPACE_FORBIDDEN = 100701,
  // End FormSG Errors ---------------------------------------------------------

  // [11xxxx] Auth Errors ------------------------------------------------------
  // [110000 - 110099] General Auth Errors (/modules/auth)
  AUTH_INVALID_DOMAIN = 110000,
  AUTH_INVALID_OTP = 110001,
  AUTH_INVALID_TOKEN = 110002,
  AUTH_MISSING_TOKEN = 110003,
  AUTH_UNAUTHORIZED = 110004,
  // [110100 - 110199] SPCP Errors (/modules/spcp)
  SPCP_CREATE_REDIRECT_URL = 110100,
  SPCP_VERIFY_JWT = 110101,
  SPCP_MISSING_ATTRIBUTES = 110102,
  SPCP_INVALID_JWT = 110103,
  SPCP_MISSING_JWT = 110104,
  SPCP_INVALID_ID_TOKEN = 110105,
  SPCP_INVALID_STATE = 110106,
  SPCP_CREATE_JWT = 110107,
  SPCP_EXCHANGE_AUTH_TOKEN = 110108,
  // [110200 - 110299] SPCP OIDC Errors (/modules/spcp)
  SPCP_OIDC_CREATE_AUTHORISATION_URL = 110200,
  SPCP_OIDC_CREATE_JWT = 110201,
  SPCP_OIDC_GET_SIGNING_KEY = 110202,
  SPCP_OIDC_GET_DECRYPTION_KEY = 110203,
  SPCP_OIDC_GET_VERIFICATION_KEY = 110204,
  SPCP_OIDC_INVALID_ID_TOKEN = 110205,
  SPCP_OIDC_JWK_SHAPE_INVALID = 110206,
  SPCP_OIDC_MISSING_ID_TOKEN = 110207,
  SPCP_OIDC_INVALID_VERIFICATION_KEY = 110208,
  SPCP_OIDC_EXCHANGE_AUTH_TOKEN = 110209,
  // [110300 - 110399] MyInfo Errors (/modules/myinfo)
  MYINFO_CIRCUIT_BREAKER = 110300,
  MYINFO_FETCH = 110301,
  MYINFO_HASHING = 110302,
  MYINFO_MISSING_HASH = 110303,
  MYINFO_HASH_DID_NOT_MATCH = 110304,
  MYINFO_PARSE_RELAY_STATE = 110305,
  MYINFO_MISSING_LOGIN_COOKIE = 110306,
  MYINFO_INVALID_LOGIN_COOKIE = 110307,
  MYINFO_INVALID_AUTH_CODE_COOKIE = 110308,
  MYINFO_COOKIE_STATE = 110309,
  // [110400 - 110499] Sgid Errors (/modules/sgid)
  SGID_CREATE_REDIRECT_URL = 110400,
  SGID_INVALID_STATE = 110401,
  SGID_FETCH_ACCESS_TOKEN = 110402,
  SGID_FETCH_USER_INFO = 110403,
  SGID_MALFORMED_MYINFO_COOKIE = 110404,
  SGID_VERIFY_JWT = 110405,
  SGID_INVALID_JWT = 110406,
  SGID_MISSING_JWT = 110407,
  // End of Auth Errors --------------------------------------------------------

  // [12xxxx] Database Errors (/modules/core) ----------------------------------
  DATABASE_ERROR = 120000,
  DATABASE_VALIDATION = 120001,
  DATABASE_CONFLICT = 120002,
  DATABASE_PAYLOAD_SIZE = 120003,
  DATABASE_DUPLICATE_KEY = 120004,
  DATABASE_WRITE_CONFLICT = 120005,
  // End of Database Errors ----------------------------------------------------

  // [13xxxx] Payment Errors ---------------------------------------------------
  // [130000 - 130099] General Payment Errors (/modules/payments)
  PAYMENT_INVALID_AMOUNT = 130000,
  PAYMENT_NOT_FOUND = 130001,
  PAYMENT_CONFIRMED_PAYMENT_NOT_FOUND = 130002,
  PAYMENT_ALREADY_CONFIRMED = 130003,
  PAYMENT_ACCOUNT_INFORMATION = 130004,
  PAYMENT_INVALID_PAYMENT_PRODUCTS = 130005,
  PAYMENT_CONFIGURATION = 130006,
  // [130100 - 130199] Stripe Errors (/modules/payments)
  PAYMENT_STRIPE_SUCCESSFUL_CHARGE_NOT_FOUND = 130100,
  PAYMENT_STRIPE_TRANSACTION_FEE_NOT_FOUND = 130101,
  PAYMENT_STRIPE_MALFORMED_CHARGE_OBJECT = 130102,
  PAYMENT_STRIPE_MALFORMED_EVENT_OBJECT = 130103,
  PAYMENT_STRIPE_METADATA_INVALID = 130104,
  PAYMENT_STRIPE_METADATA_VALID_PAYMENT_ID_NOT_FOUND = 130105,
  PAYMENT_STRIPE_METADATA_INCORRECT_ENV = 130106,
  PAYMENT_STRIPE_FETCH_ERROR = 130107,
  PAYMENT_STRIPE_ACCOUNT_ERROR = 130108,
  PAYMENT_STRIPE_COMPUTE_PAYMENT_STATE = 130109,
  // [130200 - 130299] Payment Proof Errors (/modules/payments)
  PAYMENT_PROOF_INVOICE_PDF_GENERATION = 130200,
  PAYMENT_PROOF_UPLOAD_S3 = 130201,
  PAYMENT_PROOF_PRESIGN_S3 = 130202,
  // [130300 - 130399] Billing Errors (/modules/billing)
  BILLING_FORM_HAS_NO_AUTH = 130300,
  // End of Payment Errors -----------------------------------------------------

  // [14xxxx] Communication Channel Errors (SMS, Email, Webhook) ---------------
  // [140000 - 140099] SMS Errors (/services/postman-sms)
  POSTMAN_SMS_SEND = 140000,
  POSTMAN_INVALID_NUMBER = 140001,
  // [140100 - 140199] Mail Errors (/services/mail)
  MAIL_SEND_ERROR = 140100,
  MAIL_GENERATION_ERROR = 140101,
  // [140200 - 140299] Webhook Errors (/modules/webhook)
  WEBHOOK_VALIDATION = 140200,
  WEBHOOK_FAILED_WITH_PRESIGNED_URL_GENERATION = 140201,
  WEBHOOK_FAILED_WITH_UNKNOWN_ERROR = 140202,
  WEBHOOK_FAILED_WITH_AXIOS_ERROR = 140203,
  WEBHOOK_QUEUE_MESSAGE_PARSING_ERROR = 140204,
  WEBHOOK_NO_MORE_RETRIES = 140205,
  WEBHOOK_PUSH_TO_QUEUE = 140206,
  WEBHOOK_RETRIES_NOT_ENABLED = 140207,
  // [140300 - 140399] Bounce Errors (/modules/bounce)
  BOUNCE_INVALID_NOTIFCATION = 140300,
  BOUNCE_SEND_BOUNCE_SMS_NOTIFICATION = 140301,
  BOUNCE_MISSING_EMAIL_HEADERS = 140302,
  BOUNCE_PARSE_NOTIFICATION = 140303,
  // End of Communication Channel Errors ---------------------------------------

  // [15xxxx] Verification Errors ----------------------------------------------
  // [150000 - 150099] General Verification Errors (/modules/verification)
  VERIFICATION_TRANSACTION_NOT_FOUND = 150000,
  VERIFICATION_FIELD_NOT_FOUND_IN_TRANSACTION = 150001,
  VERIFICATION_TRANSACTION_EXPIRED = 150002,
  VERIFICATION_OTP_EXPIRED = 150003,
  VERIFICATION_MISSING_HASH_DATA = 150004,
  VERIFICATION_OTP_RETRY_EXCEEDED = 150005,
  VERIFICATION_WRONG_OTP = 150006,
  VERIFICATION_WAIT_FOR_OTP = 150007,
  VERIFICATION_OTP_REQUEST_COUNT_EXCEEDED = 150008,
  VERIFICATION_NON_VERIFIED_FIELD_TYPE = 150009,
  VERIFICATION_SMS_LIMIT_EXCEEDED = 150010,
  VERIFICATION_OTP_REQUEST_ERROR = 150011,
  // [150100 - 150199] Captcha Errors (/services/captcha)
  CAPTCHA_CONNECTION = 150100,
  CAPTCHA_VERIFY = 150101,
  CAPTCHA_MISSING = 150102,
  // [150200 - 150299] Turnstile Errors (/services/turnstile)
  TURNSTILE_CONNECTION = 150200,
  TURNSTILE_RESPONSE_ERROR = 150201,
  TURNSTILE_MISSING = 150202,
  // End of Verification Errors ------------------------------------------------

  // [19xxxx] Other Errors -----------------------------------------------------
  // [190000 - 190099] Core Errors (/modules/core)
  MALFORMED_PARAMETERS = 190000,
  EMPTY_ERROR_FIELD = 190001,
  SECRETS_MANAGER = 190002,
  SECRETS_MANAGER_NOT_FOUND = 190003,
  SECRETS_MANAGER_CONFLICT = 190004,
  TWILIO_CACHE = 190005,
  // [190100 - 190199] User Errors (/modules/user)
  USER_INVALID_OTP = 190100,
  USER_MISSING = 190101,
  // [190200 - 190299] Verified Content Errors (/modules/verified-content)
  VERIFIED_CONTENT_MALFORMED = 190200,
  VERIFIED_CONTENT_ENCRYPT_FAILURE = 190201,
  // End of Other Errors -------------------------------------------------------
}

/**
 * A custom base error class that encapsulates the name, message, status code,
 * and logging meta string (if any) for the error.
 */
export class ApplicationError extends Error {
  /**
   * Meta object to be logged by the application logger, if any.
   */
  meta?: unknown
  // FormSG Business Logic errors, not to be confused with HTTP Status Codes
  code?: number

  constructor(message?: string, meta?: unknown, errorCode?: number) {
    super()

    this.name = this.constructor.name
    this.message = message || 'Something went wrong. Please try again.'
    Error.captureStackTrace(this, this.constructor)

    this.meta = meta
    this.code = errorCode

    if (this.code) {
      setErrorCode(this)
    }
  }
}

export class DatabaseError extends ApplicationError {
  constructor(message?: string) {
    super(message, undefined, ErrorCodes.DATABASE_ERROR)
  }
}

export class DatabaseValidationError extends ApplicationError {
  constructor(message: string) {
    super(message, undefined, ErrorCodes.DATABASE_VALIDATION)
  }
}

export class DatabaseConflictError extends ApplicationError {
  constructor(message: string) {
    super(message, undefined, ErrorCodes.DATABASE_CONFLICT)
  }
}

export class DatabasePayloadSizeError extends ApplicationError {
  constructor(message: string) {
    super(message, undefined, ErrorCodes.DATABASE_PAYLOAD_SIZE)
  }
}

export class DatabaseDuplicateKeyError extends ApplicationError {
  constructor(message: string) {
    super(message, undefined, ErrorCodes.DATABASE_DUPLICATE_KEY)
  }
}

export class DatabaseWriteConflictError extends ApplicationError {
  constructor(message: string) {
    super(message, undefined, ErrorCodes.DATABASE_WRITE_CONFLICT)
  }
}

export class SecretsManagerError extends ApplicationError {
  constructor(message?: string) {
    super(message, undefined, ErrorCodes.SECRETS_MANAGER)
  }
}

export class SecretsManagerNotFoundError extends ApplicationError {
  constructor(message: string) {
    super(message, undefined, ErrorCodes.SECRETS_MANAGER_NOT_FOUND)
  }
}

export class SecretsManagerConflictError extends ApplicationError {
  constructor(message: string) {
    super(message, undefined, ErrorCodes.SECRETS_MANAGER_CONFLICT)
  }
}

/**
 * Union of all possible database errors
 */
export type PossibleDatabaseError =
  | DatabaseError
  | DatabaseValidationError
  | DatabaseConflictError
  | DatabasePayloadSizeError
  | DatabaseDuplicateKeyError
  | DatabaseWriteConflictError

export class MalformedParametersError extends ApplicationError {
  constructor(message: string, meta?: unknown) {
    super(message, meta, ErrorCodes.MALFORMED_PARAMETERS)
  }
}

/**
 * A custom error class returned when a method explicitly returns a list of errors
 * but the list itself is empty.
 */
export class EmptyErrorFieldError extends ApplicationError {
  constructor(message = 'Errors were returned but list is empty.') {
    super(message, undefined, ErrorCodes.EMPTY_ERROR_FIELD)
  }
}

1	import { setErrorCode } from '../datadog/datadog.utils'	242✔
2
3	/**
4	* Global Error Code Registry
5	*
6	* - [10xxxx] FormSG Errors
7	* - [11xxxx] Auth Errors
8	* - [12xxxx] Database Errors
9	* - [13xxxx] Payment Errors
10	* - [14xxxx] Communication Channel Errors
11	* - [15xxxx] Verification Errors
12	* - [19xxxx] Other Errors
13	* Group in general categories for easy datadog queries
14	* Group in sub groups for easy allocation, identification with screaming snake case prefix of the module
15	*/
16	export enum ErrorCodes {	242✔
17	// [10xxxx] FormSG Errors ----------------------------------------------------
18	// [100000 - 100099] General Form Errors (/modules/form)
19	FORM_PRIVATE_FORM = 100000,	242✔
20	FORM_NOT_FOUND = 100001,	242✔
21	FORM_DELETED = 100002,	242✔
22	FORM_FORBIDDEN_FORM = 100003,	242✔
23	FORM_TRANSFER_OWNERSHIP = 100004,	242✔
24	FORM_LOGIC_NOT_FOUND = 100005,	242✔
25	FORM_AUTH_TYPE_MISMATCH = 100006,	242✔
26	FORM_AUTH_NO_ESRVC_ID = 100007,	242✔
27	FORM_RESPONDENT_NOT_WHITELISTED = 100008,	242✔
28	FORM_RESPONDENT_SINGLE_SUBMISSION_VALIDATION_FAILED = 100009,	242✔
29	FORM_UNEXPECTED_WHITELIST_SETTING_NOT_FOUND = 100010,	242✔
30	FORM_INVALID_RESPONSE_MODE = 100011,	242✔
31	// [100100 - 100199] Admin Form Errors (/modules/form/admin-form)
32	ADMIN_FORM_INVALID_FILE_TYPE = 100100,	242✔
33	ADMIN_FORM_EDIT_FIELD = 100101,	242✔
34	ADMIN_FORM_FIELD_NOT_FOUND = 100102,	242✔
35	ADMIN_FORM_INVALID_COLLABORATOR = 100103,	242✔
36	ADMIN_FORM_PAYMENT_CHANNEL_NOT_FOUND = 100104,	242✔
37	ADMIN_FORM_GOGOV = 100105,	242✔
38	ADMIN_FORM_GOGOV_VALIDATION = 100106,	242✔
39	ADMIN_FORM_GOGOV_ALREADY_EXIST = 100107,	242✔
40	ADMIN_FORM_GOGOV_REQUEST_LIMIT = 100108,	242✔
41	ADMIN_FORM_GOGOV_BAD_GATEWAY = 100109,	242✔
42	ADMIN_FORM_GOGOV_SERVER = 100110,	242✔
43	ADMIN_FORM_INVALID_APPROVAL_FIELD_TYPE = 100111,	242✔
44	ADMIN_FORM_MODEL_RESPONSE_INVALID_SYNTAX = 100112,	242✔
45	ADMIN_FORM_MODEL_RESPONSE_INVALID_SCHEMA_FORMAT = 100113,	242✔
46	ADMIN_FORM_MODEL_RESPONSE_FAILURE = 100114,	242✔
47	ADMIN_FORM_MODEL_GET_CLIENT_FAILURE = 100115,	242✔
48	// [100200 - 100299] Submission Errors (/modules/submission)
49	SUBMISSION_CONFLICT = 100200,	242✔
50	SUBMISSION_NOT_FOUND = 100201,	242✔
51	SUBMISSION_PENDING_NOT_FOUND = 100202,	242✔
52	SUBMISSION_INVALID_TYPE = 100203,	242✔
53	SUBMISSION_INVALID_ENCODING = 100204,	242✔
54	SUBMISSION_PROCESSING = 100205,	242✔
55	SUBMISSION_VALIDATE_FIELD = 100206,	242✔
56	SUBMISSION_VALIDATE_FIELD_V3 = 100702,	242✔
57	SUBMISSION_SEND_EMAIL_CONFIRMATION = 100207,	242✔
58	SUBMISSION_WRONG_RESPONSE_MODE = 100208,	242✔
59	SUBMISSION_ATTACHMENT_TOO_LARGE = 100209,	242✔
60	SUBMISSION_INVALID_FILE_EXTENSION = 100210,	242✔
61	SUBMISSION_FAILED = 100211,	242✔
62	SUBMISSION_INVALID_FIELD_ID = 100212,	242✔
63	SUBMISSION_ATTACHMENT_SIZE_LIMIT_EXCEEDED = 100213,	242✔
64	SUBMISSION_FEATURE_DISABLED = 100214,	242✔
65	SUBMISSION_INVALID_FILE_KEY = 100215,	242✔
66	SUBMISSION_VIRUS_SCAN_FAILED = 100216,	242✔
67	SUBMISSION_JSON_PARSE_FAILED = 100217,	242✔
68	SUBMISSION_DOWNLOAD_CLEAN_FILE_FAILED = 100218,	242✔
69	SUBMISSION_PARSE_VIRUS_SCANNER_LAMBDA_PAYLOAD = 100219,	242✔
70	SUBMISSION_MALICIOUS_FILE_DETECTED = 100220,	242✔
71	SUBMISSION_INVALID_WORKFLOW_TYPE = 100221,	242✔
72	SUBMISSION_ATTACHMENT_UPLOAD = 100222,	242✔
73	SUBMISSION_EXPECTED_RESPONSE_NOT_FOUND = 100224,	242✔
74	SUBMISSION_SAVE_FAILURE = 100225,	242✔
75	// Email Submission Errors (email mode deprecated soon)
76	EMAIL_SUBMISSION_HASH = 100223,	242✔
77	// [100300 - 100399] Receiver Errors (/modules/submission/receiver)
78	RECEIVER_INITIALISE_MULTIPART_RECEIVER = 100301,	242✔
79	RECEIVER_MULTIPART_CONTENT_LIMIT = 100302,	242✔
80	RECEIVER_MULTIPART_CONTENT_PARSING = 100303,	242✔
81	RECEIVER_MULTIPART_ERROR = 100304,	242✔
82	// [100400 - 100499] Encrypt Submission Errors (/modules/submission/encrypt-submission)
83	ENCRYPT_FORMSG_REQ_BODY_EXISTS = 100400,	242✔
84	ENCRYPT_ENCRYPTED_PAYLOAD_EXISTS = 100401,	242✔
85	// [100500 - 100599] Feedback Errors (/modules/feedback)
86	FEEDBACK_INVALID_SUBMISSION_ID = 100500,	242✔
87	FEEDBACK_DUPLICATE_SUBMISSION = 100501,	242✔
88	// [100600 - 100699] Admin Feedback Errors (/modules/admin-feedback)
89	ADMIN_FEEDBACK_MISSING = 100600,	242✔
90	// [100700 - 100799] Workspace Errors (/modules/workspace)
91	WORKSPACE_NOT_FOUND = 100700,	242✔
92	WORKSPACE_FORBIDDEN = 100701,	242✔
93	// End FormSG Errors ---------------------------------------------------------
94
95	// [11xxxx] Auth Errors ------------------------------------------------------
96	// [110000 - 110099] General Auth Errors (/modules/auth)
97	AUTH_INVALID_DOMAIN = 110000,	242✔
98	AUTH_INVALID_OTP = 110001,	242✔
99	AUTH_INVALID_TOKEN = 110002,	242✔
100	AUTH_MISSING_TOKEN = 110003,	242✔
101	AUTH_UNAUTHORIZED = 110004,	242✔
102	// [110100 - 110199] SPCP Errors (/modules/spcp)
103	SPCP_CREATE_REDIRECT_URL = 110100,	242✔
104	SPCP_VERIFY_JWT = 110101,	242✔
105	SPCP_MISSING_ATTRIBUTES = 110102,	242✔
106	SPCP_INVALID_JWT = 110103,	242✔
107	SPCP_MISSING_JWT = 110104,	242✔
108	SPCP_INVALID_ID_TOKEN = 110105,	242✔
109	SPCP_INVALID_STATE = 110106,	242✔
110	SPCP_CREATE_JWT = 110107,	242✔
111	SPCP_EXCHANGE_AUTH_TOKEN = 110108,	242✔
112	// [110200 - 110299] SPCP OIDC Errors (/modules/spcp)
113	SPCP_OIDC_CREATE_AUTHORISATION_URL = 110200,	242✔
114	SPCP_OIDC_CREATE_JWT = 110201,	242✔
115	SPCP_OIDC_GET_SIGNING_KEY = 110202,	242✔
116	SPCP_OIDC_GET_DECRYPTION_KEY = 110203,	242✔
117	SPCP_OIDC_GET_VERIFICATION_KEY = 110204,	242✔
118	SPCP_OIDC_INVALID_ID_TOKEN = 110205,	242✔
119	SPCP_OIDC_JWK_SHAPE_INVALID = 110206,	242✔
120	SPCP_OIDC_MISSING_ID_TOKEN = 110207,	242✔
121	SPCP_OIDC_INVALID_VERIFICATION_KEY = 110208,	242✔
122	SPCP_OIDC_EXCHANGE_AUTH_TOKEN = 110209,	242✔
123	// [110300 - 110399] MyInfo Errors (/modules/myinfo)
124	MYINFO_CIRCUIT_BREAKER = 110300,	242✔
125	MYINFO_FETCH = 110301,	242✔
126	MYINFO_HASHING = 110302,	242✔
127	MYINFO_MISSING_HASH = 110303,	242✔
128	MYINFO_HASH_DID_NOT_MATCH = 110304,	242✔
129	MYINFO_PARSE_RELAY_STATE = 110305,	242✔
130	MYINFO_MISSING_LOGIN_COOKIE = 110306,	242✔
131	MYINFO_INVALID_LOGIN_COOKIE = 110307,	242✔
132	MYINFO_INVALID_AUTH_CODE_COOKIE = 110308,	242✔
133	MYINFO_COOKIE_STATE = 110309,	242✔
134	// [110400 - 110499] Sgid Errors (/modules/sgid)
135	SGID_CREATE_REDIRECT_URL = 110400,	242✔
136	SGID_INVALID_STATE = 110401,	242✔
137	SGID_FETCH_ACCESS_TOKEN = 110402,	242✔
138	SGID_FETCH_USER_INFO = 110403,	242✔
139	SGID_MALFORMED_MYINFO_COOKIE = 110404,	242✔
140	SGID_VERIFY_JWT = 110405,	242✔
141	SGID_INVALID_JWT = 110406,	242✔
142	SGID_MISSING_JWT = 110407,	242✔
143	// End of Auth Errors --------------------------------------------------------
144
145	// [12xxxx] Database Errors (/modules/core) ----------------------------------
146	DATABASE_ERROR = 120000,	242✔
147	DATABASE_VALIDATION = 120001,	242✔
148	DATABASE_CONFLICT = 120002,	242✔
149	DATABASE_PAYLOAD_SIZE = 120003,	242✔
150	DATABASE_DUPLICATE_KEY = 120004,	242✔
151	DATABASE_WRITE_CONFLICT = 120005,	242✔
152	// End of Database Errors ----------------------------------------------------
153
154	// [13xxxx] Payment Errors ---------------------------------------------------
155	// [130000 - 130099] General Payment Errors (/modules/payments)
156	PAYMENT_INVALID_AMOUNT = 130000,	242✔
157	PAYMENT_NOT_FOUND = 130001,	242✔
158	PAYMENT_CONFIRMED_PAYMENT_NOT_FOUND = 130002,	242✔
159	PAYMENT_ALREADY_CONFIRMED = 130003,	242✔
160	PAYMENT_ACCOUNT_INFORMATION = 130004,	242✔
161	PAYMENT_INVALID_PAYMENT_PRODUCTS = 130005,	242✔
162	PAYMENT_CONFIGURATION = 130006,	242✔
163	// [130100 - 130199] Stripe Errors (/modules/payments)
164	PAYMENT_STRIPE_SUCCESSFUL_CHARGE_NOT_FOUND = 130100,	242✔
165	PAYMENT_STRIPE_TRANSACTION_FEE_NOT_FOUND = 130101,	242✔
166	PAYMENT_STRIPE_MALFORMED_CHARGE_OBJECT = 130102,	242✔
167	PAYMENT_STRIPE_MALFORMED_EVENT_OBJECT = 130103,	242✔
168	PAYMENT_STRIPE_METADATA_INVALID = 130104,	242✔
169	PAYMENT_STRIPE_METADATA_VALID_PAYMENT_ID_NOT_FOUND = 130105,	242✔
170	PAYMENT_STRIPE_METADATA_INCORRECT_ENV = 130106,	242✔
171	PAYMENT_STRIPE_FETCH_ERROR = 130107,	242✔
172	PAYMENT_STRIPE_ACCOUNT_ERROR = 130108,	242✔
173	PAYMENT_STRIPE_COMPUTE_PAYMENT_STATE = 130109,	242✔
174	// [130200 - 130299] Payment Proof Errors (/modules/payments)
175	PAYMENT_PROOF_INVOICE_PDF_GENERATION = 130200,	242✔
176	PAYMENT_PROOF_UPLOAD_S3 = 130201,	242✔
177	PAYMENT_PROOF_PRESIGN_S3 = 130202,	242✔
178	// [130300 - 130399] Billing Errors (/modules/billing)
179	BILLING_FORM_HAS_NO_AUTH = 130300,	242✔
180	// End of Payment Errors -----------------------------------------------------
181
182	// [14xxxx] Communication Channel Errors (SMS, Email, Webhook) ---------------
183	// [140000 - 140099] SMS Errors (/services/postman-sms)
184	POSTMAN_SMS_SEND = 140000,	242✔
185	POSTMAN_INVALID_NUMBER = 140001,	242✔
186	// [140100 - 140199] Mail Errors (/services/mail)
187	MAIL_SEND_ERROR = 140100,	242✔
188	MAIL_GENERATION_ERROR = 140101,	242✔
189	// [140200 - 140299] Webhook Errors (/modules/webhook)
190	WEBHOOK_VALIDATION = 140200,	242✔
191	WEBHOOK_FAILED_WITH_PRESIGNED_URL_GENERATION = 140201,	242✔
192	WEBHOOK_FAILED_WITH_UNKNOWN_ERROR = 140202,	242✔
193	WEBHOOK_FAILED_WITH_AXIOS_ERROR = 140203,	242✔
194	WEBHOOK_QUEUE_MESSAGE_PARSING_ERROR = 140204,	242✔
195	WEBHOOK_NO_MORE_RETRIES = 140205,	242✔
196	WEBHOOK_PUSH_TO_QUEUE = 140206,	242✔
197	WEBHOOK_RETRIES_NOT_ENABLED = 140207,	242✔
198	// [140300 - 140399] Bounce Errors (/modules/bounce)
199	BOUNCE_INVALID_NOTIFCATION = 140300,	242✔
200	BOUNCE_SEND_BOUNCE_SMS_NOTIFICATION = 140301,	242✔
201	BOUNCE_MISSING_EMAIL_HEADERS = 140302,	242✔
202	BOUNCE_PARSE_NOTIFICATION = 140303,	242✔
203	// End of Communication Channel Errors ---------------------------------------
204
205	// [15xxxx] Verification Errors ----------------------------------------------
206	// [150000 - 150099] General Verification Errors (/modules/verification)
207	VERIFICATION_TRANSACTION_NOT_FOUND = 150000,	242✔
208	VERIFICATION_FIELD_NOT_FOUND_IN_TRANSACTION = 150001,	242✔
209	VERIFICATION_TRANSACTION_EXPIRED = 150002,	242✔
210	VERIFICATION_OTP_EXPIRED = 150003,	242✔
211	VERIFICATION_MISSING_HASH_DATA = 150004,	242✔
212	VERIFICATION_OTP_RETRY_EXCEEDED = 150005,	242✔
213	VERIFICATION_WRONG_OTP = 150006,	242✔
214	VERIFICATION_WAIT_FOR_OTP = 150007,	242✔
215	VERIFICATION_OTP_REQUEST_COUNT_EXCEEDED = 150008,	242✔
216	VERIFICATION_NON_VERIFIED_FIELD_TYPE = 150009,	242✔
217	VERIFICATION_SMS_LIMIT_EXCEEDED = 150010,	242✔
218	VERIFICATION_OTP_REQUEST_ERROR = 150011,	242✔
219	// [150100 - 150199] Captcha Errors (/services/captcha)
220	CAPTCHA_CONNECTION = 150100,	242✔
221	CAPTCHA_VERIFY = 150101,	242✔
222	CAPTCHA_MISSING = 150102,	242✔
223	// [150200 - 150299] Turnstile Errors (/services/turnstile)
224	TURNSTILE_CONNECTION = 150200,	242✔
225	TURNSTILE_RESPONSE_ERROR = 150201,	242✔
226	TURNSTILE_MISSING = 150202,	242✔
227	// End of Verification Errors ------------------------------------------------
228
229	// [19xxxx] Other Errors -----------------------------------------------------
230	// [190000 - 190099] Core Errors (/modules/core)
231	MALFORMED_PARAMETERS = 190000,	242✔
232	EMPTY_ERROR_FIELD = 190001,	242✔
233	SECRETS_MANAGER = 190002,	242✔
234	SECRETS_MANAGER_NOT_FOUND = 190003,	242✔
235	SECRETS_MANAGER_CONFLICT = 190004,	242✔
236	TWILIO_CACHE = 190005,	242✔
237	// [190100 - 190199] User Errors (/modules/user)
238	USER_INVALID_OTP = 190100,	242✔
239	USER_MISSING = 190101,	242✔
240	// [190200 - 190299] Verified Content Errors (/modules/verified-content)
241	VERIFIED_CONTENT_MALFORMED = 190200,	242✔
242	VERIFIED_CONTENT_ENCRYPT_FAILURE = 190201,	242✔
243	// End of Other Errors -------------------------------------------------------
244	}
245
246	/**
247	* A custom base error class that encapsulates the name, message, status code,
248	* and logging meta string (if any) for the error.
249	*/
250	export class ApplicationError extends Error {	242✔
251	/**
252	* Meta object to be logged by the application logger, if any.
253	*/
254	meta?: unknown
255	// FormSG Business Logic errors, not to be confused with HTTP Status Codes
256	code?: number
257
258	constructor(message?: string, meta?: unknown, errorCode?: number) {
259	super()	2,059✔
260
261	this.name = this.constructor.name	2,059✔
262	this.message = message \|\| 'Something went wrong. Please try again.'	2,059✔
263	Error.captureStackTrace(this, this.constructor)	2,059✔
264
265	this.meta = meta	2,059✔
266	this.code = errorCode	2,059✔
267
268	if (this.code) {	2,059✔
269	setErrorCode(this)	2,010✔
270	}
271	}
272	}
273
274	export class DatabaseError extends ApplicationError {	242✔
275	constructor(message?: string) {
276	super(message, undefined, ErrorCodes.DATABASE_ERROR)	243✔
277	}
278	}
279
280	export class DatabaseValidationError extends ApplicationError {	242✔
281	constructor(message: string) {
282	super(message, undefined, ErrorCodes.DATABASE_VALIDATION)	18✔
283	}
284	}
285
286	export class DatabaseConflictError extends ApplicationError {	242✔
287	constructor(message: string) {
288	super(message, undefined, ErrorCodes.DATABASE_CONFLICT)	9✔
289	}
290	}
291
292	export class DatabasePayloadSizeError extends ApplicationError {	242✔
293	constructor(message: string) {
294	super(message, undefined, ErrorCodes.DATABASE_PAYLOAD_SIZE)	11✔
295	}
296	}
297
298	export class DatabaseDuplicateKeyError extends ApplicationError {	242✔
299	constructor(message: string) {
300	super(message, undefined, ErrorCodes.DATABASE_DUPLICATE_KEY)	1✔
301	}
302	}
303
304	export class DatabaseWriteConflictError extends ApplicationError {	242✔
305	constructor(message: string) {
306	super(message, undefined, ErrorCodes.DATABASE_WRITE_CONFLICT)	×
307	}
308	}
309
310	export class SecretsManagerError extends ApplicationError {	242✔
311	constructor(message?: string) {
312	super(message, undefined, ErrorCodes.SECRETS_MANAGER)	×
313	}
314	}
315
316	export class SecretsManagerNotFoundError extends ApplicationError {	242✔
317	constructor(message: string) {
318	super(message, undefined, ErrorCodes.SECRETS_MANAGER_NOT_FOUND)	×
319	}
320	}
321
322	export class SecretsManagerConflictError extends ApplicationError {	242✔
323	constructor(message: string) {
324	super(message, undefined, ErrorCodes.SECRETS_MANAGER_CONFLICT)	×
325	}
326	}
327
328	/**
329	* Union of all possible database errors
330	*/
331	export type PossibleDatabaseError =
332	\| DatabaseError
333	\| DatabaseValidationError
334	\| DatabaseConflictError
335	\| DatabasePayloadSizeError
336	\| DatabaseDuplicateKeyError
337	\| DatabaseWriteConflictError
338
339	export class MalformedParametersError extends ApplicationError {	242✔
340	constructor(message: string, meta?: unknown) {
341	super(message, meta, ErrorCodes.MALFORMED_PARAMETERS)	16✔
342	}
343	}
344
345	/**
346	* A custom error class returned when a method explicitly returns a list of errors
347	* but the list itself is empty.
348	*/
349	export class EmptyErrorFieldError extends ApplicationError {	242✔
350	constructor(message = 'Errors were returned but list is empty.') {	×
351	super(message, undefined, ErrorCodes.EMPTY_ERROR_FIELD)	×
352	}
353	}

opengovsg / FormSG / 14049170525

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous