Implement logic as provided in Automattic/node-canvas#1582 (comment)

.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# This file is used to grant contributors the ability to make pushes to default branch if the merge request changes the defined paths only
+# Reference to configuration - https://github.blog/2017-07-06-introducing-code-owners/
+# Relevant https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+# Allow access to original creator of gitpod-1582.sh script
+full/scripts/gitpod-1520.sh   @kreyren

.github/workspaces/shell.yml

@@ -0,0 +1,73 @@
+name: Shell
+
+# Relevant to events - https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows
+on:
+  # Trigger the workflow on push to master
+  push:
+    branches:
+      - master
+    paths:
+      - '**.sh'
+  # Trigger the workflow on merge requests
+  pull_request:
+    types: [synchronize, opened, reopened, ready_for_review]
+    paths:
+    - '**.sh'
+
+jobs:
+  # Linting
+  lint:
+    runs-on: ubuntu-latest
+    container: debian:stable
+    steps:
+      - name: Installing dependencies..
+        run: |
+          # Sync repos
+          # Check for git
+          if ! apt list --installed 2>/dev/null | grep -qP "^git\/stable.*"; then
+            # Check if we can install git
+            if ! apt list | grep -qP "^git\/stable.*"; then
+              apt update
+            elif apt list | grep -qP "^git\/stable.*"; then
+              true
+            else
+              exit 255
+            fi
+            # Install git
+            apt install -y git
+          elif apt list --installed 2>/dev/null | grep -qP "^git\/stable.*"; then
+            true
+          else
+            exit 255
+          fi 
+          # Check for shellcheck
+          if ! apt list --installed 2>/dev/null | grep -qP "^shellcheck\s{1}-.*"; then
+            # Check if we can install shellcheck
+            if ! apt list | grep -qP "^shellcheck\s{1}-.*"; then
+              apt update
+            elif apt list | grep -qP "^shellcheck\s{1}-.*"; then
+              true
+            else
+              exit 255
+            fi
+            # Install shellcheck
+            apt install -y shellcheck
+          elif apt list --installed 2>/dev/null | grep -qP "^shellcheck\s{1}-.*"; then
+            true
+          else
+            exit 255
+          fi 
+      - name: Pulling git dir..
+        uses: actions/checkout@v2
+      - name: Processing files..
+        # Make sure that bash is used
+        shell: bash
+        run: |
+          cd "$GITHUB_WORKSPACE"
+
+          # Process files
+          ## NOTICE: Do not use for loop to avoid pitfall https://mywiki.wooledge.org/BashPitfalls#pf1
+          git --git-dir="$GITHUB_WORKSPACE/.git" ls-files -z -- '*.sh' | while IFS= read -rd '' file; do
+              printf 'linting shell file %s\n' "$file"
+              shellcheck --external-sources --shell=sh "$file"
+          done

full/Dockerfile

@@ -192,16 +192,13 @@ RUN curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh |
         && nvm install $NODE_VERSION \
         && nvm alias default $NODE_VERSION \
         && npm install -g npm typescript yarn" \
-    && echo ". ~/.nvm/nvm-lazy.sh"  >> /home/gitpod/.bashrc.d/50-node \
-    # Relevant issue https://github.com/gitpod-io/gitpod/issues/1520 - Requires these dependencies
-    && apt-get install -y \
-        build-essential \
-        libcairo2-dev \
-        libpango1.0-dev \
-        libjpeg8-dev \
-        libgif-dev \
-        librsvg2-dev
+    && echo ". ~/.nvm/nvm-lazy.sh"  >> /home/gitpod/.bashrc.d/50-node
 # above, we are adding the lazy nvm init to .bashrc, because one is executed on interactive shells, the other for non-interactive shells (e.g. plugin-host)
+# Relevant issue https://github.com/gitpod-io/gitpod/issues/1520
+COPY full/scripts/gitpod-1520.sh /usr/bin/gitpod-1520
+RUN true \
+  && chmod +x /usr/bin/gitpod-1520 \
+  && /usr/bin/gitpod-1520
 COPY --chown=gitpod:gitpod nvm-lazy.sh /home/gitpod/.nvm/nvm-lazy.sh
 ENV PATH=$PATH:/home/gitpod/.nvm/versions/node/v${NODE_VERSION}/bin
 

full/scripts/gitpod-1520.sh

@@ -0,0 +1,99 @@
+#!/bin/sh
+# Created by Jacob Hrbek <[email protected]> under GPLv3 <https://www.gnu.org/licenses/gpl-3.0.en.html> in 17/05/2020 based on informations from Zach Bjornson <[email protected]> in https://github.com/Automattic/node-canvas/pull/1582#issuecomment-629837503 for TypeFox company maintaining gitpod <https://gitpod.io> and it's users
+
+###! This is a hotfix for https://github.com/tomas/needle/issues/312 which is on Gitpod causing issue described https://github.com/gitpod-io/gitpod/issues/1520
+
+# Required for docker-build to terminate correctly
+set -e
+
+# Identify script
+myName="script gitpod-1520"
+
+# Output handling
+# FIXME-UPSTREAM: Implement standard (1st wave of krey's refactor)
+einfo() { printf 'INFO: %s\n' "$1" ;}
+ewarn() { printf 'WARNING: %s\n' "$1" ;}
+eerror() { printf 'ERROR: %s\n' "$1" ;}
+die() {
+	case "$1" in
+		0) printf 'SUCCESS: %s\n' "$2" ;;
+		255) printf 'FATAL: Unexpected happend while %s\n' "$2" ;;
+		[1-9] | [1-9][0-9] | 1[0-9][0-9] | 2[0-5][0-5] ) printf 'FATAL: %s\n' "$2" ;;
+		*) printf 'WRONG_ARG(FATAL): %s\n' "$2"; exit 188
+	esac
+
+	exit "$1"
+}
+edebug() {
+	if [ "$DEBUG" = 1 ]; then
+		printf "DEBUG: %s\n" "$1"
+	elif [ "$DEBUG" != 1 ]; then
+		true
+	else
+		die 255 "Processing variable DEBUG with value '$DEBUG' in $myName"
+	fi
+}
+
+# Root escalation - Not expected to run as non-root
+if [ "$(id -u)" != 0 ]; then
+	ewarn "$myName is expected to be invoked as root, but it has been executed from non-root! Trying to use sudo"
+	SUDO="sudo"
+elif [ "$(id -u)" = 0 ]; then
+	unset SUDO
+else
+	die 255 "root escalation in $myName"
+fi
+
+einfo "Invoking $myName to workaround https://github.com/gitpod-io/gitpod/issues/1520"
+
+# FIXME-UPSTREAM: Set for logic (Implemented in 3rd phase of Krey's refactor)
+DISTRO="ubuntu"
+
+# Sanitization for distro used
+case "$DISTRO" in
+	ubuntu) edebug "Expected distribution '$myName' has been parsed in $myName" ;;
+	*) die 1 "Distribution '$DISTRO' is not supported by $myName"
+esac
+
+# Check if curl is available
+if ! command -v curl 1>/dev/null; then
+	case "$DISTRO" in
+		ubuntu)
+			einfo "$myName requires curl to read GitHub API to determine the logic which is not available on this environment, attempting to install it now.."
+			# Do not double-quote, spaces are expected
+			$SUDO apt install -y curl || die 1 "Unable to install curl which is required in $myName"
+		;;
+		*) die 0 "Distribution '$DISTRO' is not affected by https://github.com/gitpod-io/gitpod/issues/1520 to gitpod's knowledge"
+	esac
+elif command -v curl 1>/dev/null; then
+	edebug "Command 'curl' is already available on this environment, no need to process it"
+else
+	die 255 "checking for curl in $myName"
+fi
+
+# Apply workaround for https://github.com/tomas/needle/issues/312 if the issue is not closed
+bugStatus="$(curl https://api.github.com/repos/tomas/needle/issues/312 | grep -o "state.*")"
+case "$bugStatus" in
+	"state\": \"open\",")
+		ewarn "Upstream bug https://github.com/tomas/needle/issues/312 is still open, applying workaround"
+
+		case "$DISTRO" in
+			ubuntu)
+				if [ "$(apt list --installed node-pre-gyp | grep -o node-pre-gyp)" != "node-pre-gyp" ]; then
+					$SUDO apt install -y node-pre-gyp || { eerror "$myName was unable to install package 'node-pre-gyp' which is required to install package 'canvas' using npm to workaround bug https://github.com/gitpod-io/gitpod/issues/1520 which is affected by https://github.com/tomas/needle/issues/312 as suggested in https://github.com/Automattic/node-canvas/pull/1582#issuecomment-629837503" ; exit 0 ;}
+				elif [ "$(apt list --installed node-pre-gyp | grep -o node-pre-gyp)" = "node-pre-gyp" ]; then
+					die 0 "Package 'node-pre-gyp' is already installed, no need to do anything.."
+				else
+					die 255 "resolving package 'node-pre-gyp' in $myName"
+				fi
+			;;
+			*) einfo "Distribution '$DISTRO' is not affected by bug https://github.com/gitpod-io/gitpod/issues/1520, skipping.."
+		esac
+	;;
+	"state\": \"closed\",")
+		ewarn "The issue https://github.com/tomas/needle/issues/312 has been closed which deprecates $myName, please file an issue about this in $UPSTREAM or ideally remove $myName from gitpod's image"
+		exit 0
+	;;
+	*)
+		eerror "Unknown state '$bugStatus' of issue https://github.com/tomas/needle/issues/312 detected, please file a new issue about this in $UPSTREAM"
+esac