screwdriver-api 4.1.280 → 4.1.283

package/lib/registerPlugins.js

@@ -149,7 +149,7 @@ function registerNotificationEvent(config, server) {
             }
 
             notificationPlugin.events.forEach(event => {
-                server.events.on(event, buildData => notificationPlugin.notify(buildData));
+                server.events.on(event, buildData => notificationPlugin.notify(event, buildData));
             });
         }
     });

package/lib/server.js

@@ -141,9 +141,7 @@ module.exports = async config => {
             ecosystem: config.ecosystem,
             release: config.release,
             queueWebhook: config.queueWebhook,
-            feature: {
-                unzipArtifacts: config.unzipArtifactsEnabled
-            }
+            unzipArtifacts: config.unzipArtifactsEnabled
         };
 
         const bellConfigs = await config.auth.scm.getBellConfiguration();
@@ -162,8 +160,8 @@ module.exports = async config => {
         // Write prettier errors
         server.ext('onPreResponse', prettyPrintErrors);
 
-        // Register build_status event for notifications plugin
-        server.event('build_status');
+        // Register events for notifications plugin
+        server.event(['build_status', 'job_status']);
 
         // Register plugins
         await registerPlugins(server, config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "4.1.280",
+  "version": "4.1.283",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {
@@ -105,7 +105,7 @@
     "screwdriver-config-parser": "^7.6.0",
     "screwdriver-coverage-bookend": "^1.0.3",
     "screwdriver-coverage-sonar": "^3.4.0",
-    "screwdriver-data-schema": "^21.27.0",
+    "screwdriver-data-schema": "^21.28.1",
     "screwdriver-datastore-sequelize": "^7.2.7",
     "screwdriver-executor-base": "^8.4.0",
     "screwdriver-executor-docker": "^5.0.1",
@@ -115,8 +115,8 @@
     "screwdriver-executor-router": "^2.3.0",
     "screwdriver-logger": "^1.1.0",
     "screwdriver-models": "^28.18.1",
-    "screwdriver-notifications-email": "^2.2.0",
-    "screwdriver-notifications-slack": "^3.2.1",
+    "screwdriver-notifications-email": "^2.3.1",
+    "screwdriver-notifications-slack": "^3.3.0",
     "screwdriver-request": "^1.0.3",
     "screwdriver-scm-base": "^7.3.0",
     "screwdriver-scm-bitbucket": "^4.5.1",

package/plugins/builds/artifacts/unzip.js

@@ -18,7 +18,7 @@ module.exports = config => ({
         },
 
         handler: async (req, h) => {
-            if (!req.server.app.feature.unzipArtifacts) {
+            if (!req.server.app.unzipArtifacts) {
                 const data = {
                     statusCode: 200,
                     message: "This function is not enabled and will do nothing."

package/plugins/jobs/index.js

@@ -6,6 +6,7 @@ const listBuildsRoute = require('./listBuilds');
 const lastSuccessfulMeta = require('./lastSuccessfulMeta');
 const latestBuild = require('./latestBuild');
 const metrics = require('./metrics');
+const notify = require('./notify');
 
 /**
  * Job API Plugin
@@ -15,7 +16,15 @@ const metrics = require('./metrics');
 const jobsPlugin = {
     name: 'jobs',
     async register(server) {
-        server.route([getRoute(), updateRoute(), listBuildsRoute(), lastSuccessfulMeta(), metrics(), latestBuild()]);
+        server.route([
+            getRoute(),
+            updateRoute(),
+            listBuildsRoute(),
+            lastSuccessfulMeta(),
+            metrics(),
+            latestBuild(),
+            notify()
+        ]);
     }
 };
 

package/plugins/jobs/notify.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const boom = require('@hapi/boom');
+const joi = require('joi');
+const schema = require('screwdriver-data-schema');
+const idSchema = schema.models.job.base.extract('id');
+const statusSchema = schema.models.build.base.extract('status');
+const messageSchema = joi.string();
+
+module.exports = () => ({
+    method: 'POST',
+    path: '/jobs/{id}/notify',
+    options: {
+        description: 'Notify user about job status',
+        notes: 'Does nothing if notifaction setting was not set',
+        tags: ['api', 'jobs'],
+        auth: {
+            strategies: ['token'],
+            scope: ['pipeline']
+        },
+
+        handler: async (request, h) => {
+            const { jobFactory, pipelineFactory } = request.server.app;
+            const { credentials } = request.auth;
+            const jobId = request.params.id;
+            const job = await jobFactory.get(jobId);
+            const uiUrl = request.server.app.ecosystem.ui;
+
+            if (!job) {
+                throw boom.notFound(`Job ${jobId} does not exist`);
+            }
+
+            const pipelineId = job.pipelineId;
+
+            if (pipelineId !== credentials.pipelineId) {
+                throw boom.forbidden('Token does not have permission for this pipeline');
+            }
+
+            const pipeline = await pipelineFactory.get(pipelineId);
+
+            await request.server.events.emit('job_status', {
+                status: request.payload.status,
+                pipeline: pipeline.toJson(),
+                jobName: job.name,
+                pipelineLink: `${uiUrl}/pipelines/${pipelineId}`,
+                message: request.payload.message,
+                settings: job.permutations[0].settings
+            });
+
+            return h.response({}).code(200);
+        },
+        validate: {
+            params: joi.object({
+                id: idSchema
+            }),
+            payload: joi.object({
+                status: statusSchema,
+                message: messageSchema
+            })
+        }
+    }
+});