add-error-code

Add an error code

Error codes live in each feature's error.js, are auto-aggregated into the global ERROR_CODES at startup, and pair with an i18n string. Read README "error.js" and "services/error.js". For the full deep reference, see docs/core/errors.md.

Before editing, include the rejection policy, HTTP status, client-visible message, owning action, and tests in the approved feature plan. Confirm complete structure with yarn repair <Feature> --dry-run, then yarn repair <Feature>; do not manually scaffold a missing error.js.

Shape (in app/<Feature>/error.js, inside LOCAL_ERROR_CODES)

// V1Create            ← group by the action that owns it
<FEATURE>_BAD_REQUEST_INVALID_CREDENTIALS: {
  error: '<FEATURE>.BAD_REQUEST_INVALID_CREDENTIALS', // dot after namespace
  status: 400,
  messages: ['<FEATURE>[invalid_credentials]'] // array of i18n keys
}

Naming (three parts: NAMESPACE _ STATUS _ DESCRIPTION)

• JS object key: NAMESPACE_STATUS_DESCRIPTION — all caps, underscores throughout (ORDER_BAD_REQUEST_INVALID_STATUS).
• .error string (sent to client): NAMESPACE.STATUS_DESCRIPTION — a dot after the namespace, underscores elsewhere ('ORDER.BAD_REQUEST_INVALID_STATUS').
• Status phrasing maps to the code: BAD_REQUEST→400, UNAUTHORIZED→401, NOT_FOUND→404, INTERNAL_SERVER_ERROR→500.
• Namespace = feature name ALL_CAPS. Truly global codes omit it and live in services/error.js (BAD_REQUEST_INVALID_ARGUMENTS, UNAUTHORIZED, INTERNAL_SERVER_ERROR, SERVICE_UNAVAILABLE).

messages is an array

One conceptual error can carry multiple phrasings; pick one by index at the call site. Default to a single-entry array; you never need the index until a second phrasing exists.

Wire it up

1. Add the code to app/<Feature>/error.js, grouped under a // V1Action comment.
2. Add the i18n string(s) to app/<Feature>/languages/en.js (and every other locale) as <FEATURE>[snake_case]; run yarn lang (it validates keys — missing ones throw in test/prod). See add-locale.
3. Use it in the action:

   return errorResponse(req, ERROR_CODES.<FEATURE>_BAD_REQUEST_X);              // default message (index 0)
   return errorResponse(req, ERROR_CODES.<FEATURE>_BAD_REQUEST_X, 1);           // alternate message by index
   return errorResponse(req, ERROR_CODES.BAD_REQUEST_INVALID_ARGUMENTS, joiErrorsMessage(error)); // custom string (Joi)
   

   In a transaction, use errorResponseRollback(t, req, ERROR_CODES.X) to roll back first. In tasks/socket actions, throw instead of errorResponse.
4. Add the code to the action's JSDoc Errors: list — and write a test that triggers it and asserts errorResponse(i18n, ERROR_CODES.X). Every documented error code must have a test.
5. Run yarn conventions:check, focused tests, then yarn test; finish with mandatory review-conventions.