Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Search backend does not work when Backstage API requires auth

See original GitHub issue

Expected Behavior

Search backend worker process collates documents successfully

Current Behavior

Search backend worker process fails with the error message below as no Authorization header is sent when fetching catalog entities.

2021-04-01T23:38:59.804Z search info Collating documents for software-catalog via DefaultCatalogCollator type=plugin
2021-04-01T23:38:59.810Z backstage info ::ffff:127.0.0.1 - - [01/Apr/2021:23:38:59 +0000] "GET /api/catalog/entities HTTP/1.1" 401 12 "-" "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)" type=incomingRequest
(node:81127) UnhandledPromiseRejectionWarning: FetchError: invalid json response body at http://localhost:7000/api/catalog/entities reason: Unexpected token U in JSON at position 0
    at /adopter/backstage/node_modules/node-fetch/lib/index.js:272:32
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async DefaultCatalogCollator.execute (/adopter/backstage/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:3268:22)
    at async /adopter/backstage/node_modules/@backstage/plugin-search-backend-node/dist/index.cjs.js:39:23
    at async Promise.all (index 0)
(node:81127) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 16)

Possible Solution

Have Search backend issue its own token to use when calling Backstage APIs (see https://github.com/backstage/backstage/blob/master/plugins/auth-backend/src/providers/google/provider.ts#L164 for a possible example). Add token as a parameter to IndexBuilder and DocumentCollator interface

Steps to Reproduce

Follow instructions in https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/authenticate-api-requests.md on how to require authentication of the backstage api
Start backstage
Look at the logs to see the error message (search backend runs on a timer)