screwdriver-api 4.1.180 → 4.1.184

package/lib/registerPlugins.js

@@ -60,7 +60,8 @@ async function registerResourcePlugins(server, config) {
         'isAdmin',
         'shutdown',
         'release',
-        'validator'
+        'validator',
+        'processHooks'
     ];
 
     if (hoek.reach(config, 'coverage.coveragePlugin')) {

package/package.json

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

package/plugins/builds/artifacts/unzip.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const idSchema = schema.models.build.base.extract('id');
+
+module.exports = config => ({
+    method: 'POST',
+    path: '/builds/{id}/artifacts/unzip',
+    options: {
+        description: 'Extract a ZIP for build artifacts',
+        notes: 'Extract a specific ZIP for build artifacts',
+        tags: ['api', 'builds', 'artifacts'],
+        auth: {
+            strategies: ['token'],
+            scope: ['build']
+        },
+
+        handler: async (req, h) => {
+            const buildId = req.params.id;
+            const { username, scope } = req.auth.credentials;
+            const isBuild = scope.includes('build');
+            const { buildFactory } = req.server.app;
+
+            if (isBuild && username !== buildId) {
+                return boom.forbidden(`Credential only valid for ${username}`);
+            }
+
+            return buildFactory
+                .get(buildId)
+                .then(async buildModel => {
+                    if (!buildModel) {
+                        throw boom.notFound('Build does not exist');
+                    }
+                    await buildModel.unzipArtifacts();
+                    return h.response().code(202);
+                })
+                .catch(err => {
+                    throw err;
+                });
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            })
+        }
+    }
+});

package/plugins/builds/index.js

@@ -11,6 +11,7 @@ const createRoute = require('./create');
 const stepGetRoute = require('./steps/get');
 const listStepsRoute = require('./steps/list');
 const artifactGetRoute = require('./artifacts/get');
+const artifactUnzipRoute = require('./artifacts/unzip');
 const stepUpdateRoute = require('./steps/update');
 const stepLogsRoute = require('./steps/logs');
 const listSecretsRoute = require('./listSecrets');
@@ -528,11 +529,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;
@@ -1110,7 +1113,8 @@ const buildsPlugin = {
             listSecretsRoute(),
             tokenRoute(),
             metricsRoute(),
-            artifactGetRoute(options)
+            artifactGetRoute(options),
+            artifactUnzipRoute(),
         ]);
     }
 };

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/create.js

@@ -149,7 +149,7 @@ module.exports = () => ({
 
                 const [files, prInfo] = await Promise.all([
                     scm.getChangedFiles({
-                        payload: null,
+                        webhookConfig: null,
                         type: 'pr',
                         ...scmConfig
                     }),

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/processHooks/README.md

@@ -0,0 +1,33 @@
+# Process Hooks Plugin
+> Hapi processHooks plugin for the Screwdriver API
+
+## Usage
+
+### Register plugin
+
+```javascript
+const Hapi = require('@hapi/hapi');
+const server = new Hapi.Server();
+const processHooksPlugin = require('./');
+
+server.connection({ port: 3000 });
+
+server.register({
+    register: processHooksPlugin,
+    options: {}
+}, () => {
+    server.start((err) => {
+        if (err) {
+            throw err;
+        }
+        console.log('Server running at:', server.info.uri);
+    });
+});
+```
+
+### Routes
+
+#### Start pipeline events from scm webhook config
+
+`POST /processHooks`
+

package/plugins/processHooks/index.js

@@ -0,0 +1,47 @@
+'use strict';
+
+const logger = require('screwdriver-logger');
+const { startHookEvent } = require('../webhooks/helper');
+
+/**
+ * Process Hooks API Plugin
+ * - Start pipeline events with scm webhook config via queue-service
+ * @method register
+ * @param  {Hapi}       server  Hapi Server
+ * @param  {Object}     options Configuration
+ * @param  {Function}   next    Function to call when done
+ */
+const processHooksPlugin = {
+    name: 'processHooks',
+    async register(server, options) {
+        server.route({
+            method: 'POST',
+            path: '/processHooks',
+            options: {
+                description: 'Handle process hook events',
+                notes: 'Acts on pull request, pushes, comments, etc.',
+                tags: ['api', 'processHook'],
+                auth: {
+                    strategies: ['token'],
+                    scope: ['webhook_worker']
+                },
+                plugins: {
+                    'hapi-rate-limit': {
+                        enabled: false
+                    }
+                },
+                handler: async (request, h) => {
+                    try {
+                        return await startHookEvent(request, h, request.payload);
+                    } catch (err) {
+                        logger.error(`Error starting hook events for ${request.payload.hookId}:${err}`);
+
+                        throw err;
+                    }
+                }
+            }
+        });
+    }
+};
+
+module.exports = processHooksPlugin;