fix(shared): Improve error message when Publishable Key is missing (#…

…4785)
clerk · Dec 17, 2024 · 84ccb00 · 84ccb00
1 parent 1a69e84
commit 84ccb00
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/.changeset/long-birds-worry.md b/.changeset/long-birds-worry.md
@@ -0,0 +1,5 @@
+---
+'@clerk/shared': patch
+---
+
+Improve error message when Publishable Key is missing when trying to parse it.
diff --git a/packages/shared/src/__tests__/keys.test.ts b/packages/shared/src/__tests__/keys.test.ts
@@ -58,6 +58,12 @@ describe('parsePublishableKey(key)', () => {
     expect(() => parsePublishableKey('fake_pk', { fatal: true })).toThrowError('Publishable key not valid.');
   });
 
+  it('throws an error if the publishable key is missing, when fatal: true', () => {
+    expect(() => parsePublishableKey(undefined, { fatal: true })).toThrowError(
+      'Publishable key is missing. Ensure that your publishable key is correctly configured. Double-check your environment configuration for your keys, or access them here: https://dashboard.clerk.com/last-active?path=api-keys',
+    );
+  });
+
   it('applies the proxyUrl if provided', () => {
     expect(parsePublishableKey('pk_live_Y2xlcmsuY2xlcmsuZGV2JA==', { proxyUrl: 'example.com/__clerk' })).toEqual({
       frontendApi: 'example.com/__clerk',

diff --git a/packages/shared/src/keys.ts b/packages/shared/src/keys.ts
@@ -39,7 +39,12 @@ export function parsePublishableKey(
   key = key || '';
 
   if (!key || !isPublishableKey(key)) {
-    if (options.fatal) {
+    if (options.fatal && !key) {
+      throw new Error(
+        'Publishable key is missing. Ensure that your publishable key is correctly configured. Double-check your environment configuration for your keys, or access them here: https://dashboard.clerk.com/last-active?path=api-keys',
+      );
+    }
+    if (options.fatal && !isPublishableKey(key)) {
       throw new Error('Publishable key not valid.');
     }
     return null;