@ckeditor/ckeditor5-dev-ci 32.0.0

package/LICENSE.md

@@ -0,0 +1,16 @@
+Software License Agreement
+==========================
+
+Copyright (c) 2003-2022, [CKSource](http://cksource.com) Holding sp. z o.o. All rights reserved.
+
+Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
+
+Sources of Intellectual Property Included in CKEditor
+-----------------------------------------------------
+
+Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
+
+Trademarks
+----------
+
+**CKEditor** is a trademark of [CKSource](http://cksource.com) Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.

package/README.md

@@ -0,0 +1,20 @@
+CKEditor 5 CI utilities
+=======================
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-dev-ci.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-ci)
+[![Build Status](https://travis-ci.com/ckeditor/ckeditor5-dev.svg?branch=master)](https://app.travis-ci.com/github/ckeditor/ckeditor5-dev)
+![Dependency Status](https://img.shields.io/librariesio/release/npm/@ckeditor/ckeditor5-dev-ci)
+
+Utils for [CKEditor 5](https://ckeditor.com) CI builds.
+
+Contains tools for sending Slack notifications by Travis.
+
+More information about development tools packages can be found at the following URL: <https://github.com/ckeditor/ckeditor5-dev>.
+
+## Changelog
+
+See the [`CHANGELOG.md`](https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-ci/CHANGELOG.md) file.
+
+## License
+
+Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file.

package/bin/notifytravisstatus.js

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* eslint-env node */
+
+// This script assumes that is being executed on Travis CI. It requires following environment variables:
+//
+// - SLACK_WEBHOOK_URL - a URL where the notification should be sent
+// - START_TIME - POSIX time (when the script has begun the job)
+// - END_TIME - POSIX time (when the script has finished the job)
+// - GITHUB_TOKEN - token to a Github account with the scope: "repos". It is requires for obtaining an author of
+//   the commit if the build failed. The repository can be private and we can't use the public API.
+//
+// If the `SLACK_NOTIFY_COMMIT_URL` environment variable is defined, the script use the URL as the commit URL.
+// Otherwise, a marge of variables `TRAVIS_REPO_SLUG` and `TRAVIS_COMMIT` will be used.
+//
+// Pinging an author of the commit can be disabled by defining the `SLACK_NOTIFY_HIDE_AUTHOR` environment variable
+// to `"true"` (`SLACK_NOTIFY_HIDE_AUTHOR="true"`). See: https://github.com/ckeditor/ckeditor5/issues/9252.
+//
+// In order to enable the debug mode, set the `DEBUG=true` as the environment variable.
+
+const buildBranch = process.env.TRAVIS_BRANCH;
+
+const ALLOWED_BRANCHES = [
+	'stable',
+	'master'
+];
+
+const ALLOWED_EVENTS = [
+	'push',
+	'cron',
+	'api'
+];
+
+// Send a notification only for main branches...
+if ( !ALLOWED_BRANCHES.includes( buildBranch ) ) {
+	printDebugLog( `Aborting due to an invalid branch (${ buildBranch }).` );
+
+	process.exit();
+}
+
+// ...and an event that triggered the build is correct...
+if ( !ALLOWED_EVENTS.includes( process.env.TRAVIS_EVENT_TYPE ) ) {
+	printDebugLog( `Aborting due to an invalid event type (${ process.env.TRAVIS_EVENT_TYPE }).` );
+
+	process.exit();
+}
+
+// ...and for builds that failed.
+if ( process.env.TRAVIS_TEST_RESULT == 0 ) {
+	printDebugLog( 'The build did not fail. The notification will not be sent.' );
+
+	process.exit();
+}
+
+const notifyTravisStatus = require( '../lib/notifytravisstatus' );
+
+const options = {
+	repositorySlug: process.env.TRAVIS_REPO_SLUG,
+	startTime: parseInt( process.env.START_TIME ),
+	endTime: parseInt( process.env.END_TIME ),
+	githubToken: process.env.GITHUB_TOKEN,
+	slackWebhookUrl: process.env.SLACK_WEBHOOK_URL,
+	branch: buildBranch,
+	commit: process.env.TRAVIS_COMMIT,
+	notifyCommitUrl: process.env.SLACK_NOTIFY_COMMIT_URL,
+	shouldHideAuthor: process.env.SLACK_NOTIFY_HIDE_AUTHOR === 'true',
+	jobUrl: process.env.TRAVIS_JOB_WEB_URL,
+	jobId: process.env.TRAVIS_JOB_NUMBER
+};
+
+notifyTravisStatus( options )
+	.catch( error => {
+		console.error( error );
+
+		throw error;
+	} );
+
+/**
+ * @param {String} message
+ */
+function printDebugLog( message ) {
+	if ( process.env.DEBUG == 'true' ) {
+		console.log( '[Slack Notification]', message );
+	}
+}

package/lib/index.js

@@ -0,0 +1,12 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const notifyTravisStatus = require( './notifytravisstatus' );
+
+module.exports = {
+	notifyTravisStatus
+};

package/lib/members.json

@@ -0,0 +1,34 @@
+{
+  "Acrophost": "U03RMNJJUAG",
+  "AnnaTomanek": "U044RC5NQ",
+  "apadol-cksource": "U03HB5SSYCS",
+  "arkflpc": "U027XSCTX09",
+  "Comandeer": "U0BK6HSJJ",
+  "DawidKossowski": "U0401V31S9M",
+  "dufipl": "U02SG0U25GS",
+  "Dumluregn": "UGG2JE7JR",
+  "FilipTokarski": "URSK5KV9V",
+  "godai78": "U017DJLU7NX",
+  "gorzelinski": "U04DJ7BKSKU",
+  "illia-stv": "U048K896SCE",
+  "jacekbogdanski": "U8LAY97DE",
+  "kbinieda": "U0401V2TGG7",
+  "ldrobnik": "U04DJ7B7ZCJ",
+  "LukaszGudel": "U01FRHAT8T1",
+  "mabryl": "U045033D401",
+  "Mgsy": "U5A38S2PN",
+  "martnpaneq": "U045B560E00",
+  "mlewand": "U03UQQ1N3",
+  "mmotyczynska": "U02NSTQCTB8",
+  "mremiszewski": "U04ACUBMDGT",
+  "niegowski": "U01017YC7C7",
+  "oleq": "U03UU2MNN",
+  "pomek": "U1D6HMH5M",
+  "przemyslaw-zan": "U023HF765MK",
+  "psmyrek": "U01BJRWJCSJ",
+  "pszczesniak": "U04167FKV88",
+  "Reinmar": "U03UQRP0C",
+  "scofalik": "U05611ZMM",
+  "wwalc": "U03UQQ8PY",
+  "CKTravisBot": "CKTravisBot"
+}

package/lib/notifytravisstatus.js

@@ -0,0 +1,213 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+// A map that translates GitHub accounts to Slack ids.
+const members = require( './members.json' );
+
+const REPOSITORY_REGEXP = /github\.com\/([^/]+)\/([^/]+)/;
+
+const fetch = require( 'node-fetch' );
+const slackNotify = require( 'slack-notify' );
+
+/**
+ * @param {Object} options
+ * @param {String} options.repositorySlug
+ * @param {Number} options.startTime
+ * @param {Number} options.endTime
+ * @param {String} options.githubToken
+ * @param {String} options.slackWebhookUrl
+ * @param {String} options.branch
+ * @param {String} options.commit
+ * @param {String} options.notifyCommitUrl
+ * @param {Boolean} options.shouldHideAuthor
+ * @param {String} options.jobUrl
+ * @param {String} options.jobId
+ * @returns {Promise}
+ */
+module.exports = async function notifyTravisStatus( options ) {
+	const commitUrl = getCommitUrl( {
+		commit: options.commit,
+		notifyCommitUrl: options.notifyCommitUrl,
+		repositorySlug: options.repositorySlug
+	} );
+	const commitDetails = await getCommitDetails( commitUrl, options.githubToken );
+
+	const [ buildRepoOwner, buildRepoName ] = options.repositorySlug.split( '/' );
+	const execTime = getExecutionTime( options.endTime, options.startTime );
+
+	const slackAccount = members[ commitDetails.author ];
+	const shortCommit = commitUrl.split( '/' ).pop().substring( 0, 7 );
+	const repoMatch = commitUrl.match( REPOSITORY_REGEXP );
+
+	const slack = slackNotify( options.slackWebhookUrl );
+
+	slack.onError = err => {
+		console.log( 'API error occurred:', err );
+	};
+
+	return slack.send( {
+		username: 'Travis CI',
+		text: getNotifierMessage( {
+			slackAccount,
+			githubAccount: commitDetails.author,
+			shouldHideAuthor: options.shouldHideAuthor
+		} ),
+		icon_url: 'https://a.slack-edge.com/66f9/img/services/travis_36.png',
+		unfurl_links: 1,
+		attachments: [
+			{
+				color: 'danger',
+				fields: [
+					{
+						title: 'Repository (branch)',
+						value: [
+							`<https://github.com/${ buildRepoOwner }/${ buildRepoName }|${ buildRepoName }>`,
+							`(<https://github.com/${ buildRepoOwner }/${ buildRepoName }/tree/${ options.branch }|${ options.branch }>)`
+						].join( ' ' ),
+						short: true
+					},
+					{
+						title: 'Commit',
+						value: `<${ commitUrl }|${ shortCommit }>`,
+						short: true
+					},
+					{
+						title: 'Build number',
+						value: `<${ options.jobUrl }|#${ options.jobId }>`,
+						short: true
+					},
+					{
+						title: 'Build time',
+						value: `${ execTime.mins } min ${ execTime.secs } sec`,
+						short: true
+					},
+					{
+						title: 'Commit message',
+						value: getFormattedMessage( commitDetails.message, repoMatch[ 1 ], repoMatch[ 2 ] ),
+						short: false
+					}
+				]
+			}
+		]
+	} );
+};
+
+/**
+ * Returns an object that compares two dates.
+ *
+ * @param {Number} endTime
+ * @param {Number} startTime
+ * @returns {Object}
+ */
+function getExecutionTime( endTime, startTime ) {
+	const execTime = {
+		ms: endTime - startTime
+	};
+
+	execTime.days = Math.floor( execTime.ms / 86400 );
+	execTime.hours = Math.floor( ( execTime.ms - 86400 * execTime.days ) / 3600 );
+	execTime.mins = Math.floor( ( ( execTime.ms - 86400 * execTime.days ) - 3600 * execTime.hours ) / 60 );
+	execTime.secs = ( ( execTime.ms - 86400 * execTime.days ) - 3600 * execTime.hours ) - 60 * execTime.mins;
+
+	return execTime;
+}
+
+/**
+ * Replaces `#Id` and `Repo/Owner#Id` with URls to Github Issues.
+ *
+ * @param {String} message
+ * @param {String} repoOwner
+ * @param {String} repoName
+ * @returns {string}
+ */
+function getFormattedMessage( message, repoOwner, repoName ) {
+	return message
+		.replace( / #(\d+)/g, ( _, issueId ) => {
+			return ` <https://github.com/${ repoOwner }/${ repoName }/issues/${ issueId }|#${ issueId }>`;
+		} )
+		.replace( /([\w-]+\/[\w-]+)#(\d+)/g, ( _, repoSlug, issueId ) => {
+			return `<https://github.com/${ repoSlug }/issues/${ issueId }|${ repoSlug }#${ issueId }>`;
+		} );
+}
+
+/**
+ * Returns a URL to the commit details on GitHub.
+ *
+ * @param {Object} options
+ * @param {String} options.notifyCommitUrl
+ * @param {String} options.repositorySlug
+ * @param {String} options.commit
+ * @returns {String}
+ */
+function getCommitUrl( options ) {
+	if ( options.notifyCommitUrl ) {
+		return options.notifyCommitUrl;
+	}
+
+	return `https://github.com/${ options.repositorySlug }/commit/${ options.commit }`;
+}
+
+/**
+ * Returns a URL to GitHub API which returns details of the commit that caused the CI to fail its job.
+ *
+ * @param {String} commitUrl The URL to the commit on GitHub.
+ * @returns {String}
+ */
+function getGithubApiUrl( commitUrl ) {
+	return commitUrl.replace( 'github.com/', 'api.github.com/repos/' ).replace( '/commit/', '/commits/' );
+}
+
+/**
+ * Returns a promise that resolves the commit details (author and message) based on the specified GitHub URL.
+ *
+ * @param {String} commitUrl The URL to the commit on GitHub.
+ * @param {String} githubToken Github token used for authorization a request,
+ * @returns {Promise.<Object>}
+ */
+function getCommitDetails( commitUrl, githubToken ) {
+	const apiGithubUrlCommit = getGithubApiUrl( commitUrl );
+	const options = {
+		method: 'GET',
+		credentials: 'include',
+		headers: {
+			authorization: `token ${ githubToken }`
+		}
+	};
+
+	return fetch( apiGithubUrlCommit, options )
+		.then( response => response.json() )
+		.then( json => ( {
+			author: json.author.login,
+			message: json.commit.message
+		} ) );
+}
+
+/**
+ * Returns the additional message that will be added to the notifier post.
+ *
+ * @param {Object} options
+ * @param {Boolean} options.shouldHideAuthor
+ * @param {String} options.slackAccount
+ * @param {String} options.githubAccount
+ * @returns {String}
+ */
+function getNotifierMessage( options ) {
+	if ( options.shouldHideAuthor ) {
+		return '_The author of the commit was hidden. <https://github.com/ckeditor/ckeditor5/issues/9252|Read more about why.>_';
+	}
+
+	if ( !options.slackAccount ) {
+		return '_The author of the commit could not be obtained._';
+	}
+
+	// Slack and GitHub names for bots are equal.
+	if ( options.slackAccount === options.githubAccount ) {
+		return '_This commit is a result of merging a branch into another branch._';
+	}
+
+	return `<@${ options.slackAccount }>, could you take a look?`;
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@ckeditor/ckeditor5-dev-ci",
+  "version": "32.0.0",
+  "description": "Utils for CKEditor5 CI builds.",
+  "keywords": [],
+  "dependencies": {
+    "node-fetch": "^2.6.7",
+    "slack-notify": "^0.1.7"
+  },
+  "engines": {
+    "node": ">=14.0.0",
+    "npm": ">=5.7.1"
+  },
+  "files": [
+    "bin",
+    "lib"
+  ],
+  "bin": {
+    "ckeditor5-dev-ci-notify-travis-status": "bin/notifytravisstatus.js"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://github.com/ckeditor/ckeditor5-dev/tree/master/packages/ckeditor5-dev-ci",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5-dev.git",
+    "directory": "packages/ckeditor5-dev-ci"
+  }
+}