Release braintree-web 3.132.0 source

Author: braintreeps

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 3.132.0 (2025-10-16)
+
+- API Latency Logging
+  - Added FPTI logs to track the performance metrics
+
 ## 3.131.0 (2025-10-15)
 
 - Instant Verification

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "braintree-web",
-  "version": "3.131.0",
+  "version": "3.132.0",
   "license": "MIT",
   "main": "src/index.js",
   "private": true,

package.json

@@ -356,8 +356,12 @@ Client.prototype.request = function (options, callback) {
     }
 
     requestOptions.url = baseUrl + options.endpoint;
-    requestOptions.sendAnalyticsEvent = function (kind) {
-      analytics.sendEvent(self, kind);
+    requestOptions.sendAnalyticsEvent = function (kind, extraFields) {
+      if (extraFields) {
+        analytics.sendEventPlus(self, kind, extraFields);
+      } else {
+        analytics.sendEvent(self, kind);
+      }
     };
 
     self._request(requestOptions, function (err, data, status) {

src/client/client.js

@@ -11,11 +11,63 @@ var DefaultRequest = require("./default-request");
 
 var MAX_TCP_RETRYCOUNT = 1;
 var TCP_PRECONNECT_BUG_STATUS_CODE = 408;
+var PAYPAL_HERMES_CREATE_PAYMENT_RESOURCE_PATTERN =
+  /\/client_api\/v1\/paypal_hermes\/create_payment_resource/;
+var MERCHANT_ID_PATTERN = /\/merchants\/[A-Za-z0-9_-]+\/client_api/;
 
 function requestShouldRetry(status) {
   return !status || status === TCP_PRECONNECT_BUG_STATUS_CODE;
 }
 
+function sendApiLatencyAnalytics(url, analyticsStartTime, options) {
+  var domain, path, cleanedPath, parsedUrl;
+  var analyticsConnectionStartTime, analyticsRequestStartTime, analyticsEndTime;
+  var finalStartTime;
+  var entries, entry;
+
+  try {
+    parsedUrl = new URL(url);
+    domain = parsedUrl.hostname;
+    path = parsedUrl.pathname;
+    // eslint-disable-next-line no-unused-vars
+  } catch (e) {
+    domain = (url.match(/^https?:\/\/([^\/]+)/) || [])[1] || "";
+    path = (url.match(/^https?:\/\/[^\/]+(\/.*)$/) || [])[1] || url;
+  }
+  cleanedPath = path.replace(MERCHANT_ID_PATTERN, "");
+
+  finalStartTime = analyticsStartTime;
+  analyticsEndTime = Date.now();
+
+  if (
+    typeof window !== "undefined" &&
+    window.performance &&
+    window.performance.getEntriesByName
+  ) {
+    entries = window.performance.getEntriesByName(url);
+    if (entries && entries.length > 0) {
+      entry = entries[entries.length - 1];
+      analyticsConnectionStartTime = entry.connectStart
+        ? Math.round(entry.connectStart)
+        : null;
+      analyticsRequestStartTime = entry.requestStart
+        ? Math.round(entry.requestStart)
+        : null;
+      finalStartTime = Math.round(entry.startTime);
+      analyticsEndTime = Math.round(entry.responseEnd);
+    }
+  }
+
+  options.sendAnalyticsEvent("core.api-request-latency", {
+    connectionStartTime: analyticsConnectionStartTime,
+    domain: domain,
+    endpoint: cleanedPath,
+    endTime: analyticsEndTime,
+    requestStartTime: analyticsRequestStartTime,
+    startTime: finalStartTime,
+  });
+}
+
 function graphQLRequestShouldRetryWithClientApi(body) {
   var errorClass =
     !body.data &&
@@ -29,6 +81,7 @@ function graphQLRequestShouldRetryWithClientApi(body) {
 
 function _requestWithRetry(options, tcpRetryCount, cb) {
   var status, resBody, ajaxRequest, body, method, headers, parsedBody;
+  var analyticsStartTime = Date.now();
   var url = options.url;
   var graphQL = options.graphQL;
   var timeout = options.timeout;
@@ -80,6 +133,13 @@ function _requestWithRetry(options, tcpRetryCount, cb) {
       resBody = ajaxRequest.adaptResponseBody(parsedBody);
       status = ajaxRequest.determineStatus(req.status, parsedBody);
 
+      if (
+        PAYPAL_HERMES_CREATE_PAYMENT_RESOURCE_PATTERN.test(url) &&
+        options.sendAnalyticsEvent
+      ) {
+        sendApiLatencyAnalytics(url, analyticsStartTime, options);
+      }
+
       if (status >= 400 || status < 200) {
         if (
           isGraphQLRequest &&

src/client/request/ajax-driver.js

@@ -56,5 +56,11 @@ module.exports = {
     "payment_ready_page_type",
     "payment_ready_session_id",
     "button_type",
+    "connectionStartTime",
+    "domain",
+    "endpoint",
+    "endTime",
+    "requestStartTime",
+    "startTime",
   ],
 };

src/lib/constants.js

@@ -577,4 +577,44 @@ describe("AJAXDriver", () => {
       testContext.fakeXHR.onreadystatechange();
     });
   });
+
+  describe("API latency tracking", () => {
+    afterEach(() => {
+      server._routes = {};
+    });
+
+    it("sends analytics event for create_payment_resource endpoint", (done) => {
+      const sendAnalyticsEventSpy = jest.fn();
+
+      server.post(
+        "/merchants/test/client_api/v1/paypal_hermes/create_payment_resource",
+        {
+          status: 200,
+          body: '{"success":true}',
+        }
+      );
+
+      AJAXDriver.request(
+        {
+          url: "https://api.braintreegateway.com/merchants/test/client_api/v1/paypal_hermes/create_payment_resource",
+          method: "POST",
+          data: {},
+          graphQL: testContext.fakeGraphQL,
+          sendAnalyticsEvent: sendAnalyticsEventSpy,
+        },
+        () => {
+          expect(sendAnalyticsEventSpy).toHaveBeenCalledWith(
+            "core.api-request-latency",
+            expect.objectContaining({
+              domain: "api.braintreegateway.com",
+              endpoint: "/v1/paypal_hermes/create_payment_resource",
+              startTime: expect.any(Number),
+              endTime: expect.any(Number),
+            })
+          );
+          done();
+        }
+      );
+    });
+  });
 });