meta-capi-param-builder-clientjs/capiParamBuilder/src/clientParamBuilder.js

Conversions API parameter builder for Client-side JavaScript

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the license found in the
 * LICENSE file in the root directory of this source tree.
 */
import {
  updateClickIdCookieIfNecessary,
  updateDomainScopedBrowserIdCookieIfNecessary,
} from '@shared/utils/cookieUtil.js';
import {
  CLICKTHROUGH_COOKIE_NAME,
  DOMAIN_SCOPED_BROWSER_ID_COOKIE_NAME,
  IP_COOKIE_NAME
} from '@shared/model/constants.js';
import { collectAndSetParams } from '@shared/ext/ebpExtension.js';
import {
  getFbc as readFbc,
  getFbp as readFbp,
  getClientIpAddress as readClientIpAddress,
} from '@shared/utils/commonUtil.js';
import { updateClientIpAddress } from '@shared/utils/ipUtil.js';
import { getNormalizedAndHashedPII } from '@shared/utils/piiUtil/piiUtil.js';

function processAndCollectParams(url) {
  const params = {};
  const fbc = updateClickIdCookieIfNecessary(url);
  const fbp = updateDomainScopedBrowserIdCookieIfNecessary();

  if (fbc != null) {
    params[CLICKTHROUGH_COOKIE_NAME] = fbc;
  }
  if (fbp != null) {
    params[DOMAIN_SCOPED_BROWSER_ID_COOKIE_NAME] = fbp;
  }

  return params;
}

let pendingCollections = 0;

function warnIfCollectionPending(methodName) {
  if (pendingCollections === 0) {
    return;
  }
  console.warn(
    'Warning: clientParamBuilder.' +
      methodName +
      '() was called before processAndCollectAllParams() resolved, and may ' +
      'return an empty or stale value. Await processAndCollectAllParams() ' +
      'first, or read the value from the object it returns.'
  );
}

async function processAndCollectAllParams(url, getIpFn) {
  const params = {};
  pendingCollections++;
  try {
    updateClickIdCookieIfNecessary(url);
    updateDomainScopedBrowserIdCookieIfNecessary();
    // Collect backup click ID from in-app browsers (Extended Browser Properties)
    await collectAndSetParams(true);

    // Set ip
    await updateClientIpAddress(getIpFn);

    params[IP_COOKIE_NAME] = readClientIpAddress();
    params[CLICKTHROUGH_COOKIE_NAME] = readFbc();
    params[DOMAIN_SCOPED_BROWSER_ID_COOKIE_NAME] = readFbp();
  } finally {
    pendingCollections--;
  }

  return params;
}

function getFbc() {
  warnIfCollectionPending('getFbc');
  return readFbc();
}

// _fbp is written before processAndCollectAllParams reaches its first await.
function getFbp() {
  return readFbp();
}

function getClientIpAddress() {
  warnIfCollectionPending('getClientIpAddress');
  return readClientIpAddress();
}

export {
  processAndCollectParams,
  processAndCollectAllParams,
  getFbc,
  getFbp,
  getClientIpAddress,
  getNormalizedAndHashedPII,
};