fix: Add ability to filter pipeline events for commit message, author, or creator (#3244)

Author: tkyi

plugins/pipelines/README.md

@@ -110,12 +110,19 @@ Query Params:
 * `sortBy` - *Optional* Field to sort by
 * `type` - *Optional* Get pipeline or pr events (default `pipeline`)
 * `prNum` - *Optional* Return only PR events of specified PR number
-* `sha` - *Optional* Search `sha` and `configPipelineSha` for events
 * `groupEventId` - *Optional* Return only events with a specified groupEventId
 * `id` - *Optional* Fetch specific event ID; alternatively can use greater than(`gt:`) or less than(`lt:`) prefix
+* `sha` - *Optional* Search `sha` and `configPipelineSha` for events
+* `author` - *Optional* Search commit author `username` and `name` for events
+* `creator` - *Optional* Search creator `username` and `name` for events
+* `message` - *Optional* Search commit `message` for events
+
+_Caveats_: Only one of the search fields can be used at one time (sha, author, creator, or message).
 
 `GET /pipelines/{id}/events?page={pageNumber}&count={countNumber}&sort={sort}&type={type}&prNum={prNumber}&sha={sha}`
 
+`GET /pipelines/{id}/events?message={message}`
+
 `GET /pipelines/{id}/events?id=gt:{eventId}&count={countNumber}` (greater than eventId)
 
 `GET /pipelines/{id}/events?id=lt:{eventId}&count={countNumber}&sort=ascending` (less than eventId)

plugins/pipelines/listEvents.js

@@ -34,7 +34,7 @@ module.exports = () => ({
 
         handler: async (request, h) => {
             const factory = request.server.app.pipelineFactory;
-            const { page, count, sha, prNum, id, sort, sortBy, groupEventId } = request.query;
+            const { page, count, sha, prNum, id, sort, sortBy, groupEventId, message, author, creator } = request.query;
 
             return factory
                 .get(request.params.id)
@@ -62,13 +62,18 @@ module.exports = () => ({
                         config.params.prNum = prNum;
                     }
 
+                    // Do a search
+                    // See https://www.w3schools.com/sql/sql_like.asp for syntax
                     if (sha) {
-                        config.search = {
-                            field: ['sha', 'configPipelineSha'],
-                            // Do a search for sha
-                            // See https://www.w3schools.com/sql/sql_like.asp for syntax
-                            keyword: `${sha}%`
-                        };
+                        config.search = { field: ['sha', 'configPipelineSha'], keyword: `${sha}%` };
+                    } else if (message) {
+                        config.search = { field: ['commit'], keyword: `%"message":"${message}%` };
+                    } else if (author) {
+                        // searches name and username
+                        config.search = { field: ['commit'], keyword: `%name":"${author}%` };
+                    } else if (creator) {
+                        // searches name and username
+                        config.search = { field: ['creator'], keyword: `%name":"${creator}%` };
                     }
 
                     if (groupEventId) {
@@ -95,15 +100,24 @@ module.exports = () => ({
                 id: pipelineIdSchema
             }),
             query: schema.api.pagination.concat(
-                joi.object({
-                    type: typeSchema,
-                    prNum: prNumSchema,
-                    sha: shaSchema,
-                    id: queryIdSchema,
-                    groupEventId: pipelineIdSchema,
-                    search: joi.forbidden(), // we don't support search for Pipeline list events
-                    getCount: joi.forbidden() // we don't support getCount for Pipeline list events
-                })
+                joi
+                    .object({
+                        type: typeSchema,
+                        prNum: prNumSchema,
+                        sha: shaSchema,
+                        message: joi.string().label('Commit message').example('fix: Typo'),
+                        author: joi.string().label('Author Name').example('Dao Lam'),
+                        creator: joi.string().label('Creator Name').example('Dao Lam'),
+                        id: queryIdSchema,
+                        groupEventId: pipelineIdSchema,
+                        search: joi.forbidden(), // we don't support search for Pipeline list events
+                        getCount: joi.forbidden() // we don't support getCount for Pipeline list events
+                    })
+                    // https://joi.dev/api/?v=17.13.3#objectoxorpeers-options
+                    .oxor('sha', 'message', 'author', 'creator')
+                    .messages({
+                        'object.oxor': 'You can only specify one search parameter: sha, message, author, or creator.'
+                    })
             )
         }
     }

test/plugins/pipelines.test.js

@@ -1568,6 +1568,60 @@ describe('pipeline plugin test', () => {
             });
         });
 
+        it('returns 200 for getting events with commit author name', () => {
+            options.url = `/pipelines/${id}/events?author=Dao`;
+
+            return server.inject(options).then(reply => {
+                assert.calledOnce(pipelineMock.getEvents);
+                assert.calledWith(pipelineMock.getEvents, {
+                    params: { type: 'pipeline' },
+                    search: {
+                        field: ['commit'],
+                        keyword: '%name":"Dao%'
+                    },
+                    sort: 'descending'
+                });
+                assert.deepEqual(reply.result, testEvents);
+                assert.equal(reply.statusCode, 200);
+            });
+        });
+
+        it('returns 200 for getting events with commit creator name', () => {
+            options.url = `/pipelines/${id}/events?creator=Dao`;
+
+            return server.inject(options).then(reply => {
+                assert.calledOnce(pipelineMock.getEvents);
+                assert.calledWith(pipelineMock.getEvents, {
+                    params: { type: 'pipeline' },
+                    search: {
+                        field: ['creator'],
+                        keyword: '%name":"Dao%'
+                    },
+                    sort: 'descending'
+                });
+                assert.deepEqual(reply.result, testEvents);
+                assert.equal(reply.statusCode, 200);
+            });
+        });
+
+        it('returns 200 for getting events with commit message', () => {
+            options.url = `/pipelines/${id}/events?message=Update screwdriver.yaml`;
+
+            return server.inject(options).then(reply => {
+                assert.calledOnce(pipelineMock.getEvents);
+                assert.calledWith(pipelineMock.getEvents, {
+                    params: { type: 'pipeline' },
+                    search: {
+                        field: ['commit'],
+                        keyword: '%"message":"Update screwdriver.yaml%'
+                    },
+                    sort: 'descending'
+                });
+                assert.deepEqual(reply.result, testEvents);
+                assert.equal(reply.statusCode, 200);
+            });
+        });
+
         it('returns 200 for getting events with groupEventId', () => {
             options.url = `/pipelines/${id}/events?groupEventId=4`;
 
@@ -1632,6 +1686,15 @@ describe('pipeline plugin test', () => {
                 assert.equal(reply.statusCode, 500);
             });
         });
+
+        it('returns 400 when trying to search multiple fields at once', () => {
+            options.url = `/pipelines/${id}/events?creator=Dao&sha=33`;
+
+            return server.inject(options).then(reply => {
+                assert.equal(reply.statusCode, 400);
+                assert.equal(reply.result.message, 'Invalid request query input');
+            });
+        });
     });
 
     describe('GET /pipelines/{id}/builds', () => {