Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

misc: remove unused pendo lib import #913

Merged
merged 1 commit into from
Nov 19, 2024
Merged

misc: remove unused pendo lib import #913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
327 changes: 327 additions & 0 deletions src/modules/Analytics/AnalyticsBase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,327 @@
import { RcModuleV2, watch } from '@ringcentral-integration/core';
import type { IAnalytics } from '@ringcentral-integration/core/lib/track';

import { Module } from '@ringcentral-integration/commons/lib/di';
import { proxify } from '@ringcentral-integration/commons/lib/proxy/proxify';
import saveBlob from '@ringcentral-integration/commons/lib/saveBlob';
import type {
Deps,
IdentifyOptions,
IExtendedProps,
// PendoAgent,
TrackLog,
TrackProps,
TrackRouter,
} from '@ringcentral-integration/commons/modules/AnalyticsV2/Analytics.interface';
import { trackRouters } from '@ringcentral-integration/commons/modules/AnalyticsV2/analyticsRouters';

// TODO: if use `dialerUI`/`callLogSection`/`adapter`, make sure they should all be RcModuleV2
@Module({
name: 'Analytics',
deps: [
'Auth',
'Brand',
'AnalyticsOptions',
{ dep: 'AccountInfo', optional: true },
{ dep: 'ExtensionInfo', optional: true },
{ dep: 'RouterInteraction', optional: true },
{ dep: 'Locale', optional: true },
],
})
export class Analytics<T extends Deps = Deps>
extends RcModuleV2<T>
implements IAnalytics
{
protected _useLog = this._deps.analyticsOptions.useLog ?? false;

protected _lingerThreshold =
this._deps.analyticsOptions.lingerThreshold ?? 1000;

protected _enablePendo = this._deps.analyticsOptions.enablePendo ?? false;

protected _pendoApiKey = this._deps.analyticsOptions.pendoApiKey ?? '';

protected _trackRouters =
this._deps.analyticsOptions.trackRouters ?? trackRouters;

protected _segment: any;

protected _logs: TrackLog[] = [];

protected _lingerTimeout: NodeJS.Timeout | null = null;

private _pendo: any;

private _waitPendoCount = 0;

private _pendoTimeout?: ReturnType<typeof setTimeout>;

private _env = this._deps.analyticsOptions.env ?? 'dev';

private _eventExtendedPropsMap = new Map<string, IExtendedProps>();
private _useLocalPendoJS =
this._deps.analyticsOptions.useLocalPendoJS ?? false;
private _useLocalAnalyticsJS =
this._deps.analyticsOptions.useLocalAnalyticsJS ?? false;

constructor(deps: T) {
super({
deps,
});
// this._segment = Segment();
// if (this._enablePendo && this._pendoApiKey) {
// Pendo.init(
// this._pendoApiKey,
// this._useLocalPendoJS,
// (pendoInstance: any) => {
// this._pendo = pendoInstance;
// },
// );
// }
}

override onInitOnce() {
if (this._deps.analyticsOptions.analyticsKey && this._segment) {
this._segment.load(
this._deps.analyticsOptions.analyticsKey,
{
integrations: {
All: true,
Mixpanel: true,
},
},
this._useLocalAnalyticsJS,
);
}
if (this._deps.routerInteraction) {
// make sure that track if refresh app
this.trackRouter();
watch(
this,
() => this._deps.routerInteraction!.currentPath,
(currentPath) => {
this.trackRouter(currentPath);
},
);
}
}

trackRouter(currentPath = this._deps.routerInteraction?.currentPath) {
const target = this.getTrackTarget(currentPath);
if (target) {
this.trackNavigation(target);
}

if (this._lingerTimeout) {
clearTimeout(this._lingerTimeout);
}
this._lingerTimeout = setTimeout(() => {
this._lingerTimeout = null;
if (target && this._deps.routerInteraction?.currentPath === currentPath) {
this.trackLinger(target);
}
}, this._lingerThreshold);
}

setUserId() {
this._identify({
userId: this._deps.auth.ownerId,
});
}

identify(options: IdentifyOptions) {
this._identify(options);
}

protected _identify({ userId, ...props }: IdentifyOptions) {
this.analytics?.identify(userId, props, {
integrations: {
All: true,
Mixpanel: true,
Pendo: this._enablePendo,
},
});
// if (this._enablePendo && this._pendoApiKey) {
// this._pendoInitialize({ userId, ...props, env: this._env });
// }
}

// pendoIdentify({
// userId,
// ...props
// }: { userId: string } & Record<string, any>) {
// this._pendoInitialize({ userId, ...props, env: this._env });
// }

// protected _pendoInitialize({
// userId,
// ...props
// }: { userId: string } & Record<string, any>) {
// if (!this._deps.accountInfo || !this._deps.accountInfo.id || !userId) {
// return;
// }
// if (this._pendoTimeout) {
// clearTimeout(this._pendoTimeout);
// }
// if (this._waitPendoCount > 3) {
// return;
// }
// if (!this._pendo) {
// this._pendoTimeout = setTimeout(() => {
// this._waitPendoCount += 1;
// this._pendoInitialize({ userId, ...props });
// }, 5 * 1000);
// return;
// }
// const initializeFunc = !this._pendo.isReady()
// ? this._pendo.initialize
// : this._pendo.updateOptions;
// const pendoAgent: PendoAgent = {
// visitor: {
// id: userId,
// ...props,
// appName: this._deps.brand.defaultConfig.appName,
// appVersion: this._deps.analyticsOptions.appVersion,
// appBrand: this._deps.brand.defaultConfig.code,
// plaBrand: this._deps.accountInfo?.serviceInfo?.brand?.name,
// countryCode: this._deps.accountInfo?.countryCode,
// },
// account: {
// id: `${this._deps.accountInfo.id}`,
// },
// };
// typeof initializeFunc === 'function' &&
// initializeFunc({
// ...pendoAgent,
// });
// }

@proxify
async track(event: string, properties: any = {}) {
if (!this.analytics) {
return;
}

const trackProps: TrackProps = {
...this.trackProps,
...properties,
...this.extendedProps.get(event),
};

this.analytics.track(event, trackProps, {
integrations: {
All: true,
Mixpanel: true,
Pendo: this._enablePendo,
},
});

if (this._useLog) {
this._logs.push({
timeStamp: new Date().toISOString(),
event,
trackProps,
});
}

// if (this._enablePendo && this._pendo?.isReady?.()) {
// this._pendo.track(`${trackProps.appName}-${event}`, trackProps);
// }
}

downloadLogs() {
if (!this._useLog) {
return;
}
const blob = new Blob([JSON.stringify(this._logs, null, 2)], {
type: 'application/json',
});
saveBlob('logs.json', blob);
}

trackNavigation({
router,
eventPostfix,
}: Exclude<TrackRouter, null | undefined>) {
const trackProps = {
router,
appName: this._deps.brand.defaultConfig.appName,
appVersion: this._deps.analyticsOptions.appVersion,
brand: this._deps.brand.defaultConfig.code,
};
this.track(`Navigation: Click/${eventPostfix}`, trackProps);
}

trackLinger({
router,
eventPostfix,
}: Exclude<TrackRouter, null | undefined>) {
const trackProps = {
router,
appName: this._deps.brand.defaultConfig.appName,
appVersion: this._deps.analyticsOptions.appVersion,
brand: this._deps.brand.defaultConfig.code,
};
this.track(`Navigation: View/${eventPostfix}`, trackProps);
}

getTrackTarget(
currentPath = this._deps.routerInteraction?.currentPath,
): TrackRouter {
if (!currentPath) {
return null;
}
const routes = currentPath.split('/');
let formatRoute: string | null = null;
const needMatchSecondRoutes = ['calls'];
if (routes.length >= 3 && needMatchSecondRoutes.indexOf(routes[1]) !== -1) {
formatRoute = `/${routes[1]}/${routes[2]}`;
} else if (routes.length > 1) {
formatRoute = `/${routes[1]}`;
}
const target = this._trackRouters.find(
(target) => formatRoute === target?.router,
);
return target;
}

addEventsExtendedProps({
events,
extendedProps,
}: {
events: string[];
extendedProps: IExtendedProps;
}) {
if (!events || !extendedProps) {
console.error('[events or extendedProps] is required');
return;
}
events.forEach((event) => {
const oldValue = this._eventExtendedPropsMap.get(event);
this._eventExtendedPropsMap.set(event, { ...oldValue, ...extendedProps });
});
}

get extendedProps() {
return this._eventExtendedPropsMap;
}

get analytics() {
return (global as any).analytics;
}

get trackProps(): TrackProps {
return {
appName: this._deps.brand.defaultConfig.appName,
appVersion: this._deps.analyticsOptions.appVersion,
brand: this._deps.brand.defaultConfig.code,
'App Language': this._deps.locale?.currentLocale || '',
'Browser Language': this._deps.locale?.browserLocale || '',
'Extension Type': this._deps.extensionInfo?.info.type || '',
};
}

get pendo() {
return this._pendo;
}
}
4 changes: 1 addition & 3 deletions src/modules/Analytics/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
import crypto from 'crypto';
import { Module } from '@ringcentral-integration/commons/lib/di';
import { watch } from '@ringcentral-integration/core';
import {
Analytics as AnalyticsBase,
} from '@ringcentral-integration/commons/modules/AnalyticsV2';
import type { TrackRouter } from '@ringcentral-integration/commons/modules/AnalyticsV2/Analytics.interface';
import { Analytics as AnalyticsBase } from './AnalyticsBase';
import { AnalyticsBrowser } from './AnalyticsBrowser';
import { trackRouters } from './trackRouters';

Expand Down
2 changes: 1 addition & 1 deletion src/modules/Analytics/trackRouters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {
trackRouters as trackRoutersBase,
} from '@ringcentral-integration/commons/modules/AnalyticsV2';
} from '@ringcentral-integration/commons/modules/AnalyticsV2/analyticsRouters';

export const trackRouters = trackRoutersBase
.filter(r => r.router !== '/conferenceCall')
Expand Down
Loading