Improve running tests when server is missing #6494
Merged
Conversation
This file contains 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
kraenhansen
force-pushed
the
kh/skip-tests-missing-server
branch
from
ff58f60
to
368cd6e
Compare
…ion has gone away
kraenhansen
force-pushed
the
kh/skip-tests-missing-server
branch
from
368cd6e
to
e8f32bc
Compare
|
I'll merge to improve our DX tomorrow 🙈 Feel free to review in retrospect (or not 😊). |
elle-j
reviewed
Feb 21, 2024
Comment on lines
+49
to
+65
| function getCredentials(): Credentials { | ||
| if (typeof publicKey === "string" && typeof privateKey === "string") { | ||
| return { | ||
| kind: "api-key", | ||
| publicKey, | ||
| privateKey, | ||
| }; | ||
| } else { | ||
| return { | ||
| kind: "username-password", | ||
| username, | ||
| password, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| const credentials = getCredentials(); |
There was a problem hiding this comment.
Looks like the function is only used once, so it may not need to be a function.
Suggested change
| function getCredentials(): Credentials { | |
| if (typeof publicKey === "string" && typeof privateKey === "string") { | |
| return { | |
| kind: "api-key", | |
| publicKey, | |
| privateKey, | |
| }; | |
| } else { | |
| return { | |
| kind: "username-password", | |
| username, | |
| password, | |
| }; | |
| } | |
| } | |
| const credentials = getCredentials(); | |
| const credentials: Credentials = | |
| typeof publicKey === "string" && typeof privateKey === "string" | |
| ? { kind: "api-key", publicKey, privateKey } | |
| : { kind: "username-password", username, password }; |
| ); | ||
| } | ||
|
|
||
| function printWarningBox(...lines: string[]) { |
There was a problem hiding this comment.
We may want to utilize this elsewhere as well, could we move this into /utils? 🙂
| describe("Logging", () => { | ||
| importAppBefore(buildAppConfig("with-pbs").anonAuth().flexibleSync()); | ||
| afterEach(() => Realm.clearTestState()); | ||
| // Skipped because reusing a single app across tests break this |
There was a problem hiding this comment.
Suggested change
| // Skipped because reusing a single app across tests break this |
kraenhansen
added a commit
that referenced
this pull request
Feb 29, 2024
kraenhansen
added a commit
that referenced
this pull request
Feb 29, 2024
bimusiek
pushed a commit
to bimusiek/realm-js
that referenced
this pull request
Mar 14, 2024
* Moved app import util into the hook * Moved skipping tests on missingServer into importAppBefore hook * Skip tests which importAppBefore when failing to install * Renamed "realmBaseUrl" to "baseUrl" * Fix closing a realm if import skips it completely * Moved testing non-existing app id into "with valid app" * Printing warning after all tests * Fixed "allowSkippingServerTests" * Adding documentation to importAppBefore * Moved "Logging" test out of "SessionTest" because the importApp function has gone away
bimusiek
pushed a commit
to bimusiek/realm-js
that referenced
this pull request
Mar 14, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What, How & Why?
I want to improve the default experience of running our tests.
Unfortunately, contributors to the project isn't allowed to pull the docker image and run the test server, but that shouldn't keep them from running tests at all. In its current form, its a subtly documented feature of the test runner that you can run with
missingServercontext, but I want to make this more obvious and improve the default experience (when the server is missing).If the environment does not explicitly provide a
baseUrlnor setmissingServer=falsethe tests usingimportAppBeforewill skip if the app import fails due to a connection refusal. If this happens, a warning will be printed after all tests has ran:realmBaseUrltobaseUrlsince theres only ever one base url, so there's no need to disambiguate it and the latter is the name used in the code anyway.missingServer, to include this check in theimportAppBeforehook as they were (almost) always used together anyway and could easily be forgotten.☑️ ToDos
Compatibilitylabel is updated or copied from previous entryCOMPATIBILITY.mdpackage.jsons (if updating internal packages)Breakinglabel has been applied or is not necessary