maint(web): re-add engine .js tests 🎼 #15497
Open
+262
−176
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
keymanapp-test-bot
bot
changed the title
github-actions
bot
added
web/
maint
ermshiperete
force-pushed
the
maint/web/jstests
branch
from
39763fc to
677ca5f
Compare
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
ermshiperete
force-pushed
the
maint/web/jstests
branch
from
677ca5f to
e2b31c4
Compare
mcdurdin
requested changes
Jan 29, 2026
Member
mcdurdin
left a comment
mcdurdin
left a comment
There was a problem hiding this comment.
I think we should have another go at sorting the locations of files. And a few more changes requested. Happy to rubber-ducky if that makes it easier.
Comment on lines
+17
to
+22
| import { CLOUD_TIMEOUT_ERR, CLOUD_STUB_REGISTRATION_ERR } from './cloud/cloudQueryEngine.js'; | ||
|
|
||
| export const unitTestEndpoints = { | ||
| CLOUD_TIMEOUT_ERR, | ||
| CLOUD_STUB_REGISTRATION_ERR | ||
| }; |
Member
There was a problem hiding this comment.
This doesn't feel right. unitTestEndpoints are intended for targets for unit tests, not for sharing variables. There's no need for these to be exported for their usages in unit tests -- they are both used just one time in nodeCloudeRequester.ts (tests):
keyman/web/src/test/auto/resources/loader/nodeCloudRequester.ts
Lines 35 to 38 in 9930a8c
keyman/web/src/test/auto/resources/loader/nodeCloudRequester.ts
Lines 58 to 60 in 9930a8c
IMHO, those errors should just be plain strings in the unit testing code -- it's not deployed, there's no localization need, etc, etc. Just KISS. We can then eliminate the messiness of exporting these two constants.
Suggested change
| import { CLOUD_TIMEOUT_ERR, CLOUD_STUB_REGISTRATION_ERR } from './cloud/cloudQueryEngine.js'; | |
| export const unitTestEndpoints = { | |
| CLOUD_TIMEOUT_ERR, | |
| CLOUD_STUB_REGISTRATION_ERR | |
| }; |
Contributor
Author
There was a problem hiding this comment.
ok, inlined those consts.
Comment on lines
+76
to
+90
| # 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 |
Member
There was a problem hiding this comment.
This doesn't seem right. We are running code coverage tests elsewhere just fine.
Comment on lines
12
to
+17
| 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 + '/../../../../../../../../'); |
Member
There was a problem hiding this comment.
Can we put this into a helper module in keyman/test/resources and avoid repeating it?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
queryEngine.tstocloudQueryEngine.tsto match the class namekeyboard-storage/cloud/index.tsCLOUD_TIMEOUT_ERRandCLOUD_STUB_REGISTRATION_ERRasunitTestEndpointstest/resourcesto exports inweb/package.json. This was necessary because the compiled .ts test files are underweb/buildwhereas the .js test files are underweb/srcand so the relative paths in imports no longer work. Also fix the imports in test files.node-keyboard-loader.tswhich was just a wrapper aroundNodeKeyboardLoader.specialized-backspace.tests.jstospecialized-backspace.tests.tsand fixed resulting issues/warnings.I'm not happy to put the compiled files for
test/auto/resourcesunderweb/src/test/auto/resources/build, but that's the only way I got it to work. If I put the compiled files inweb/build/test/resourcesit couldn't find the types forpromise-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