vwo-fme-node-sdk/lib/api/TrackEvent.ts

VWO Node/JavaScript SDK for Feature Management and Experimentation

/**
 * Copyright 2024-2025 Wingify Software Pvt. Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { ApiEnum } from '../enums/ApiEnum';
import { ErrorLogMessagesEnum } from '../enums/log-messages';
import { SettingsModel } from '../models/settings/SettingsModel';
import { ContextModel } from '../models/user/ContextModel';
import { LogManager } from '../packages/logger';
import IHooksService from '../services/HooksService';
import { dynamic } from '../types/Common';
import { doesEventBelongToAnyFeature } from '../utils/FunctionUtil';
import { buildMessage } from '../utils/LogMessageUtil';
import { BatchEventsQueue } from '../services/BatchEventsQueue';
import {
  getEventsBaseProperties,
  getTrackGoalPayloadData,
  sendPostApiRequest,
  getShouldWaitForTrackingCalls,
} from '../utils/NetworkUtil';

interface ITrack {
  /**
   * Tracks an event with given properties and context.
   * @param settings Configuration settings for the tracking.
   * @param eventName Name of the event to track.
   * @param context Contextual information like user details.
   * @param eventProperties Properties associated with the event.
   * @param hooksService Manager for handling hooks and callbacks.
   * @returns A promise that resolves to a record indicating the success or failure of the event tracking.
   */
  track(
    settings: SettingsModel,
    eventName: string,
    context: ContextModel,
    eventProperties: Record<string, dynamic>,
    hooksService: IHooksService,
  ): Promise<Record<string, boolean>>;
}

export class TrackApi implements ITrack {
  /**
   * Implementation of the track method to handle event tracking.
   * Checks if the event exists, creates an impression, and executes hooks.
   */
  async track(
    settings: SettingsModel,
    eventName: string,
    context: ContextModel,
    eventProperties: Record<string, dynamic>,
    hooksService: IHooksService,
  ): Promise<Record<string, boolean>> {
    if (doesEventBelongToAnyFeature(eventName, settings)) {
      // Create an impression for the track event
      if (getShouldWaitForTrackingCalls()) {
        await createImpressionForTrack(settings, eventName, context, eventProperties);
      } else {
        createImpressionForTrack(settings, eventName, context, eventProperties);
      }
      // Set and execute integration callback for the track event
      hooksService.set({ eventName: eventName, api: ApiEnum.TRACK_EVENT });
      hooksService.execute(hooksService.get());

      return { [eventName]: true };
    }
    // Log an error if the event does not exist
    LogManager.Instance.error(
      buildMessage(ErrorLogMessagesEnum.EVENT_NOT_FOUND, {
        eventName,
      }),
    );

    return { [eventName]: false };
  }
}

/**
 * Creates an impression for a track event and sends it via a POST API request.
 * @param settings Configuration settings for the tracking.
 * @param eventName Name of the event to track.
 * @param user User details.
 * @param eventProperties Properties associated with the event.
 */
const createImpressionForTrack = async (
  settings: SettingsModel,
  eventName: string,
  context: ContextModel,
  eventProperties: any,
) => {
  // Get base properties for the event
  const properties = getEventsBaseProperties(
    eventName,
    encodeURIComponent(context.getUserAgent()),
    context.getIpAddress(),
  );
  // Prepare the payload for the track goal
  const payload = getTrackGoalPayloadData(
    settings,
    context.getId(),
    eventName,
    eventProperties,
    context?.getUserAgent(),
    context?.getIpAddress(),
  );
  // Send the prepared payload via POST API request
  if (BatchEventsQueue.Instance) {
    BatchEventsQueue.Instance.enqueue(payload);
  } else {
    // Send the constructed payload via POST request
    await sendPostApiRequest(properties, payload, context.getId());
  }
};