[Ingest Manager] Create default Error handler. Use on /setup & EPM routes

[jfsiii]

Summary

• Added defaultIngestErrorHandler
  • error handler which deals with logging & responses in a consistent way. Based on discussions/iterations like [Ingest Manager] Error handling in server APIs #66688 (comment) and elsewhere
• Use it for error handling on these API routes
  • /setup
  • /fleet/setup
  • /epm/* (7 handlers)

This adds an IngestErrorHandler type/function. It has same output as a RequestHandler and its inputs are the 3 RequestHandler inputs + error.

type IngestErrorHandler = (
  params: IngestErrorHandlerParams
) => IKibanaResponse | Promise<IKibanaResponse>;

interface IngestErrorHandlerParams {
  error: IngestManagerError | Boom | Error;
  response: KibanaResponseFactory;
  request?: KibanaRequest;
  context?: RequestHandlerContext;
}

It maps an Error and ResponseFactory to an IKibanaResponse. Now the handlers look roughly like:

async function handler(context, request, response): KibanaResponse {
  try {
    const result = await something();
    return response.ok({ body: result });
  } catch (error) {
    return defaultIngestErrorHandler({ error, response });
  }
}

I've started with defaultIngestErrorHandler and we can add different Error handlers when/if needed.

Checklist

• Unit or functional tests were updated or added to match the most common scenarios

• The tests added in ensure the POST /setup case didn't regress, but I'm not sure what additional tests we want.
• I'll add tests to confirm defaultIngestErrorHandler behaves as advertised

  defaultIngestErrorHandler
    IngestManagerError
      ✓ 502: RegistryError (7ms)
      ✓ 404: PackageNotFoundError (2ms)
      ✓ 400: IngestManagerError (2ms)
    Boom
      ✓ 500: constructor - one arg (2ms)
      ✓ custom: constructor - 2 args (1ms)
      ✓ 400: Boom.badRequest (2ms)
      ✓ 404: Boom.notFound (1ms)
    all other errors
      ✓ 500 (2ms)

[jfsiii]

@elasticmachine merge upstream

[elasticmachine]

merge conflict between base and head

[elasticmachine]

Pinging @elastic/ingest-management (Team:Ingest Management)

[jfsiii]

@elasticmachine merge upstream

[jfsiii]

@elasticmachine merge upstream

[jfsiii]

@elasticmachine merge upstream

[jfsiii]

@elasticmachine merge upstream

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: a24408f

Build metrics

✅ unchanged

History

• 💚 Build #72362 succeeded 0ca52aae5382193f79c07546aa28e234c6b11c01
• 💔 Build #72328 failed 6e39f4913f56656e3924cc9bbde9085dd4809286
• 💚 Build #72285 succeeded d7ad578
• 💚 Build #71763 succeeded 1019605c8491a17b159b3552ea956a5042688e0b
• 💚 Build #70844 succeeded cc595ab6eafd9917e1313466dcf7d70b6a0cde42

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[kibanamachine]

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

[ghost]

Hi @jfsiii

We have gone through the ticket and observed it required DEV_Validation to test the ticket .

Please let us know if anything is missing from our end.