@patternfly/chatbot 2.2.1 → 6.3.0-prerelease.10

package/src/tracking/umami_tracking_provider.ts

@@ -8,15 +8,25 @@ declare global {
   }
 }
 
+// Items in a queue.
+// We need to queue up requests until the script is fully loaded
+interface queueT {
+  what: 'i' | 't' | 'p'; // identify, track, pageview
+  name: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  payload?: any;
+}
+
 export class UmamiTrackingProvider implements TrackingSpi, TrackingApi {
-  getKey(): string {
-    return 'umamiKey';
-  }
+  private verbose = false;
+  private websiteId: string | undefined;
+  private queue: queueT[] = [];
 
   initialize(props: InitProps): void {
-    // eslint-disable-next-line no-console
-    console.log('UmamiProvider initialize');
-    const umamiKey = props.umamiKey as string;
+    this.verbose = props.verbose;
+    this.log('UmamiProvider initialize');
+
+    this.websiteId = props.umamiKey as string;
     const hostUrl = props.umamiHostUrl as string;
 
     const script = document.createElement('script');
@@ -25,30 +35,76 @@ export class UmamiTrackingProvider implements TrackingSpi, TrackingApi {
     script.defer = true;
 
     // Configure Umami properties
-    script.setAttribute('data-website-id', umamiKey);
-    script.setAttribute('data-domains', 'localhost'); // TODO ?
+    script.setAttribute('data-website-id', this.websiteId);
+    script.setAttribute('data-host-url', hostUrl);
     script.setAttribute('data-auto-track', 'false');
-    script.setAttribute('data-host-url', hostUrl); // TODO ?
-    script.setAttribute('data-exclude-search', 'false'); // TODO ?
+    script.setAttribute('data-exclude-search', 'false');
+
+    // Now get from config, which may override some of the above.
+    const UMAMI_PREFIX = 'umami-';
+    for (const prop in props) {
+      if (prop.startsWith(UMAMI_PREFIX)) {
+        const att = 'data-' + prop.substring(UMAMI_PREFIX.length);
+        const val = props[prop];
+        script.setAttribute(att, String(val));
+      }
+    }
+    script.onload = () => {
+      this.log('UmamiProvider script loaded');
+      this.flushQueue();
+    };
 
     document.body.appendChild(script);
   }
 
-  identify(userID: string): void {
-    // eslint-disable-next-line no-console
-    console.log('UmamiProvider userID: ' + userID);
-    window.umami?.identify({ userID });
+  identify(userID: string, userProperties: TrackingEventProperties = {}): void {
+    this.log('UmamiProvider userID: ' + userID + ' => ' + JSON.stringify(userProperties));
+    if (window.umami) {
+      window.umami.identify({ userID, userProperties });
+    } else {
+      this.queue.push({ what: 'i', name: userID, payload: userProperties });
+    }
   }
 
   trackPageView(url: string | undefined): void {
-    // eslint-disable-next-line no-console
-    console.log('UmamiProvider url', url);
-    window.umami?.track({ url });
+    this.log('UmamiProvider url ' + url);
+    if (window.umami) {
+      window.umami.track({ url, website: this.websiteId });
+    } else {
+      this.queue.push({ what: 'p', name: String(url) });
+    }
   }
 
   trackSingleItem(item: string, properties?: TrackingEventProperties): void {
-    // eslint-disable-next-line no-console
-    console.log('UmamiProvider: trackSingleItem' + item, properties);
-    window.umami?.track(item, properties);
+    this.log('UmamiProvider: trackSingleItem ' + item + JSON.stringify(properties));
+    if (window.umami) {
+      window.umami.track(item, properties);
+    } else {
+      this.queue.push({ what: 't', name: item, payload: properties });
+    }
+  }
+
+  flushQueue(): void {
+    for (const item of this.queue) {
+      this.log('Queue flush ' + JSON.stringify(item));
+      switch (item.what) {
+        case 'i':
+          this.identify(item.name, item.payload);
+          break;
+        case 't':
+          this.trackSingleItem(item.name, item.payload);
+          break;
+        case 'p':
+          this.trackPageView(item.name);
+          break;
+      }
+    }
+  }
+
+  log(msg: string): void {
+    if (this.verbose) {
+      // eslint-disable-next-line no-console
+      console.debug('UmamiProvider: ', msg);
+    }
   }
 }

package/src/SourcesCard/__snapshots__/SourcesCard.test.tsx.snap

@@ -1,34 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`SourcesCard should render card 1`] = `
-<div>
-  <div
-    class="pf-chatbot__source"
-  >
-    <span>
-      1 source
-    </span>
-    <div
-      class="pf-v6-c-card pf-chatbot__sources-card"
-      data-ouia-component-id="OUIA-Generated-Card-1"
-      data-ouia-component-type="PF6/Card"
-      data-ouia-safe="true"
-      id=""
-    >
-      <div
-        class="pf-v6-c-card__title"
-      >
-        <div
-          class="pf-v6-c-card__title-text pf-chatbot__sources-card-title"
-        >
-          <a
-            href=""
-          >
-            Source 1
-          </a>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-`;