🐛catalog-backend-module-keycloak: Cannot run in windows

[sednus]

Plugin Name

catalog-backend-module-keycloak

📜 Description

When attempting to run yarn dev after adding the plugin in backend's index.ts file. It throws the following error immediately after login process:

Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only URLs with a scheme in: file, data, and node are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'

👍 Expected behavior

It should attempt to retrieve the data from the configured keycloak's instance

👎 Actual Behavior with Screenshots

It crashes shortly after logging in, giving the following error:

[1] 2025-01-02T15:34:12.635Z catalog info Reading Keycloak users and groups class=KeycloakOrgEntityProvider taskId=KeycloakOrgEntityProvider:default:refresh taskInstanceId=00edcc78-8461-4e65-9240-f3dc2ef85585

[1] Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only URLs with a scheme in: file, data, and node are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'

[1]     at throwIfUnsupportedURLScheme (node:internal/modules/esm/load:217:11)

[1]     at defaultLoad (node:internal/modules/esm/load:109:3)

[1]     at ModuleLoader.load (node:internal/modules/esm/loader:670:12)

[1]     at ModuleLoader.loadAndTranslate (node:internal/modules/esm/loader:483:43)

[1]     at #createModuleJob (node:internal/modules/esm/loader:507:36)

[1]     at #getJobFromResolveResult (node:internal/modules/esm/loader:275:34)

[1]     at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:243:41)

[1]     at async onImport.tracePromise.__proto__ (node:internal/modules/esm/loader:546:25) {

[1]   code: 'ERR_UNSUPPORTED_ESM_URL_SCHEME'

[1] }

[0] webpack compiled successfully

[0] <i> [webpack-dev-server] Gracefully shutting down. To force exit, press ^C again. Please wait...

[1] Terminate batch job (Y/N)? yarn start-backend exited with code 1

[0] yarn start exited with code 1

👟 Reproduction steps

Follow steps in plugin's README.

1. yarn workspace backend add @backstage-community/plugin-catalog-backend-module-keycloak
2. add keycloak configuration using the new backend configuration

catalog:
 providers:
   keycloakOrg:
     default:
       baseUrl: https://<keycloak_host>
       loginRealm: ${KEYCLOAK_REALM}
       realm: ${KEYCLOAK_REALM}
       clientId: ${KEYCLOAK_CLIENTID}
       clientSecret: ${KEYCLOAK_CLIENTSECRET}
       schedule: # Optional (defaults to the configurations below if not provided); same options as in TaskScheduleDefinition
         # supports cron, ISO duration, "human duration" as used in code
         frequency: { minutes: 30 } # Customize this to fit your needs
         # supports ISO duration, "human duration" as used in code
         timeout: { minutes: 3 } # Customize this to fit your needs

3. Register plugin in backend's index

const backend = createBackend();

/* highlight-add-next-line */
backend.add(
 import('@backstage-community/plugin-catalog-backend-module-keycloak'),
);

backend.start();

4. run yarn dev to start the client

📃 Provide the context for the Bug.

[1] 2025-01-02T15:34:12.635Z catalog info Reading Keycloak users and groups class=KeycloakOrgEntityProvider taskId=KeycloakOrgEntityProvider:default:refresh taskInstanceId=00edcc78-8461-4e65-9240-f3dc2ef85585

[1] Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only URLs with a scheme in: file, data, and node are supported by the default ESM loader. On Windows, absolute paths must be valid file:// URLs. Received protocol 'c:'

[1]     at throwIfUnsupportedURLScheme (node:internal/modules/esm/load:217:11)

[1]     at defaultLoad (node:internal/modules/esm/load:109:3)

[1]     at ModuleLoader.load (node:internal/modules/esm/loader:670:12)

[1]     at ModuleLoader.loadAndTranslate (node:internal/modules/esm/loader:483:43)

[1]     at #createModuleJob (node:internal/modules/esm/loader:507:36)

[1]     at #getJobFromResolveResult (node:internal/modules/esm/loader:275:34)

[1]     at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:243:41)

[1]     at async onImport.tracePromise.__proto__ (node:internal/modules/esm/loader:546:25) {

[1]   code: 'ERR_UNSUPPORTED_ESM_URL_SCHEME'

[1] }

[0] webpack compiled successfully

[0] <i> [webpack-dev-server] Gracefully shutting down. To force exit, press ^C again. Please wait...

[1] Terminate batch job (Y/N)? yarn start-backend exited with code 1

[0] yarn start exited with code 1

👀 Have you spent some time to check if this bug has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Are you willing to submit PR?

Yes I am willing to submit a PR!

[christoph-jerolimov]

Hi @sednus,

the error message said that you configure somewhere a path like c:\, could you try file://c:/.. or file:///c:/.. instead?

Does this really just happen after installing and configuring the keycloak backend?

[sednus]

Yes, following the steps in the README. In a clean build with only the keycloak plugin installed yields the mentioned error. It appears to run fine if running in WSL but we don't all have access to it in out development environments.

There is no file path configuration added at all, simply the catalog provider configuration specified for the connectivity to keycloak to be established.

catalog:
 providers:
   keycloakOrg:
     default:
       baseUrl: https://<keycloak_host>
       loginRealm: ${KEYCLOAK_REALM}
       realm: ${KEYCLOAK_REALM}
       clientId: ${KEYCLOAK_CLIENTID}
       clientSecret: ${KEYCLOAK_CLIENTSECRET}
       schedule: # Optional (defaults to the configurations below if not provided); same options as in TaskScheduleDefinition
         # supports cron, ISO duration, "human duration" as used in code
         frequency: { minutes: 30 } # Customize this to fit your needs
         # supports ISO duration, "human duration" as used in code
         timeout: { minutes: 3 } # Customize this to fit your needs

It appears to happen as the plugin attempts to do the initial loading of user/groups from keycloak, since I do get an info log indicating that it is attempting to do so

[backend]: 2025-01-14T16:40:47.364Z catalog info Reading Keycloak users and groups class=KeycloakOrgEntityProvider taskId=KeycloakOrgEntityProvider:default:refresh taskInstanceId=2df6eff4-cca6-48ea-8e81-c640acd51906

[sednus]

I believe this issue is related to using the inclusion package as they have logged a similar issue:

davidmarkclements/inclusion#1

The call after the successful info log that we get is using inclusion to load the keycloak admin client.:

https://github.com/backstage/community-plugins/blob/9c1f5c1c889e8c0b690d77e945ade915895ead7d/workspaces/keycloak/plugins/catalog-backend-module-keycloak/src/providers/KeycloakOrgEntityProvider.ts#L202C4-L204C7

[christoph-jerolimov]

Interesting. I like to see if I can reproduce this on Windows, but I can't give any promises on the timeline.

[christoph-jerolimov]

@AndrienkoAleksandr @schultzp2020 @dzemanov please let me know if you want check that yourself or if you have any idea on that issue?

[sednus]

Somebody did put a pull request to fix the issue in the inclusion library but there are no maintainers that can pull it in. I think finding an alternative its probably for the best

[04kash]

This might be a good place to look for alternative approaches to using inclusion: microsoft/TypeScript#43329 (If that is what is causing the issue, haven't tried reproducing it)

[mishraabhay2010]

For me inclusion did not worked . As a workaround I build package using esbuild . Created these 3 files and build local package.
package,json

{
"name": "@my-localpackage/keycloak-bundle",
"version": "1.0.0",
"main": "dist/bundle.js",
"types": "dist/index.d.ts",
"scripts": {
"build": "node build.js && node copy-types.js"
},
"keywords": [],
"author": "",
"license": "ISC",
"description": "",
"dependencies": {
"@keycloak/keycloak-admin-client": "^26.0.5",
"esbuild": "^0.24.0"
}
}

build.js

const esbuild = require('esbuild');

esbuild.build({
entryPoints: ['node_modules/@keycloak/keycloak-admin-client/lib/index.js'],
bundle: true,
outfile: 'dist/bundle.js',
platform: 'node',
external: ['fs', 'path'], // Add any other external dependencies here
}).catch(() => process.exit(1));

copy-types.js
const fs = require('fs');
const path = require('path');

const src = path.resolve(__dirname, 'node_modules/@keycloak/keycloak-admin-client/lib/index.d.ts');
const dest = path.resolve(__dirname, 'dist/index.d.ts');

fs.copyFileSync(src, dest);

npm install
npm run build
npm pack

in package.json , include reference
"@my-localpackage/keycloak-bundle": "file:my-localpackage-keycloak-bundle-1.0.0.tgz",

in KeycloakOrgEntityProvider.ts , reference KeycloakAdminClient from local package
import KeycloakAdminClient from '@my-localpackage/keycloak-bundle'

[awanlin]

@04kash any ideas here?

[04kash]

The inclusion package was added to support using @keycloak/keycloak-admin-client (an ESM package). However, since Backstage version 1.36 supports dynamic imports for ESM packages, we can now replace inclusion with dynamic imports. I tested this by updating the Keycloak plugin to 1.36 and replacing inclusion, and didn't encounter any issues. I'll open a PR after further testing.