@omega-tracker/omg-abstract-strategy-plugin 0.0.1-security → 934.746.0

package/src/com/didichuxing/tracker/plugin/events/AEvent.ts

@@ -0,0 +1,261 @@
+/**
+ * Copyright (c) 2018-present, Didi, Inc.
+ * All rights reserved.
+ *
+ * @author Cory(kuanghongrui@didichuxing.com)
+ *
+ * @file The class of AEvent
+ */
+
+import { IPlanObject } from 'com/didichuxing/IPlanObject';
+import { IObjectMap } from 'com/didichuxing/IObjectMap';
+import { IContext } from 'com/didichuxing/context/IContext';
+import { ITrackerContext } from 'com/didichuxing/tracker/context/ITrackerContext';
+import { IContextContainer } from 'com/didichuxing/context/IContextContainer';
+import { ITrackedEvent } from 'com/didichuxing/tracker/event/ITrackedEvent';
+import { ITrackedEventData } from 'com/didichuxing/tracker/event/ITrackedEventData';
+import { IAttrs } from 'com/didichuxing/tracker/IAttrs';
+import { EventStatus } from 'com/didichuxing/tracker/plugin/events/EventStatus';
+import GlobalUtil from 'com/didichuxing/tracker/plugin/utils/GlobalUtil';
+
+export default abstract class AEvent implements ITrackedEvent, IContextContainer {
+
+  /**
+   * 上报的上下文环境
+   */
+  private readonly context: IContext;
+
+  /**
+   * 事件的额外参数。
+   */
+  private readonly attrs: IAttrs;
+
+  /**
+   * @constructor
+   * @param {IAttrs} attrs
+   * @param {IContext} context
+   */
+  constructor(attrs: IAttrs, context: IContext) {
+    this.attrs = attrs;
+    this.context = context;
+  }
+
+  /**
+   * 获取版本号
+   */
+  private getVersion() {
+    return {
+      trackerVersion: this.getContext().version
+    };
+  }
+
+  /**
+   * @abstract
+   * @returns {string}
+   */
+  public abstract getType(): string;
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {ITrackedEventData}
+   */
+  public getData(): ITrackedEventData {
+    const context: ITrackerContext = this.getContext() as ITrackerContext;
+    return {
+      eventId: this.getType(),
+      timestamp: new Date().getTime(),
+      viewportId: context.viewportId,
+      appName: context.appName,
+      appVersion: context.appVersion,
+      omgId: context.omgId,
+      url: context.url || location.href,
+      latitude: context.latitude,
+      longitude: context.longitude,
+      userAgent: context.userAgent,
+      osType: context.osType,
+      osVersion: context.osVersion,
+      appKey: context.appKey || context.productName,
+      userName: context.userName,
+      userId: context.userId,
+      cityId: context.cityId,
+      telephone: context.telephone,
+      bizId: context.bizId,
+      locale: context.locale,
+      countyId: context.countyId,
+      countryCallingCode: context.countryCallingCode,
+      utcOffset: context.utcOffset,
+      attrs: this.getAttrs(),
+      from: this.getFrom()
+    };
+  }
+
+  /**
+   * 将事件数据属性映射成上报的字段。
+   * @returns {IObjectMap<string>}
+   */
+  protected getDataKeyMap(): IObjectMap<string> {
+    return {
+      eventId: 'e',
+      timestamp: 'ts',
+      viewportId: 'uwid',
+      version: 'jv',
+      appName: 'an',
+      appVersion: 'av',
+      omgId: 'oid',
+      url: 'v',
+      latitude: 'lat',
+      longitude: 'lng',
+      userAgent: 'ua',
+      osType: 'ot',
+      osVersion: 'ov',
+      appKey: 'ak',
+      userName: 'un',
+      userId: 'uid',
+      cityId: 'cityid',
+      telephone: 'tel',
+      bizId: 'bizId',
+      locale: 'le',
+      countyId: 'coi',
+      countryCallingCode: 'dcc',
+      utcOffset: 'uo',
+      from: 'fr'
+    };
+  }
+
+  /**
+   * 将attrs属性映射成上报的字段。
+   * @returns {IObjectMap<string>}
+   */
+  protected getAttrsKeyMap(): IObjectMap<string> {
+    return {
+      _label: 'l',
+      trackerVersion: 'jv'
+    };
+  }
+
+  /**
+   * 把event data（去除attrs）序列化成json字符串。
+   * @returns {string}
+   */
+  public serialize2JsonStrWithoutAttrs(): string {
+    try {
+      const eventData: ITrackedEventData = this.getData();
+      const obj: IPlanObject = {};
+      const dataKeyMap: IObjectMap<string> = this.getDataKeyMap();
+      for (const prop in eventData) {
+        if (prop !== 'attrs' && !/Null|Undefined/.test(Object.prototype.toString.call(eventData[prop]))) {
+          obj[dataKeyMap[prop] || prop] = eventData[prop];
+        }
+      }
+      return JSON.stringify(obj);
+    } catch (e) {
+      GlobalUtil.dispatchOmgLog('serialize2JsonStrWithoutAttrs Error');
+      return '';
+    }
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {string}
+   */
+  public serialize(): string {
+    try {
+      const eventData: ITrackedEventData = this.getData();
+      // 先用Object内置类的keys方法获取要排序对象的属性名，再利用Array原型上的sort方法对获取的属性名进行排序，newkey是一个数组
+      const newkeys = Object.keys(eventData).sort();
+      const kvs: string[] = [];
+      const dataKeyMap: IObjectMap<string> = this.getDataKeyMap();
+      // 要保证顺序 所以attrs也放进了循环
+      newkeys.forEach((prop) => {
+        if (prop !== 'attrs' && !/Null|Undefined/.test(Object.prototype.toString.call(eventData[prop]))) {
+          kvs.push(`${ dataKeyMap[prop] || prop }=${ encodeURIComponent(eventData[prop]) }`);
+        } else if (prop === 'attrs') {
+          const attrsJsonStr: string = this.serializeAttrs2JsonStr(eventData.attrs || {});
+          if (attrsJsonStr !== '{}') {
+            kvs.push(`attrs=${ encodeURIComponent(attrsJsonStr) }`);
+          }
+        }
+      });
+      return kvs.join('&');
+    } catch (e) {
+      GlobalUtil.dispatchOmgLog('serialize Error');
+      return '';
+    }
+  }
+
+  /**
+   * 格式化attrs
+   * @param {IAttrs} attrs
+   * @returns {string}
+   */
+  public serializeAttrs2JsonStr(attrs: IAttrs): string {
+    try {
+      const serializedAttrs: IPlanObject = {};
+      const attrsKeyMap: IObjectMap<string> = this.getAttrsKeyMap();
+      for (const prop in attrs) {
+        if (attrs.hasOwnProperty(prop)) {
+          const key: string = attrsKeyMap[prop] || prop;
+          if (/Object|Array/.test(Object.prototype.toString.call(attrs[prop]))) {
+            serializedAttrs[key] = JSON.stringify(attrs[prop]);
+          } else if (/String/.test(Object.prototype.toString.call(attrs[prop])) && attrs[prop]) {
+            serializedAttrs[key] = attrs[prop];
+          } else if (/Number/.test(Object.prototype.toString.call(attrs[prop]))) {
+            serializedAttrs[key] = attrs[prop];
+          } else if (/Boolean/.test(Object.prototype.toString.call(attrs[prop]))) {
+            serializedAttrs[key] = attrs[prop] | 0;
+          }
+        }
+      }
+      return JSON.stringify(serializedAttrs);
+    } catch (e) {
+      GlobalUtil.dispatchOmgLog('serializeAttrs2JsonStr Error');
+      return '';
+    }
+
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {IContext}
+   */
+  public getContext(): IContext {
+    return this.context;
+  }
+
+  /**
+   * 该事件的额外参数。
+   * @returns {IAttrs}
+   */
+  protected getAttrs(): IAttrs {
+    const thisAttrs: any = {};
+    const context = this.getContext() as ITrackerContext;
+    if (context.openId) {
+      thisAttrs['_OMGPUID'] = context.openId;
+    }
+
+    return Object.assign(thisAttrs, context.attrs || {}, this.attrs, this.getVersion());
+  }
+
+  /**
+   * 获取框架来源
+   * 由业务方指定
+   */
+  protected getFrom(): string {
+    const context: ITrackerContext = this.getContext() as ITrackerContext;
+    if (GlobalUtil.isEmptyString(context.from)) {
+      return `h5-${ context.from }`;
+    } else {
+      return 'h5';
+    }
+  }
+
+  /**
+   * 事件的状态。
+   * {@link com/didichuxing/tracker/h5/plugins/events/EventStatus}
+   * @returns {EventStatus}
+   */
+  public abstract get status(): EventStatus;
+}

package/src/com/didichuxing/tracker/plugin/events/BlockedEvent.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2018-present, Didi, Inc.
+ * All rights reserved.
+ *
+ * @author Cory(kuanghongrui@didichuxing.com)
+ *
+ * @file The class of BlockedEvent
+ */
+
+import { IContext } from 'com/didichuxing/context/IContext';
+import { IAttrs } from 'com/didichuxing/tracker/IAttrs';
+import { EventStatus } from 'com/didichuxing/tracker/plugin/events/EventStatus';
+import AEvent from 'com/didichuxing/tracker/plugin/events/AEvent';
+
+export default class BlockedEvent extends AEvent {
+
+  /**
+   * custom event id
+   */
+  private readonly eventId: string;
+
+  /**
+   * @constructor
+   * @param {IAttrs} attrs
+   * @param {IContext} context
+   */
+  constructor(eventId: string, attrs: IAttrs, context: IContext) {
+    super(attrs, context);
+    this.eventId = eventId;
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   */
+  protected initSequence(): void {
+    /* stop sequence */
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {string}
+   */
+  public getType(): string {
+    return this.eventId;
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {EventStatus}
+   */
+  public get status(): EventStatus {
+    return EventStatus.BLOCKED;
+  }
+}

package/src/com/didichuxing/tracker/plugin/events/EventStatus.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2018-present, Didi, Inc.
+ * All rights reserved.
+ *
+ * @author Cory(kuanghongrui@didichuxing.com)
+ *
+ * @file The enum class of EventStatus
+ */
+
+export enum EventStatus {
+
+  /**
+   * 正常状态的事件。
+   */
+  NORMAL = 'normal',
+
+  /**
+   * 被阻止上报的事件
+   * @type {string}
+   */
+  BLOCKED = 'blocked',
+
+  /**
+   * 上报失败的事件。
+   * @type {string}
+   */
+  FAILED = 'failed',
+
+  /**
+   * 上报超时的事件。
+   * @type {string}
+   */
+  TIMEOUT = 'timeout'
+}

package/src/com/didichuxing/tracker/plugin/events/FailedEvent.ts

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) 2018-present, Didi, Inc.
+ * All rights reserved.
+ *
+ * @author Cory(kuanghongrui@didichuxing.com)
+ *
+ * @file The class of FailedEvent
+ */
+
+import { IContext } from 'com/didichuxing/context/IContext';
+import { IAttrs } from 'com/didichuxing/tracker/IAttrs';
+import { EventStatus } from 'com/didichuxing/tracker/plugin/events/EventStatus';
+import AEvent from 'com/didichuxing/tracker/plugin/events/AEvent';
+
+export default class FailedEvent extends AEvent {
+
+  /**
+   * custom event id
+   */
+  private readonly eventId: string;
+
+  /**
+   * error event
+   * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error}
+   */
+  private readonly error: Error;
+
+  /**
+   * @constructor
+   * @param {IAttrs} attrs
+   * @param {IContext} context
+   */
+  constructor(error: Error, eventId: string, attrs: IAttrs, context: IContext) {
+    super(attrs, context);
+    this.error = error;
+    this.eventId = eventId;
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {string}
+   */
+  public getType(): string {
+    return this.eventId;
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {EventStatus}
+   */
+  public get status(): EventStatus {
+    return EventStatus.FAILED;
+  }
+
+  /**
+   * 获取出错信息事件。
+   * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error}
+   * @returns {ErrorEvent}
+   */
+  public getError(): Error {
+    return this.error;
+  }
+}

package/src/com/didichuxing/tracker/plugin/events/SequencedEvent.ts

@@ -0,0 +1,85 @@
+/**
+ * Copyright (c) 2018-present, Didi, Inc.
+ * All rights reserved.
+ *
+ * @author Cory(kuanghongrui@didichuxing.com)
+ *
+ * @file The class of SequencedEvent
+ */
+
+import { IContext } from 'com/didichuxing/context/IContext';
+import { IObjectMap } from 'com/didichuxing/IObjectMap';
+import { IAttrs } from 'com/didichuxing/tracker/IAttrs';
+import { ITrackerContext } from 'com/didichuxing/tracker/context/ITrackerContext';
+import { ITrackedEventData } from 'com/didichuxing/tracker/event/ITrackedEventData';
+import { EventStatus } from 'com/didichuxing/tracker/plugin/events/EventStatus';
+import AEvent from 'com/didichuxing/tracker/plugin/events/AEvent';
+
+export default abstract class SequencedEvent extends AEvent {
+
+  /**
+   * Omega事件全局序列名称前缀。
+   * @type {string}
+   */
+  public static readonly OMG_SEQUENCE_NAME_PREFIX: string = '__OMG_SEQUENCE_';
+
+  /**
+   * Omega事件全局序列名称后缀。
+   * @type {string}
+   */
+  public static readonly OMG_SEQUENCE_NAME_SUFFIX: string = '__';
+
+  /**
+   * 事件的序列号。
+   * 默认为-1，表示没有序列号。
+   */
+  private readonly sequence: number;
+
+  /**
+   * @constructor
+   * @param {IAttrs} attrs
+   * @param {IContext} context
+   */
+  constructor(attrs: IAttrs, context: IContext) {
+    super(attrs, context);
+    const prefix: string = SequencedEvent.OMG_SEQUENCE_NAME_PREFIX;
+    const suffix: string = SequencedEvent.OMG_SEQUENCE_NAME_SUFFIX;
+    if (!(window as any)[`${ prefix }${ (context as ITrackerContext).viewportId }${ suffix }`]) {
+      (window as any)[`${ prefix }${ (context as ITrackerContext).viewportId }${ suffix }`] = 0;
+    }
+    this.sequence = (window as any)[`${ prefix }${ (context as ITrackerContext).viewportId }${ suffix }`]++;
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {ITrackedEventData}
+   */
+  public getData(): ITrackedEventData {
+    return {
+      ...super.getData(),
+      sequence: this.sequence
+    };
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {IObjectMap<string>}
+   */
+  protected getDataKeyMap(): IObjectMap<string> {
+    return {
+      ...super.getDataKeyMap(),
+      sequence: 'seq'
+    };
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {EventStatus}
+   */
+  public get status(): EventStatus {
+    return EventStatus.NORMAL;
+  }
+}

package/src/com/didichuxing/tracker/plugin/events/TimeoutEvent.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) 2018-present, Didi, Inc.
+ * All rights reserved.
+ *
+ * @author Cory(kuanghongrui@didichuxing.com)
+ *
+ * @file The class of TimeoutEvent
+ */
+
+import { IContext } from 'com/didichuxing/context/IContext';
+import { IAttrs } from 'com/didichuxing/tracker/IAttrs';
+import { EventStatus } from 'com/didichuxing/tracker/plugin/events/EventStatus';
+import AEvent from 'com/didichuxing/tracker/plugin/events/AEvent';
+
+export default class TimeoutEvent extends AEvent {
+
+  /**
+   * custom event id
+   */
+  private readonly eventId: string;
+
+  /**
+   * @constructor
+   * @param {IAttrs} attrs
+   * @param {IContext} context
+   */
+  constructor(eventId: string, attrs: IAttrs, context: IContext) {
+    super(attrs, context);
+    this.eventId = eventId;
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {string}
+   */
+  public getType(): string {
+    return this.eventId;
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {EventStatus}
+   */
+  public get status(): EventStatus {
+    return EventStatus.TIMEOUT;
+  }
+}

package/src/com/didichuxing/tracker/plugin/reportor/AH5EventReportor.ts

@@ -0,0 +1,135 @@
+/**
+ * Copyright (c) 2018-present, Didi, Inc.
+ * All rights reserved.
+ *
+ * @author Cory(kuanghongrui@didichuxing.com)
+ *
+ * @file The class of AH5EventReportor
+ */
+
+import { ITrackerContext } from 'com/didichuxing/tracker/context/ITrackerContext';
+import { IEventReportor } from 'com/didichuxing/tracker/plugin/reportor/IEventReportor';
+import { ITrackedEvent } from 'com/didichuxing/tracker/event/ITrackedEvent';
+import PluginUtils from 'com/didichuxing/tracker/plugin/utils/PluginUtils';
+import GlobalUtil from 'com/didichuxing/tracker/plugin/utils/GlobalUtil';
+import DataQueueSet from 'com/didichuxing/tracker/plugin/reportor/DataQueueSet';
+
+interface IUnreportedItem {
+
+  /**
+   * 未上报事件
+   */
+  event: ITrackedEvent;
+
+  /**
+   * 该事件上报成功后执行的方法。
+   * @param {ITrackedEvent} evt
+   */
+  resolve(evt: ITrackedEvent): void;
+
+  /**
+   * 该事件上报失败后执行的方法。
+   * @param {ITrackedEvent} evt
+   */
+  reject(evt: ITrackedEvent): void;
+}
+
+export default abstract class AH5EventReportor implements IEventReportor {
+
+  private context: ITrackerContext;
+  private event: ITrackedEvent;
+
+  /**
+   * 待上报事件。
+   */
+  private unreportedEvents: IUnreportedItem[];
+  /**
+   * 上报失败事件
+   */
+  protected readonly errorreportedEvents = DataQueueSet.getInstance();
+
+  /**
+   * @constructor
+   * @param {ITrackerContext} context
+   * @param {ITrackedEvent} event
+   */
+  constructor(context: ITrackerContext, event: ITrackedEvent) {
+    this.event = event;
+    this.context = context;
+    this.unreportedEvents = [];
+    this.reportEventsAfterLoad = this.reportEventsAfterLoad.bind(this);
+    window.addEventListener('load', this.reportEventsAfterLoad);
+  }
+
+  /**
+   * load之后，将未上报事件集中依次上报。
+   */
+  private reportEventsAfterLoad(): void {
+    window.removeEventListener('load', this.reportEventsAfterLoad);
+    while (this.unreportedEvents.length) {
+      const unreportedItem: IUnreportedItem | undefined = this.unreportedEvents.shift();
+      if (unreportedItem) {
+        this.reportEventImmediately(unreportedItem.event).then(unreportedItem.resolve, unreportedItem.reject);
+      }
+    }
+  }
+
+  /**
+   * 得到context信息
+   * @returns {ITrackerContext}
+   */
+  protected getContext(): ITrackerContext {
+    return this.context;
+  }
+
+  /**
+   * 上报路径path
+   * @returns {string}
+   */
+  protected get reportPath(): string {
+    return '/api/web/stat';
+  }
+
+  /**
+   * @override
+   * @inheritDoc
+   * @returns {Promise<ITrackedEvent>}
+   */
+  public reportEvent(): Promise<ITrackedEvent> {
+    if (!GlobalUtil.isEmptyString(this.event.getData().appKey)) {
+      GlobalUtil.dispatchOmgLog('[Omega] H5 appKey 参数 不可为空');
+      throw new Error('[Omega] H5 appKey 参数 不可为空');
+      return Promise.reject();
+    }
+
+    if (GlobalUtil.isLoaded() || this.event.getType() === PluginUtils.EVENT_ID_PAGE_INIT ||
+      this.event.getType() === PluginUtils.EVENT_ID_OMG_LOG) {
+      // onload已经执行完或者当前事件为页面初始化事件
+      // 如果有上报错误的数据也去上报
+      if (!this.errorreportedEvents.empty()) {
+        this.errorreportedEvents.getData().forEach((value) => {
+          this.reportEventImmediately(value);
+        });
+      }
+      this.errorreportedEvents.removeAll();
+      return this.reportEventImmediately(this.event);
+    } else {
+      // load未完成，将事件聚集，等待集中上报。
+      return new Promise<ITrackedEvent>((resolve: (evt: ITrackedEvent) => void,
+        reject: (evt: ITrackedEvent) => void): void => {
+        this.unreportedEvents.push({
+          event: this.event,
+          resolve: resolve,
+          reject: reject
+        });
+      });
+    }
+  }
+
+  /**
+   * 马上直接上报事件。
+   * @param {ITrackedEvent} event
+   * @returns {Promise<ITrackedEvent>}
+   */
+  protected abstract reportEventImmediately(event: ITrackedEvent): Promise<ITrackedEvent>;
+}