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

remove usages of some backend-common helpers

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2024-12-21 19:54:17 +01:00
parent 46c2f6eda2
commit d9d62ef90c
20 changed files with 77 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/nervous-bottles-occur.md
+11
View File
@@ -0,0 +1,11 @@
---
'@backstage/plugin-catalog-backend-module-gitlab-org': patch
'@backstage/plugin-permission-backend': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-permission-node': patch
'@backstage/plugin-events-backend': patch
'@backstage/plugin-app-backend': patch
'@backstage/plugin-auth-node': patch
---
Remove some internal usages of the backend-common package
plugins/app-backend/src/service/appPlugin.test.ts
-4
View File
@@ -20,7 +20,6 @@ import {
startTestBackend,
} from '@backstage/backend-test-utils';
import { appPlugin } from './appPlugin';
import { createRootLogger } from '@backstage/backend-common';
import { overridePackagePathResolution } from '@backstage/backend-plugin-api/testUtils';
const mockDir = createMockDirectory();
@@ -29,9 +28,6 @@ overridePackagePathResolution({
path: mockDir.path,
});
// Make sure root logger is initialized ahead of FS mock
createRootLogger();
describe('appPlugin', () => {
afterEach(() => {
mockDir.clear();
plugins/app-backend/src/service/router.ts
+4 -3
View File
@@ -14,7 +14,6 @@
* limitations under the License.
*/
import { notFoundHandler } from '@backstage/backend-common';
import {
DatabaseService,
resolvePackagePath,
@@ -22,7 +21,7 @@ import {
} from '@backstage/backend-plugin-api';
import { AppConfig } from '@backstage/config';
import helmet from 'helmet';
import express from 'express';
import express, { Request, Response } from 'express';
import Router from 'express-promise-router';
import fs from 'fs-extra';
import { resolve as resolvePath } from 'path';
@@ -299,7 +298,9 @@ async function createEntryPointRouter({
if (staticFallbackHandler) {
staticRouter.use(staticFallbackHandler);
}
staticRouter.use(notFoundHandler());
staticRouter.use((_req: Request, res: Response) => {
res.status(404).end();
});
router.use('/static', staticRouter);
plugins/auth-node/package.json
+1
View File
@@ -56,6 +56,7 @@
"zod-validation-error": "^3.4.0"
},
"devDependencies": {
"@backstage/backend-defaults": "workspace:^",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"cookie-parser": "^1.4.6",
plugins/auth-node/src/oauth/createOAuthRouteHandlers.test.ts
+7 -2
View File
@@ -22,10 +22,11 @@ import PromiseRouter from 'express-promise-router';
import { AuthProviderRouteHandlers, AuthResolverContext } from '../types';
import { createOAuthRouteHandlers } from './createOAuthRouteHandlers';
import { OAuthAuthenticator } from './types';
import { errorHandler } from '@backstage/backend-common';
import { encodeOAuthState, OAuthState } from './state';
import { PassportProfile } from '../passport';
import { parseWebMessageResponse } from '../flow/__testUtils__/parseWebMessageResponse';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
import { mockServices } from '@backstage/backend-test-utils';
const mockAuthenticator: jest.Mocked<OAuthAuthenticator<unknown, unknown>> = {
initialize: jest.fn(_r => ({ ctx: 'authenticator' })),
@@ -63,13 +64,17 @@ const baseConfig = {
};
function wrapInApp(handlers: AuthProviderRouteHandlers) {
const middleware = MiddlewareFactory.create({
logger: mockServices.logger.mock(),
config: mockServices.rootConfig(),
});
const app = express();
const router = PromiseRouter();
router.use(cookieParser());
app.use('/my-provider', router);
app.use(errorHandler());
app.use(middleware.error());
router.get('/start', handlers.start.bind(handlers));
router.get('/handler/frame', handlers.frameHandler.bind(handlers));
plugins/catalog-backend-module-gitlab-org/package.json
-1
View File
@@ -33,7 +33,6 @@
"test": "backstage-cli package test"
},
"dependencies": {
"@backstage/backend-common": "^0.25.0",
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/plugin-catalog-backend-module-gitlab": "workspace:^",
"@backstage/plugin-catalog-node": "workspace:^",
plugins/catalog-backend-module-gitlab-org/src/catalogModuleGitlabOrgDiscoveryEntityProvider.ts
+1 -2
View File
@@ -14,7 +14,6 @@
* limitations under the License.
*/
import { loggerToWinstonLogger } from '@backstage/backend-common';
import {
coreServices,
createBackendModule,
@@ -44,7 +43,7 @@ export const catalogModuleGitlabOrgDiscoveryEntityProvider =
async init({ config, catalog, logger, scheduler, events }) {
const gitlabOrgDiscoveryEntityProvider =
GitlabOrgDiscoveryEntityProvider.fromConfig(config, {
logger: loggerToWinstonLogger(logger),
logger,
events,
scheduler,
});
plugins/catalog-backend/src/service/createRouter.test.ts
+8
View File
@@ -42,6 +42,12 @@ import { wrapServer } from '@backstage/backend-openapi-utils';
import { Server } from 'http';
import { mockCredentials, mockServices } from '@backstage/backend-test-utils';
import { LocationAnalyzer } from '@backstage/plugin-catalog-node';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
const middleware = MiddlewareFactory.create({
logger: mockServices.logger.mock(),
config: mockServices.rootConfig(),
});
describe('createRouter readonly disabled', () => {
let entitiesCatalog: jest.Mocked<EntitiesCatalog>;
@@ -86,6 +92,7 @@ describe('createRouter readonly disabled', () => {
locationAnalyzer,
permissionsService,
});
router.use(middleware.error());
app = await wrapServer(express().use(router));
});
@@ -965,6 +972,7 @@ describe('createRouter readonly and raw json enabled', () => {
httpAuth: mockServices.httpAuth(),
permissionsService,
});
router.use(middleware.error());
app = express().use(router);
});
plugins/catalog-backend/src/service/createRouter.ts
-2
View File
@@ -14,7 +14,6 @@
* limitations under the License.
*/
import { errorHandler } from '@backstage/backend-common';
import {
ANNOTATION_LOCATION,
ANNOTATION_ORIGIN_LOCATION,
@@ -446,6 +445,5 @@ export async function createRouter(
});
}
router.use(errorHandler());
return router;
}
plugins/events-backend/src/service/http/HttpPostIngressEventPublisher.test.ts
+12 -3
View File
@@ -21,6 +21,12 @@ import Router from 'express-promise-router';
import request from 'supertest';
import { HttpPostIngressEventPublisher } from './HttpPostIngressEventPublisher';
import { mockServices } from '@backstage/backend-test-utils';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
const middleware = MiddlewareFactory.create({
logger: mockServices.logger.mock(),
config: mockServices.rootConfig(),
});
describe('HttpPostIngressEventPublisher', () => {
const logger = mockServices.logger.mock();
@@ -110,6 +116,7 @@ describe('HttpPostIngressEventPublisher', () => {
logger,
});
publisher.bind(router);
router.use(middleware.error());
const response = await request(app)
.post('/http/testA')
@@ -124,7 +131,7 @@ describe('HttpPostIngressEventPublisher', () => {
'Failed to retrieve raw body from incoming event for topic testA; not a buffer: object',
name: 'Error',
},
request: { method: 'POST', url: '/testA' },
request: { method: 'POST', url: '/http/testA' },
response: { statusCode: 500 },
}),
);
@@ -149,6 +156,7 @@ describe('HttpPostIngressEventPublisher', () => {
logger,
});
publisher.bind(router);
router.use(middleware.error());
const response = await request(app)
.post('/http/testA')
@@ -163,7 +171,7 @@ describe('HttpPostIngressEventPublisher', () => {
name: 'UnsupportedCharsetError',
statusCode: 415,
},
request: { method: 'POST', url: '/testA' },
request: { method: 'POST', url: '/http/testA' },
response: { statusCode: 415 },
}),
);
@@ -188,6 +196,7 @@ describe('HttpPostIngressEventPublisher', () => {
logger,
});
publisher.bind(router);
router.use(middleware.error());
const response = await request(app)
.post('/http/testA')
@@ -202,7 +211,7 @@ describe('HttpPostIngressEventPublisher', () => {
name: 'UnsupportedMediaTypeError',
statusCode: 415,
},
request: { method: 'POST', url: '/testA' },
request: { method: 'POST', url: '/http/testA' },
response: { statusCode: 415 },
}),
);
plugins/events-backend/src/service/http/HttpPostIngressEventPublisher.ts
-2
View File
@@ -14,7 +14,6 @@
* limitations under the License.
*/
import { errorHandler } from '@backstage/backend-common';
import { LoggerService } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
import { CustomErrorBase } from '@backstage/errors';
@@ -97,7 +96,6 @@ export class HttpPostIngressEventPublisher {
this.addRouteForTopic(router, topic, ingresses[topic].validator),
);
router.use(errorHandler());
return router;
}
plugins/example-todo-list-backend/src/service/router.ts
-2
View File
@@ -14,7 +14,6 @@
* limitations under the License.
*/
import { errorHandler } from '@backstage/backend-common';
import express from 'express';
import Router from 'express-promise-router';
import { add, getAll, update } from './todos';
@@ -75,7 +74,6 @@ export async function createRouter(
res.json(update(req.body));
});
router.use(errorHandler());
return router;
}
plugins/kubernetes-backend/src/service/KubernetesProxy.test.ts
+8 -3
View File
@@ -16,7 +16,6 @@
import 'buffer';
import { resolve as resolvePath } from 'path';
import { errorHandler } from '@backstage/backend-common';
import {
createMockDirectory,
mockServices,
@@ -53,6 +52,12 @@ import {
import type { Request } from 'express';
import { BackstageCredentials } from '@backstage/backend-plugin-api';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
const middleware = MiddlewareFactory.create({
logger: mockServices.logger.mock(),
config: mockServices.rootConfig(),
});
const mockCertDir = createMockDirectory({
content: {
@@ -117,7 +122,7 @@ describe('KubernetesProxy', () => {
const app = express().use(
Router()
.use(proxyPath, proxy.createRequestHandler({ permissionApi }))
.use(errorHandler()),
.use(middleware.error()),
);
const requestPromise = request(app).get(proxyPath + requestPath);
@@ -924,7 +929,7 @@ describe('KubernetesProxy', () => {
.use(
Router()
.use(proxyPath, proxy.createRequestHandler({ permissionApi }))
.use(errorHandler()),
.use(middleware.error()),
)
.listen(0, '0.0.0.0', () => {
proxyPort = (expressServer.address() as AddressInfo).port;
plugins/permission-backend/package.json
+1
View File
@@ -67,6 +67,7 @@
"zod": "^3.22.4"
},
"devDependencies": {
"@backstage/backend-defaults": "workspace:^",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@types/lodash": "^4.14.151",
plugins/permission-backend/src/service/router.test.ts
+7 -1
View File
@@ -27,6 +27,7 @@ import { createRouter } from './router';
import { ConfigReader } from '@backstage/config';
import { BackstageCredentials } from '@backstage/backend-plugin-api';
import { mockCredentials, mockServices } from '@backstage/backend-test-utils';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
const mockApplyConditions: jest.MockedFunction<
InstanceType<typeof PermissionIntegrationClient>['applyConditions']
@@ -60,6 +61,11 @@ const policy = {
}),
};
const middleware = MiddlewareFactory.create({
logger: mockServices.logger.mock(),
config: mockServices.rootConfig(),
});
describe('createRouter', () => {
let app: express.Express;
@@ -75,7 +81,7 @@ describe('createRouter', () => {
userInfo: mockServices.userInfo(),
policy,
});
router.use(middleware.error());
app = express().use(router);
});
plugins/permission-backend/src/service/router.ts
+1 -6
View File
@@ -17,10 +17,7 @@
import { z } from 'zod';
import express, { Request, Response } from 'express';
import Router from 'express-promise-router';
import {
createLegacyAuthAdapters,
errorHandler,
} from '@backstage/backend-common';
import { createLegacyAuthAdapters } from '@backstage/backend-common';
import { InputError } from '@backstage/errors';
import { IdentityApi } from '@backstage/plugin-auth-node';
import {
@@ -251,7 +248,5 @@ export async function createRouter(
},
);
router.use(errorHandler());
return router;
}
plugins/permission-node/package.json
+1
View File
@@ -69,6 +69,7 @@
"zod-to-json-schema": "^3.20.4"
},
"devDependencies": {
"@backstage/backend-defaults": "workspace:^",
"@backstage/backend-test-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@types/supertest": "^2.0.8",
plugins/permission-node/src/integration/createPermissionIntegrationRouter.test.ts
+12 -3
View File
@@ -29,6 +29,8 @@ import {
PermissionIntegrationRouterOptions,
} from './createPermissionIntegrationRouter';
import { createPermissionRule } from './createPermissionRule';
import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';
import { mockServices } from '@backstage/backend-test-utils';
const testPermission: Permission = createPermission({
name: 'test.permission',
@@ -109,6 +111,11 @@ const mockedOptionResources: PermissionIntegrationRouterOptions = {
],
};
const middleware = MiddlewareFactory.create({
logger: mockServices.logger.mock(),
config: mockServices.rootConfig(),
});
const createApp = (
mockedGetResources:
| typeof defaultMockedGetResources1 = defaultMockedGetResources1,
@@ -122,7 +129,7 @@ const createApp = (
})
: createPermissionIntegrationRouter({ permissions: [testPermission] });
return express().use(router);
return express().use(router.use(middleware.error()));
};
describe('createPermissionIntegrationRouter', () => {
@@ -453,7 +460,9 @@ describe('createPermissionIntegrationRouter', () => {
beforeEach(async () => {
const app = express().use(
createPermissionIntegrationRouter(mockedOptionResources),
createPermissionIntegrationRouter(mockedOptionResources).use(
middleware.error(),
),
);
response = await request(app)
@@ -765,7 +774,7 @@ describe('createPermissionIntegrationRouter', () => {
resourceType: 'test-resource',
permissions: [testPermission],
rules: [testRule1, testRule2],
}),
}).use(middleware.error()),
),
)
.post('/.well-known/backstage/permissions/apply-conditions')
plugins/permission-node/src/integration/createPermissionIntegrationRouter.ts
-4
View File
@@ -19,7 +19,6 @@ import Router from 'express-promise-router';
import { z } from 'zod';
import zodToJsonSchema from 'zod-to-json-schema';
import { InputError } from '@backstage/errors';
import { errorHandler } from '@backstage/backend-common';
import {
AuthorizeResult,
DefinitivePolicyDecision,
@@ -483,9 +482,6 @@ export function createPermissionIntegrationRouter<
},
);
// TODO(belugas): Remove this when dropping support to the legacy backend system because setting the error handler manually is no logger required in the new system.
router.use(errorHandler());
return router;
}
yarn.lock
+3 -1
View File
@@ -5350,6 +5350,7 @@ __metadata:
resolution: "@backstage/plugin-auth-node@workspace:plugins/auth-node"
dependencies:
"@backstage/backend-common": ^0.25.0
"@backstage/backend-defaults": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/catalog-client": "workspace:^"
@@ -5612,7 +5613,6 @@ __metadata:
version: 0.0.0-use.local
resolution: "@backstage/plugin-catalog-backend-module-gitlab-org@workspace:plugins/catalog-backend-module-gitlab-org"
dependencies:
"@backstage/backend-common": ^0.25.0
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/cli": "workspace:^"
@@ -6914,6 +6914,7 @@ __metadata:
resolution: "@backstage/plugin-permission-backend@workspace:plugins/permission-backend"
dependencies:
"@backstage/backend-common": ^0.25.0
"@backstage/backend-defaults": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/cli": "workspace:^"
@@ -6957,6 +6958,7 @@ __metadata:
resolution: "@backstage/plugin-permission-node@workspace:plugins/permission-node"
dependencies:
"@backstage/backend-common": ^0.25.0
"@backstage/backend-defaults": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/backend-test-utils": "workspace:^"
"@backstage/cli": "workspace:^"