@financial-times/n-myft-ui 33.1.0 → 34.0.0

package/toolkit/demoScripts/index.js

@@ -0,0 +1,77 @@
+const { Task, Hook } = require('@dotcom-tool-kit/types');
+const { spawn } = require('child_process');
+const { hookFork, waitOnExit } = require('@dotcom-tool-kit/logger');
+
+class ShExcutor extends Task {
+	async executeCommand (command, scriptPath, args = []) {
+		if (!command) {
+			throw new Error('Invalid command');
+		}
+
+		this.logger.info(`running sh script: ${command}`);
+		const deployChild = spawn(scriptPath, args, { shell: true });
+		hookFork(this.logger, command, deployChild);
+		return waitOnExit(command, deployChild);
+	}
+}
+
+class DemoBuilder extends ShExcutor {
+	async run () {
+		let command = process.argv[4];
+		if (!['demo-build', 'demo', 'static-demo'].includes(command)) {
+			command = 'demo-build';
+		}
+
+		return this.executeCommand(`build-demo: ${command}`, 'scripts/build-demo.sh', [command]);
+	}
+}
+
+class TranspileJsx extends ShExcutor {
+	async run () {
+		return this.executeCommand('transpile-jsx', 'scripts/transpile-jsx.sh');
+	}
+}
+
+class RunPa11yCi extends Task {
+	async run () {
+		let serverProcess;
+
+		const serverStartedPromise = new Promise((resolve, reject) => {
+			serverProcess = spawn('node', ['demos/app.js']);
+			hookFork(this.logger, 'server', serverProcess);
+
+			serverProcess.stdout.on('data', data => {
+				const message = data.toString();
+				if (message.includes('event: "EXPRESS_START"')) {
+					this.logger.info('Server started successfully.');
+					resolve();
+				}
+			});
+
+			serverProcess.on('error', error => {
+				reject(error);
+			});
+		});
+
+		await serverStartedPromise;
+
+		const pa11yProcess = spawn('pa11y-ci', ['--config', '.pa11yci.js']);
+		hookFork(this.logger, 'pa11y', pa11yProcess);
+
+		await waitOnExit('pa11y', pa11yProcess);
+
+		serverProcess.kill('SIGINT');
+		this.logger.info('Server and related processes stopped.');
+	}
+}
+class buildDemo extends Hook {
+	async check () {
+		return true;
+	}
+}
+
+exports.hooks = {
+	'build:demo': buildDemo,
+};
+
+exports.tasks = [ DemoBuilder, TranspileJsx, RunPa11yCi ];

package/toolkit/karma/index.js

@@ -0,0 +1,16 @@
+const { Task } = require('@dotcom-tool-kit/types');
+const { spawn } = require('child_process');
+const { hookFork, waitOnExit } = require('@dotcom-tool-kit/logger');
+const karmaCLIPath = require.resolve('karma/bin/karma');
+
+class Karma extends Task {
+	async run () {
+		const args = ['start', 'karma.conf.js'];
+		this.logger.info(`running karma ${args.join(' ')}`);
+		const child = spawn(karmaCLIPath, args);
+		hookFork(this.logger, 'karma', child);
+		return waitOnExit('karma', child);
+	}
+}
+
+exports.tasks = [ Karma ];

package/.circleci/shared-helpers/.github/settings.yml

@@ -1 +0,0 @@
-_extends: github-apps-config-next

package/.circleci/shared-helpers/CODEOWNERS

@@ -1,3 +0,0 @@
-# See https://help.github.com/articles/about-codeowners/ for more information about this file.
-
-* @financial-times/platforms

package/.circleci/shared-helpers/Makefile

@@ -1,5 +0,0 @@
-install:
-	@echo '#!/bin/sh\n\nnpx --package @financial-times/secret-squirrel@^2.9.0 secret-squirrel' > .git/hooks/pre-commit;
-	@echo '#!/bin/sh\n\nnpx --package @financial-times/secret-squirrel@^2.9.0 secret-squirrel-commitmsg' > .git/hooks/commit-msg;
-	@chmod +x .git/hooks/pre-commit .git/hooks/commit-msg;
-	@echo "Installed pre-commit and commit-msg .git/hooks for @financial-times/secret-squirrel";

package/.circleci/shared-helpers/README.md

@@ -1,72 +0,0 @@
-# Next CI Helper Scripts [![CircleCI](https://circleci.com/gh/Financial-Times/next-ci-shared-helpers.svg?style=svg&circle-token=33bcf2eb98fe2e875cc66de93d7e4a50369c952d)](https://github.com/Financial-Times/next-ci-shared-helpers)
-
-This repo contains a set of common bash scripts to be used in the delivery pipeline.
-
-
-## Installation
-
-```sh
-git clone git@github.com:Financial-Times/next-ci-shared-helpers.git
-cd next-ci-shared-helpers
-```
-
-
-## Development
-
-### Working locally
-
-Many of the scripts require a Unix environment so in order to run existing scripts you'll need to be familiar with [Docker](https://www.docker.com/get-started).
-
-The first step is to [install docker](https://www.docker.com/get-started) and once you're up and running you'll be able to run the scripts locally inside a Docker container.
-
-For example, the following command will run the `helper-install-awscli` script inside the container (this will output many logs but if it has worked correctly the last line on the console should read `Setting up awscli (1.11.13-1) ...`.
-
-```shell
-docker run --rm -it -w /tmp --mount type=bind,source="$(pwd)",destination=/tmp circleci/node:12.18-browsers ./helper-install-awscli
-```
-
-The command in the example can be largely re-used by simply changing the Docker image and script to run:
-
-```shell
-docker run --rm -it -w /tmp --mount type=bind,source="$(pwd)",destination=/tmp DOCKER_IMAGE_NAME ./SCRIPT_TO_RUN
-```
-
-
-### Usage
-
-To make use of this package in your CircleCI deployment pipeline, firstly create a new `step` and clone the package:
-
-```yaml
-- run:
-    name: Checkout next-ci-shared-helpers
-    command: git clone --depth 1 git@github.com:Financial-Times/next-ci-shared-helpers.git .circleci/shared-helpers
-```
-
-_The convention across all FT repos is to put the helpers inside the `.circleci/shared-helpers` folder._
-
-Then add another step after it to run one of the scripts:
-
-```yaml
-- run:
-    name: shared-helper / npm-install-peer-deps
-    command: .circleci/shared-helpers/helper-npm-install-peer-deps
-```
-
-_The convention across all FT repos is to name the step as follows: `shared-helper / NAME_OF_SCRIPT`._
-
-### General guidelines for helper scripts
-
-- Copy `helper.example` as a starting point
-- Avoid being "clever" - developers shouldn't require knowledge of obscure bash syntax to understand the helper scripts that you write
-- Comment liberally - help others (and your future self) understand *why* the helper script is doing the things it's doing
-- Include links to any relevant documentation in your comments
-- Try and avoid noisy output - it's hard to debug CI builds or understand what has happened if there are lots of unnecessary messages in the shell output
-- Echo out useful messages about progress and actions taken by the script - the flip side of avoiding noisy output: humans want to know what's happening/happened with their build
-- Remember to make your script executable by running the command `chmod +x ./<NAME_OF_SCRIPT>`
-
-### Naming guidelines
-
-The filename of a helper script should give a clear indication of what it does:
-
-- ❌ `helper-test`
-- ✅ `helper-run-mocha-tests`

package/.circleci/shared-helpers/helper-check-service-ready

@@ -1,37 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Checks availability of service containers
-
-# Set error handling
-set -eu -o pipefail
-
-DOCKERIZE_VERSION=v0.3.0
-
-if hash wget 2>/dev/null; then
-	wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz;
-elif hash curl 2>/dev/null; then
-	curl -XGET -L https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz --output dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz;
-else
-	echo 'wget or curl are required to run helper-check-service-ready'
-	exit 1
-fi
-mkdir -p ~/tmp
-tar -C ~/tmp -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
-rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
-
-for var in "$@"
-do
-    case $var in
-    redis)
-      ~/tmp/dockerize -wait tcp://localhost:6379 -timeout 1m
-      ;;
-    neo4j)
-      ~/tmp/dockerize -wait tcp://localhost:7687 -timeout 1m
-      ;;
-    mongo)
-      ~/tmp/dockerize -wait tcp://localhost:27017 -timeout 1m
-      ;;
-    esac
-done

package/.circleci/shared-helpers/helper-configure-awscli

@@ -1,20 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Configures the awscli tool with aws authentication keys
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-# provide keys as arguments when invoking the helper
-access_key_id="$1"
-secret_access_key="$2"
-
-# write the auth keys to .aws/credentials
-aws configure set aws_access_key_id "$access_key_id"
-aws configure set aws_secret_access_key "$secret_access_key"
-

package/.circleci/shared-helpers/helper-generate-build-state-artifacts

@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Generate artifacts that represent the state of
-# the build and can be used after the build has
-# run to aid with debugging
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-BUILD_STATE_DIR_PATH="build-state/"
-
-mkdir -p "${BUILD_STATE_DIR_PATH}";
-
-echo -e ">> You can find all build-state artifacts under the 'Artifacts' tab for this build\n";
-
-# artifact: npm-shrinkwrap.json
-npm shrinkwrap --loglevel=warn && mv npm-shrinkwrap.json "${BUILD_STATE_DIR_PATH}";
-echo ">> artifact: npm-shrinkwrap.json generated, saved";
-
-# artifact: npm-debug.log
-if [ -e npm-debug.log ]; then
-    mv npm-debug.log "${BUILD_STATE_DIR_PATH}";
-    echo ">> artifact: npm-debug.log exists, saved";
-fi

package/.circleci/shared-helpers/helper-install-awscli

@@ -1,14 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Installs the awscli tool
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-# install the awscli
-sudo apt-get install awscli

package/.circleci/shared-helpers/helper-install-puppeteer-deps

@@ -1,25 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Required for pupeteer on docker based CI
-# https://github.com/GoogleChrome/puppeteer/issues/290
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-sudo apt-get update
-
-sudo apt-get install -yq \
-    gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 \
-    libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 \
-    libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 \
-    libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 \
-    libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 \
-    libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates \
-    fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget
-
-# This is used in the request to the Change API made after deployments
-sudo apt-get install -yq jq

package/.circleci/shared-helpers/helper-npm-install-peer-deps

@@ -1,40 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-
-# Workaround for a bug in npm where it doesn't correctly
-# resolve conflicting peer dependencies.
-#
-# Parses errors for missing peer dependencies from
-# the output of `npm ls` and then pipes the package
-# names to `npm install`.
-#
-# Why we pass the flags we do to `npm install`:
-#
-# --no-package-lock - While we now use package-lock.json
-#   in our repos, skip package-lock.json in this instance
-#   as we don't want to accidentally modify the file
-#   for subsequent steps in the workflow, e.g cache keys
-#   and artefact generation.
-#
-# --no-save - We don't want to modify package.json as we
-#   use its checksum for some CI tasks e.g. naming node_module caches
-#
-
-# Set error handling
-#
-# Do *not* set `-o pipefail` as `npm ls --production --parseable`
-# will have an exit code of 1 when there are missing peer
-# dependencies, but that's what we're expecting to happen
-set -eu
-
-# HELPER COMMANDS
-
-if [ -e package.json ]; then
-
-    npm ls --production --parseable 2>&1 >/dev/null | \
-      sed -n -e 's/^npm ERR! peer dep missing: \(.*\),.*/\1/p' | \
-          xargs -I{} echo -n '"{}" ' | \
-            xargs npm install --no-package-lock --no-save
-
-fi

package/.circleci/shared-helpers/helper-npm-store-auth-token

@@ -1,14 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Store npmjs registry auth token so npm can authenticate with it
-# e.g. for `npm publish` (see `helper-npm-publish`)
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > ${HOME}/.npmrc

package/.circleci/shared-helpers/helper-npm-update

@@ -1,26 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Run npm update to ensure npm packages in node_modules are the latest.
-#
-# Why we pass the flags we do to `npm update`:
-#
-# --dev - Also update devDependencies
-#
-# --no-package-lock - While we now use package-lock.json 
-#   in our repos, skip package-lock.json in this instance 
-#   as we don't want to accidentally modify the file 
-#   for subsequent steps in the workflow, e.g cache keys 
-#   and artefact generation.
-#
-# --no-save - We don't want to modify package.json as we
-#   use its checksum for some CI tasks e.g. naming node_module caches
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-npm update --dev --no-package-lock --no-save

package/.circleci/shared-helpers/helper-npm-version-and-publish-public

@@ -1,19 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Bump package version and publicly publish to npm
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-PRERELEASE_IDENTIFIER="-[a-z-]+"
-RELEASE_TAG="latest"
-
-if [[ $CIRCLE_TAG =~ $PRERELEASE_IDENTIFIER ]]; then RELEASE_TAG="pre-release"; fi
-
-npm version --no-git-tag-version ${CIRCLE_TAG}
-npm publish --access public --tag=${RELEASE_TAG}

package/.circleci/shared-helpers/helper-publish-github-pages

@@ -1,43 +0,0 @@
-#!/usr/bin/env bash
-
-# HELPER PURPOSE
-#
-# Deploy to Github Pages
-# Your project should set the GITHUB_EMAIL, GITHUB_NAME and TARGET_DIR variables in Vault
-
-TARGET_BRANCH=gh-pages
-TEMP_DIR=tmp
-
-# Set error handling
-set -eu -o pipefail
-
-# Set GitHub user information (the email must match the SSH key provided to Circle)
-git config --global user.email $GITHUB_EMAIL
-git config --global user.name $GITHUB_NAME
-
-# HACK: Add GitHub to known hosts to avoid an interactive prompt when cloning over SSH
-mkdir -p ~/.ssh
-ssh-keyscan -H github.com >> ~/.ssh/known_hosts
-
-# Clone only the branch we need so we don't download all of the project history
-git clone $CIRCLE_REPOSITORY_URL $TEMP_DIR --single-branch --branch $TARGET_BRANCH
-
-# Remove all of the files, -q prevents logging every filename
-cd $TEMP_DIR
-git rm -rf .
-cd ..
-
-# Copy contents of target directory to the deployment directory
-cp -R -L $TARGET_DIR $TEMP_DIR
-
-# Copy CI config (which should instruct Circle to ignore this branch)
-cp -r .circleci $TEMP_DIR
-
-cd $TEMP_DIR
-
-# Stage and commit all of the files
-git add -A &> /dev/null
-git commit -m "Automated deployment to GitHub Pages: ${CIRCLE_SHA1}" --allow-empty
-
-# Push to the target branch, staying quiet unless something goes wrong
-git push -q origin $TARGET_BRANCH

package/.circleci/shared-helpers/helper-setup-heroku-cli

@@ -1,46 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Download heroku-cli tool, config auth with .netrc
-#
-# Based on standalone script from https://devcenter.heroku.com/articles/heroku-cli#standalone-installation
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-# Install Heroku CLI
-wget https://cli-assets.heroku.com/channels/stable/heroku-linux-x64.tar.gz
-sudo mkdir -p /usr/local/lib /usr/local/bin
-sudo tar -xzf heroku-linux-x64.tar.gz -C /usr/local/lib
-sudo ln -s /usr/local/lib/heroku/bin/heroku /usr/local/bin/heroku
-
-# Output heroku-cli version so user can see in
-# build log what version is being used
-heroku --version
-
-# Heroku Repo plugin allows us to clear the git repo, so we can force deploys on circle rebuild
-heroku plugins:install heroku-repo
-
-# Heroku CLI Authentication - Netrc file format
-# https://devcenter.heroku.com/articles/authentication#netrc-file-format
-
-cat > ~/.netrc << EOF
-machine api.heroku.com
-	login $HEROKU_LOGIN
-	password $HEROKU_AUTH_TOKEN
-
-machine git.heroku.com
-	login $HEROKU_LOGIN
-	password $HEROKU_AUTH_TOKEN
-
-machine code.heroku.com
-	login $HEROKU_LOGIN
-	password $HEROKU_AUTH_TOKEN
-EOF
-
-# Set umask - owner r+w only
-chmod 0600 ~/.netrc

package/.circleci/shared-helpers/helper-setup-s3-upload

@@ -1,17 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Download s3up for uploading files to Amazon S3 buckets
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-# Install S3UP binary
-sudo mkdir -p /usr/local/bin
-
-sudo curl -sfL https://github.com/matthew-andrews/s3up/releases/download/v1.0.5/s3up_linux_386 -o /usr/local/bin/s3up
-sudo chmod +x /usr/local/bin/s3up

package/.circleci/shared-helpers/helper-upload-assets-to-s3

@@ -1,69 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# Uploads the compressed assets generated by apps using Page kit to S3
-#
-# This helper will be executed in place of the current deploy-hashed-assets
-# command in n-heroku-tools for all apps that are using Page Kit.
-#
-# It uploads JavaScipt, CSS, sourcemaps and compressed files to the EU and US
-# regions, making the assets available to our CDN layer.
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-
-SOURCE_FOLDER=${1:-"public"}
-DESTINATION_FOLDER=${2:-"hashed-assets/uploads"}
-DESTINATION_BUCKET_EU="ft-next-hashed-assets-prod"
-DESTINATION_BUCKET_US="ft-next-hashed-assets-prod-us"
-
-upload_file() {
-	local FILE="$1"
-	local BASENAME=$(basename $FILE)
-	local DESTINATION_BUCKET="$2"
-	local ENCODING="identity"
-	local TYPE
-
-	if [[ "$FILE" == *".gz" ]]; then
-		ENCODING="gzip"
-	elif [[ "$FILE" == *".br" ]]; then
-		ENCODING="br"
-	fi
-
-	# the AWS CLI can guess content types but not the original type of compressed files
-	# <https://github.com/aws/aws-cli/issues/3817>
-	case "$FILE" in
-		*".js"|*".js.gz"|*".js.br")
-			TYPE="application/javascript"
-			;;
-		*".css"|*".css.gz"|*".css.br")
-			TYPE="text/css"
-			;;
-		*".map")
-			TYPE="application/octet-stream"
-			;;
-	esac
-
-	aws s3 cp $FILE "s3://$DESTINATION_BUCKET/$DESTINATION_FOLDER/$BASENAME" \
-		--cache-control=31536000 \
-		--content-type="$TYPE; charset=utf-8" \
-		--content-encoding="$ENCODING" \
-		--acl="public-read"
-}
-
-upload_files() {
-	local SOURCE_FILES=($(find $SOURCE_FOLDER/*.{js,css,gz,br,map} 2>/dev/null))
-
-	for FILE in ${SOURCE_FILES[@]}; do
-		# Uploading to both regions to remove the dependency on our AWS poller
-		upload_file "$FILE" $DESTINATION_BUCKET_EU
-		upload_file "$FILE" $DESTINATION_BUCKET_US
-	done
-}
-
-upload_files

package/.circleci/shared-helpers/helper.example

@@ -1,13 +0,0 @@
-#!/usr/bin/env bash
-#
-# HELPER PURPOSE
-#
-# TODO: Make this example a bit more useful
-#
-
-# Set error handling
-set -eu -o pipefail
-
-# HELPER COMMANDS
-
-# ...

package/.circleci/shared-helpers/secret-squirrel.js

@@ -1,25 +0,0 @@
-module.exports = {
-	files: {
-		allow: [
-			'helper-generate-build-state-artifacts',
-			'helper-configure-awscli',
-			'helper-install-awscli',
-			'helper-install-puppeteer-deps',
-			'helper-npm-install-peer-deps',
-			'helper-npm-store-auth-token',
-			'helper-npm-update',
-			'helper-check-service-ready',
-			'helper-npm-version-and-publish-public',
-			'helper-publish-github-pages',
-			'helper-setup-heroku-cli',
-			'helper-setup-s3-upload',
-			'helper-upload-assets-to-s3',
-			'helper.example'
-		],
-		allowOverrides: []
-	},
-	strings: {
-		deny: [],
-		denyOverrides: []
-	}
-};