How to consume version 6.* in CJS code

[madsteer]

I was trying to bump versions from version 5.6.1 to 6.0.0 in a CJS module I support. I can see in the release notes for 6.0.0 says

(Node.js) CJS style let client = require('openid-client') is possible in versions where process.features.require_module is true.

Using node v 20.17.0, I tried to run my unit tests by NODE_OPTIONS='--experimental-require-module' npm test but I'm still getting an error

SyntaxError: Cannot use import statement outside a module

    > 1 | const client = require('openid-client')

Just wondering if I'm misunderstanding the release note or how I can get this to work.

Thanks,

[panva]

You understand this 100% right. It's quite possible whatever "test" tooling you have is just not ready for this setup. I made the concious decision to only do ESM knowing that support for require(esm) needs to trickle down to tooling.

➜  node -v                                                                        
v20.17.0
➜  NODE_OPTIONS='--experimental-require-module' node -p 'require("openid-client")'
[Module: null prototype] {
  AuthorizationResponseError: [class AuthorizationResponseError extends Error],
  ClientError: [class ClientError extends Error],
  ClientSecretBasic: [Function: ClientSecretBasic],
  ClientSecretJwt: [Function: ClientSecretJwt],
  ClientSecretPost: [Function: ClientSecretPost],
  Configuration: [class Configuration],
  None: [Function: None],
  PrivateKeyJwt: [Function: PrivateKeyJwt],
  ResponseBodyError: [class ResponseBodyError extends Error],
  TlsClientAuth: [Function: TlsClientAuth],
  WWWAuthenticateChallengeError: [class WWWAuthenticateChallengeError extends Error],
  allowInsecureRequests: [Function: allowInsecureRequests],
  authorizationCodeGrant: [AsyncFunction: authorizationCodeGrant],
  buildAuthorizationUrl: [Function: buildAuthorizationUrl],
  buildAuthorizationUrlWithJAR: [AsyncFunction: buildAuthorizationUrlWithJAR],
  buildAuthorizationUrlWithPAR: [AsyncFunction: buildAuthorizationUrlWithPAR],
  buildEndSessionUrl: [Function: buildEndSessionUrl],
  calculatePKCECodeChallenge: [Function: calculatePKCECodeChallenge],
  clientCredentialsGrant: [AsyncFunction: clientCredentialsGrant],
  clockSkew: Symbol(),
  clockTolerance: Symbol(),
  customFetch: Symbol(),
  discovery: [AsyncFunction: discovery],
  enableDecryptingResponses: [Function: enableDecryptingResponses],
  enableDetachedSignatureResponseChecks: [Function: enableDetachedSignatureResponseChecks],
  enableNonRepudiationChecks: [Function: enableNonRepudiationChecks],
  fetchProtectedResource: [AsyncFunction: fetchProtectedResource],
  fetchUserInfo: [AsyncFunction: fetchUserInfo],
  genericGrantRequest: [AsyncFunction: genericGrantRequest],
  getDPoPHandle: [Function: getDPoPHandle],
  initiateDeviceAuthorization: [AsyncFunction: initiateDeviceAuthorization],
  modifyAssertion: Symbol(),
  pollDeviceAuthorizationGrant: [AsyncFunction: pollDeviceAuthorizationGrant],
  randomDPoPKeyPair: [Function: randomDPoPKeyPair],
  randomNonce: [Function: randomNonce],
  randomPKCECodeVerifier: [Function: randomPKCECodeVerifier],
  randomState: [Function: randomState],
  refreshTokenGrant: [AsyncFunction: refreshTokenGrant],
  skipStateCheck: Symbol(),
  skipSubjectCheck: Symbol(),
  tokenIntrospection: [AsyncFunction: tokenIntrospection],
  tokenRevocation: [AsyncFunction: tokenRevocation],
  useCodeIdTokenResponseType: [Function: useCodeIdTokenResponseType],
  useJwtResponseMode: [Function: useJwtResponseMode]
}

➜  node -v
v20.19.0
➜  node -p 'require("openid-client")'
[Module: null prototype] {
  AuthorizationResponseError: [class AuthorizationResponseError extends Error],
  ClientError: [class ClientError extends Error],
  ClientSecretBasic: [Function: ClientSecretBasic],
  ClientSecretJwt: [Function: ClientSecretJwt],
  ClientSecretPost: [Function: ClientSecretPost],
  Configuration: [class Configuration],
  None: [Function: None],
  PrivateKeyJwt: [Function: PrivateKeyJwt],
  ResponseBodyError: [class ResponseBodyError extends Error],
  TlsClientAuth: [Function: TlsClientAuth],
  WWWAuthenticateChallengeError: [class WWWAuthenticateChallengeError extends Error],
  allowInsecureRequests: [Function: allowInsecureRequests],
  authorizationCodeGrant: [AsyncFunction: authorizationCodeGrant],
  buildAuthorizationUrl: [Function: buildAuthorizationUrl],
  buildAuthorizationUrlWithJAR: [AsyncFunction: buildAuthorizationUrlWithJAR],
  buildAuthorizationUrlWithPAR: [AsyncFunction: buildAuthorizationUrlWithPAR],
  buildEndSessionUrl: [Function: buildEndSessionUrl],
  calculatePKCECodeChallenge: [Function: calculatePKCECodeChallenge],
  clientCredentialsGrant: [AsyncFunction: clientCredentialsGrant],
  clockSkew: Symbol(),
  clockTolerance: Symbol(),
  customFetch: Symbol(),
  discovery: [AsyncFunction: discovery],
  enableDecryptingResponses: [Function: enableDecryptingResponses],
  enableDetachedSignatureResponseChecks: [Function: enableDetachedSignatureResponseChecks],
  enableNonRepudiationChecks: [Function: enableNonRepudiationChecks],
  fetchProtectedResource: [AsyncFunction: fetchProtectedResource],
  fetchUserInfo: [AsyncFunction: fetchUserInfo],
  genericGrantRequest: [AsyncFunction: genericGrantRequest],
  getDPoPHandle: [Function: getDPoPHandle],
  getJwksCache: [Function: getJwksCache],
  initiateBackchannelAuthentication: [AsyncFunction: initiateBackchannelAuthentication],
  initiateDeviceAuthorization: [AsyncFunction: initiateDeviceAuthorization],
  modifyAssertion: Symbol(),
  pollBackchannelAuthenticationGrant: [AsyncFunction: pollBackchannelAuthenticationGrant],
  pollDeviceAuthorizationGrant: [AsyncFunction: pollDeviceAuthorizationGrant],
  randomDPoPKeyPair: [Function: randomDPoPKeyPair],
  randomNonce: [Function: randomNonce],
  randomPKCECodeVerifier: [Function: randomPKCECodeVerifier],
  randomState: [Function: randomState],
  refreshTokenGrant: [AsyncFunction: refreshTokenGrant],
  setJwksCache: [Function: setJwksCache],
  skipStateCheck: Symbol(),
  skipSubjectCheck: Symbol(),
  tokenIntrospection: [AsyncFunction: tokenIntrospection],
  tokenRevocation: [AsyncFunction: tokenRevocation],
  useCodeIdTokenResponseType: [Function: useCodeIdTokenResponseType],
  useJwtResponseMode: [Function: useJwtResponseMode]
}

If you would attempt to do a minimal reproduction repo for this issue I'm sure you'd identify the right place to open an issue

[madsteer]

Yes, it does appear to be a Jest issue. However, I don't want to turn testing off and I can't get my build pipeline to succeed without a passing test run so I still have a problem that I'm not sure how to resolve besides not upgrading.

Thanks,

[panva]

It's okay to not upgrade if your stack isn't ready for ESM or can't yet handle require(esm)

[PSanetra]

@madsteer did you find a solution to this issue? I think jest is actually pretty common and I would expect that other users of this library will have the same problem.

[madsteer]

I must have, but it’s been so long I don’t know/remember.

[alxndrsn]

Stability of loading ECMAScript modules using require() can be tracked at https://nodejs.org/api/modules.html#loading-ecmascript-modules-using-require; it's currently marked as "1 - Experimental", but looks likely to be officially "Stable" soon.