screwdriver-api 8.0.10 → 8.0.11

package/package.json

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

package/plugins/builds/helper/updateBuild.js

@@ -135,18 +135,26 @@ async function getStage({ stageFactory, workflowGraph, jobName, pipelineId }) {
 }
 
 /**
- * Checks if all builds in stage are done running
+ * Get all builds in stage
  *
  * @param  {Stage}      stage   Stage
  * @param  {Event}      event   Event
- * @return {Boolean}            Flag if stage is done
+ * @return {Promise<Build[]>}   Builds in stage
  */
-async function isStageDone({ stage, event }) {
+async function getStageJobBuilds({ stage, event }) {
     // Get all jobIds for jobs in the stage
     const stageJobIds = [...stage.jobIds, stage.setup];
 
     // Get all builds in a stage for this event
-    const stageJobBuilds = await event.getBuilds({ params: { jobId: stageJobIds } });
+    return event.getBuilds({ params: { jobId: stageJobIds } });
+}
+
+/**
+ * Checks if all builds in stage are done running
+ * @param {Build[]} stageJobBuilds Builds in stage
+ * @returns {Boolean}              Flag if stage is done
+ */
+function isStageDone(stageJobBuilds) {
     let stageIsDone = false;
 
     if (stageJobBuilds && stageJobBuilds.length !== 0) {
@@ -292,10 +300,13 @@ async function updateBuildAndTriggerDownstreamJobs(config, build, server, userna
 
         // Start stage teardown build if stage is done
         if (stageTeardownBuild && stageTeardownBuild.status === 'CREATED') {
-            const stageIsDone = await isStageDone({ stage, event: newEvent });
+            const stageJobBuilds = await getStageJobBuilds({ stage, event: newEvent });
+            const stageIsDone = isStageDone(stageJobBuilds);
 
             if (stageIsDone) {
                 stageTeardownBuild.status = 'QUEUED';
+                stageTeardownBuild.parentBuildId = stageJobBuilds.map(b => b.id);
+
                 await stageTeardownBuild.update();
                 await stageTeardownBuild.start();
             }

package/plugins/builds/triggers/and.js

@@ -98,7 +98,6 @@ class AndTrigger extends JoinBase {
             nextBuild,
             nextJob,
             parentBuilds: newParentBuilds,
-            parentBuildId: this.currentBuild.id,
             joinListNames,
             isNextJobVirtual,
             nextJobStageName

package/plugins/builds/triggers/helpers.js

@@ -534,10 +534,9 @@ async function getBuildsForGroupEvent(groupEventId, buildFactory) {
  * @param {Object} arg
  * @param {ParentBuilds} arg.joinParentBuilds Parent builds object for join job
  * @param {Build} arg.nextBuild Next build
- * @param {Build} arg.build Build for current completed job
  * @returns {Promise<Build>} Updated next build
  */
-async function updateParentBuilds({ joinParentBuilds, nextBuild, build }) {
+async function updateParentBuilds({ joinParentBuilds, nextBuild }) {
     // Override old parentBuilds info
     const newParentBuilds = merge({}, joinParentBuilds, nextBuild.parentBuilds, (objVal, srcVal) =>
         // passthrough objects, else mergeWith mutates source
@@ -545,59 +544,69 @@ async function updateParentBuilds({ joinParentBuilds, nextBuild, build }) {
     );
 
     nextBuild.parentBuilds = newParentBuilds;
-    // nextBuild.parentBuildId may be int or Array, so it needs to be flattened
-    nextBuild.parentBuildId = Array.from(new Set([build.id, nextBuild.parentBuildId || []].flat()));
 
     return nextBuild.update();
 }
 
 /**
- * Check if all parent builds of the new build are done
- * @param {Object} arg
- * @param {Build} arg.newBuild Updated build
+ * Get builds in join list from parent builds
+ * @param {newBuild} arg.newBuild Updated build
  * @param {String[]} arg.joinListNames Join list names
  * @param {Number} arg.pipelineId Pipeline ID
  * @param {BuildFactory} arg.buildFactory Build factory
- * @returns {Promise<{hasFailure: Boolean, done: Boolean}>} Object with done and hasFailure statuses
+ * @returns {Promise<Map<String, Build>>} Join builds
  */
-async function getParentBuildStatus({ newBuild, joinListNames, pipelineId, buildFactory }) {
+async function getJoinBuilds({ newBuild, joinListNames, pipelineId, buildFactory }) {
     const upstream = newBuild.parentBuilds || {};
+    const joinBuilds = {};
 
-    // Get buildId
-    const joinBuildIds = joinListNames.map(name => {
+    for (const jobName of joinListNames) {
         let upstreamPipelineId = pipelineId;
-        let upstreamJobName = name;
+        let upstreamJobName = jobName;
 
-        if (isExternalTrigger(name)) {
-            const { externalPipelineId, externalJobName } = getExternalPipelineAndJob(name);
+        if (isExternalTrigger(upstreamJobName)) {
+            const { externalPipelineId, externalJobName } = getExternalPipelineAndJob(jobName);
 
             upstreamPipelineId = externalPipelineId;
             upstreamJobName = externalJobName;
         }
 
         if (upstream[upstreamPipelineId] && upstream[upstreamPipelineId].jobs[upstreamJobName]) {
-            return upstream[upstreamPipelineId].jobs[upstreamJobName];
+            const buildId = upstream[upstreamPipelineId].jobs[upstreamJobName];
+
+            const build = await buildFactory.get(buildId);
+
+            if (typeof build.endTime === 'string') {
+                build.endTime = new Date(build.endTime);
+            }
+
+            joinBuilds[jobName] = build;
         }
+    }
 
-        return undefined;
-    });
+    return joinBuilds;
+}
 
+/**
+ * Check if all parent builds of the new build are done
+ * @param {Object} arg
+ * @param {String[]} arg.joinListNames Join list names
+ * @param {String[]} arg.joinBuilds Join builds
+ * @returns {Promise<{hasFailure: Boolean, done: Boolean}>} Object with done and hasFailure statuses
+ */
+async function getParentBuildStatus({ joinListNames, joinBuilds }) {
     // If buildId is empty, the job hasn't executed yet and the join is not done
-    const isExecuted = !joinBuildIds.includes(undefined);
-
-    // Get the status of the builds
-    const buildIds = joinBuildIds.filter(buildId => buildId !== undefined);
-    const promisesToAwait = buildIds.map(buildId => buildFactory.get(buildId));
-    const joinedBuilds = await Promise.all(promisesToAwait);
+    const isExecuted = joinListNames.every(name => joinBuilds[name] !== undefined);
+    const parentBuilds = Object.values(joinBuilds);
 
-    const hasFailure = joinedBuilds
+    const hasFailure = parentBuilds
         .map(build => {
             // Do not need to run the next build; terminal status
             return [Status.FAILURE, Status.ABORTED, Status.COLLAPSED, Status.UNSTABLE].includes(build.status);
         })
         .includes(true);
 
-    const isDoneStatus = joinedBuilds.every(build => {
+    const isDoneStatus = parentBuilds.every(build => {
         // All builds are done
         return [Status.FAILURE, Status.SUCCESS, Status.ABORTED, Status.UNSTABLE, Status.COLLAPSED].includes(
             build.status
@@ -616,40 +625,40 @@ async function getParentBuildStatus({ newBuild, joinListNames, pipelineId, build
  *          if no failure, start new build
  * Otherwise, do nothing
  * @param {Object} arg If the build is done or not
- * @param {Boolean} arg.done If the build is done or not
- * @param {Boolean} arg.hasFailure If the build has a failure or not
+ * @param {String[]} arg.joinListNames Join list names
  * @param {Build} arg.newBuild Next 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
- * @param {Build} arg.currentBuild Current build
+ * @param {BuildFactory} arg.buildFactory Build factory
  * @returns {Promise<Build|null>} The newly updated/created build
  */
 async function handleNewBuild({
-    done,
-    hasFailure,
+    joinListNames,
     newBuild,
     job,
     pipelineId,
     stageName,
     isVirtualJob,
     event,
-    currentBuild
+    buildFactory
 }) {
-    if (!done || Status.isStarted(newBuild.status)) {
-        // The virtual job does not inherit metadata because the Launcher is not executed.
-        // Therefore, it is necessary to take over the metadata from the previous build.
-
-        // TODO There is a bug when virtual job requires [a, b] and if "a" and "b" are completed simultaneously.
-        // https://github.com/screwdriver-cd/screwdriver/issues/3287
-        if (isVirtualJob && !hasFreezeWindows(job)) {
-            newBuild.meta = merge({}, newBuild.meta, currentBuild.meta);
+    const joinBuilds = await getJoinBuilds({
+        newBuild,
+        joinListNames,
+        pipelineId,
+        buildFactory
+    });
 
-            await newBuild.update();
-        }
+    /* CHECK IF ALL PARENT BUILDS OF NEW BUILD ARE DONE */
+    const { hasFailure, done } = await getParentBuildStatus({
+        joinBuilds,
+        joinListNames
+    });
 
+    if (!done || Status.isStarted(newBuild.status)) {
         return null;
     }
 
@@ -668,14 +677,28 @@ async function handleNewBuild({
         return null;
     }
 
+    /* Prepare to execute the build */
+    const parentBuilds = Object.values(joinBuilds);
+
+    parentBuilds.sort((l, r) => {
+        if (l.endTime && r.endTime) {
+            return l.endTime.getTime() - r.endTime.getTime();
+        }
+
+        // Move to tail if endTime is not set
+        return (l.endTime ? 0 : 1) - (r.endTime ? 0 : 1);
+    });
+    newBuild.parentBuildId = parentBuilds.map(build => build.id);
+
     // Bypass execution of the build if the job is virtual
     if (isVirtualJob && !hasFreezeWindows(job)) {
         newBuild.status = Status.SUCCESS;
         newBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
         newBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
+
         // The virtual job does not inherit metadata because the Launcher is not executed.
         // Therefore, it is necessary to take over the metadata from the previous build.
-        newBuild.meta = merge({}, newBuild.meta, currentBuild.meta);
+        newBuild.meta = parentBuilds.reduce((acc, build) => merge(acc, build.meta), {});
 
         return newBuild.update();
     }
@@ -1015,38 +1038,6 @@ async function ensureStageTeardownBuildExists({
     }
 }
 
-/**
- * Get parentBuildId from parentBuilds object
- * @param {Object} arg
- * @param {ParentBuilds} arg.parentBuilds Builds that triggered this build
- * @param {String[]} arg.joinListNames Array of join job name
- * @param {Number} arg.pipelineId Pipeline ID
- * @returns {String[]} Array of parentBuildId
- */
-function getParentBuildIds({ currentBuildId, parentBuilds, joinListNames, pipelineId }) {
-    const parentBuildIds = joinListNames
-        .map(name => {
-            let parentBuildPipelineId = pipelineId;
-            let parentBuildJobName = name;
-
-            if (isExternalTrigger(name)) {
-                const { externalPipelineId, externalJobName } = getExternalPipelineAndJob(name);
-
-                parentBuildPipelineId = externalPipelineId;
-                parentBuildJobName = externalJobName;
-            }
-
-            if (parentBuilds[parentBuildPipelineId] && parentBuilds[parentBuildPipelineId].jobs[parentBuildJobName]) {
-                return parentBuilds[parentBuildPipelineId].jobs[parentBuildJobName];
-            }
-
-            return null;
-        })
-        .filter(Boolean); // Remove undefined or null values
-
-    return Array.from(new Set([currentBuildId, ...parentBuildIds]));
-}
-
 /**
  * Extract a current pipeline's next jobs from pipeline join data
  * (Next jobs triggered as external are not included)
@@ -1206,13 +1197,13 @@ module.exports = {
     getSameParentEvents,
     mergeParentBuilds,
     updateParentBuilds,
+    getJoinBuilds,
     getParentBuildStatus,
     handleNewBuild,
     ensureStageTeardownBuildExists,
     getBuildsForGroupEvent,
     createJoinObject,
     createExternalEvent,
-    getParentBuildIds,
     strToInt,
     createEvent,
     deleteBuild,

package/plugins/builds/triggers/joinBase.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const logger = require('screwdriver-logger');
-const { createInternalBuild, updateParentBuilds, getParentBuildStatus, handleNewBuild } = require('./helpers');
+const { createInternalBuild, updateParentBuilds, handleNewBuild } = require('./helpers');
 
 /**
  * @typedef {import('screwdriver-models').EventFactory} EventFactory
@@ -41,7 +41,6 @@ class JoinBase {
      * @param {Build} nextBuild
      * @param {Job} nextJob
      * @param {import('./helpers').ParentBuilds} parentBuilds
-     * @param {String} parentBuildId
      * @param {String[]} joinListNames
      * @param {Boolean} isNextJobVirtual
      * @param {String} nextJobStageName
@@ -53,7 +52,6 @@ class JoinBase {
         nextBuild,
         nextJob,
         parentBuilds,
-        parentBuildId,
         joinListNames,
         isNextJobVirtual,
         nextJobStageName
@@ -73,7 +71,7 @@ class JoinBase {
                 event, // this is the parentBuild for the next build
                 baseBranch: event.baseBranch || null,
                 parentBuilds,
-                parentBuildId,
+                parentBuildId: this.currentBuild.id,
                 start: false
             });
         } else {
@@ -90,24 +88,15 @@ class JoinBase {
             return null;
         }
 
-        /* CHECK IF ALL PARENT BUILDS OF NEW BUILD ARE DONE */
-        const { hasFailure, done } = await getParentBuildStatus({
-            newBuild,
-            joinListNames,
-            pipelineId,
-            buildFactory: this.buildFactory
-        });
-
         return handleNewBuild({
-            done,
-            hasFailure,
+            joinListNames,
             newBuild,
             job: nextJob,
             pipelineId,
             isVirtualJob: isNextJobVirtual,
             stageName: nextJobStageName,
             event,
-            currentBuild: this.currentBuild
+            buildFactory: this.buildFactory
         });
     }
 }

package/plugins/builds/triggers/orBase.js

@@ -56,12 +56,16 @@ class OrBase {
                 return nextBuild;
             }
 
+            nextBuild.parentBuildId = [this.currentBuild.id];
+
             // Bypass execution of the build if the job is virtual
             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.meta = merge({}, nextBuild.meta, this.currentBuild.meta);
+
+                // Overwrite metadata by current build's
+                nextBuild.meta = merge({}, this.currentBuild.meta);
 
                 return nextBuild.update();
             }
@@ -93,7 +97,9 @@ class OrBase {
             nextBuild.status = Status.SUCCESS;
             nextBuild.statusMessage = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessage;
             nextBuild.statusMessageType = BUILD_STATUS_MESSAGES.SKIP_VIRTUAL_JOB.statusMessageType;
-            nextBuild.meta = merge({}, nextBuild.meta, this.currentBuild.meta);
+
+            // Overwrite metadata by current build's
+            nextBuild.meta = merge({}, this.currentBuild.meta);
 
             await nextBuild.update();
         }

package/plugins/builds/triggers/remoteJoin.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { mergeParentBuilds, getParentBuildIds } = require('./helpers');
+const { mergeParentBuilds } = require('./helpers');
 const { JoinBase } = require('./joinBase');
 
 /**
@@ -45,20 +45,12 @@ class RemoteJoin extends JoinBase {
 
         const newParentBuilds = mergeParentBuilds(parentBuilds, groupEventBuilds, this.currentEvent, externalEvent);
 
-        const parentBuildId = getParentBuildIds({
-            currentBuildId: this.currentBuild.id,
-            parentBuilds: newParentBuilds,
-            joinListNames,
-            pipelineId: externalEvent.pipelineId
-        });
-
         return this.processNextBuild({
             pipelineId: externalEvent.pipelineId,
             event: externalEvent,
             nextBuild,
             nextJob,
             parentBuilds: newParentBuilds,
-            parentBuildId,
             joinListNames,
             isNextJobVirtual,
             nextJobStageName

package/plugins/jobs/buildCluster/update.js

@@ -74,7 +74,7 @@ module.exports = () => ({
 
             permutation.annotations = permutation.annotations || {};
 
-            const annotations = permutation.annotations;
+            const { annotations } = permutation;
 
             if (annotations[adminAnnotation]) {
                 logger.info(