paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add error handler middleware in the plugin router

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2024-12-21 15:51:38 +01:00
parent 6b92433d5e
commit ec547b8032
9 changed files with 48 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/cyan-frogs-count.md
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch
'@backstage/plugin-devtools-backend': patch
---
Remove the error handler middleware, since that is now provided by the framework
.changeset/shiny-walls-press.md
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/backend-defaults': minor
---
**BREAKING**: Ensure that an error handler middleware exists at the end of each plugin `httpRouter` handler chain. This makes it so that exceptions thrown by plugin routes are caught and encoded in the standard error format.
If you were using the standard `MiddlewareFactory` just to put an `error` middleware in you router, you can now remove that at your earliest convenience since it's redundant. If you have custom error handlers in your plugin router, those will continue to function as previously. If you were relying on thrown errors propagating all the way down to the root HTTP router, you will find that they no longer do that, and may want to hoist your error handling up to the plugin level instead.
packages/backend-defaults/src/entrypoints/httpRouter/httpRouterServiceFactory.ts
+18 -2
View File
@@ -27,6 +27,7 @@ import {
createCredentialsBarrier,
createAuthIntegrationRouter,
} from './http';
import { MiddlewareFactory } from '../rootHttpRouter';
/**
* HTTP route registration for plugins.
@@ -47,8 +48,17 @@ export const httpRouterServiceFactory = createServiceFactory({
rootHttpRouter: coreServices.rootHttpRouter,
auth: coreServices.auth,
httpAuth: coreServices.httpAuth,
logger: coreServices.logger,
},
async factory({ auth, httpAuth, config, plugin, rootHttpRouter, lifecycle }) {
async factory({
auth,
httpAuth,
config,
plugin,
rootHttpRouter,
lifecycle,
logger,
}) {
const router = PromiseRouter();
rootHttpRouter.use(`/api/${plugin.getId()}`, router);
@@ -63,9 +73,15 @@ export const httpRouterServiceFactory = createServiceFactory({
router.use(credentialsBarrier.middleware);
router.use(createCookieAuthRefreshMiddleware({ auth, httpAuth }));
const pluginRoutes = PromiseRouter();
router.use(pluginRoutes);
const middleware = MiddlewareFactory.create({ config, logger });
router.use(middleware.error());
return {
use(handler: Handler): void {
router.use(handler);
pluginRoutes.use(handler);
},
addAuthPolicy(policy: HttpRouterServiceAuthPolicy): void {
credentialsBarrier.addAuthPolicy(policy);
plugins/catalog-backend-module-incremental-ingestion/src/module/WrapperProviders.ts
-1
View File
@@ -79,7 +79,6 @@ export class WrapperProviders {
return new IncrementalProviderRouter(
new IncrementalIngestionDatabaseManager({ client: this.options.client }),
this.options.logger,
this.options.config,
).createRouter();
}
plugins/catalog-backend-module-incremental-ingestion/src/router/routes.ts
-11
View File
@@ -18,22 +18,17 @@ import express from 'express';
import Router from 'express-promise-router';
import { IncrementalIngestionDatabaseManager } from '../database/IncrementalIngestionDatabaseManager';
import { LoggerService } from '@backstage/backend-plugin-api';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
import { Config } from '@backstage/config';
export class IncrementalProviderRouter {
private manager: IncrementalIngestionDatabaseManager;
private logger: LoggerService;
private config: Config;
constructor(
manager: IncrementalIngestionDatabaseManager,
logger: LoggerService,
config: Config,
) {
this.manager = manager;
this.logger = logger;
this.config = config;
}
createRouter(): express.Router {
@@ -253,12 +248,6 @@ export class IncrementalProviderRouter {
},
);
const middleware = MiddlewareFactory.create({
logger: this.logger,
config: this.config,
});
router.use(middleware.error());
return router;
}
}
plugins/catalog-backend-module-incremental-ingestion/src/service/IncrementalCatalogBuilder.ts
-1
View File
@@ -66,7 +66,6 @@ export class IncrementalCatalogBuilder {
const incrementalAdminRouter = await new IncrementalProviderRouter(
this.manager,
routerLogger,
this.env.config,
).createRouter();
return { incrementalAdminRouter };
plugins/devtools-backend/src/service/router.ts
+1 -5
View File
@@ -13,6 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AuthorizeResult } from '@backstage/plugin-permission-common';
import {
devToolsConfigReadPermission,
@@ -20,7 +21,6 @@ import {
devToolsInfoReadPermission,
devToolsPermissions,
} from '@backstage/plugin-devtools-common';
import { DevToolsBackendApi } from '../api';
import { NotAllowedError } from '@backstage/errors';
import Router from 'express-promise-router';
@@ -33,7 +33,6 @@ import {
PermissionsService,
RootConfigService,
} from '@backstage/backend-plugin-api';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
/**
* @internal
@@ -121,8 +120,5 @@ export async function createRouter(
response.status(200).json(health);
});
const middleware = MiddlewareFactory.create({ logger, config });
router.use(middleware.error());
return router;
}
plugins/kubernetes-backend/src/routes/resourceRoutes.test.ts
+15 -15
View File
@@ -169,7 +169,7 @@ describe('resourcesRoutes', () => {
error: { name: 'InputError', message: 'entity is a required field' },
request: {
method: 'POST',
url: '/api/kubernetes/resources/workloads/query',
url: '/resources/workloads/query',
},
response: { statusCode: 400 },
});
@@ -193,7 +193,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/workloads/query',
url: '/resources/workloads/query',
},
response: { statusCode: 400 },
});
@@ -216,7 +216,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/workloads/query',
url: '/resources/workloads/query',
},
response: { statusCode: 400 },
});
@@ -240,7 +240,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/workloads/query',
url: '/resources/workloads/query',
},
response: { statusCode: 401 },
});
@@ -264,7 +264,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/workloads/query',
url: '/resources/workloads/query',
},
response: { statusCode: 401 },
});
@@ -287,7 +287,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/workloads/query',
url: '/resources/workloads/query',
},
response: { statusCode: 500 },
});
@@ -346,7 +346,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 400 },
});
@@ -370,7 +370,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 400 },
});
@@ -394,7 +394,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 400 },
});
@@ -420,7 +420,7 @@ describe('resourcesRoutes', () => {
error: { name: 'InputError', message: 'entity is a required field' },
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 400 },
});
@@ -451,7 +451,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 400 },
});
@@ -481,7 +481,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 400 },
});
@@ -512,7 +512,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 401 },
});
@@ -543,7 +543,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 401 },
});
@@ -573,7 +573,7 @@ describe('resourcesRoutes', () => {
},
request: {
method: 'POST',
url: '/api/kubernetes/resources/custom/query',
url: '/resources/custom/query',
},
response: { statusCode: 500 },
});
plugins/notifications-backend/dev/index.ts
+1 -7
View File
@@ -26,7 +26,6 @@ import {
} from '@backstage/plugin-notifications-common';
import express, { Response } from 'express';
import Router from 'express-promise-router';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
const randomSeverity = (): NotificationSeverity => {
return notificationSeverities[
@@ -77,12 +76,8 @@ const notificationsDebug = createBackendPlugin({
deps: {
notifications: notificationService,
httpRouter: coreServices.httpRouter,
config: coreServices.rootConfig,
logger: coreServices.logger,
},
async init({ notifications, httpRouter, config, logger }) {
const middleware = MiddlewareFactory.create({ config, logger });
async init({ notifications, httpRouter }) {
const router = Router();
router.use(express.json());
router.post('/', async (_, res: Response<unknown>) => {
@@ -100,7 +95,6 @@ const notificationsDebug = createBackendPlugin({
});
res.status(200).send({ status: 'ok' });
});
router.use(middleware.error());
httpRouter.use(router);
httpRouter.addAuthPolicy({