maint(web): re-add engine .js tests

PR #15093 merged multiple engine modules into one. However, in doing so
we lost the .js tests and ran only the .ts ones. This change re-adds the
.js tests and fixes them where the code diverged since then.

Other changes:
- rename `queryEngine.ts` to `cloudQueryEngine.ts` to match the class name
- remove unused `keyboard-storage/cloud/index.ts`
- expose `CLOUD_TIMEOUT_ERR` and `CLOUD_STUB_REGISTRATION_ERR` as
  `unitTestEndpoints`
- add `test/resources` to exports in `web/package.json`. This was necessary
  because the compiled .ts test files are under `web/build` whereas the
  .js test files are under `web/src` and so the relative paths in imports
  no longer work. Also fix the imports in test files.
- apply fix from #15477 if KEYMAN_ROOT is not set

I'm not happy to put the compiled files under
`web/src/test/auto/resources/build`, but that's the only way I got it
to work. If I put the compiled files in `web/build/test/resources` it
couldn't find the types for `promise-status-async`.

Also, running the .js tests succeeded but then creating the coverage
report failed. I was not able to find the reason or a fix for that. As a
hack to work around this problem we check the number of failed tests
instead of relying on the exit code of the test.

Follows: #15093
Test-bot: skip

Author: ermshiperete

web/common.inc.sh

@@ -17,7 +17,7 @@
 #   compile engine/main
 # ```
 function compile() {
-  if [ $# -lt 1 ]; then
+  if [[ $# -lt 1 ]]; then
     builder_die "Scripting error: insufficient argument count!"
   fi
 
@@ -27,10 +27,10 @@ function compile() {
   local SRC_DIR=${2:-"${KEYMAN_ROOT}/web/src"}
   local BUILD_DIR=${3:-"${KEYMAN_ROOT}/web/build"}
 
-  tsc -b "${SRC_DIR}/$COMPILE_TARGET"
+  tsc -b "${SRC_DIR}/${COMPILE_TARGET}"
 
   # So... tsc does declaration-bundling on its own pretty well, at least for local development.
-  tsc --emitDeclarationOnly --outFile "${BUILD_DIR}/$COMPILE_TARGET/lib/index.d.ts" -p "${SRC_DIR}/$COMPILE_TARGET"
+  tsc --emitDeclarationOnly --outFile "${BUILD_DIR}/${COMPILE_TARGET}/lib/index.d.ts" -p "${SRC_DIR}/${COMPILE_TARGET}"
 }
 
 function _copy_dir_if_exists() {

web/package.json

@@ -81,6 +81,10 @@
     "./tools/testing/test-utils": {
       "types": "./build/tools/testing/test-utils/obj/index.d.ts",
       "import": "./build/tools/testing/test-utils/obj/index.js"
+    },
+    "./test/resources": {
+      "types": "./src/test/auto/resources/build/index.d.ts",
+      "import": "./src/test/auto/resources/build/index.js"
     }
   },
   "imports": {

web/src/engine/build.sh

@@ -68,11 +68,35 @@ do_build () {
   node src/osk/validate-gesture-specs.js
 }
 
-builder_run_action clean rm -rf "$KEYMAN_ROOT/web/build/engine"
+run_tests() {
+  local OUTPUT_FILE FAILURE_COUNT
+  # Remove stale coverage data
+  rm -rf "${KEYMAN_ROOT}/web/build/coverage/raw/engine"
+
+  # Unfortunately we get an error from the coverage report generation:
+  # "TypeError [ERR_INVALID_URL_SCHEME]: The URL must be of scheme file"
+  # The following lines ignore the exit code and instead check the number
+  # of failed tests from the output.
+  set +e
+  OUTPUT_FILE=$(mktemp)
+  test-headless engine "" 2>&1 | tee "${OUTPUT_FILE}"
+  set -e
+
+  FAILURE_COUNT=$(grep ' failing' "${OUTPUT_FILE}" | xargs | cut -f 1 -d' ')
+  rm "${OUTPUT_FILE}"
+  builder_echo "(The 'TypeError [ERR_INVALID_URL_SCHEME]: The URL must be of scheme file' is expected)"
+  if ((FAILURE_COUNT > 0)); then
+    builder_die "Headless engine tests failed (.js tests)"
+  fi
+
+  test-headless-typescript engine
+}
+
+builder_run_action clean rm -rf "${KEYMAN_ROOT}/web/build/engine"
 builder_run_child_actions clean
 builder_run_action configure node_select_version_and_npm_ci
 builder_run_child_actions configure
 builder_run_child_actions build
 builder_run_action build do_build
-builder_run_action test test-headless-typescript engine
+builder_run_action test  run_tests
 builder_run_child_actions test

…rc/keyboard-storage/cloud/queryEngine.ts …yboard-storage/cloud/cloudQueryEngine.tsweb/src/engine/src/keyboard-storage/cloud/queryEngine.ts renamed to web/src/engine/src/keyboard-storage/cloud/cloudQueryEngine.ts web/src/engine/src/keyboard-storage/cloud/queryEngine.ts renamed to web/src/engine/src/keyboard-storage/cloud/cloudQueryEngine.ts

@@ -1,6 +1,6 @@
 import { ManagedPromise } from 'keyman/common/web-utils';
 import { CloudRequesterInterface } from './cloud/requesterInterface.js';
-import { CLOUD_MALFORMED_OBJECT_ERR, CLOUD_TIMEOUT_ERR, CLOUD_STUB_REGISTRATION_ERR } from './cloud/queryEngine.js';
+import { CLOUD_MALFORMED_OBJECT_ERR, CLOUD_TIMEOUT_ERR, CLOUD_STUB_REGISTRATION_ERR } from './cloud/cloudQueryEngine.js';
 
 export class DOMCloudRequester implements CloudRequesterInterface {
   private readonly fileLocal: boolean;

web/src/engine/src/keyboard-storage/cloud/index.ts

@@ -8,8 +8,15 @@ export {
   REGION_CODES
 } from './keyboardStub.js';
 export { StubAndKeyboardCache, toPrefixedKeyboardId, toUnprefixedKeyboardId } from './stubAndKeyboardCache.js';
-export { CloudQueryResult, CloudQueryEngine } from './cloud/queryEngine.js';
+export { CloudQueryResult, CloudQueryEngine } from './cloud/cloudQueryEngine.js';
 export { CloudRequesterInterface } from './cloud/requesterInterface.js';
 export { KeyboardRequisitioner } from './keyboardRequisitioner.js';
 export { ModelCache } from './modelCache.js';
-export { DOMCloudRequester } from './domCloudRequester.js';
+export { DOMCloudRequester } from './domCloudRequester.js';
+
+import { CLOUD_TIMEOUT_ERR, CLOUD_STUB_REGISTRATION_ERR } from './cloud/cloudQueryEngine.js';
+
+export const unitTestEndpoints = {
+  CLOUD_TIMEOUT_ERR,
+  CLOUD_STUB_REGISTRATION_ERR
+};

web/src/engine/src/keyboard-storage/domCloudRequester.ts

@@ -3,8 +3,8 @@ import sinon from 'sinon';
 
 import { LanguageProcessor, TranscriptionCache } from 'keyman/engine/main';
 import { PredictionContext } from 'keyman/engine/interfaces';
-import { Worker as LMWorker } from "@keymanapp/lexical-model-layer/node";
-import { DeviceSpec, SyntheticTextStore } from 'keyman/engine/keyboard';
+import { NodeWorker } from "@keymanapp/lexical-model-layer/node";
+import { SyntheticTextStore } from 'keyman/engine/keyboard';
 
 function compileDummyModel(suggestionSets) {
   return `
@@ -66,7 +66,7 @@ describe("PredictionContext", () => {
   let langProcessor;
 
   beforeEach(function() {
-    langProcessor = new LanguageProcessor(LMWorker, new TranscriptionCache());
+    langProcessor = new LanguageProcessor(NodeWorker, new TranscriptionCache());
   });
 
   afterEach(function() {
@@ -83,7 +83,7 @@ describe("PredictionContext", () => {
 
     let textStore = new SyntheticTextStore("appl", 4); // "appl|", with '|' as the caret position.
     const initialTextStore = SyntheticTextStore.from(textStore);
-    const promise = predictiveContext.setCurrentTarget(textStore);
+    const promise = predictiveContext.setCurrentTextStore(textStore);
 
     // Initial predictive state:  no suggestions.  context.initializeState() has not yet been called.
     assert.equal(updateFake.callCount, 1);
@@ -122,7 +122,7 @@ describe("PredictionContext", () => {
 
     let textStore = new SyntheticTextStore("appl", 4); // "appl|", with '|' as the caret position.
     const initialTextStore = SyntheticTextStore.from(textStore);
-    const promise = predictiveContext.setCurrentTarget(textStore);
+    const promise = predictiveContext.setCurrentTextStore(textStore);
 
     // Initial predictive state:  no suggestions.  context.initializeState() has not yet been called.
     assert.equal(updateFake.callCount, 1);
@@ -181,7 +181,7 @@ describe("PredictionContext", () => {
     const predictiveContext = new PredictionContext(langProcessor, dummiedGetLayer);
 
     let textStore = new SyntheticTextStore("appl", 4); // "appl|", with '|' as the caret position.
-    const initialSuggestions = await predictiveContext.setCurrentTarget(textStore);
+    const initialSuggestions = await predictiveContext.setCurrentTextStore(textStore);
 
     let updateFake = sinon.fake();
     predictiveContext.on('update', updateFake);
@@ -206,7 +206,7 @@ describe("PredictionContext", () => {
 
     let textState = new SyntheticTextStore("appl", 4); // "appl|", with '|' as the caret position.
 
-    await predictiveContext.setCurrentTarget(textState);
+    await predictiveContext.setCurrentTextStore(textState);
 
     let updateFake = sinon.fake();
     predictiveContext.on('update', updateFake);
@@ -274,7 +274,7 @@ describe("PredictionContext", () => {
 
     // Test setup - return to the state at the end of the prior-defined unit test ('suggestion application...')
 
-    await predictiveContext.setCurrentTarget(textState);
+    await predictiveContext.setCurrentTextStore(textState);
 
     // This is the point in time that a reversion operation will rewind the context to.
     const revertBaseTextState = SyntheticTextStore.from(textState);

web/src/engine/src/keyboard-storage/index.ts

@@ -7,11 +7,15 @@ const require = createRequire(import.meta.url);
 
 import { MinimalKeymanGlobal } from 'keyman/engine/keyboard';
 import { JSKeyboardInterface } from 'keyman/engine/js-processor';
-import { NodeKeyboardLoader } from '../../../resources/loader/nodeKeyboardLoader.js';
+import { NodeKeyboardLoader } from 'keyman/test/resources';
 import { KeyboardTest, NodeProctor } from '@keymanapp/recorder-core';
 
 import { env } from 'node:process';
-const KEYMAN_ROOT = env.KEYMAN_ROOT;
+import { fileURLToPath } from 'node:url';
+import { dirname } from 'node:path';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const KEYMAN_ROOT = env.KEYMAN_ROOT ?? (__dirname + '/../../../../../../../');
 
 describe('Engine - Basic Simulation', function() {
   let testJSONtext = fs.readFileSync(require.resolve('@keymanapp/common-test-resources/json/engine_tests/basic_lao_simulation.json'));

web/src/test/auto/headless/engine/interfaces/prediction/predictionContext.tests.js

@@ -4,8 +4,7 @@ import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
 
 import { JSKeyboardProcessor } from 'keyman/engine/js-processor';
-import { NodeKeyboardLoader } from '../../../resources/loader/nodeKeyboardLoader.js';
-import { DEFAULT_PROCESSOR_INIT_OPTIONS } from '../../../resources/defaultProcessorInitOptions.js';
+import { DEFAULT_PROCESSOR_INIT_OPTIONS, NodeKeyboardLoader } from 'keyman/test/resources';
 
 global.keyman = {}; // So that keyboard-based checks against the global `keyman` succeed.
                     // 10.0+ dependent keyboards, like khmer_angkor, will otherwise fail to load.