Small enhancements to types, adding userAgent to GA and fixing Segment deprecated encoder

Author: ulricesparra-oliveai

src/index.ts

@@ -5,7 +5,7 @@ import { Component, WhisperComponentType } from '@oliveai/ldk/dist/whisper';
 import * as Transports from './transports';
 
 class AnalyticsClient {
-  transport?: Transports.BaseTransport;
+  constructor(public transport?: Transports.BaseTransport) {}
 
   setTransport(transport: Transports.BaseTransport) {
     this.transport = transport;

src/transports/base/index.ts

@@ -15,7 +15,7 @@ export abstract class BaseTransport<
 
   constructor(readonly transportConfig: T, readonly userConfig: U, readonly loopConfig: L) {}
 
-  static async send(request: network.HTTPRequest) {
+  protected static async send(request: network.HTTPRequest) {
     const { statusCode } = await network.httpRequest(request);
     if (statusCode < 200 || statusCode >= 300) {
       console.error(`Request failed with status code ${statusCode}: ${request.url}`);
@@ -31,4 +31,6 @@ export abstract class BaseTransport<
   abstract trackComponentCopied(type: whisper.WhisperComponentType): Promise<void>;
 
   abstract trackEvent(props: any): Promise<void>;
+
+  protected abstract buildRequest(...args: any[]): network.HTTPRequest;
 }

src/transports/google/index.ts

@@ -15,7 +15,7 @@ export class GoogleTransport extends BaseTransport<GoogleTransportConfig> {
 
     await this.trackEvent({
       ...this.transportConfig.categoryActionMap.whisperDisplayed,
-      label: isUpdated ? 'Updated' : 'Created',
+      label: `${name}, ${isUpdated ? 'updated' : 'created'}`,
     });
   }
 
@@ -44,14 +44,12 @@ export class GoogleTransport extends BaseTransport<GoogleTransportConfig> {
     await GoogleTransport.send(this.buildRequest(HitType.Event, props));
   }
 
-  private buildRequest(hitType: HitType, props?: EventProps) {
+  protected buildRequest(hitType: HitType, props?: EventProps) {
     return {
       method: 'POST',
       url: this.baseUrl,
       headers: {
-        'User-Agent': [
-          `OliveHelps @oliveai/loop-analytics ${this.loopConfig.name.replace(/ /g, '')}`,
-        ],
+        'User-Agent': [this.transportConfig.userAgent], // Required by GA
       },
       body: this.buildRequestBody(hitType, props),
     };
@@ -71,12 +69,12 @@ export class GoogleTransport extends BaseTransport<GoogleTransportConfig> {
       t: hitType,
       dh: this.loopConfig.name,
       dp: `/${this.loopConfig.name}/${this.currentWhisperName}`,
-      dt: this.currentWhisperName || '',
+      dt: this.currentWhisperName ?? '',
     };
     if (hitType === HitType.Event && props) {
       propStringObj.ec = props.category;
       propStringObj.ea = props.action;
-      propStringObj.el = props.label;
+      propStringObj.el = props.label ?? '';
     }
     customDimensions?.forEach(({ index, value }) => {
       propStringObj[`cd${index}`] = value;
@@ -86,6 +84,7 @@ export class GoogleTransport extends BaseTransport<GoogleTransportConfig> {
     });
 
     return Object.entries(propStringObj)
+      .filter(([, value]) => !!value)
       .map(([key, value]) => `${key}=${encodeURIComponent(value)}`)
       .join('&');
   }

src/transports/google/types.ts

@@ -8,28 +8,31 @@ export enum HitType {
 export interface EventProps {
   category: string;
   action: string;
-  label: string;
+  label?: string;
 }
 
-export interface CategoryActionObj {
-  category: string;
-  action: string;
+export interface CategoryActionMap {
+  [key: string]: EventProps;
+  whisperDisplayed: EventProps;
+  whisperClosed: EventProps;
+  componentClicked: EventProps;
+  componentCopied: EventProps;
 }
 
-export interface CategoryActionMap {
-  [key: string]: CategoryActionObj;
-  whisperDisplayed: CategoryActionObj;
-  whisperClosed: CategoryActionObj;
-  componentClicked: CategoryActionObj;
-  componentCopied: CategoryActionObj;
+export interface CustomDimensionOrMetric {
+  index: number;
+  name: string;
+  value: string;
 }
 
 export interface GoogleTransportConfig extends TransportConfig {
   apiVersion?: number;
   trackingId: string;
+  userAgent: string;
   /** Set expectations for what categories and actions are going to be used */
   categoryActionMap: CategoryActionMap;
   /** Map custom dimension index to an alias name and set its value */
-  customDimensions?: { index: number; name: string; value: string }[];
-  customMetrics?: { index: number; name: string; value: string }[];
+  customDimensions?: CustomDimensionOrMetric[];
+  /** Map custom metric index to an alias name and set its value */
+  customMetrics?: CustomDimensionOrMetric[];
 }

src/transports/segment/index.ts

@@ -72,7 +72,7 @@ export class SegmentTransport extends BaseTransport<SegmentTransportConfig, Segm
     await SegmentTransport.send(this.buildRequest('/track', props));
   }
 
-  private buildRequest(endpoint: string, props: SegmentProps) {
+  protected buildRequest(endpoint: string, props: SegmentProps) {
     return {
       method: 'POST',
       url: `${this.baseUrl}${endpoint}`,
@@ -83,7 +83,9 @@ export class SegmentTransport extends BaseTransport<SegmentTransportConfig, Segm
 
   private buildRequestHeaders() {
     return {
-      Authorization: [`Basic ${btoa(`${this.transportConfig.writeKey}:`)}`],
+      Authorization: [
+        `Basic ${Buffer.from(`${this.transportConfig.writeKey}:`).toString('base64')}`,
+      ],
       'Content-Type': ['application/json'],
     };
   }