screwdriver-api 7.0.241 → 7.0.243

package/package.json

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

package/plugins/events/create.js

@@ -5,8 +5,7 @@ const boom = require('@hapi/boom');
 const validationSchema = require('screwdriver-data-schema');
 const ANNOT_RESTRICT_PR = 'screwdriver.cd/restrictPR';
 const { getScmUri, isStageTeardown } = require('../helper');
-const { updateBuildAndTriggerDownstreamJobs } = require('../builds/helper/updateBuild');
-const { Status, BUILD_STATUS_MESSAGES } = require('../builds/triggers/helpers');
+const { createEvent } = require('./helper/createEvent');
 
 module.exports = () => ({
     method: 'POST',
@@ -220,15 +219,27 @@ module.exports = () => ({
 
             payload.sha = sha;
 
-            // If there is parentEvent, pass workflowGraph and sha to payload
+            // If there is parentEvent, pass workflowGraph, meta and sha to payload
             // Skip PR, for PR builds, we should always start from latest commit
             if (payload.parentEventId) {
                 const parentEvent = await eventFactory.get(parentEventId);
+                let mergedParameters = payload.meta.parameters || {};
 
                 payload.baseBranch = parentEvent.baseBranch || null;
 
+                // Merge parameters if they exist in the parent event and not in the payload
                 if (!payload.meta.parameters && parentEvent.meta && parentEvent.meta.parameters) {
-                    payload.meta.parameters = parentEvent.meta.parameters;
+                    mergedParameters = parentEvent.meta.parameters;
+                }
+                delete payload.meta.parameters;
+
+                // Copy meta from parent event if payload.meta is empty except for the parameters
+                if (Object.keys(payload.meta).length === 0) {
+                    payload.meta = { ...parentEvent.meta };
+                }
+
+                if (Object.keys(mergedParameters).length > 0) {
+                    payload.meta.parameters = mergedParameters;
                 }
 
                 if (!prNum) {
@@ -241,28 +252,12 @@ module.exports = () => ({
                 }
             }
 
-            const event = await eventFactory.create(payload);
+            const event = await createEvent(payload, request.server);
 
             if (event.builds === null) {
                 return boom.notFound('No jobs to start.');
             }
 
-            const virtualJobBuilds = event.builds.filter(b => b.status === 'CREATED');
-
-            for (const build of virtualJobBuilds) {
-                await updateBuildAndTriggerDownstreamJobs(
-                    {
-                        status: Status.SUCCESS,
-                        statusMessage: BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage,
-                        statusMessageType: BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType
-                    },
-                    build,
-                    request.server,
-                    username,
-                    scmContext
-                );
-            }
-
             // everything succeeded, inform the user
             const location = urlLib.format({
                 host: request.headers.host,

package/plugins/events/helper/createEvent.js

@@ -0,0 +1,50 @@
+'use strict';
+
+const { updateBuildAndTriggerDownstreamJobs } = require('../../builds/helper/updateBuild');
+const { Status, BUILD_STATUS_MESSAGES } = require('../../builds/triggers/helpers');
+
+/**
+ * @typedef {import('screwdriver-models/lib/event')} Event
+ */
+
+/**
+ * Create a new event.
+ * Updates the status of all the virtual builds at the beginning of the event workflow to "SUCCESS"
+ * and trigger their downstream jobs.
+ *
+ * @method createEvent
+ * @param   {Object}    config
+ * @param   {String}    config.username
+ * @param   {Object}    config.scmContext
+ * @param   {Object}    server
+ * @returns {Promise<Event>} Newly created event
+ */
+async function createEvent(config, server) {
+    const { eventFactory } = server.app;
+    const { username, scmContext } = config;
+    const event = await eventFactory.create(config);
+
+    if (event.builds) {
+        const virtualJobBuilds = event.builds.filter(b => b.status === 'CREATED');
+
+        for (const build of virtualJobBuilds) {
+            await updateBuildAndTriggerDownstreamJobs(
+                {
+                    status: Status.SUCCESS,
+                    statusMessage: BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage,
+                    statusMessageType: BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType
+                },
+                build,
+                server,
+                username,
+                scmContext
+            );
+        }
+    }
+
+    return event;
+}
+
+module.exports = {
+    createEvent
+};

package/plugins/pipelines/startAll.js

@@ -4,6 +4,7 @@ const boom = require('@hapi/boom');
 const joi = require('joi');
 const schema = require('screwdriver-data-schema');
 const { getUserPermissions } = require('../helper');
+const { createEvent } = require('../events/helper/createEvent');
 const idSchema = schema.models.pipeline.base.extract('id');
 
 module.exports = () => ({
@@ -19,7 +20,7 @@ module.exports = () => ({
         },
 
         handler: async (request, h) => {
-            const { pipelineFactory, eventFactory, userFactory } = request.server.app;
+            const { pipelineFactory, userFactory } = request.server.app;
             const { username, scmContext } = request.auth.credentials;
             const { id } = request.params;
             const { scm } = pipelineFactory;
@@ -41,7 +42,7 @@ module.exports = () => ({
                 }
             });
 
-            const createEvents = await Promise.allSettled(
+            const createdEvents = await Promise.allSettled(
                 pipelines.map(async p => {
                     const pipelineToken = await p.token;
                     const pipelineScmContext = p.scmContext;
@@ -53,18 +54,21 @@ module.exports = () => ({
 
                     await getUserPermissions({ user, scmUri: p.scmUri, level: 'push' });
 
-                    await eventFactory.create({
-                        pipelineId: p.id,
-                        sha,
-                        username,
-                        scmContext: pipelineScmContext,
-                        startFrom: '~commit',
-                        causeMessage: `Started by ${username}`
-                    });
+                    await createEvent(
+                        {
+                            pipelineId: p.id,
+                            sha,
+                            username,
+                            scmContext: pipelineScmContext,
+                            startFrom: '~commit',
+                            causeMessage: `Started by ${username}`
+                        },
+                        request.server
+                    );
                 })
             );
 
-            const rejected = createEvents.filter(createEvent => createEvent.status === 'rejected');
+            const rejected = createdEvents.filter(createdEvent => createdEvent.status === 'rejected');
 
             if (rejected.length) {
                 throw boom.forbidden('Failed to start some child pipelines due to lack of permissions.');

package/plugins/webhooks/helper.js

@@ -4,6 +4,7 @@ const workflowParser = require('screwdriver-workflow-parser');
 const schema = require('screwdriver-data-schema');
 const logger = require('screwdriver-logger');
 const { getReadOnlyInfo } = require('../helper');
+const { createEvent } = require('../events/helper/createEvent');
 
 const ANNOT_NS = 'screwdriver.cd';
 const ANNOT_CHAIN_PR = `${ANNOT_NS}/chainPR`;
@@ -413,10 +414,10 @@ async function triggeredPipelines(
  * Start Events
  * @async  startEvents
  * @param  {Array}  eventConfigs Array of event config objects
- * @param  {Object} eventFactory Factory to create events
+ * @param  {Object} server Server
  * @return {Promise<Array>}  Array of created events
  */
-async function startEvents(eventConfigs, eventFactory) {
+async function startEvents(eventConfigs, server) {
     const events = [];
     let errorCount = 0;
     let eventsCount = 0;
@@ -426,7 +427,7 @@ async function startEvents(eventConfigs, eventFactory) {
             if (eventConfig && eventConfig.configPipelineSha) {
                 eventsCount += 1;
 
-                return eventFactory.create(eventConfig);
+                return createEvent(eventConfig, server);
             }
 
             return Promise.resolve(null);
@@ -626,7 +627,7 @@ async function createPREvents(options, request) {
         })
     );
 
-    const events = await startEvents(eventConfigs, eventFactory);
+    const events = await startEvents(eventConfigs, request.server);
 
     return events;
 }
@@ -944,23 +945,15 @@ function pullRequestEvent(pluginOptions, request, h, parsed, token) {
 /**
  * Create events for each pipeline
  * @async   createEvents
- * @param   {EventFactory}       eventFactory       To create event
- * @param   {UserFactory}        userFactory        To get user permission
- * @param   {PipelineFactory}    pipelineFactory    To use scm module
- * @param   {Array}              pipelines          The pipelines to start events
- * @param   {Object}             parsed             It has information to create event
+ * @param   {Object}            server
+ * @param   {UserFactory}       userFactory         To get user permission
+ * @param   {PipelineFactory}   pipelineFactory     To use scm module
+ * @param   {Array}             pipelines           The pipelines to start events
+ * @param   {Object}            parsed              It has information to create event
  * @param   {String}            [skipMessage]       Message to skip starting builds
  * @returns {Promise}                               Promise that resolves into events
  */
-async function createEvents(
-    eventFactory,
-    userFactory,
-    pipelineFactory,
-    pipelines,
-    parsed,
-    skipMessage,
-    scmConfigFromHook
-) {
+async function createEvents(server, userFactory, pipelineFactory, pipelines, parsed, skipMessage, scmConfigFromHook) {
     const { action, branch, sha, username, scmContext, changedFiles, type, releaseName, ref } = parsed;
 
     const pipelineTuples = await Promise.all(
@@ -1101,7 +1094,7 @@ async function createEvents(
         })
     );
 
-    const events = await startEvents(eventConfigs, eventFactory);
+    const events = await startEvents(eventConfigs, server);
 
     return events;
 }
@@ -1117,7 +1110,7 @@ async function createEvents(
  * @param  {String}             [skipMessage]          Message to skip starting builds
  */
 async function pushEvent(request, h, parsed, skipMessage, token) {
-    const { eventFactory, pipelineFactory, userFactory } = request.server.app;
+    const { pipelineFactory, userFactory } = request.server.app;
     const { hookId, checkoutUrl, branch, scmContext, type, action, changedFiles, releaseName, ref } = parsed;
 
     const fullCheckoutUrl = `${checkoutUrl}#${branch}`;
@@ -1154,7 +1147,7 @@ async function pushEvent(request, h, parsed, skipMessage, token) {
             request.log(['webhook', hookId], `Skipping since Pipeline ${fullCheckoutUrl} does not exist`);
         } else {
             events = await createEvents(
-                eventFactory,
+                request.server,
                 userFactory,
                 pipelineFactory,
                 pipelines,