screwdriver-api 4.1.177 → 4.1.181

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "4.1.177",
+  "version": "4.1.181",
   "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');
@@ -270,7 +271,6 @@ async function createInternalBuild(config) {
     } else {
         job = await jobFactory.get(jobId);
     }
-
     const internalBuildConfig = {
         jobId: job.id,
         sha: event.sha,
@@ -410,6 +410,11 @@ 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 });
 
@@ -1106,7 +1111,8 @@ const buildsPlugin = {
             listSecretsRoute(),
             tokenRoute(),
             metricsRoute(),
-            artifactGetRoute(options)
+            artifactGetRoute(options),
+            artifactUnzipRoute(),
         ]);
     }
 };

package/plugins/events/README.md

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

package/plugins/events/listBuilds.js

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

package/plugins/jobs/README.md

@@ -46,8 +46,6 @@ Example payload:
 #### Get list of builds for a single job
 `GET /jobs/{id}/builds`
 
-`GET /jobs/{id}/builds?steps=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, steps } = request.query;
+            const { sort, sortBy, page, count } = request.query;
 
             return factory
                 .get(request.params.id)
@@ -32,7 +32,7 @@ module.exports = () => ({
                         throw boom.notFound('Job does not exist');
                     }
 
-                    const config = { sort, sortBy: 'createTime', readOnly: true };
+                    const config = { sort, sortBy: 'createTime' };
 
                     if (sortBy) {
                         config.sortBy = sortBy;
@@ -45,13 +45,7 @@ module.exports = () => ({
                     return job.getBuilds(config);
                 })
                 .then(async builds => {
-                    let data;
-
-                    if (steps) {
-                        data = await Promise.all(builds.map(b => b.toJsonWithSteps()));
-                    } else {
-                        data = await Promise.all(builds.map(b => b.toJson()));
-                    }
+                    const data = await Promise.all(builds.map(b => b.toJsonWithSteps()));
 
                     return h.response(data);
                 })
@@ -66,15 +60,7 @@ module.exports = () => ({
             params: joi.object({
                 id: jobIdSchema
             }),
-            query: schema.api.pagination.concat(
-                joi.object({
-                    steps: joi
-                        .boolean()
-                        .truthy('true')
-                        .falsy('false')
-                        .default(false)
-                })
-            )
+            query: schema.api.pagination
         }
     }
 });