From 471b9243dead0d1fa0fe027137307096f30d2e91 Mon Sep 17 00:00:00 2001 From: Dominik Henneke Date: Thu, 28 Oct 2021 15:46:16 +0200 Subject: [PATCH] Rename endpoint to /events Signed-off-by: Dominik Henneke --- .../src/service/router.test.ts | 6 +- .../scaffolder-backend/src/service/router.ts | 2 +- plugins/scaffolder/src/api.test.ts | 145 ++++++++++-------- plugins/scaffolder/src/api.ts | 2 +- 4 files changed, 82 insertions(+), 73 deletions(-) diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts index d6136fe872..5b9b248097 100644 --- a/plugins/scaffolder-backend/src/service/router.test.ts +++ b/plugins/scaffolder-backend/src/service/router.test.ts @@ -319,7 +319,7 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{ }); }); - describe('GET /v2/tasks/:taskId/logs', () => { + describe('GET /v2/tasks/:taskId/events', () => { it('should return log messages', async () => { const unsubscribe = jest.fn(); MockStorageTaskBroker.prototype.observe.mockImplementation( @@ -346,7 +346,7 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{ }, ); - const response = await request(app).get('/v2/tasks/a-random-id/logs'); + const response = await request(app).get('/v2/tasks/a-random-id/events'); expect(response.status).toEqual(200); expect(response.body).toEqual([ @@ -384,7 +384,7 @@ data: {"id":1,"taskId":"a-random-id","type":"completion","createdAt":"","body":{ ); const response = await request(app) - .get('/v2/tasks/a-random-id/logs') + .get('/v2/tasks/a-random-id/events') .query({ after: 10 }); expect(response.status).toEqual(200); diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts index 076a7b0036..35bedb3651 100644 --- a/plugins/scaffolder-backend/src/service/router.ts +++ b/plugins/scaffolder-backend/src/service/router.ts @@ -292,7 +292,7 @@ export async function createRouter( logger.debug(`Event stream observing taskId '${taskId}' closed`); }); }) - .get('/v2/tasks/:taskId/logs', async (req, res) => { + .get('/v2/tasks/:taskId/events', async (req, res) => { const { taskId } = req.params; const after = Number(req.query.after) || undefined; diff --git a/plugins/scaffolder/src/api.test.ts b/plugins/scaffolder/src/api.test.ts index 8b53029cd7..01463a6e1c 100644 --- a/plugins/scaffolder/src/api.test.ts +++ b/plugins/scaffolder/src/api.test.ts @@ -133,40 +133,43 @@ describe('api', () => { it('should work', async () => { server.use( - rest.get(`${mockBaseUrl}/v2/tasks/:taskId/logs`, (req, res, ctx) => { - const { taskId } = req.params; - const after = req.url.searchParams.get('after'); + rest.get( + `${mockBaseUrl}/v2/tasks/:taskId/events`, + (req, res, ctx) => { + const { taskId } = req.params; + const after = req.url.searchParams.get('after'); - if (taskId === 'a-random-task-id') { - if (!after) { - return res( - ctx.json([ - { - id: 1, - taskId: 'a-random-id', - type: 'log', - createdAt: '', - body: { message: 'My log message' }, - }, - ]), - ); - } else if (after === '1') { - return res( - ctx.json([ - { - id: 2, - taskId: 'a-random-id', - type: 'completion', - createdAt: '', - body: { message: 'Finished!' }, - }, - ]), - ); + if (taskId === 'a-random-task-id') { + if (!after) { + return res( + ctx.json([ + { + id: 1, + taskId: 'a-random-id', + type: 'log', + createdAt: '', + body: { message: 'My log message' }, + }, + ]), + ); + } else if (after === '1') { + return res( + ctx.json([ + { + id: 2, + taskId: 'a-random-id', + type: 'completion', + createdAt: '', + body: { message: 'Finished!' }, + }, + ]), + ); + } } - } - return res(ctx.status(500)); - }), + return res(ctx.status(500)); + }, + ), ); const next = jest.fn(); @@ -198,30 +201,33 @@ describe('api', () => { expect.assertions(3); server.use( - rest.get(`${mockBaseUrl}/v2/tasks/:taskId/logs`, (req, res, ctx) => { - const { taskId } = req.params; + rest.get( + `${mockBaseUrl}/v2/tasks/:taskId/events`, + (req, res, ctx) => { + const { taskId } = req.params; - const after = req.url.searchParams.get('after'); + const after = req.url.searchParams.get('after'); - // use assertion to make sure it is not called after unsubscribing - expect(after).toBe(null); + // use assertion to make sure it is not called after unsubscribing + expect(after).toBe(null); - if (taskId === 'a-random-task-id') { - return res( - ctx.json([ - { - id: 1, - taskId: 'a-random-id', - type: 'log', - createdAt: '', - body: { message: 'My log message' }, - }, - ]), - ); - } + if (taskId === 'a-random-task-id') { + return res( + ctx.json([ + { + id: 1, + taskId: 'a-random-id', + type: 'log', + createdAt: '', + body: { message: 'My log message' }, + }, + ]), + ); + } - return res(ctx.status(500)); - }), + return res(ctx.status(500)); + }, + ), ); const next = jest.fn(); @@ -252,25 +258,28 @@ describe('api', () => { const called = jest.fn(); server.use( - rest.get(`${mockBaseUrl}/v2/tasks/:taskId/logs`, (_req, res, ctx) => { - called(); + rest.get( + `${mockBaseUrl}/v2/tasks/:taskId/events`, + (_req, res, ctx) => { + called(); - if (called.mock.calls.length > 1) { - return res( - ctx.json([ - { - id: 2, - taskId: 'a-random-id', - type: 'completion', - createdAt: '', - body: { message: 'Finished!' }, - }, - ]), - ); - } + if (called.mock.calls.length > 1) { + return res( + ctx.json([ + { + id: 2, + taskId: 'a-random-id', + type: 'completion', + createdAt: '', + body: { message: 'Finished!' }, + }, + ]), + ); + } - return res(ctx.status(500)); - }), + return res(ctx.status(500)); + }, + ), ); const next = jest.fn(); diff --git a/plugins/scaffolder/src/api.ts b/plugins/scaffolder/src/api.ts index 5f2874d653..a16ab59053 100644 --- a/plugins/scaffolder/src/api.ts +++ b/plugins/scaffolder/src/api.ts @@ -265,7 +265,7 @@ export class ScaffolderClient implements ScaffolderApi { while (!subscriber.closed) { const url = `${baseUrl}/v2/tasks/${encodeURIComponent( taskId, - )}/logs?${qs.stringify({ after })}`; + )}/events?${qs.stringify({ after })}`; const response = await fetch(url); if (!response.ok) {