Add troubleshooting links (#294)

croct-tech · Aug 11, 2024 · ae589b9 · ae589b9
1 parent aed496d
commit ae589b9
Show file tree

Hide file tree

Showing 26 changed files with 8 additions and 5 deletions.
diff --git a/preview/playwright.config.ts b/preview/playwright.config.ts
@@ -21,7 +21,7 @@ const config: PlaywrightTestConfig = {
         timeout: 5000,
 
         toHaveScreenshot: {
-            maxDiffPixelRatio: 0.01,
+            maxDiffPixelRatio: 0.02,
         },
     },
     /* Run test in files in parallel */

diff --git a/preview/test/widget.spec.ts-snapshots/widget-expanded-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-expanded-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-expanded-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-expanded-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-expanded-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-expanded-webkit.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-invalid-locale-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-invalid-locale-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-invalid-locale-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-invalid-locale-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-invalid-locale-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-invalid-locale-webkit.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-minimized-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-minimized-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-minimized-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-minimized-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-minimized-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-minimized-webkit.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-slot-default-content-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-slot-default-content-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-slot-default-content-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-slot-default-content-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-slot-default-content-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-slot-default-content-webkit.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-truncated-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-truncated-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-truncated-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-truncated-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-truncated-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-truncated-webkit.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-experiment-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-without-experiment-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-experiment-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-without-experiment-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-experiment-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-without-experiment-webkit.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-locale-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-without-locale-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-locale-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-without-locale-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-locale-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-without-locale-webkit.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-variant-chromium.png b/preview/test/widget.spec.ts-snapshots/widget-without-variant-chromium.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-variant-firefox.png b/preview/test/widget.spec.ts-snapshots/widget-without-variant-firefox.png
diff --git a/preview/test/widget.spec.ts-snapshots/widget-without-variant-webkit.png b/preview/test/widget.spec.ts-snapshots/widget-without-variant-webkit.png
diff --git a/src/plug.ts b/src/plug.ts
@@ -137,7 +137,9 @@ export class GlobalPlug implements Plug {
             throw new Error(
                 'The specified app ID and the auto-detected app ID are conflicting. '
                 + 'There is no need to specify an app ID when using an application-specific tag. '
-                + 'Please try again omitting the "appId" option.',
+                + 'Please try again omitting the "appId" option. '
+                + 'Read more on https://croct.help/sdk/js/conflicting-app-id',
+
             );
         }
 
@@ -146,7 +148,8 @@ export class GlobalPlug implements Plug {
         if (appId === null) {
             throw new Error(
                 'The app ID must be specified when it cannot be auto-detected. '
-                + 'Please try again specifying the "appId" option.',
+                + 'Please try again specifying the "appId" option.'
+                + 'Read more on https://croct.help/sdk/js/missing-app-id',
             );
         }
 
@@ -295,7 +298,7 @@ export class GlobalPlug implements Plug {
 
     private get sdk(): SdkFacade {
         if (this.instance === undefined) {
-            throw new Error('Croct is not plugged in.');
+            throw new Error('Croct is not plugged in. Read more on https://croct.help/sdk/js/not-plugged-in');
         }
 
         return this.instance;
@@ -331,7 +334,7 @@ export class GlobalPlug implements Plug {
 
     public identify(userId: string): void {
         if (typeof userId !== 'string') {
-            throw new Error('The user ID must be a string. Read more on https://croct.help/plug-js/id-conversion');
+            throw new Error('The user ID must be a string. Read more on https://croct.help/sdk/js/invalid-user-id');
         }
 
         this.sdk.identify(userId);