screwdriver-api 4.1.182 → 4.1.186

package/bin/server

@@ -50,6 +50,9 @@ const notificationConfig = config.get('notifications');
 // Multiple build cluster feature flag
 const multiBuildClusterEnabled = convertToBool(config.get('multiBuildCluster').enabled);
 
+// Queue Webhook feature flag
+const queueWebhookEnabled = convertToBool(config.get('queueWebhook').enabled);
+
 // Default cluster environment variable
 const clusterEnvConfig = config.get('build').environment; // readonly
 const clusterEnv = { ...clusterEnvConfig };
@@ -254,6 +257,10 @@ datastore.setup(datastoreConfig.ddlSyncEnabled).then(() =>
         validator: {
             externalJoin: true,
             notificationsValidationErr
+        },
+        queueWebhook: {
+            executor,
+            queueWebhookEnabled
         }
     })
         .then(instance => logger.info('Server running at %s', instance.info.uri))

package/config/custom-environment-variables.yaml

@@ -271,6 +271,11 @@ executor:
           tls: QUEUE_REDIS_TLS_ENABLED
         database: QUEUE_REDIS_DATABASE
 
+
+queueWebhook:
+  # Enabled events from webhook queue or not
+  enabled: QUEUE_WEBHOOK_ENABLED
+
 scms:
   __name: SCM_SETTINGS
   __format: json

package/config/default.yaml

@@ -190,6 +190,10 @@ executor:
           tls: false
         database: 0
 
+queueWebhook:
+  # Enabled events from webhook queue or not
+  enabled: false
+
 scms: {}
 #   github:
 #     plugin: github

package/lib/server.js

@@ -136,7 +136,8 @@ module.exports = async config => {
             collectionFactory: config.collectionFactory,
             buildClusterFactory: config.buildClusterFactory,
             ecosystem: config.ecosystem,
-            release: config.release
+            release: config.release,
+            queueWebhook: config.queueWebhook
         };
 
         const bellConfigs = await config.auth.scm.getBellConfiguration();

package/package.json

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

package/plugins/builds/index.js

@@ -410,11 +410,6 @@ function parseJobInfo({ joinObj = {}, current, nextJobName, nextPipelineId }) {
  * @return {Promise}                            All finished builds
  */
 async function getFinishedBuilds(event, buildFactory) {
-    if (!event.parentEventId) {
-        // FIXME: remove this flow to always use buildFactory.getLatestBuilds
-        return event.getBuilds();
-    }
-
     // FIXME: buildFactory.getLatestBuilds doesn't return build model
     const builds = await buildFactory.getLatestBuilds({ groupEventId: event.groupEventId });
 
@@ -529,11 +524,13 @@ async function handleNewBuild({ done, hasFailure, newBuild, jobName, pipelineId
             return null;
         }
 
-        // If all join builds finished successfully, start new build
-        newBuild.status = 'QUEUED';
-        const queuedBuild = await newBuild.update();
+        // If all join builds finished successfully and it's clear that a new build has not been started before, start new build
+        if ([ 'CREATED', null, undefined ].includes(newBuild.status)) {
+            newBuild.status = 'QUEUED';
+            const queuedBuild = await newBuild.update();
 
-        return queuedBuild.start();
+            return queuedBuild.start();
+        }
     }
 
     return null;

package/plugins/events/README.md

@@ -32,6 +32,9 @@ server.register({
 #### Returns a list of builds associated with the event
 `GET /events/{id}/builds`
 
+`GET /events/{id}/builds?fetchSteps=false&readOnly=true`
+
+
 #### Get build metrics for a single event
 `GET /events/{id}/metrics`
 

package/plugins/events/listBuilds.js

@@ -24,14 +24,23 @@ module.exports = () => ({
         handler: async (request, h) => {
             const { eventFactory } = request.server.app;
             const event = await eventFactory.get(request.params.id);
+            const { fetchSteps, readOnly } = request.query;
 
             if (!event) {
                 throw boom.notFound('Event does not exist');
             }
 
-            const buildsModel = await event.getBuilds();
+            const config = readOnly ? { readOnly: true } : {};
 
-            const data = await Promise.all(buildsModel.map(async buildModel => buildModel.toJsonWithSteps()));
+            const buildsModel = await event.getBuilds(config);
+
+            let data;
+
+            if (fetchSteps) {
+                data = await Promise.all(buildsModel.map(async buildModel => buildModel.toJsonWithSteps()));
+            } else {
+                data = await Promise.all(buildsModel.map(async buildModel => buildModel.toJson()));
+            }
 
             return h.response(data);
         },
@@ -41,7 +50,21 @@ module.exports = () => ({
         validate: {
             params: joi.object({
                 id: eventIdSchema
-            })
+            }),
+            query: schema.api.pagination.concat(
+                joi.object({
+                    readOnly: joi
+                        .boolean()
+                        .truthy('true')
+                        .falsy('false')
+                        .default(false),
+                    fetchSteps: joi
+                        .boolean()
+                        .truthy('true')
+                        .falsy('false')
+                        .default(true)
+                })
+            )
         }
     }
 });

package/plugins/jobs/README.md

@@ -46,6 +46,8 @@ Example payload:
 #### Get list of builds for a single job
 `GET /jobs/{id}/builds`
 
+`GET /jobs/{id}/builds?fetchSteps=false&readOnly=true`
+
 `GET /jobs/{id}/builds?page=2&count=30&sort=ascending`
 
 `GET /jobs/{id}/builds?page=2&count=30&sort=ascending&sortBy=id`

package/plugins/jobs/listBuilds.js

@@ -23,7 +23,7 @@ module.exports = () => ({
 
         handler: async (request, h) => {
             const factory = request.server.app.jobFactory;
-            const { sort, sortBy, page, count } = request.query;
+            const { sort, sortBy, page, count, fetchSteps, readOnly } = request.query;
 
             return factory
                 .get(request.params.id)
@@ -32,7 +32,9 @@ module.exports = () => ({
                         throw boom.notFound('Job does not exist');
                     }
 
-                    const config = { sort, sortBy: 'createTime' };
+                    const config = readOnly
+                        ? { sort, sortBy: 'createTime', readOnly: true }
+                        : { sort, sortBy: 'createTime' };
 
                     if (sortBy) {
                         config.sortBy = sortBy;
@@ -45,7 +47,13 @@ module.exports = () => ({
                     return job.getBuilds(config);
                 })
                 .then(async builds => {
-                    const data = await Promise.all(builds.map(b => b.toJsonWithSteps()));
+                    let data;
+
+                    if (fetchSteps) {
+                        data = await Promise.all(builds.map(b => b.toJsonWithSteps()));
+                    } else {
+                        data = await Promise.all(builds.map(b => b.toJson()));
+                    }
 
                     return h.response(data);
                 })
@@ -60,7 +68,20 @@ module.exports = () => ({
             params: joi.object({
                 id: jobIdSchema
             }),
-            query: schema.api.pagination
+            query: schema.api.pagination.concat(
+                joi.object({
+                    readOnly: joi
+                        .boolean()
+                        .truthy('true')
+                        .falsy('false')
+                        .default(false),
+                    fetchSteps: joi
+                        .boolean()
+                        .truthy('true')
+                        .falsy('false')
+                        .default(true)
+                })
+            )
         }
     }
 });

package/plugins/webhooks/index.js

@@ -62,9 +62,11 @@ const webhooksPlugin = {
                     maxBytes: parseInt(pluginOptions.maxBytes, 10) || DEFAULT_MAX_BYTES
                 },
                 handler: async (request, h) => {
-                    const { pipelineFactory } = request.server.app;
+                    const { pipelineFactory, queueWebhook } = request.server.app;
                     const { scm } = pipelineFactory;
+                    const { executor, queueWebhookEnabled } = queueWebhook;
                     let message = 'Unable to process this kind of event';
+                    let hookId;
 
                     try {
                         const parsed = await scm.parseHook(request.headers, request.payload);
@@ -76,10 +78,26 @@ const webhooksPlugin = {
 
                         parsed.pluginOptions = pluginOptions;
 
-                        const { type, hookId } = parsed;
+                        const { type } = parsed;
+                        hookId = parsed.hookId;
 
                         request.log(['webhook', hookId], `Received event type ${type}`);
 
+                        if (queueWebhookEnabled) {
+                            parsed.token = request.server.plugins.auth.generateToken({
+                                scope: ['sdapi']
+                            });
+
+                            try {
+                                return await executor.enqueueWebhook(parsed);
+                            } catch (err) {
+                                // if enqueueWebhook is not implemented, an event starts without enqueuing
+                                if (err.message != 'Not implemented') {
+                                    throw err;
+                                }
+                            }
+                        }
+
                         return await startHookEvent(request, h, parsed);
 
                     } catch (err) {