screwdriver-api 5.0.3 → 5.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "5.0.3",
+  "version": "5.0.5",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {

package/plugins/commands/list.js

@@ -81,7 +81,7 @@ module.exports = () => ({
 
             // check if the call wants compact data
             if (compact === 'true') {
-                // removing `config` trims most of the bytes
+                // removing these fields trims most of the bytes
                 config.exclude = ['usage', 'docker', 'habitat', 'binary'];
                 // using spread operator because params could be null
                 config.params = {

package/plugins/commands/listTags.js

@@ -53,7 +53,11 @@ module.exports = () => ({
                 namespace: namespaceSchema,
                 name: nameSchema
             }),
-            query: schema.api.pagination
+            query: schema.api.pagination.concat(
+                joi.object({
+                    search: joi.forbidden() // we don't support search for Command list tag
+                })
+            )
         }
     }
 });

package/plugins/commands/listVersions.js

@@ -60,7 +60,11 @@ module.exports = () => ({
                 namespace: namespaceSchema,
                 name: nameSchema
             }),
-            query: schema.api.pagination
+            query: schema.api.pagination.concat(
+                joi.object({
+                    search: joi.forbidden() // we don't support search for Command list versions
+                })
+            )
         }
     }
 });

package/plugins/events/listBuilds.js

@@ -62,7 +62,8 @@ module.exports = () => ({
                         .boolean()
                         .truthy('true')
                         .falsy('false')
-                        .default(true)
+                        .default(true),
+                    search: joi.forbidden() // we don't support search for Event list builds
                 })
             )
         }

package/plugins/jobs/listBuilds.js

@@ -86,7 +86,7 @@ module.exports = () => ({
                         .falsy('false')
                         .default(true),
                     status: statusSchema,
-                    search: joi.forbidden() // we don't support search for list builds
+                    search: joi.forbidden() // we don't support search for Job list builds
                 })
             )
         }

package/plugins/pipelines/badge.js

@@ -2,44 +2,10 @@
 
 const joi = require('joi');
 const schema = require('screwdriver-data-schema');
-const workflowParser = require('screwdriver-workflow-parser');
 const idSchema = schema.models.pipeline.base.extract('id');
+const logger = require('screwdriver-logger');
 const { getPipelineBadge } = require('./helper');
-
-/**
- * DFS the workflowGraph from the start point
- * @method dfs
- * @param  {Object} workflowGraph   workflowGraph
- * @param  {String} start           Start job name
- * @param  {String} prNum           PR number in case of PR trigger
- * @return {Set}                    A set of build ids that are visited
- */
-function dfs(workflowGraph, start, prNum) {
-    let nextJobsConfig;
-
-    if (start === '~pr') {
-        nextJobsConfig = {
-            trigger: start,
-            prNum
-        };
-    } else {
-        nextJobsConfig = {
-            trigger: start
-        };
-    }
-
-    const nextJobs = workflowParser.getNextJobs(workflowGraph, nextJobsConfig);
-
-    let visited = new Set(nextJobs);
-
-    nextJobs.forEach(job => {
-        const subJobs = dfs(workflowGraph, job);
-
-        visited = new Set([...visited, ...subJobs]);
-    });
-
-    return visited;
-}
+const BUILD_META_KEYWORD = '%"build":%';
 
 module.exports = config => ({
     method: 'GET',
@@ -54,64 +20,72 @@ module.exports = config => ({
             }
         },
         handler: async (request, h) => {
-            const factory = request.server.app.pipelineFactory;
+            const { pipelineFactory, eventFactory } = request.server.app;
+            const pipelineId = request.params.id;
             const { statusColor } = config;
             const badgeConfig = {
                 statusColor
             };
             const contentType = 'image/svg+xml;charset=utf-8';
 
-            return factory
-                .get(request.params.id)
-                .then(pipeline => {
-                    if (!pipeline) {
-                        return h.response(getPipelineBadge(badgeConfig)).header('Content-Type', contentType);
-                    }
-
-                    return pipeline.getEvents({ sort: 'ascending' }).then(allEvents => {
-                        const getLastEffectiveEvent = events => {
-                            const lastEvent = events.pop();
-
-                            if (!lastEvent) {
-                                return h.response(getPipelineBadge(badgeConfig)).header('Content-Type', contentType);
-                            }
-
-                            return lastEvent.getBuilds().then(builds => {
-                                if (!builds || builds.length < 1) {
-                                    return getLastEffectiveEvent(events);
-                                }
-
-                                const buildsStatus = builds.reverse().map(build => build.status.toLowerCase());
-
-                                let workflowLength = 0;
-
-                                if (lastEvent.workflowGraph) {
-                                    const nextJobs = dfs(lastEvent.workflowGraph, lastEvent.startFrom, lastEvent.prNum);
-
-                                    workflowLength = nextJobs.size;
-                                }
-
-                                for (let i = builds.length; i < workflowLength; i += 1) {
-                                    buildsStatus[i] = 'unknown';
-                                }
-
-                                return h
-                                    .response(
-                                        getPipelineBadge(
-                                            Object.assign(badgeConfig, {
-                                                buildsStatus,
-                                                label: pipeline.name
-                                            })
-                                        )
-                                    )
-                                    .header('Content-Type', contentType);
-                            });
-                        };
-
-                        return getLastEffectiveEvent(allEvents);
-                    });
-                })
-                .catch(() => h.response(getPipelineBadge(badgeConfig)));
+            try {
+                // Get pipeline
+                const pipeline = await pipelineFactory.get(pipelineId);
+
+                if (!pipeline) {
+                    return h.response(getPipelineBadge(badgeConfig)).header('Content-Type', contentType);
+                }
+
+                // Get latest pipeline events
+                const latestEvents = await eventFactory.list({
+                    params: {
+                        pipelineId,
+                        parentEventId: null,
+                        type: 'pipeline'
+                    },
+                    // Make sure build exists for event, meta will be {} for skipped builds
+                    search: {
+                        field: 'meta',
+                        keyword: BUILD_META_KEYWORD
+                    },
+                    // removing these fields trims most of the bytes
+                    exclude: ['workflowGraph', 'meta', 'commit'],
+                    paginate: {
+                        count: 1
+                    },
+                    sort: 'descending'
+                });
+
+                if (!latestEvents || Object.keys(latestEvents).length === 0) {
+                    return h.response(getPipelineBadge(badgeConfig)).header('Content-Type', contentType);
+                }
+
+                // Only care about latest
+                const lastEvent = latestEvents[0];
+                const builds = await lastEvent.getBuilds({ readOnly: true });
+
+                if (!builds || builds.length < 1) {
+                    return h.response(getPipelineBadge(badgeConfig)).header('Content-Type', contentType);
+                }
+
+                // Convert build statuses
+                const buildsStatus = builds.reverse().map(build => build.status.toLowerCase());
+
+                return h
+                    .response(
+                        getPipelineBadge(
+                            Object.assign(badgeConfig, {
+                                buildsStatus,
+                                label: pipeline.name
+                            })
+                        )
+                    )
+                    .header('Content-Type', contentType);
+            } catch (err) {
+                logger.error(`Failed to get badge for pipeline:${pipelineId}: ${err.message}`);
+
+                return h.response(getPipelineBadge(badgeConfig));
+            }
         },
         validate: {
             params: joi.object({

package/plugins/pipelines/listEvents.js

@@ -64,7 +64,8 @@ module.exports = () => ({
             query: schema.api.pagination.concat(
                 joi.object({
                     type: joi.string(),
-                    prNum: prNumSchema
+                    prNum: prNumSchema,
+                    search: joi.forbidden() // we don't support search for Pipeline list events
                 })
             )
         }

package/plugins/pipelines/listJobs.js

@@ -67,7 +67,8 @@ module.exports = () => ({
                         .truthy('true')
                         .falsy('false')
                         .default(false),
-                    jobName: jobNameSchema
+                    jobName: jobNameSchema,
+                    search: joi.forbidden() // we don't support search for Pipeline list jobs
                 })
             )
         }

package/plugins/pipelines/listStages.js

@@ -87,7 +87,8 @@ module.exports = () => ({
             query: schema.api.pagination.concat(
                 joi.object({
                     eventId: pipelineIdSchema,
-                    groupEventId: pipelineIdSchema
+                    groupEventId: pipelineIdSchema,
+                    search: joi.forbidden() // we don't support search for Pipeline list stages
                 })
             )
         }

package/plugins/pipelines/metrics.js

@@ -102,7 +102,8 @@ module.exports = () => ({
                     endTime: joi.string().isoDate(),
                     aggregateInterval: joi.string().valid('none', 'day', 'week', 'month', 'year'),
                     'downtimeJobs[]': jobIdsSchema.optional(),
-                    'downtimeStatuses[]': statusesSchema.optional()
+                    'downtimeStatuses[]': statusesSchema.optional(),
+                    search: joi.forbidden() // we don't support search for Pipeline metrics
                 })
             )
         }

package/plugins/templates/listTags.js

@@ -50,7 +50,11 @@ module.exports = () => ({
             params: joi.object({
                 name: nameSchema
             }),
-            query: schema.api.pagination
+            query: schema.api.pagination.concat(
+                joi.object({
+                    search: joi.forbidden() // we don't support search for Template list tags
+                })
+            )
         }
     }
 });

package/plugins/templates/listVersions.js

@@ -57,7 +57,11 @@ module.exports = () => ({
             params: joi.object({
                 name: nameSchema
             }),
-            query: schema.api.pagination
+            query: schema.api.pagination.concat(
+                joi.object({
+                    search: joi.forbidden() // we don't support search for Template list versions
+                })
+            )
         }
     }
 });

package/plugins/templates/listVersionsWithMetric.js

@@ -54,7 +54,11 @@ module.exports = () => ({
             params: joi.object({
                 name: nameSchema
             }),
-            query: schema.api.pagination
+            query: schema.api.pagination.concat(
+                joi.object({
+                    search: joi.forbidden() // we don't support search for Template list versions with metrics
+                })
+            )
         }
     }
 });