screwdriver-api 7.0.254 → 7.0.255

package/package.json

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

package/plugins/builds/index.js

@@ -39,7 +39,8 @@ const {
     getParallelBuilds,
     isStartFromMiddleOfCurrentStage,
     Status,
-    getSameParentEvents
+    getSameParentEvents,
+    isVirtualJob
 } = require('./triggers/helpers');
 const { getFullStageJobName } = require('../helper');
 
@@ -97,7 +98,7 @@ async function triggerNextJobs(config, app) {
 
     for (const [nextJobName, nextJobInfo] of Object.entries(currentPipelineNextJobs)) {
         const nextJob = await getJob(nextJobName, currentPipeline.id, jobFactory);
-        const { isVirtual: isNextJobVirtual, stageName: nextJobStageName } = nextJobInfo;
+        const { stageName: nextJobStageName } = nextJobInfo;
         const resource = `pipeline:${currentPipeline.id}:groupEvent:${currentEvent.groupEventId}`;
         let lock;
         let nextBuild;
@@ -123,24 +124,12 @@ async function triggerNextJobs(config, app) {
                 isOrTrigger(currentEvent.workflowGraph, originalCurrentJobName, trimJobName(nextJobName)) ||
                 isStartFromMiddleOfCurrentStage(currentJob.name, currentEvent.startFrom, currentEvent.workflowGraph)
             ) {
-                nextBuild = await orTrigger.execute(
-                    currentEvent,
-                    currentPipeline.id,
-                    nextJob,
-                    parentBuilds,
-                    isNextJobVirtual
-                );
+                nextBuild = await orTrigger.execute(currentEvent, currentPipeline.id, nextJob, parentBuilds);
             } else {
-                nextBuild = await andTrigger.execute(
-                    nextJob,
-                    parentBuilds,
-                    joinListNames,
-                    isNextJobVirtual,
-                    nextJobStageName
-                );
+                nextBuild = await andTrigger.execute(nextJob, parentBuilds, joinListNames, nextJobStageName);
             }
 
-            if (isNextJobVirtual && nextBuild.status === Status.SUCCESS) {
+            if (isVirtualJob(nextJob) && nextBuild && nextBuild.status === Status.SUCCESS) {
                 downstreamOfNextJobsToBeProcessed.push({
                     build: nextBuild,
                     event: currentEvent,
@@ -285,7 +274,7 @@ async function triggerNextJobs(config, app) {
         if (externalEvent) {
             for (const [nextJobName, nextJobInfo] of Object.entries(joinedPipeline.jobs)) {
                 const nextJob = await getJob(nextJobName, joinedPipelineId, jobFactory);
-                const { isVirtual: isNextJobVirtual, stageName: nextJobStageName } = nextJobInfo;
+                const { stageName: nextJobStageName } = nextJobInfo;
 
                 const { parentBuilds } = parseJobInfo({
                     joinObj: joinedPipeline.jobs,
@@ -306,8 +295,7 @@ async function triggerNextJobs(config, app) {
                             externalEvent,
                             externalEvent.pipelineId,
                             nextJob,
-                            parentBuilds,
-                            isNextJobVirtual
+                            parentBuilds
                         );
                     } else {
                         // Re get join list when first time remote trigger since external event was empty and cannot get workflow graph then
@@ -323,12 +311,11 @@ async function triggerNextJobs(config, app) {
                             parentBuilds,
                             groupEventBuilds,
                             joinListNames,
-                            isNextJobVirtual,
                             nextJobStageName
                         );
                     }
 
-                    if (isNextJobVirtual && nextBuild.status === Status.SUCCESS) {
+                    if (isVirtualJob(nextJob) && nextBuild && nextBuild.status === Status.SUCCESS) {
                         downstreamOfNextJobsToBeProcessed.push({
                             build: nextBuild,
                             event: currentEvent,

package/plugins/builds/triggers/helpers.js

@@ -128,6 +128,28 @@ function isExternalTrigger(jobName) {
     return EXTERNAL_TRIGGER_ALL.test(jobName);
 }
 
+/**
+ * Checks if job is virtual
+ * @param {Job} job Job object
+ * @returns {Boolean}
+ */
+function isVirtualJob(job) {
+    const { annotations } = job.permutations[0];
+
+    return annotations ? annotations['screwdriver.cd/virtualJob'] === true : false;
+}
+
+/**
+ * Checks if job has freezeWindows
+ * @param {Job} job Job object
+ * @returns {Boolean}
+ */
+function hasFreezeWindows(job) {
+    const { freezeWindows } = job.permutations[0];
+
+    return freezeWindows ? freezeWindows.length > 0 : false;
+}
+
 /**
  * Get external pipelineId and job name from the `name`
  * @param {String} name Job name
@@ -611,11 +633,10 @@ async function getParentBuildStatus({ newBuild, joinListNames, pipelineId, build
  * @param {Job} arg.job Next job
  * @param {String|undefined} arg.pipelineId Pipeline ID
  * @param {String|undefined} arg.stageName Stage name
- * @param {Boolean} arg.isVirtualJob If the job is virtual or not
  * @param {Event} arg.event Event
  * @returns {Promise<Build|null>} The newly updated/created build
  */
-async function handleNewBuild({ done, hasFailure, newBuild, job, pipelineId, stageName, isVirtualJob, event }) {
+async function handleNewBuild({ done, hasFailure, newBuild, job, pipelineId, stageName, event }) {
     if (!done || Status.isStarted(newBuild.status)) {
         return null;
     }
@@ -636,9 +657,7 @@ async function handleNewBuild({ done, hasFailure, newBuild, job, pipelineId, sta
     }
 
     // Bypass execution of the build if the job is virtual
-    const hasFreezeWindows = job.permutations[0].freezeWindows && job.permutations[0].freezeWindows.length > 0;
-
-    if (isVirtualJob && !hasFreezeWindows) {
+    if (isVirtualJob(job) && !hasFreezeWindows(job)) {
         newBuild.status = Status.SUCCESS;
         newBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
         newBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
@@ -902,7 +921,6 @@ async function createJoinObject(nextJobNames, current, eventFactory) {
 
         const node = event.workflowGraph.nodes.find(n => n.name === trimJobName(jobName));
         const jId = node.id;
-        const isVirtual = node.virtual || false;
         const stageName = node.stageName || null;
 
         if (!joinObj[nextJobPipelineId]) joinObj[nextJobPipelineId] = {};
@@ -923,7 +941,7 @@ async function createJoinObject(nextJobNames, current, eventFactory) {
         }
 
         if (!pipelineObj.jobs) pipelineObj.jobs = {};
-        pipelineObj.jobs[nextJobName] = { id: jId, join: jobs, isExternal, isVirtual, stageName };
+        pipelineObj.jobs[nextJobName] = { id: jId, join: jobs, isExternal, stageName };
     }
 
     return joinObj;
@@ -1192,5 +1210,7 @@ module.exports = {
     buildsToRestartFilter,
     trimJobName,
     isStartFromMiddleOfCurrentStage,
+    isVirtualJob,
+    hasFreezeWindows,
     BUILD_STATUS_MESSAGES
 };

package/plugins/builds/triggers/joinBase.js

@@ -43,7 +43,6 @@ class JoinBase {
      * @param {import('./helpers').ParentBuilds} parentBuilds
      * @param {String} parentBuildId
      * @param {String[]} joinListNames
-     * @param {Boolean} isNextJobVirtual
      * @param {String} nextJobStageName
      * @returns {Promise<Build[]|null>}
      */
@@ -55,7 +54,6 @@ class JoinBase {
         parentBuilds,
         parentBuildId,
         joinListNames,
-        isNextJobVirtual,
         nextJobStageName
     }) {
         let newBuild;
@@ -104,7 +102,6 @@ class JoinBase {
             newBuild,
             job: nextJob,
             pipelineId,
-            isVirtualJob: isNextJobVirtual,
             stageName: nextJobStageName,
             event
         });

package/plugins/builds/triggers/orBase.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { createInternalBuild, Status, BUILD_STATUS_MESSAGES } = require('./helpers');
+const { createInternalBuild, Status, BUILD_STATUS_MESSAGES, isVirtualJob, hasFreezeWindows } = require('./helpers');
 
 /**
  * @typedef {import('screwdriver-models').BuildFactory} BuildFactory
@@ -38,18 +38,16 @@ class OrBase {
      * @param {Number} pipelineId
      * @param {Job} nextJob
      * @param {import('./helpers').ParentBuilds} parentBuilds
-     * @param {Boolean} isNextJobVirtual
      * @return {Promise<Build|null>}
      */
-    async trigger(event, pipelineId, nextJob, parentBuilds, isNextJobVirtual) {
+    async trigger(event, pipelineId, nextJob, parentBuilds) {
         let nextBuild = await this.buildFactory.get({
             eventId: event.id,
             jobId: nextJob.id
         });
 
-        const hasFreezeWindows =
-            nextJob.permutations[0].freezeWindows && nextJob.permutations[0].freezeWindows.length > 0;
-
+        const isNextJobVirtual = isVirtualJob(nextJob);
+        const hasWindows = hasFreezeWindows(nextJob);
         const causeMessage = nextJob.name === event.startFrom ? event.causeMessage : '';
 
         if (nextBuild !== null) {
@@ -58,7 +56,7 @@ class OrBase {
             }
 
             // Bypass execution of the build if the job is virtual
-            if (isNextJobVirtual && !hasFreezeWindows) {
+            if (isNextJobVirtual && !hasWindows) {
                 nextBuild.status = Status.SUCCESS;
                 nextBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
                 nextBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
@@ -84,17 +82,17 @@ class OrBase {
             baseBranch: event.baseBranch || null,
             parentBuilds,
             parentBuildId: this.currentBuild.id,
-            start: hasFreezeWindows || !isNextJobVirtual,
+            start: hasWindows || !isNextJobVirtual,
             causeMessage
         });
 
         // Bypass execution of the build if the job is virtual
-        if (isNextJobVirtual && !hasFreezeWindows) {
+        if (isNextJobVirtual && !hasWindows) {
             nextBuild.status = Status.SUCCESS;
             nextBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
             nextBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
 
-            nextBuild = nextBuild.update();
+            await nextBuild.update();
         }
 
         return nextBuild;