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

enhancement: 4423 switch sending back data from server to res.json() instead of res.send()

Browse Source 
changeset
This commit is contained in:
NHI TRAN
2021-02-19 14:05:27 -05:00
parent ca559171bf
commit f43192207a
14 changed files with 57 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/kind-pens-deliver.md
+13
View File
@@ -0,0 +1,13 @@
---
'@backstage/backend-common': minor
'@backstage/cli': minor
'@backstage/techdocs-common': minor
'@backstage/plugin-auth-backend': minor
'@backstage/plugin-catalog': minor
'@backstage/plugin-kafka-backend': minor
'@backstage/plugin-kubernetes-backend': minor
'@backstage/plugin-scaffolder-backend': minor
'@backstage/plugin-techdocs-backend': minor
---
remove usage of res.send() for use of res.json() and res.end()
packages/backend-common/src/middleware/errorHandler.test.ts
+2 -2
View File
@@ -39,12 +39,12 @@ describe('errorHandler', () => {
const mockSend = jest.fn();
app.use('/works_with_async_fail', (_, res) => {
res.status(200).send('hello');
res.status(200).json('hello');
// mutate the response object to test the middlware.
// it's hard to catch errors inside middleware from the outside.
// @ts-ignore
res.send = mockSend;
res.json = mockSend;
throw new Error('some message');
});
packages/cli/src/commands/create-github-app/GithubCreateAppServer.ts
+1 -1
View File
@@ -129,7 +129,7 @@ export class GithubCreateAppServer {
body = body.replace('ACTION_URL', this.actionUrl);
res.setHeader('content-type', 'text/html');
res.send(body);
res.json(body);
};
private async listen(app: Express) {
packages/techdocs-common/src/stages/publish/awsS3.ts
+1 -2
View File
@@ -231,8 +231,7 @@ export class AwsS3Publish implements PublisherBase {
)) {
res.setHeader(headerKey, headerValue);
}
res.send(fileContent);
res.json();
})
.catch(err => {
this.logger.warn(err.message);
packages/techdocs-common/src/stages/publish/azureBlobStorage.ts
+2 -2
View File
@@ -228,11 +228,11 @@ export class AzureBlobStoragePublish implements PublisherBase {
)) {
res.setHeader(headerKey, headerValue);
}
res.send(fileContent);
res.json(fileContent);
});
} catch (e) {
this.logger.error(e.message);
res.status(404).send(e.message);
res.status(404).json(e.message);
}
};
}
plugins/auth-backend/src/lib/oauth/OAuthAdapter.test.ts
+13 -7
View File
@@ -172,7 +172,8 @@ describe('OAuthAdapter', () => {
const mockResponse = ({
cookie: jest.fn().mockReturnThis(),
send: jest.fn().mockReturnThis(),
json: jest.fn().mockReturnThis(),
status: jest.fn().mockReturnThis(),
} as unknown) as express.Response;
await oauthProvider.logout(mockRequest, mockResponse);
@@ -200,12 +201,15 @@ describe('OAuthAdapter', () => {
} as unknown) as express.Request;
const mockResponse = ({
send: jest.fn().mockReturnThis(),
json: jest.fn().mockReturnThis(),
status: jest.fn().mockReturnThis(),
} as unknown) as express.Response;
await oauthProvider.refresh(mockRequest, mockResponse);
expect(mockResponse.send).toHaveBeenCalledTimes(1);
expect(mockResponse.send).toHaveBeenCalledWith({
expect(mockResponse.status).toHaveBeenCalledTimes(1);
expect(mockResponse.status).toHaveBeenCalledWith(200);
expect(mockResponse.json).toHaveBeenCalledTimes(1);
expect(mockResponse.json).toHaveBeenCalledWith({
...mockResponseData,
backstageIdentity: {
id: mockResponseData.backstageIdentity.id,
@@ -229,12 +233,14 @@ describe('OAuthAdapter', () => {
} as unknown) as express.Request;
const mockResponse = ({
send: jest.fn().mockReturnThis(),
json: jest.fn().mockReturnThis(),
status: jest.fn().mockReturnThis(),
} as unknown) as express.Response;
await oauthProvider.refresh(mockRequest, mockResponse);
expect(mockResponse.send).toHaveBeenCalledTimes(1);
expect(mockResponse.send).toHaveBeenCalledWith(
expect(mockResponse.status).toHaveBeenCalledWith(406);
expect(mockResponse.json).toHaveBeenCalledTimes(1);
expect(mockResponse.json).toHaveBeenCalledWith(
'Refresh token not supported for provider: test-provider',
);
});
plugins/auth-backend/src/lib/oauth/OAuthAdapter.ts
+8 -6
View File
@@ -155,7 +155,7 @@ export class OAuthAdapter implements AuthProviderRouteHandlers {
// remove refresh token cookie before logout
this.removeRefreshTokenCookie(res);
}
res.send('logout!');
res.status(204).json('logout!');
}
async refresh(req: express.Request, res: express.Response): Promise<void> {
@@ -165,9 +165,11 @@ export class OAuthAdapter implements AuthProviderRouteHandlers {
}
if (!this.handlers.refresh || this.options.disableRefresh) {
res.send(
`Refresh token not supported for provider: ${this.options.providerId}`,
);
res
.status(406)
.json(
`Refresh token not supported for provider: ${this.options.providerId}`,
);
return;
}
@@ -198,9 +200,9 @@ export class OAuthAdapter implements AuthProviderRouteHandlers {
this.setRefreshTokenCookie(res, response.providerInfo.refreshToken);
}
res.send(response);
res.status(200).json(response);
} catch (error) {
res.status(401).send(`${error.message}`);
res.status(401).json(`${error.message}`);
}
}
plugins/auth-backend/src/providers/aws-alb/provider.test.ts
+7 -8
View File
@@ -77,7 +77,6 @@ describe('AwsALBAuthProvider', () => {
getEntityByName: jest.fn(),
};
const mockResponseSend = jest.fn();
const mockRequest = ({
header: jest.fn(() => {
return 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZvbyIsImlzcyI6ImZvbyJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.T2BNS4G-6RoiFnXc8Q8TiwdWzTpNitY8jcsGM3N3-Yo';
@@ -90,7 +89,8 @@ describe('AwsALBAuthProvider', () => {
} as unknown) as express.Request;
const mockResponse = ({
header: () => jest.fn(),
send: mockResponseSend,
json: jest.fn().mockReturnThis(),
status: jest.fn(),
} as unknown) as express.Response;
describe('should transform to type OAuthResponse', () => {
@@ -107,7 +107,7 @@ describe('AwsALBAuthProvider', () => {
await provider.refresh(mockRequest, mockResponse);
expect(mockResponseSend.mock.calls[0][0]).toEqual({
expect(mockResponse.json).toHaveBeenCalledWith({
backstageIdentity: {
id: 'foo',
idToken: '',
@@ -129,7 +129,7 @@ describe('AwsALBAuthProvider', () => {
await provider.refresh(mockRequestWithoutJwt, mockResponse);
expect(mockResponseSend.mock.calls[0][0]).toEqual(401);
expect(mockResponse.status).toHaveBeenCalledWith(401);
});
it('JWT is invalid', async () => {
@@ -145,7 +145,7 @@ describe('AwsALBAuthProvider', () => {
await provider.refresh(mockRequest, mockResponse);
expect(mockResponseSend.mock.calls[0][0]).toEqual(401);
expect(mockResponse.status).toHaveBeenCalledWith(401);
});
it('issuer is invalid', async () => {
@@ -158,8 +158,7 @@ describe('AwsALBAuthProvider', () => {
jwtMock.verify.mockReturnValueOnce({});
await provider.refresh(mockRequest, mockResponse);
expect(mockResponseSend.mock.calls[0][0]).toEqual(401);
expect(mockResponse.status).toHaveBeenCalledWith(401);
});
it('identity resolution callback rejects', async () => {
@@ -173,7 +172,7 @@ describe('AwsALBAuthProvider', () => {
await provider.refresh(mockRequest, mockResponse);
expect(mockResponseSend.mock.calls[0][0]).toEqual(401);
expect(mockResponse.status).toHaveBeenCalledWith(401);
});
});
});
plugins/auth-backend/src/providers/aws-alb/provider.ts
+3 -3
View File
@@ -78,13 +78,13 @@ export class AwsAlbAuthProvider implements AuthProviderRouteHandlers {
payload,
this.catalogClient,
);
res.send(resolvedEntity);
res.json(resolvedEntity);
} catch (e) {
this.logger.error('exception occurred during JWT processing', e);
res.send(401);
res.status(401);
}
} else {
res.send(401);
res.status(401);
}
}
plugins/auth-backend/src/providers/saml/provider.ts
+1 -1
View File
@@ -105,7 +105,7 @@ export class SamlAuthProvider implements AuthProviderRouteHandlers {
}
async logout(_req: express.Request, res: express.Response): Promise<void> {
res.send('noop');
res.json('noop');
}
identifyEnv(): string | undefined {
plugins/kafka-backend/src/service/router.ts
+1 -1
View File
@@ -68,7 +68,7 @@ export const makeRouter = (
}));
}),
);
res.send({ consumerId, offsets: groupWithTopicOffsets.flat() });
res.json({ consumerId, offsets: groupWithTopicOffsets.flat() });
});
return router;
plugins/kubernetes-backend/src/service/router.ts
+1 -1
View File
@@ -80,7 +80,7 @@ export const makeRouter = (
logger,
requestBody,
);
res.send(response);
res.json(response);
} catch (e) {
logger.error(
`action=retrieveObjectsByServiceId service=${serviceId}, error=${e}`,
plugins/scaffolder-backend/src/service/router.ts
+1 -1
View File
@@ -73,7 +73,7 @@ export async function createRouter(
return;
}
res.send({
res.json({
id: job.id,
metadata: {
...job.context,
plugins/techdocs-backend/src/service/router.ts
+3 -4
View File
@@ -63,7 +63,7 @@ export async function createRouter({
entityName,
);
res.send(techdocsMetadata);
res.json(techdocsMetadata);
} catch (err) {
logger.error(
`Unable to get metadata for ${entityName.namespace}/${entityName.name} with error ${err}`,
@@ -89,7 +89,7 @@ export async function createRouter({
).json()) as Entity;
const locationMetadata = getLocationForEntity(entity);
res.send({ ...entity, locationMetadata });
res.json({ ...entity, locationMetadata });
} catch (err) {
logger.info(
`Unable to get metadata for ${kind}/${namespace}/${name} with error ${err}`,
@@ -112,8 +112,7 @@ export async function createRouter({
const catalogRes = await fetch(`${catalogUrl}/entities/by-name/${triple}`);
if (!catalogRes.ok) {
const catalogResText = await catalogRes.text();
res.status(catalogRes.status);
res.send(catalogResText);
res.status(catalogRes.status).json(catalogResText);
return;
}