mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-15 21:29:23 +00:00
7d8e3978a1
The existing ngrok package is no longer maintained, so this commit switches to @ngrok/ngrok. However, this means a number of deployment changes, as the new module uses a node binary module rather than a standalone executable, and the path to the module is assumed to be on the Node search path. The new module also requires VC++ redistributable, so installation of that has been added to the Server Options dialog. Use of ngrok with Keyman Developer Server should be in theory possible with non-Windows platforms with this change, if the user installs the appropriate @ngrok binary package (e.g. @ngrok/ngrok-darwin-universal) globally before starting the server. Fixes: #15625 Build-bot: skip release:developer
180 lines
6.9 KiB
Bash
Executable file
180 lines
6.9 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
|
|
## START STANDARD BUILD SCRIPT INCLUDE
|
|
# adjust relative paths as necessary
|
|
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
|
|
. "${THIS_SCRIPT%/*}/../../../resources/build/builder-full.inc.sh"
|
|
## END STANDARD BUILD SCRIPT INCLUDE
|
|
|
|
. "$KEYMAN_ROOT/resources/build/utils.inc.sh"
|
|
. "$KEYMAN_ROOT/resources/build/node.inc.sh"
|
|
. "$KEYMAN_ROOT/resources/build/jq.inc.sh"
|
|
|
|
builder_describe "Build Keyman Developer Server" \
|
|
@/common/web/keyman-version \
|
|
@/developer/src/common/web/utils \
|
|
@/web \
|
|
clean \
|
|
configure \
|
|
build \
|
|
test \
|
|
"run Run Server in dev mode" \
|
|
"installer Prepare for Keyman Developer installer" \
|
|
publish \
|
|
":server Keyman Developer Server main program" \
|
|
":addins Windows addins for GUI integration"
|
|
|
|
builder_describe_internal_dependency \
|
|
publish:server build:server \
|
|
publish:server build:addins
|
|
|
|
builder_describe_outputs \
|
|
configure:server /node_modules \
|
|
configure:addins /node_modules \
|
|
build:server /developer/src/server/build/src/index.js \
|
|
build:addins /developer/src/server/build/src/win32/trayicon/addon.node
|
|
|
|
builder_parse "$@"
|
|
|
|
. "$KEYMAN_ROOT/resources/build/win/environment.inc.sh"
|
|
|
|
#-------------------------------------------------------------------------------------------------------------------
|
|
|
|
function clean_server() {
|
|
rm -rf "$THIS_SCRIPT_PATH/build"
|
|
rm -rf "$THIS_SCRIPT_PATH/node_modules"
|
|
rm -rf "$THIS_SCRIPT_PATH/tsconfig.tsbuildinfo"
|
|
rm -rf "$THIS_SCRIPT_PATH/src/site/resource"
|
|
|
|
# No longer in use, cleanup from previous versions:
|
|
rm -rf "$THIS_SCRIPT_PATH/dist"
|
|
}
|
|
|
|
function configure_server() {
|
|
node_select_version_and_npm_ci
|
|
}
|
|
|
|
function build_addins() {
|
|
# Rebuild and bundle addins
|
|
source ./build-addins.inc.sh
|
|
|
|
# If we have an x64 version of node installed
|
|
if [[ $(isNodeX64) ]]; then
|
|
do_build_addins
|
|
fi
|
|
|
|
# Build with the Keyman Developer x86 version of node
|
|
PATH="$KEYMAN_ROOT/developer/src/inst/node/dist:$PATH" do_build_addins
|
|
}
|
|
|
|
function build_server() {
|
|
# Copy keymanweb build artifacts
|
|
local WEB_SRC="$KEYMAN_ROOT/web/build/publish/debug"
|
|
local DST="$THIS_SCRIPT_PATH/src/site/resource"
|
|
|
|
rm -rf "$DST"
|
|
mkdir -p "$DST/osk"
|
|
mkdir -p "$DST/ui"
|
|
cp "$WEB_SRC/"*.js "$WEB_SRC/"*.js.map "$DST/"
|
|
cp -R "$WEB_SRC/osk/"* "$DST/osk/"
|
|
cp -R "$WEB_SRC/ui/"* "$DST/ui/"
|
|
cp "$KEYMAN_ROOT/web/LICENSE" "$DST/"
|
|
cp "$KEYMAN_ROOT/web/README.md" "$DST/"
|
|
|
|
# Build server
|
|
tsc --build
|
|
|
|
# Post build
|
|
mkdir -p "$THIS_SCRIPT_PATH/build/src/site/"
|
|
cp -r "$THIS_SCRIPT_PATH/src/site/"** "$THIS_SCRIPT_PATH/build/src/site/"
|
|
|
|
mkdir -p "$THIS_SCRIPT_PATH/build/src/win32/"
|
|
mkdir -p "$THIS_SCRIPT_PATH/build/src/win32/console"
|
|
mkdir -p "$THIS_SCRIPT_PATH/build/src/win32/trayicon"
|
|
cp "$THIS_SCRIPT_PATH/src/win32/README.md" "$THIS_SCRIPT_PATH/build/src/win32/"
|
|
cp "$THIS_SCRIPT_PATH/src/win32/console/node-hide-console-window.node" "$THIS_SCRIPT_PATH/build/src/win32/console/"
|
|
cp "$THIS_SCRIPT_PATH/src/win32/console/node-hide-console-window.x64.node" "$THIS_SCRIPT_PATH/build/src/win32/console/"
|
|
cp "$THIS_SCRIPT_PATH/src/win32/trayicon/addon.node" "$THIS_SCRIPT_PATH/build/src/win32/trayicon/"
|
|
cp "$THIS_SCRIPT_PATH/src/win32/trayicon/addon.x64.node" "$THIS_SCRIPT_PATH/build/src/win32/trayicon/"
|
|
|
|
replaceVersionStrings "$THIS_SCRIPT_PATH/build/src/site/lib/sentry/init.js.in" "$THIS_SCRIPT_PATH/build/src/site/lib/sentry/init.js"
|
|
rm "$THIS_SCRIPT_PATH/build/src/site/lib/sentry/init.js.in"
|
|
}
|
|
|
|
function installer_server() {
|
|
# We need to build in a tmp folder so that npm doesn't get confused by our
|
|
# monorepo setup, and so we can copy the relevant node_modules in, because
|
|
# we'll need them in order to build the deployable version.
|
|
|
|
local PRODBUILDTEMP=`mktemp -d`
|
|
echo "Preparing in $PRODBUILDTEMP"
|
|
# Remove @keymanapp devDependencies because they won't install outside the
|
|
# monorepo context
|
|
cat package.json | "$JQ" \
|
|
'. | del(.devDependencies."@keymanapp/resources-gosh") | del(.devDependencies."@keymanapp/keyman-version") | del(.dependencies."@keymanapp/developer-utils")' \
|
|
> "$PRODBUILDTEMP/package0.json"
|
|
|
|
# #12950: Merge dependencies from @keymanapp/developer-utils and Server; this
|
|
# is a bit messy but will mean we don't lose the needed dependencies.
|
|
"$JQ" -s '.[0] + { dependencies: (.[1].dependencies * .[0].dependencies) }' "$PRODBUILDTEMP/package0.json" \
|
|
"$KEYMAN_ROOT/developer/src/common/web/utils/package.json" > "$PRODBUILDTEMP/package1.json"
|
|
cat $PRODBUILDTEMP/package1.json | "$JQ" \
|
|
'. | del(.dependencies."@keymanapp/common-types")' \
|
|
> "$PRODBUILDTEMP/package.json"
|
|
rm "$PRODBUILDTEMP/package0.json"
|
|
rm "$PRODBUILDTEMP/package1.json"
|
|
|
|
pushd "$PRODBUILDTEMP"
|
|
npm install --omit=dev --omit=optional
|
|
popd
|
|
|
|
# Dependencies are required in build/ but we need to copy them in manually
|
|
mkdir -p "$PRODBUILDTEMP/node_modules/@keymanapp/"
|
|
cp -R "$KEYMAN_ROOT/node_modules/@keymanapp/keyman-version/" "$PRODBUILDTEMP/node_modules/@keymanapp/"
|
|
cp -R "$KEYMAN_ROOT/node_modules/@keymanapp/developer-utils/" "$PRODBUILDTEMP/node_modules/@keymanapp/"
|
|
cp -R "$KEYMAN_ROOT/node_modules/@keymanapp/common-types/" "$PRODBUILDTEMP/node_modules/@keymanapp/"
|
|
cp -R "$KEYMAN_ROOT/node_modules/@keymanapp/ldml-keyboard-constants/" "$PRODBUILDTEMP/node_modules/@keymanapp/"
|
|
cp -R "$KEYMAN_ROOT/node_modules/eventemitter3/" "$PRODBUILDTEMP/node_modules/"
|
|
|
|
# We'll build in the $KEYMAN_ROOT/developer/bin/server/ folder
|
|
rm -rf "$KEYMAN_ROOT/developer/bin/server/"
|
|
mkdir -p "$KEYMAN_ROOT/developer/bin/server/build/"
|
|
cp -R build/* "$KEYMAN_ROOT/developer/bin/server/build/"
|
|
cp -R "$PRODBUILDTEMP"/* "$KEYMAN_ROOT/developer/bin/server/"
|
|
rm -rf "$PRODBUILDTEMP"
|
|
}
|
|
|
|
function test_server() {
|
|
# eslint .
|
|
tsc --build test
|
|
# c8 --reporter=lcov --reporter=text
|
|
mocha --recursive build/test
|
|
}
|
|
|
|
function publish_server() {
|
|
installer_server
|
|
wrap-signcode //d "Keyman Developer" "$DEVELOPER_PROGRAM/server/build/src/win32/console/node-hide-console-window.node"
|
|
wrap-signcode //d "Keyman Developer" "$DEVELOPER_PROGRAM/server/build/src/win32/console/node-hide-console-window.x64.node"
|
|
wrap-signcode //d "Keyman Developer" "$DEVELOPER_PROGRAM/server/build/src/win32/trayicon/addon.node"
|
|
wrap-signcode //d "Keyman Developer" "$DEVELOPER_PROGRAM/server/build/src/win32/trayicon/addon.x64.node"
|
|
}
|
|
|
|
function run_server() {
|
|
node .
|
|
}
|
|
|
|
builder_run_action clean:server clean_server
|
|
builder_run_action configure:server configure_server
|
|
builder_run_action build:addins build_addins
|
|
builder_run_action build:server build_server
|
|
builder_run_action test:server test_server
|
|
builder_run_action run:server run_server
|
|
# builder_run_action test:addins # no op
|
|
builder_run_action installer:server installer_server # TODO: rename to install-prep
|
|
builder_run_action publish:server publish_server
|
|
|
|
# TODO: consider 'watch'
|
|
# function watch_server() {
|
|
# tsc-watch --onSuccess "node --inspect ." --onFailure "node --inspect ."
|
|
# }
|
|
# builder_run_action watch:server watch_server
|