@ckeditor/ckeditor5-dev-ci 38.2.1 → 38.3.0

package/bin/circle-workflow-notifier.js

@@ -0,0 +1,109 @@
+#!/usr/bin/env node
+
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* eslint-env node */
+
+'use strict';
+
+const { execSync } = require( 'child_process' );
+const fetch = require( 'node-fetch' );
+const minimist = require( 'minimist' );
+const processJobStatuses = require( '../lib/process-job-statuses' );
+
+// This script allows the creation of a new job within a workflow that will be executed
+// in the end, when all other jobs will be finished or errored.
+//
+// Below, you can find an example workflow.
+//
+//   ┌─────┐     ┌─────┐
+//   │Job A├────►│Job B├──────────┐
+//   └─────┘     └─────┘          ▼
+//                           ┌────────┐
+//                           │Notifier│
+//                           └────────┘
+//   ┌─────┐                      ▲
+//   │Job C├──────────────────────┘
+//   └─────┘
+//
+// Job A triggers Job B, and Job C has no dependencies. When all jobs are done, we would like to execute Notifier.
+//
+// The Notifier job should also be executed when Job A ends with an error. In such a case, Job B is still blocked.
+// Hence, we need to iterate over all jobs and verify if their dependencies ended with an error to unlock
+// executing the final part of the workflow.
+
+const {
+	/**
+	 * Required. CircleCI API token used for obtaining data about the build from API.
+	 */
+	CKE5_CIRCLE_TOKEN,
+
+	// Variables that are available by default in Circle environment.
+	CIRCLE_WORKFLOW_ID,
+	CIRCLE_JOB
+} = process.env;
+
+const { task } = parseArguments( process.argv.slice( 2 ) );
+
+waitForOtherJobsAndSendNotification()
+	.catch( err => {
+		console.error( err );
+
+		process.exit( 1 );
+	} );
+
+async function waitForOtherJobsAndSendNotification() {
+	const jobs = processJobStatuses(
+		await getOtherJobsData()
+	);
+
+	const workflowFinished = jobs.every( job => [ 'success', 'failed', 'failed_parent' ].includes( job.status ) );
+	const anyJobsFailed = jobs.some( job => job.status === 'failed' );
+
+	if ( !workflowFinished ) {
+		await new Promise( r => setTimeout( r, 30 * 1000 ) );
+
+		return waitForOtherJobsAndSendNotification();
+	}
+
+	if ( anyJobsFailed ) {
+		return execSync( task, { stdio: 'inherit' } );
+	}
+
+	console.log( 'All jobs were successful.' );
+}
+
+/**
+ * Fetches and returns data of all jobs except the one where this script runs.
+ */
+async function getOtherJobsData() {
+	const url = `https://circleci.com/api/v2/workflow/${ CIRCLE_WORKFLOW_ID }/job`;
+	const options = { headers: { 'Circle-Token': CKE5_CIRCLE_TOKEN } };
+
+	const response = await fetch( url, options );
+	const data = await response.json();
+
+	return data.items.filter( job => job.name !== CIRCLE_JOB );
+}
+
+/**
+ * @param {Array.<String>} args
+ * @returns {Object} result
+ * @returns {String} result.task
+ */
+function parseArguments( args ) {
+	const config = {
+		string: [
+			'task'
+		],
+
+		default: {
+			task: 'yarn ckeditor5-dev-ci-notify-circle-status'
+		}
+	};
+
+	return minimist( args, config );
+}

package/bin/notify-circle-status.js

@@ -7,8 +7,9 @@
 
 /* eslint-env node */
 
-const formatMessage = require( '../lib/format-message' );
+const fetch = require( 'node-fetch' );
 const slackNotify = require( 'slack-notify' );
+const formatMessage = require( '../lib/format-message' );
 
 // This script assumes that is being executed on Circle CI.
 // Step it is used on should have set value: `when: on_fail`, since it does not

package/lib/process-job-statuses.js

@@ -0,0 +1,93 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+/**
+ * The function aims to determine a proper build status for children's jobs based on their parent's statuses.
+ *
+ * For example, in the following workflow:
+ *
+ * ┌────┐     ┌────┐
+ * │Id 1├────►│Id 2│
+ * └────┘     └────┘
+ *
+ * If the "Id 1" job is marked as failed, the "Id 2" job should be kept, too (it will never start due to an error in the parent task).
+ *
+ * @param {Array.<WorkflowJob>} jobs
+ * @returns {Array.<WorkflowJob>}
+ */
+module.exports = function processJobStatuses( jobs ) {
+	// To avoid modifying the original object, let's clone.
+	const jobsClone = clone( jobs );
+
+	// Find jobs to mark as "failed" based on their relationship.
+	const jobsToProcess = jobsClone
+		.filter( job => {
+			// Ignore job with no dependencies.
+			if ( !job.dependencies.length ) {
+				return false;
+			}
+
+			// If the job is already marked as failed, ignore it, too.
+			if ( isJobFailed( job ) ) {
+				return false;
+			}
+
+			// Verify if the job is a descant child of any failed job.
+			const dependencies = job.dependencies
+				.map( parentJobId => jobsClone.find( job => job.id === parentJobId ) )
+				.filter( parentJob => isJobFailed( parentJob ) );
+
+			// If so, save the job to process.
+			return dependencies.length;
+		} );
+
+	for ( const job of jobsToProcess ) {
+		job.status = 'failed_parent';
+	}
+
+	// Whenever a job has been changed, we need to iterate over all jobs again to verify the remaining jobs.
+	if ( jobsToProcess.length ) {
+		return processJobStatuses( jobsClone );
+	}
+
+	return jobsClone;
+};
+
+/**
+ * @param {WorkflowJob} job
+ * @returns {Boolean}
+ */
+function isJobFailed( job ) {
+	if ( job.status === 'failed' ) {
+		return true;
+	}
+
+	if ( job.status === 'failed_parent' ) {
+		return true;
+	}
+
+	return false;
+}
+
+/**
+ * @template T
+ * @param {T} obj
+ * @returns {T}
+ */
+function clone( obj ) {
+	return JSON.parse( JSON.stringify( obj ) );
+}
+
+/**
+ * @typedef {Object} WorkflowJob
+ *
+ * @property {String} id
+ *
+ * @property {'blocked'|'running'|'failed'|'failed_parent'|'success'} status
+ *
+ * @property {Array.<String>} dependencies
+ */

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@ckeditor/ckeditor5-dev-ci",
-  "version": "38.2.1",
-  "description": "Utils for CKEditor5 CI builds.",
+  "version": "38.3.0",
+  "description": "Utils used on various Continuous Integration services.",
   "keywords": [],
   "dependencies": {
+    "minimist": "^1.2.5",
     "node-fetch": "^2.6.7",
     "slack-notify": "^2.0.6"
   },
@@ -17,7 +18,8 @@
   ],
   "bin": {
     "ckeditor5-dev-ci-notify-travis-status": "bin/notify-travis-status.js",
-    "ckeditor5-dev-ci-notify-circle-status": "bin/notify-circle-status.js"
+    "ckeditor5-dev-ci-notify-circle-status": "bin/notify-circle-status.js",
+    "ckeditor5-dev-ci-circle-workflow-notifier": "bin/circle-workflow-notifier.js"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",