udpate config validation logic

Author: tusharpandey13

README.md

@@ -159,12 +159,7 @@ The SDK performs validation of required configuration options when initializing
   - `clientSecret` (or `AUTH0_CLIENT_SECRET` environment variable), OR
   - `clientAssertionSigningKey` (or `AUTH0_CLIENT_ASSERTION_SIGNING_KEY` environment variable)
 
-If any of these required options are missing, the SDK will throw a `ConfigurationError` with the code `missing_required_options` and details about which specific options are missing. The error includes:
-
-- A list of missing options
-- Instructions on how to provide each missing option (via the correct environment variable or constructor parameter)
-
-Example of handling configuration errors:
+If any of these required options are missing, the SDK will throw a `ConfigurationError` with the code `MISSING_REQUIRED_OPTIONS` and a detailed error message explaining which options are missing and how to provide them.
 
 ## Routes
 

src/errors/index.ts

@@ -170,11 +170,30 @@ export class ConfigurationError extends SdkError {
    * Constructs a new `ConfigurationError` instance.
    *
    * @param code - The error code.
-   * @param message - The error message.
-   * @param missingOptions - Optional array of missing configuration option names.
+   * @param missingOptions - Array of missing configuration option names.
+   * @param envVarMapping - Optional mapping of option names to their environment variable names.
    */
-  constructor(code: string, message: string, missingOptions?: string[]) {
-    super(message);
+  constructor(
+    code: string,
+    missingOptions: string[] = [],
+    envVarMapping: Record<string, string> = {}
+  ) {
+    // Standard intro message explaining the issue
+    let errorMessage =
+      "Not all required options where provided when creating an instance of Auth0Client. Ensure to provide all missing options, either by passing it to the Auth0Client constructor, or by setting the corresponding environment variable.\n\n";
+
+    // Add specific details for each missing option
+    missingOptions.forEach((key) => {
+      if (key === "clientAuthentication") {
+        errorMessage += `Missing: either 'clientSecret' (AUTH0_CLIENT_SECRET env var) or 'clientAssertionSigningKey' (AUTH0_CLIENT_ASSERTION_SIGNING_KEY env var)\n`;
+      } else if (envVarMapping[key]) {
+        errorMessage += `Missing: ${key}: Set ${envVarMapping[key]} env var or pass ${key} in options\n`;
+      } else {
+        errorMessage += `Missing: ${key}\n`;
+      }
+    });
+
+    super(errorMessage.trim());
     this.name = "ConfigurationError";
     this.code = code;
     this.missingOptions = missingOptions;

src/server/client.test.ts

@@ -54,7 +54,10 @@ describe("Auth0Client", () => {
         expect(configError.missingOptions).toContain("appBaseUrl");
         expect(configError.missingOptions).toContain("secret");
 
-        // Check that error message contains correct environment variable names
+        // Check that error message contains specific text
+        expect(configError.message).toContain(
+          "Not all required options where provided"
+        );
         expect(configError.message).toContain(ENV_VARS.DOMAIN);
         expect(configError.message).toContain(ENV_VARS.CLIENT_ID);
         expect(configError.message).toContain(ENV_VARS.CLIENT_SECRET);

src/server/client.ts

@@ -684,11 +684,6 @@ export class Auth0Client {
     }
 
     if (missing.length) {
-      // Create the error message for all missing options
-      let errorMsg =
-        `Missing mandatory configuration: ${missing.join(", ")}\n` +
-        "Provide via constructor options or environment variables:\n";
-
       // Map of option keys to their exact environment variable names
       const envVarNames: Record<string, string> = {
         domain: "AUTH0_DOMAIN",
@@ -697,19 +692,10 @@ export class Auth0Client {
         secret: "AUTH0_SECRET"
       };
 
-      // Generate specific error messages for each missing option using the exact env var names
-      for (const key of missing) {
-        if (key === "clientAuthentication") {
-          errorMsg += `- Either provide 'clientSecret' (AUTH0_CLIENT_SECRET env var) or 'clientAssertionSigningKey' (AUTH0_CLIENT_ASSERTION_SIGNING_KEY env var)\n`;
-        } else {
-          errorMsg += `- ${key}: Set ${envVarNames[key]} env var or pass ${key} in options\n`;
-        }
-      }
-
       throw new ConfigurationError(
         ConfigurationErrorCode.MISSING_REQUIRED_OPTIONS,
-        errorMsg.trim(),
-        missing
+        missing,
+        envVarNames
       );
     }