Use Fetch API instead of XMLHttpRequest #91
Merged
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
2254da3 to
c01ff8c
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the adapter’s network interactions by replacing all XMLHttpRequest calls with the Fetch API, improving maintainability and aligning with modern asynchronous patterns. It also enhances test coverage and supplements the documentation for these changes.
- Replaces XHR calls with promise-based Fetch API calls in key adapter functions.
- Updates and adds tests to validate proper error messaging and functionality for user profile, user info, and login flows.
- Adjusts configuration instantiation and adds support for dynamic adapter configuration.
Reviewed Changes
Copilot reviewed 9 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test/tests/*.spec.ts | Updates tests with improved error messages and additional profile checks. |
| test/support/test-executor.ts | Adds new executor methods for handling profile and user info. |
| test/app/app.ts | Introduces an Express-based test server and removes legacy JS server. |
| lib/keycloak.js | Refactors network-related code from XHR to Fetch API, with promise handling. |
| .github/workflows/main.yml | Updates Node.js version for enhanced TypeScript support. |
Files not reviewed (2)
- docs/guides/securing-apps/javascript-adapter.adoc: Language not supported
- test/package.json: Language not supported
Comments suppressed due to low confidence (2)
lib/keycloak.js:652
- The reference to 'req.status' in the token refresh catch block is invalid since the code now uses fetch. Consider removing this check or replacing it with a validation based on the fetch response.
if (req.status === 400) {
lib/keycloak.js:568
- [nitpick] The error message could be revised for improved clarity (e.g., 'make sure the adapter is not configured using a generic OIDC provider') provided that tests are updated accordingly.
throw new Error('Unable to load user profile, make sure the adapter not is configured using a generic OIDC provider.');
Closes keycloak#87 Signed-off-by: Jon Koops <jonkoops@gmail.com>
rmartinc
approved these changes
May 5, 2025
| } | ||
| } | ||
| if (!realmUrl) { | ||
| throw new Error('Unable to load user profile, make sure the adapter not is configured using a generic OIDC provider.'); |
Contributor
There was a problem hiding this comment.
Suggested change
| throw new Error('Unable to load user profile, make sure the adapter not is configured using a generic OIDC provider.'); | |
| throw new Error('Unable to load user profile, make sure the adapter is not configured using a generic OIDC provider.'); |
| await executor.submitLoginForm() | ||
| await executor.instantiateAdapter(configOptions) | ||
| await executor.initializeAdapter(initOptions) | ||
| await expect(executor.loadUserProfile()).rejects.toThrow('Unable to load user profile, make sure the adapter not is configured using a generic OIDC provider.') |
Contributor
There was a problem hiding this comment.
Suggested change
| await expect(executor.loadUserProfile()).rejects.toThrow('Unable to load user profile, make sure the adapter not is configured using a generic OIDC provider.') | |
| await expect(executor.loadUserProfile()).rejects.toThrow('Unable to load user profile, make sure the adapter is not configured using a generic OIDC provider.') |
Contributor
Author
|
Thanks @rmartinc, looks like the auto-merge already happened, but I will fix your comments in a follow up. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR is the first step in refactoring the internals so that we can get rid of the callback nightmare that is preventing the library from being maintainable. It replaces all the
XMLHttpRequestcalls with the Fetch API, so that we can use promises instead, allowing forasync/awaiteverywhere in later refactors.It also improves test coverage for the code that was touched, as well as supplementing some documentation related to these features.
Closes #87