Skip to content

refactor: Migrate Forwarder module to TypeScript #988

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

Draft
wants to merge 8 commits into
base: development
Choose a base branch
from
Draft

refactor: Migrate Forwarder module to TypeScript #988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6cb7247
refactor: Migrate Forwarder module to TypeScript
alexs-mparticle Feb 28, 2025
cac319e
Save Point
alexs-mparticle Mar 18, 2025
76359af
Save Point
alexs-mparticle Mar 18, 2025
a6ffd29
Save Point
alexs-mparticle Mar 18, 2025
a695bb8
Save Point
alexs-mparticle Mar 18, 2025
52d0b36
Save Point
alexs-mparticle Mar 18, 2025
34feff4
Save Point
alexs-mparticle Mar 18, 2025
e449d19
Save Point
alexs-mparticle Mar 18, 2025
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
14 changes: 7 additions & 7 deletions src/apiClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import Constants from './constants';
import Types from './types';
import Types, { MessageType } from './types';
import { BatchUploader } from './batchUploader';
import { SDKEvent, SDKDataPlan } from './sdkRuntimeModels';
import KitBlocker from './kitBlocking';
import { Dictionary, isEmpty, parseNumber } from './utils';
import { IUploadObject } from './serverModel';
import { MPForwarder } from './forwarders.interfaces';
import { IMParticleUser, ISDKUserAttributes } from './identity-user-interfaces';
import { AsyncUploader, FetchUploader, XHRUploader } from './uploaders';
import { IMParticleWebSDKInstance } from './mp-instance';
import { appendUserInfo } from './user-utils';
import { ConfiguredKit } from './forwarders.interfaces';

export interface IAPIClient {
uploader: BatchUploader | null;
Expand All @@ -24,7 +24,7 @@ export interface IAPIClient {
) => void;
initializeForwarderStatsUploader: () => AsyncUploader;
prepareForwardingStats: (
forwarder: MPForwarder,
forwarder: ConfiguredKit,
event: IUploadObject
) => void;
}
Expand Down Expand Up @@ -140,7 +140,7 @@ export default function APIClient(
// https://go.mparticle.com/work/SQDSDKS-6935
// While Event Name is 'usually' a string, there are some cases where it is a number
// in that it could be a type of MessageType Enum
if (event.EventName as unknown as number !== Types.MessageType.AppStateTransition) {
if (event.EventName as unknown as number !== MessageType.AppStateTransition) {
if (kitBlocker && kitBlocker.kitBlockingEnabled) {
event = kitBlocker.createBlockedEvent(event);
}
Expand Down Expand Up @@ -193,7 +193,7 @@ export default function APIClient(
};

this.prepareForwardingStats = function(
forwarder: MPForwarder,
forwarder: ConfiguredKit,
event:SDKEvent,
) : void {
let forwardingStatsData: IForwardingStatsData;
Expand All @@ -206,8 +206,8 @@ export default function APIClient(
n: event.EventName,
attrs: event.EventAttributes,
sdk: event.SDKVersion,
dt: event.EventDataType,
et: event.EventCategory,
dt: event.EventDataType as number,
et: event.EventCategory as number,
dbg: event.Debug,
ct: event.Timestamp,
eec: event.ExpandedEventCount,
Expand Down
16 changes: 12 additions & 4 deletions src/configAPIClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import {
SDKEventCustomFlags,
SDKInitConfig,
} from './sdkRuntimeModels';
import { Dictionary } from './utils';
import {
AsyncUploader,
IFetchPayload,
Expand All @@ -14,6 +13,11 @@ import {
} from './uploaders';
import { IPixelConfiguration } from './cookieSyncManager';
import { IMParticleWebSDKInstance } from './mp-instance';
import {
ForwarderSettings,
UserAttributeFilters,
UserIdentityFilters,
} from './forwarders.interfaces';

export interface IKitConfigs extends IKitFilterSettings {
name: string;
Expand All @@ -23,18 +27,22 @@ export interface IKitConfigs extends IKitFilterSettings {
isVisible: boolean;
isDebugString: BooleanStringLowerCase;
hasDebugString: BooleanStringLowerCase;
settings: Dictionary;
settings: ForwarderSettings;
eventSubscriptionId: number;
excludeAnonymousUser: boolean;

// https://go.mparticle.com/work/SQDSDKS-5156
isSandbox?: boolean;
hasSandbox?: boolean;
}

export interface IKitFilterSettings {
eventTypeFilters: number[];
eventNameFilters: number[];
screenNameFilters: number[];
screenAttributeFilters: number[];
userIdentityFilters: number[];
userAttributeFilters: number[];
userIdentityFilters: UserIdentityFilters;
userAttributeFilters: UserAttributeFilters;
attributeFilters: number[];
filteringEventAttributeValue?: IFilteringEventAttributeValue;
filteringUserAttributeValue?: IFilteringUserAttributeValue;
Expand Down
155 changes: 140 additions & 15 deletions src/forwarders.interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
import { SDKEvent, SDKEventCustomFlags, SDKInitConfig } from './sdkRuntimeModels';
import { Dictionary } from './utils';
import { IKitConfigs, IKitFilterSettings } from './configAPIClient';
import { IdentityApiData } from '@mparticle/web-sdk';
import {
IFilteringConsentRuleValues,
IFilteringEventAttributeValue,
IFilteringUserAttributeValue,
IKitConfigs,
IKitFilterSettings
} from './configAPIClient';
import {
Callback,
IdentityApiData,
Logger,
UserIdentities
} from '@mparticle/web-sdk';
import {
IMParticleUser,
ISDKUserIdentity,
UserAttributes,
ISDKUserAttributes,
ISDKUserIdentity
} from './identity-user-interfaces';

// TODO: https://go.mparticle.com/work/SQDSDKS-4475
export type MPForwarder = Dictionary;
import { IForwardingStatsData } from './apiClient';
import { IPixelConfiguration } from './cookieSyncManager';
import { IdentityAPIMethod } from './identity.interfaces';
import { AsyncUploader } from './uploaders';
import { IdentityType } from './types';

// The state of the kit when accessed via window.KitName via CDN
// or imported as an NPM package
Expand Down Expand Up @@ -40,17 +53,17 @@ export interface ConfiguredKit
common: Dictionary<unknown>;
id: number;
init(
settings: Dictionary<unknown>,
settings: ForwarderSettings,
service: forwardingStatsCallback,
testMode: boolean,
trackerId: string | null,
userAttributes: UserAttributes,
userIdentities: ISDKUserIdentity,
userAttributes: ISDKUserAttributes,
userIdentities: ISDKUserIdentity[],
appVersion: string,
appName: string,
customFlags: SDKEventCustomFlags,
clientId: string
): string;
): string;
onIdentifyComplete(
user: IMParticleUser,
filteredIdentityRequest: IdentityApiData
Expand All @@ -67,16 +80,27 @@ export interface ConfiguredKit
user: IMParticleUser,
filteredIdentityRequest: IdentityApiData
): string;
onUserIdentified(user: IMParticleUser): string;

// Techically these do not return a value, but we sometimes use a string as a debug message
onUserIdentified(user: IMParticleUser, identityApiData?: IdentityApiData): string;
process(event: SDKEvent): string;
setOptOut(isOptingOut: boolean): string;
removeUserAttribute(key: string): string;
setUserAttribute(key: string, value: string): string;
setUserIdentity(id: UserIdentityId, type: UserIdentityType): void;
setUserAttribute(key: string, value: string | string[]): string;
setUserIdentity(id: UserIdentityId, type: UserIdentityType): string;

// TODO: https://go.mparticle.com/work/SQDSDKS-5156
isSandbox: boolean;
hasSandbox: boolean;

filteringConsentRuleValues: IFilteringConsentRuleValues;
filteringUserAttributeValue: IFilteringUserAttributeValue;
filteringEventAttributeValue: IFilteringEventAttributeValue;
excludeAnonymousUser: boolean;
userIdentityFilters: UserIdentityFilters;
userAttributeFilters: UserAttributeFilters;
initialized: boolean;
logger: Logger;
}

export type UserIdentityId = string;
Expand All @@ -86,3 +110,104 @@ export type forwardingStatsCallback = (
forwarder: ConfiguredKit,
event: SDKEvent
) => void;


export type UserIdentityFilters = typeof IdentityType[];
export type UserAttributeFilters = number[];

// FIXME: Remove in favor of IKitConfigs.settings
// https://go.mparticle.com/work/SQDSDKS-7113
export interface ForwarderSettings {
PriorityValue?: number;
}

// Represents the Forwarder Module in the SDK
export interface IMPForwarder {
// @deprecated
setForwarderUserIdentities: (userIdentities: UserIdentities) => void;

setForwarderOnUserIdentified: (user: IMParticleUser) => void;
setForwarderOnIdentityComplete: (user: IMParticleUser, identityMethod: IdentityAPIMethod) => void;
handleForwarderUserAttributes: (functionNameKey: string, key: string, value: string | string[]) => void;
id: number;
settings: ForwarderSettings;
forwarderStatsUploader: AsyncUploader;
isInitialized: boolean;
// filteringConsentRuleValues: IFilteringConsentRuleValues;
// filteringUserAttributeValue: IFilteringUserAttributeValue;
// filteringEventAttributeValue: IFilteringEventAttributeValue;
// excludeAnonymousUser: boolean;
// userIdentityFilters: UserIdentityFilters;
// userAttributeFilters: UserAttributeFilters;
// initialized: boolean;
// logger: Logger;

suffix?: string;

eventSubscriptionId: number;

eventNameFilters: number[];
eventTypeFilters: number[];
attributeFilters: number[];

screenNameFilters: number[];
screenAttributeFilters: number[];


// Side loaded kit functionality in Forwarder methods
kitInstance: UnregisteredKit;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i see this as existing on the unregistered Kit, rather than IMPForwarder

// https://go.mparticle.com/work/SQDSDKS-5156
isSandbox?: boolean;
hasSandbox?: boolean;
isVisible?: boolean;

Comment on lines +161 to +163
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are on the kitconfig and not the IMPForwarder class also

configureSideloadedKit: (kitConstructor: RegisteredKit) => void;

sendSingleForwardingStatsToServer: (forwardingStatsData: IForwardingStatsData) => void;
applyToForwarders: (functionName: string, functionArgs: any[]) => void;
sendEventToForwarders: (event: SDKEvent) => void;
processPixelConfigs: (pixelConfigs: SDKInitConfig) => void;
configurePixel: (pixelConfig: IPixelConfiguration) => void;
returnConfiguredKit: (forwarder: RegisteredKit, config: IKitConfigs) => ConfiguredKit;

processSideloadedKits: (mpConfig: SDKInitConfig) => void;

// init: (
// setting: ForwarderSettings,
// forwarderSettingsCallback: Callback,
// testMode: boolean,
// trackerId: string | number | null,
// filteredUserAttributes: ISDKUserAttributes,
// filteredUserIdentities: ISDKUserIdentity[],
// appVersion: string,
// appName: string,
// customFlags: SDKEventCustomFlags,
// clientId: string
// ) => void;

initForwarders: (userIdentities: UserIdentities, forwarderStatsCallback: Callback) => void;
isEnabledForUserAttributes: (filterObject?: IFilteringUserAttributeValue, user?: IMParticleUser) => boolean;
isEnabledForUnknownUser: (excludeAnonymousUserBoolean: boolean, user: IMParticleUser) => boolean;

name?: string;

// Techically these do not return a value, but we sometimes use a string as a debug message
// onUserIdentified?: (user: IMParticleUser, identityApiData?: IdentityApiData) => string;
// onIdentifyComplete?: (user: IMParticleUser, identityApiData: IdentityApiData) => string;
// onLoginComplete?: (user: IMParticleUser, identityApiData: IdentityApiData) => string;
// onLogoutComplete?: (user: IMParticleUser, identityApiData: IdentityApiData) => string;
// onModifyComplete?: (user: IMParticleUser, identityApiData: IdentityApiData) => string;
// setOptOut: (optOut: boolean) => string;
// setUserAttribute?: (key: string, value: string | string[]) => string;
// removeUserAttribute?: (key: string) => string;
// process?: (event: SDKEvent) => string;
// setUserIdentity?: (identity: string, type: number) => string;

getForwarderStatsQueue: () => IForwardingStatsData[];
setForwarderStatsQueue: (queue: IForwardingStatsData[]) => void;
processForwarders: (config: SDKInitConfig, forwardingStatsCallback: Callback) => void;
processUIEnabledKits: (config: SDKInitConfig) => void;
returnKitConstructors: () => Dictionary<RegisteredKit>;
configureUIEnabledKit: (config: IKitConfigs, kitConstructor: Dictionary<RegisteredKit>) => void;
}
Loading
Loading