dcp-client 4.4.15 → 4.4.17

package/build/all

@@ -0,0 +1,15 @@
+#! /bin/bash -e
+
+oldDir="`pwd`"
+cd `dirname $0`
+myDir="`pwd`"
+
+if [ ! -d "$myDir/node_modules" ]; then
+  cd "$myDir"
+  npm ci
+fi
+
+cd "$oldDir"
+"${myDir}/generate-sandbox-definitions-json"
+echo
+"${myDir}/bundle" "$@"

package/build/bundle

@@ -0,0 +1,203 @@
+#! /bin/bash
+#
+# @file         build.sh        Rebuild the dcp-client bundle without affecting
+#                               the intermediate files in the dcp repo.
+#
+#                               Usage: build/bundle.sh <path to dcp repo>
+#
+# @author       Wes Garland, wes@distributive.network
+# @date         Mar 2020
+#
+
+# portable implementation of linux realpath
+realpath()
+{
+  (
+    filename="$1"
+    dirname="`dirname \"$1\"`"
+    basename="`basename \"$1\"`"
+    [ "$dirname" ] || dirname="."
+    cd "$dirname" && echo "`pwd -P`/$basename"
+  )
+}
+
+argvZero="$0"
+argvRest="$*"
+myDir="`dirname \`realpath $argvZero\``"
+
+usage()
+{
+cat <<EOHELP
+
+$0 - Rebuild the DCP-Client Bundle
+Copyright (c) 2020-2024 Distributive Corp. All Rights Reserved.
+
+Usage: $0 [path to dcp repo] [[--options] ... ]
+Where:
+  --help                      Shows this help
+  --dcp=<dir>                 Sets the DCP source directory
+  --build=<debug|release>     Sets the DCP build type
+  --install-flags=<flags>     Sets extra flags used by dcp/install.sh
+  -d or --debug               Debug the bundle-build process
+  --reset                     Empty the invocation cache
+  --no-cache                  Do not read or update the invocation cache
+Note: Options will be cached as future invocations' defaults.
+EOHELP
+}
+
+# Main program entry point
+if [ "$1" ] && [ -d "$1" ]; then
+  _DCP_SRC="$1"
+  shift
+fi
+
+# pre-process args to scan for --no-cache
+cd `dirname "$0"`/..
+NO_CACHE=""
+for opt in "$@"
+do
+  if [ "$opt" = "--no-cache" ]; then
+    NO_CACHE=1
+    echo " * Disabling cache" >&2
+  fi
+done
+
+[ ! "${NO_CACHE}" ] && [ -f "${myDir}/etc/config.cache" ] && . "${myDir}/etc/config.cache" ]
+[ "${_DCP_SRC}" ] && DCP_SRC="${_DCP_SRC}"
+
+while getopts "dh-:" OPTION; do
+  if [ "$OPTION" = "-" ]; then
+    if [[ "$OPTARG" =~ (^[a-z0-9-]+)=(.*) ]]; then
+      OPTION="${BASH_REMATCH[1]}"
+      OPTARG="${BASH_REMATCH[2]}"
+    else
+      OPTION="${OPTARG}"
+      OPTARG=""
+    fi
+  fi
+
+  OPTFILES="`eval echo \"${OPTARG}\"`"
+  [ -f "$OPTFILES" ] && OPTFILE="$OPTFILES" || OPTFILE=""
+
+  case $OPTION in
+    h|help)
+      usage
+      exit 1
+      ;;
+    dcp)
+      DCP_SRC="${OPTARG}"
+      ;;
+    install-flags)
+      DCP_INSTALL_FLAGS="${DCP_INSTALL_FLAGS} ${OPTARG}"
+      ;;
+    reset)
+      rm -f "${myDir}/etc/config.cache"
+      argvRest="`echo \"$argvRest\" | sed -e 's/--reset//' -e 's/^ *//'`"
+      [ "$argvRest" ] && exec $SHELL -c "\"$argvZero\" $argvRest"
+      exit 99
+      ;;
+    d|debug)
+      DCP_INSTALL_FLAGS="${DCP_INSTALL_FLAGS} -d"
+      DEBUG=1
+      DEBUG_BUNDLE=1
+      ;;
+    build)
+      [ "$DCP_BUILD" != "$OPTARGS" ] && echo "Setting DCP build type to ${OPTARG}"
+      DCP_BUILD="${OPTARG}"
+      ;;
+    no-cache)
+      ;;
+    *)
+      echo "Unrecognized option: $OPTION"
+      exit 2
+      ;;
+  esac
+done
+
+DCP_SRC="`eval echo $DCP_SRC`"
+if [ ! "$DCP_SRC" ] || [ ! -d "$DCP_SRC" ]; then
+  echo "Could not locate DCP repo ($DCP_SRC). Once specified, it will be cached for future runs."
+  echo "See $0 --help for more information. Stop."
+  exit 98
+else
+  DCP_SRC="`realpath \"$DCP_SRC\"`"
+fi >/dev/stderr
+
+echo "Building DCP Client ${DCP_BUILD} bundle from DCP in ${DCP_SRC}"
+
+case "${DCP_BUILD}" in
+  debug|release)
+  ;;
+  *)
+  echo "Unknown build type: ${DCP_BUILD}" >/dev/stderr
+  exit 96
+esac
+
+# Write cache
+[ -d "${myDir}/etc" ] || mkdir -p "${myDir}/etc"
+if [ ! "${NO_CACHE}" ]; then
+  cat > "${myDir}/etc/config.cache" << EOF
+DCP_SRC="${DCP_SRC}"
+DCP_INSTALL_FLAGS="${DCP_INSTALL_FLAGS}"
+DCP_BUILD="${DCP_BUILD}"
+EOF
+fi
+
+# Create staging folder so we don't make changes in dcp repo dist
+BUNDLE_TMP="`mktemp -d -t XXXXX.dcpClientBuild`"
+[ "$DEBUG_BUNDLE" ] || trap "rm -rf \"${BUNDLE_TMP}\"" EXIT
+[ "$DEBUG_BUNDLE" ] && trap "echo 'Debug Mode: left \"$BUNDLE_TMP\" behind.'" EXIT
+mkdir -p "${BUNDLE_TMP}/dist" || exit $?
+
+# Write install.sh override files
+cat > "${BUNDLE_TMP}/local-config.incl" <<EOF
+echo " . Loading DCP local-config extras for dcp-client build/bundle" >&2
+SRC_DIR="${DCP_SRC}"
+DCP_PREFIX="${BUNDLE_TMP}"
+BUILD="${DCP_BUILD}"
+DCP_LOCAL_CONFIG_JSON="${BUNDLE_TMP}/local-config.json"
+EOF
+
+node > "${BUNDLE_TMP}/local-config.json" << EOJS
+const localConfig = {};
+localConfig.generated = "`date` by `id -un` on `hostname`";
+if ("${DCP_BUILD}") localConfig.build = "${DCP_BUILD}";
+localConfig.dcpClientDestination = "${BUNDLE_TMP}/dist";
+console.log(JSON.stringify(localConfig));
+EOJS
+
+if [ ! -d "${DCP_SRC}/node_modules" ]; then
+  echo "Cannot find ${DCP_SRC}/node_modules. Please run npm i from ${DCP_SRC}" >&2
+  exit 97
+fi
+
+NO_LOG=1 \
+SKIP_SUDO_CHECK=1 \
+DCP_LOCAL_CONFIG_EXTRAS="${BUNDLE_TMP}/local-config.incl" \
+  "${DCP_SRC}/install.sh" -NI ${DCP_INSTALL_FLAGS} build-dcp-client
+
+EXIT_CODE="$?"
+if [ "$EXIT_CODE" != "0" ]; then
+  echo "Error: ${DCP_SRC}/install.sh failed with code $EXIT_CODE. Stop." >&2
+  exit 3
+fi
+
+echo
+echo "Importing DCP Client Bundle"
+cd "${myDir}/.."
+[ "$?" = "0" ] || exit 4
+[ "${DEBUG}" ] || [ "${DEBUG_BUNDLE}" ] && find "${BUNDLE_TMP}" -ls
+
+# Copy all generated files tracked by the repo into this repo
+git ls-tree --full-tree -r --name-only HEAD dist |\
+  (cd "${BUNDLE_TMP}" && while read file;
+   do
+     ls "$file" 2>/dev/null
+   done) > "${BUNDLE_TMP}/flist"
+
+[ "$DEBUG_BUNDLE" ] && echo "Files to copy:" && cat "${BUNDLE_TMP}/flist" | sed 's/^/ - /'
+
+(cd "${BUNDLE_TMP}" && tar -T ./flist -cf -) | tar -xvf - | sed 's/^/ - /'
+STATUS=$?
+echo "Done."
+exit $STATUS

package/build/etc/config.cache

@@ -0,0 +1,3 @@
+DCP_SRC="/home/wes/git/dcp"
+DCP_INSTALL_FLAGS=""
+DCP_BUILD="debug"

package/build/generate-sandbox-definitions-json

@@ -0,0 +1,63 @@
+#! /usr/bin/env node
+'use strict';
+/**
+ * @file        generate-sandbox-definitions-json
+ *              This file is the single-source-of-authority with respect
+ *              to which files are run for which evaluators.  It is used
+ *              to generate code in ../generated.
+ *
+ * @author      Wes Garland, wes@kingsds.network
+ * @date        Feb 2021
+ */
+
+const fs   = require('fs');
+const path = require('path');
+
+var o = {};
+const target = '../generated/sandbox-definitions.json';
+console.log(`Generating sandbox definitions in ${target}`);
+
+/** All sandbox types use the base files */
+const base = [
+  'script-load-wrapper',
+  'timer-classes',
+  'wrap-event-listeners',
+  'event-loop-virtualization',
+  'lift-webgl',
+  'lift-wasm',
+  'lift-webgpu',
+  'worktimes',
+  'access-lists',
+  'bravojs-init',
+  'bravojs/bravo.js',
+  'bravojs-env',
+  'pyodide-core',
+  'calculate-capabilities',
+];
+
+o.browser = [].concat(base);
+
+/** A node-evaluator sandbox needs extra code to emulate a Web Worker */
+o.node = ['sa-ww-simulation'].concat(base);
+
+/** A native-evaluator sandbox needs extra code to emulate a Web Worker */
+o.native = ['sa-ww-simulation'].concat(base);
+o.native.splice(2, 0, 'native-event-loop');
+
+for (let type in o) {
+  o[type].unshift('kvin/kvin.js');
+  if (type !== 'node')
+    o[type].unshift('deny-node');
+  o[type].push('bootstrap');
+}
+
+/** A node-testing evaluator similar to the node evaluator but with an additional testing script loaded */
+o.nodeTesting = o.node.concat(['testing.js']);
+
+/** A testing sandbox is a native sandbox with an additional testing script
+ * injected that can be changed to test global symbols in the evaluator
+ */
+o.testing = o.native.concat(['testing.js']);
+
+fs.writeFileSync(path.resolve(__dirname, target), JSON.stringify(o), 'utf-8');
+console.log(`Done - ${Object.keys(o).join(', ')}.`);

package/build/publish-docs.sh

@@ -0,0 +1,74 @@
+#! /usr/bin/env bash
+#
+# @file         publish-docs.sh
+# @athor        Brandon Christie <brandon@distributive.network>
+# @date         Aug 2023
+#
+# @description  Publishes the docs for each component
+#               to backstage.
+
+set -euo pipefail
+
+cd "$(dirname "$0")/.."
+
+ROOT_DIR=$PWD
+
+echo "TechDocs Bucket Name: $TECHDOCS_S3_BUCKET_NAME"
+echo "Namespace: $ENTITY_NAMESPACE"
+
+ENTITY_KIND=$(yq ".kind" < catalog-info.yaml)
+echo "Kind: $ENTITY_KIND"
+
+ENTITY_NAME=$(yq ".metadata.name" < catalog-info.yaml)
+echo "Name: $ENTITY_NAME"
+
+TECHDOCS_REF=$(yq ".metadata.annotations.\"backstage.io/techdocs-ref\"" < catalog-info.yaml)
+echo "TechDocs Ref: $TECHDOCS_REF"
+
+# An example of the the techdocs-ref in the YAML file:
+# dir:./docs/dcp
+#
+# The Regex below will isolate the directory path giving the
+# result 'docs/dcp' for the given example.
+if [[ "$TECHDOCS_REF" =~ dir:\.(.*) ]]; then
+  RELATIVE_DOCS_DIR="${BASH_REMATCH[1]%%[[:space:]]*}"
+  DOCS_DIR="$ROOT_DIR/$RELATIVE_DOCS_DIR"
+fi
+
+# The techdocs-cli commands must be called in the directory where the
+# mkdocs.yml file is present.
+cd "$DOCS_DIR"
+
+# MkDocs requires an index.md or README.md file, if one does not exist it will
+# be generated automatically.
+if ! [ -f index.md ] && ! [ -f README.md ]; then
+  if [ -z "$CI" ]; then  
+    AUTHOR="$(git config user.name) <$(git config user.email)>"
+  else  
+    AUTHOR="$CI_COMMIT_AUTHOR"
+  fi  
+
+  echo "README.md or index.md was not found and will be automatically generated."  
+  cat >> index.md <<EOF
+<!--
+@author  $AUTHOR
+@date    $(date)
+@machine $HOSTNAME
+@rev     $(git rev-parse HEAD)
+-->
+> **Warning**: MkDocs requires a top level index.md or README.md (case sensitive)
+This index.md file has been generated automatically to ensure MkDocs works correctly
+EOF
+fi
+
+npx techdocs-cli generate --no-docker --verbose
+
+npx techdocs-cli publish \
+  --publisher-type awsS3 \
+  --storage-name "$TECHDOCS_S3_BUCKET_NAME" \
+  --entity "$ENTITY_NAMESPACE"/"$ENTITY_KIND"/"$ENTITY_NAME" \
+  --directory "$DOCS_DIR"/site
+
+rm -r "$DOCS_DIR"/site
+
+echo "View generated component: https://backstage.overwatch.distributive.network/docs/default/component/$ENTITY_NAME"