fix: improve windows build support

Fixes #3332

Author: starpit

.travis.yml

@@ -1,5 +1,5 @@
 language: node_js
-node_js: 8
+node_js: 12   # Note: windows requires 10 or higher
 dist: xenial # Note: dist>=xenial required by microk8s
 cache: false # as of 20190709 trav-ci.org started loading garbage from the build cache
 
@@ -22,7 +22,8 @@ env:
     - WINDOW_HEIGHT=1050                  # ! ibid !
     - LINUX_BUILD="${TRAVIS_BUILD_DIR}/clients/electron/dist/electron/Kui-linux-x64/Kui" # test against linux electron build
     - OSX_BUILD="${TRAVIS_BUILD_DIR}/clients/electron/dist/electron/Kui-darwin-x64/Kui.app/Contents/MacOS/Kui" # test against darwin electron build
-    - TEST_FROM_BUILD=`[ "$TRAVIS_OS_NAME" == linux ] && echo "$LINUX_BUILD" || echo "$OSX_BUILD"`
+    - WINDOWS_BUILD="${TRAVIS_BUILD_DIR}/clients/electron/dist/electron/Kui-win32-x64/Kui.exe" # test against darwin electron build
+    - TEST_FROM_BUILD=`[ "$TRAVIS_OS_NAME" = linux ] && echo "$LINUX_BUILD" || ([ "$TRAVIS_OS_NAME" = osx ] && echo "$OSX_BUILD" || echo "$WINDOWS_BUILD")`
     - BUILD_ENV=production                # please note: used in dist/electron/build.sh with npm prune --production
     - HOMEBREW_NO_AUTO_UPDATE=1           # disable auto update before running brew install, brew upgrade or brew tap
 
@@ -43,6 +44,10 @@ jobs:
         - KUI_USE_PROXY=true
     - <<: *test-core
       os: osx
+    - stage: test
+      os: windows
+      before_install: npm config set script-shell C:\\Program\ Files\\git\\bin\\bash.exe
+      env: LAYERS=core MOCHA_TARGETS="electron" TEST_FILTER='about'
     - stage: test
       env:
         - WAIT_LAYERS="bash-like-wait"

package.json

@@ -2,7 +2,7 @@
   "name": "kui-shell",
   "version": "5.1.0",
   "description": "This is the monorepo for Kui, the hybrid command-line/GUI electron-based Kubernetes tool",
-  "main": "node_modules/@kui-shell/core/dist/src/main/main.js",
+  "main": "node_modules/@kui-shell/core/main/main.js",
   "scripts": {
     "lint": "eslint '**/*.{js,ts}'",
     "format": "prettier --write '**/*.{css,html,js,json,md,ts}'",
@@ -18,12 +18,12 @@
     "clean": "npm run compile:clean; rm -rf node_modules; for i in plugins/*; do rm -rf $i/node_modules; done; for i in packages/*; do rm -rf $i/node_modules; done",
     "purge": "npm run clean; rm -f package-lock.json",
     "pack": "./bin/pack.sh",
-    "pty:rebuild": "cd node_modules/node-pty-prebuilt-multiarch && npm run install",
-    "pty:electron": "rm -f .npmrc; cp packages/builder/npmrc node_modules/node-pty-prebuilt-multiarch/.npmrc && npm run pty:rebuild",
-    "pty:nodejs": "rm -f node_modules/node-pty-prebuilt-multiarch/.npmrc; npm run pty:rebuild",
-    "build:html": "CLIENT=${CLIENT-default}; rm -f node_modules/@kui-shell/settings/config-dev.json; npm run pty:electron && CLIENT_HOME=\"$(cd ./clients/$CLIENT && pwd)\" node packages/builder/lib/configure.js && CLIENT_HOME=./clients/$CLIENT ./packages/builder/dist/dev/build.sh && CLIENT_HOME=./clients/$CLIENT ./packages/builder/bin/seticon.js",
+    "pty:rebuild": "kui-pty-rebuild",
+    "pty:electron": "npm run pty:rebuild electron",
+    "pty:nodejs": "npm run pty:rebuild node",
+    "build:html": "CLIENT=${CLIENT-default}; rm -f node_modules/@kui-shell/settings/config-dev.json; npm run pty:electron && CLIENT_HOME=\"$(cd ./clients/$CLIENT && pwd)\" node packages/builder/lib/configure.js && CLIENT_HOME=\"$(cd ./clients/$CLIENT && pwd)\" ./packages/builder/dist/dev/build.sh && CLIENT_HOME=\"$(cd ./clients/$CLIENT && pwd)\" ./packages/builder/bin/seticon.js",
     "postinstall": "npm run build:html && npm run compile",
-    "start": "node bin/kui shell"
+    "start": "electron . shell"
   },
   "engines": {
     "node": ">=8.15.0",

packages/builder/bin/pty-rebuild.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+if [ -z "$1" ]; then
+    echo "please provide a prebuild target, such as electron or nodejs"
+    exit 1
+fi
+ 
+# Notes: keep the prebuild --target in sync with the major version of
+# electron desired for this client; see the dependencies section of
+# ../package.json
+if [ "$1" = "electron" ]; then
+    # create an electron dist to test against
+    PLATFORM=$(node -e 'console.log(process.platform)')
+    echo "node-pty PLATFORM=$PLATFORM"
+    mkdir -p node_modules/node-pty-prebuilt-multiarch/build/Release
+    rm -f node_modules/node-pty-prebuilt-multiarch/build/Release/*
+    cp node_modules/@kui-shell/builder/dist/electron/vendor/node-pty-prebuilt-multiarch/build/$PLATFORM/electron/* node_modules/node-pty-prebuilt-multiarch/build/Release
+    gunzip node_modules/node-pty-prebuilt-multiarch/build/Release/*.gz
+    ls node_modules/node-pty-prebuilt-multiarch/build/Release
+else
+    if [ -e ./node_modules/.bin/rc ] && [ ! -L ./node_modules/.bin/rc ]; then
+        echo "rc is not a symlink"
+        (cd node_modules/.bin && rm -f rc && node -e 'require("fs").symlinkSync("../rc/cli.js", "rc")')
+    fi
+    if [ -e ./node_modules/.bin/prebuild-install ] && [ ! -L ./node_modules/.bin/prebuild-install ]; then
+        echo "prebuild-install is not a symlink"
+        (cd node_modules/.bin && rm -f prebuild-install && node -e 'require("fs").symlinkSync("../prebuild-install/bin.js", "prebuild-install")')
+    fi
+
+    cd node_modules/node-pty-prebuilt-multiarch
+    prebuild-install --force --download --runtime $1
+fi
+
+# Notes: why --force --download?  for some reason, when run from `npm
+# run ...` prebuild-install insists on the --build-from-source option,
+# and nothing we do, short of --force, seems to override this

packages/builder/dist/bin/compile.js

@@ -33,7 +33,7 @@ function codecov() {
       ? join(process.env.TRAVIS_BUILD_DIR, 'packages/test/.nyc_output')
       : join(process.env.TEST_ROOT, '.nyc_output')
 
-  process.chdir('/tmp')
+  process.chdir(require('os').tmpdir())
 
   // Create the nyc instance
   const tempDirectory = codeCoverageTempDirectory()

packages/builder/dist/dev/build.sh

@@ -22,7 +22,14 @@ STAGING="${TOPDIR}"/node_modules/@kui-shell/build
 
 (cd "$STAGING" && rm -f css && ln -s "$TOPDIR"/packages/core/web/css)
 
-THEME=$(cd "$CLIENT_HOME"/theme && pwd)
+# (darwin doesn't support uname -o, but linux and git bash on windows both do)
+if [ "$(uname)" != "Darwin" ] && [ "$(uname -o)" = "Msys" ]; then
+    # a bit of a hack for windows, given that clients/default/theme is
+    # a symlink
+    THEME=$(cd "$TOPDIR"/packages/builder/examples/build-configs/default/theme && pwd)
+else
+    THEME=$(cd "$CLIENT_HOME"/theme && pwd)
+fi
 if [ ! -d "$THEME" ]; then
     echo "Cannot find THEME"
     exit 1

packages/builder/dist/electron/build.sh

@@ -117,6 +117,11 @@ function configure {
     echo '{ "name": "@kui-shell/settings", "version": "0.0.1" }' > "$STAGING"/settings/package.json
     npm install --save --no-package-lock --ignore-scripts ./settings
 
+    if [ "$(uname)" != "Darwin" ] && [ "$(uname -o)" = "Msys" ]; then
+        echo "for some reason, npm install to a relative path creates absolute-path symlinks on windows. fixing"
+	(cd node_modules/@kui-shell && rm settings && ln -s ../../settings)
+    fi
+
     CLIENT_HOME="$CLIENT_HOME" KUI_STAGE="$STAGING" node "$BUILDER_HOME"/lib/configure.js
     UGLIFY=true npx --no-install kui-prescan
 }
@@ -346,18 +351,30 @@ function tarball {
     wait
 }
 
-# copy the npmrc into the client staging area
-function npmrc {
-    cp "$BUILDER_HOME"/npmrc "$STAGING/.npmrc"
-    (cd "$STAGING" && npm rebuild --update-binary node-pty-prebuilt-multiarch)
+# make sure we have the needed native modules compiled and ready
+function native {
+    (cd "$STAGING" && npx --no-install kui-pty-rebuild electron)
+}
+
+# windows-specific bits
+function windows {
+    if [ "$(uname)" != "Darwin" ] && [ "$(uname -o)" = "Msys" ]; then
+        echo "handling windows idiosyncracies"
+        if [ ! -d theme ]; then
+            echo "handling symlink issues for windows"
+            rm -f theme
+            cp -a node_modules/@kui-shell/builder/examples/build-configs/default/theme theme
+        fi
+    fi
 }
 
 # this is the main routine
 function build {
+    echo "windows" && windows
     echo "prereq" && prereq
     echo "init" && init
     echo "tarCopy" && tarCopy
-    echo "npmrc" && npmrc
+    echo "native" && native
     echo "configure" && configure
     echo "assembleHTMLPieces" && assembleHTMLPieces
     echo "win32" && win32

packages/builder/dist/electron/builders/electron.js

@@ -43,7 +43,7 @@
 
 const { join } = require('path')
 const { createGunzip } = require('zlib')
-const { createReadStream, createWriteStream } = require('fs')
+const { createReadStream, createWriteStream, readdir } = require('fs')
 const packager = require('electron-packager')
 
 process.argv.shift()
@@ -57,23 +57,49 @@ async function copyNodePty(buildPath, electronVersion, targetPlatform, arch, cal
     // nothing to do
     callback()
   } else {
-    const source = join(
+    const sourceDir = join(
       process.env.BUILDER_HOME,
       'dist/electron/vendor',
       nodePty,
       'build',
       targetPlatform,
-      'electron/pty.node.gz'
+      'electron'
     )
-    const target = join(buildPath, 'node_modules', nodePty, 'build/Release/pty.node')
-    console.log(`node-pty source: ${source}`)
-    console.log(`node-pty target: ${target}`)
 
-    createReadStream(source)
-      .pipe(createGunzip())
-      .pipe(createWriteStream(target))
-      .on('error', callback)
-      .on('finish', () => callback())
+    readdir(sourceDir, async (err, files) => {
+      if (err) {
+        callback(err)
+      } else {
+        try {
+          await Promise.all(
+            files.map(
+              sourceFileGz =>
+                new Promise((resolve, reject) => {
+                  const source = join(sourceDir, sourceFileGz)
+                  const target = join(
+                    buildPath,
+                    'node_modules',
+                    nodePty,
+                    'build/Release',
+                    sourceFileGz.replace(/\.gz$/, '')
+                  )
+                  console.log(`node-pty source: ${source}`)
+                  console.log(`node-pty target: ${target}`)
+
+                  createReadStream(source)
+                    .pipe(createGunzip())
+                    .pipe(createWriteStream(target))
+                    .on('error', reject)
+                    .on('finish', resolve)
+                })
+            )
+          )
+          callback()
+        } catch (err) {
+          callback(err)
+        }
+      }
+    })
   }
 }
 
@@ -95,7 +121,7 @@ const args = {
   ignore: process.env.IGNORE,
 
   // default settings
-  asar: true,
+  asar: process.platform !== 'win32', // node-pty loading native modules versus asar :(
   overwrite: true,
 
   // and finally, this is the reason we are here:

packages/builder/dist/electron/package.json

@@ -10,11 +10,13 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "debug": "4.1.1",
-    "electron": "6.0.12",
-    "electron-installer-debian": "2.0.1",
-    "electron-installer-dmg": "3.0.0",
-    "electron-packager": "14.0.6",
-    "glob": "7.1.4",
+    "electron": "6.1.5",
+    "electron-packager": "14.1.1",
+    "glob": "7.1.6",
     "minifier": "0.8.1"
+  },
+  "optionalDependencies": {
+    "electron-installer-debian": "2.0.1",
+    "electron-installer-dmg": "3.0.0"
   }
 }