chore: Merge branch 'staging' into auto/A19S28-merge-master-into-staging

Author: mcdurdin

.gitattributes

@@ -0,0 +1,4 @@
+
+Dockerfile    text eol=lf
+*.Dockerfile  text eol=lf
+*.sh          eol=lf

.github/workflows/master_com-keyman-status.yml

@@ -19,13 +19,29 @@ jobs:
     - name: Set up Node.js version
       uses: actions/setup-node@v1
       with:
-        node-version: '20.x'
+        node-version: '22.x'
 
-    - name: npm install, build, and test
+    - name: npm ci + build - public
       run: |
-        npm install
-        npm run build --if-present
-        npm run test --if-present
+        echo "- Building public for release"
+        cd public
+        npm ci
+        ./node_modules/.bin/ng build --configuration production
+        cd ..
+
+    - name: npm ci + build - server
+      run: |
+        echo "- Building server for release"
+        cd server
+        npm ci
+        ./node_modules/.bin/tsc
+        cd ..
+
+    - name: server test
+      run: |
+        cd server
+        npx mocha --import=./_mocha_register.js
+        cd ..
 
     - name: 'Deploy to Azure Web App'
       uses: azure/webapps-deploy@v2

.github/workflows/test.yml

@@ -25,10 +25,8 @@ jobs:
       - name: Set up Node.js version
         uses: actions/setup-node@v1
         with:
-          node-version: '20.x'
+          node-version: '22.x'
 
       - name: npm install, build, and test
         run: |
-          npm install
-          npm run build
-          npm run test
+          ./build.sh configure build test --release

.gitignore

@@ -1,4 +1,15 @@
 localenv.sh
 node_modules/
 .keymanapp-test-bot.*
-local*.sh
+local*.sh
+
+# Shared files are bootstrapped:
+resources/bootstrap.inc.sh*
+resources/.bootstrap-version
+resources/.bootstrap-registry
+_common/
+
+# State files
+_control/debug
+_control/release
+_control/ready

README.md

@@ -1,4 +1,45 @@
-# Quick Start
+# status.keyman.com
+
+## Overview
+
+* Back end is a node server in `/server`.
+* Front end is an Angular app in `/public`.
+* The [Keyman Test-bot](https://github.com/keymanapp/keyman/wiki/User-Testing-Workflows)
+  (@keymanapp-test-bot) is in `/server/keymanapp-test-bot`.
+
+The site is setup to run in Docker container(s).
+
+The site can be setup in development (`--debug`) or production (`--release`)
+modes. When in development mode, the front end is hosted (on
+http://localhost:8061) in a separate container to the back end (on
+http://localhost:8060) in order to facilitate live-reload on changes.
+
+For production mode, the front end is compiled to static pages which are then
+served by the back end (on http://localhost:8060).
+
+## Prerequisites
+
+* Docker Desktop
+* On Windows, you'll need to have Git Bash installed in `C:\Program Files\git\bin\bash.exe`.
+
+Before building and starting the site, you need to have API tokens set as
+environment variables. These should be added in script `server/localenv.sh`.
+
+```bash
+export KEYMANSTATUS_TEAMCITY_TOKEN=[your personal auth token here]
+export KEYMANSTATUS_GITHUB_TOKEN=[your personal auth token here]
+export KEYMANSTATUS_SENTRY_TOKEN=[your personal auth token here]
+```
+
+### @keymanapp-test-bot
+
+Three files are needed for development:
+
+* `.keymanapp-test-bot.appid`: integer appid (e.g. 134443 for the normal test app)
+* `.keymanapp-test-bot.pem`: certificate for GitHub integration for app
+* `.keymanapp-test-bot.secret`: secret for GitHub integration for app
+
+## Development setup
 
 Clone the repo:
 
@@ -7,50 +48,57 @@ git clone https://github.com/keymanapp/status.keyman.com
 cd status.keyman.com/
 ```
 
-Build status.keyman.com:
+### Build the docker containers
+
+Build status.keyman.com, in development mode:
 
 ```bash
-cd server
-npm install
-npm run-script build
-cd ../public
-npm install
-npm run-script build
-cd ..
+./build.sh stop build --debug
 ```
 
-Before running the node server, you need to have two API tokens set as environment variables.  You might want to add these to script `server/localenv.sh`.
+### Start the development server
+
+This repo is configured for live build and reload of both the client and server,
+running in Docker.
 
 ```bash
-export KEYMANSTATUS_TEAMCITY_TOKEN=[your personal auth token here]
-export KEYMANSTATUS_GITHUB_TOKEN=[your personal auth token here]
-export KEYMANSTATUS_SENTRY_TOKEN=[your personal auth token here]
+./build.sh start --debug
 ```
 
-On Windows, you'll also need to have Git Bash installed in `C:\Program Files\git\bin\bash.exe`.
+* Point your browser to <http://localhost:8061> to view the live reload version
+  of the application.
+* The site takes a moment to compile and load; you can watch the logs to see
+  when it is ready.
 
-## Development server
+### Running unit tests
 
-This repo is configured for live build and reload of both the client and server. You'll need two terminals open. In the first, run:
+The unit tests will currently stop the back end container before running.
 
 ```bash
-npm run start-server
+./build.sh test --debug
 ```
 
-and in the second, run:
+## Production setup
+
+This site is deployed to a Kubernetes cluster via configuration in a private
+repo to status.keyman.com.
+
+You can run the production mode site locally with:
 
 ```bash
-npm run start-client
+./build.sh stop build start --release
 ```
 
-* Point your browser to <http://localhost:4200> to view the live reload version of the application.
-* The query parameter `?c=1` adds a contributions view which is not visible by default.
-* Another query parameter `?sprint=P8S4` parameter to view sprint contributions data for P8S4
-
-### @keymanapp-test-bot
+* Point your browser to <http://localhost:8060> to view the production version
+  of the application.
 
-Three files needed for development:
+## Site query parameters
 
-* `.keymanapp-test-bot.appid`: integer appid (e.g. 134443 for the normal test app)
-* `.keymanapp-test-bot.pem`: certificate for GitHub integration for app
-* `.keymanapp-test-bot.secret`: secret for GitHub integration for app
+* The following query parameters are available:
+  * `?c=1` shows contributions at the top center
+  * `?o=1` shows owner for each platform
+  * `?a=1` shows build agent status at the top right
+  * `?r=1` adds a refresh button to force a server-side full refresh (this is
+           costly, so only press this when there has been a data error such as a
+           network failure making status data out of date; most errors are
+           actually self-healing)

_control/.keep

@@ -0,0 +1,95 @@
+#!/usr/bin/env bash
+## START STANDARD SITE BUILD SCRIPT INCLUDE
+readonly THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
+readonly BOOTSTRAP="$(dirname "$THIS_SCRIPT")/resources/bootstrap.inc.sh"
+readonly BOOTSTRAP_VERSION=v1.0.10
+if ! [ -f "$BOOTSTRAP" ] || ! source "$BOOTSTRAP"; then
+  curl -H "Cache-Control: no-cache" --fail --silent --show-error -w "curl: Finished attempt to download %{url}" "https://raw.githubusercontent.com/keymanapp/shared-sites/$BOOTSTRAP_VERSION/bootstrap.inc.sh" -o "$BOOTSTRAP.tmp" || exit 1
+  source "$BOOTSTRAP.tmp"
+  rm -f "$BOOTSTRAP.tmp"
+fi
+## END STANDARD SITE BUILD SCRIPT INCLUDE
+
+source _common/keyman-local-ports.inc.sh
+source _common/docker.inc.sh
+
+readonly HOST_STATUS_KEYMAN_COM=status.keyman.com.localhost
+
+readonly THIS_CONTAINER_NAME=status-keyman-website
+readonly PUBLIC_CONTAINER_NAME=status-keyman-public
+readonly THIS_CONTAINER_DESC=status-keyman-com-app
+readonly PUBLIC_CONTAINER_DESC=status-keyman-com-public
+readonly THIS_IMAGE_NAME=status-keyman-website
+readonly PUBLIC_IMAGE_NAME=status-keyman-public
+readonly THIS_HOST="$HOST_STATUS_KEYMAN_COM"
+readonly PUBLIC_HOST="$HOST_STATUS_KEYMAN_COM" # same host
+readonly THIS_PORT="$PORT_STATUS_KEYMAN_COM"
+readonly PUBLIC_PORT="$PORT_STATUS_KEYMAN_COM_PUBLIC"
+
+
+################################ Main script ################################
+
+builder_describe \
+  "Setup status.keyman.com site to run via Docker." \
+  configure \
+  clean \
+  build \
+  start \
+  stop \
+  test
+
+builder_parse "$@"
+
+function build_docker_containers() {
+  NEWVERSION="$(git rev-parse HEAD)"
+  echo "Writing version '$NEWVERSION' to version.ts"
+  echo "export const buildVersion = '$NEWVERSION';" > shared/version.ts
+
+  build_docker_container $THIS_IMAGE_NAME $THIS_CONTAINER_NAME $BUILDER_CONFIGURATION server.Dockerfile
+  if builder_is_debug_build; then
+    build_docker_container $PUBLIC_IMAGE_NAME $PUBLIC_CONTAINER_NAME $BUILDER_CONFIGURATION public.Dockerfile
+  fi
+
+  git checkout shared/version.ts
+}
+
+function start_docker_containers() {
+  start_docker_container $THIS_IMAGE_NAME $THIS_CONTAINER_NAME $THIS_CONTAINER_DESC $THIS_HOST $THIS_PORT $BUILDER_CONFIGURATION
+  if builder_is_debug_build; then
+    start_docker_container $PUBLIC_IMAGE_NAME $PUBLIC_CONTAINER_NAME $PUBLIC_CONTAINER_DESC $PUBLIC_HOST $PUBLIC_PORT $BUILDER_CONFIGURATION
+  fi
+}
+
+function stop_docker_containers() {
+  rm -f ./_control/ready
+  stop_docker_container  $THIS_IMAGE_NAME $THIS_CONTAINER_NAME
+  # always stop all containers - even in release build
+  stop_docker_container  $PUBLIC_IMAGE_NAME $PUBLIC_CONTAINER_NAME
+}
+
+function clean_docker_containers() {
+  clean_docker_container $THIS_IMAGE_NAME $THIS_CONTAINER_NAME
+  # always clean all containers - even in release build
+  clean_docker_container $PUBLIC_IMAGE_NAME $PUBLIC_CONTAINER_NAME
+}
+
+function do_clean() {
+  clean_docker_containers
+  rm -rf ./server/node_modules ./server/dist
+  rm -rf ./public/node_modules ./public/angular ./public/dist
+  rm -rf ./public/angular
+  rm -rf ./_common
+  rm -rf ./resources/.bootstrap-registry ./resources/bootstrap-version ./resources/bootstrap.inc.sh
+}
+
+function test_docker_container() {
+  stop_docker_container $THIS_IMAGE_NAME $THIS_CONTAINER_NAME
+  MSYS_NO_PATHCONV=1 start_docker_container $THIS_IMAGE_NAME $THIS_CONTAINER_NAME $THIS_CONTAINER_DESC $THIS_HOST $THIS_PORT $BUILDER_CONFIGURATION "/bin/sh" "./resources/test.sh"
+}
+
+builder_run_action configure  bootstrap_configure
+builder_run_action clean      do_clean
+builder_run_action stop       stop_docker_containers
+builder_run_action build      build_docker_containers
+builder_run_action start      start_docker_containers
+builder_run_action test       test_docker_container

build.sh

@@ -2,24 +2,7 @@
   "name": "keyman-status",
   "version": "1.0.0",
   "description": "Report on status of Keyman projects",
-  "main": "server/dist/server/code.js",
   "type": "module",
-  "scripts": {
-    "prebuild": "run-script-os",
-    "prebuild:windows": "tools\\_prebuild.bat",
-    "prebuild:default": "./tools/_prebuild.sh",
-    "postbuild": "git checkout shared/version.ts",
-    "build": "npm ci && npm run-script prebuild && npm run-script build-server && npm run-script build-client && npm run-script postbuild",
-    "build-client": "cd public && npm ci && npm run-script build",
-    "build-server": "cd server && npm ci && npm run-script build",
-    "start-client": "cd public && npm run-script start",
-    "start-server": "cd server && npm run-script start",
-    "test": "cd server && npx mocha --import=./_mocha_register.js",
-    "log": "az webapp log tail --resource-group keyman --name com-keyman-status"
-  },
   "author": "Marc Durdin",
-  "license": "MIT",
-  "devDependencies": {
-    "run-script-os": "^1.1.6"
-  }
+  "license": "MIT"
 }

package-lock.json

@@ -0,0 +1,13 @@
+# syntax=docker/dockerfile:1
+
+FROM node:22@sha256:cd6fb7efa6490f039f3471a189214d5f548c11df1ff9e5b181aa49e22c14383e AS node-builder
+
+WORKDIR /var/www/html
+
+ARG BUILDER_CONFIGURATION="debug"
+ENV BUILDER_CONFIGURATION=$BUILDER_CONFIGURATION
+
+# DOCKER_RUNTIME_PUBLIC env var helps prevent the resource scripts running on the host
+ENV DOCKER_RUNTIME_PUBLIC=1
+
+CMD [ "/bin/sh", "./resources/start-public.sh" ]