@vtex/faststore-plugin-buyer-portal 2.0.31 → 2.0.33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/faststore-plugin-buyer-portal",
-  "version": "2.0.31",
+  "version": "2.0.33",
   "description": "A plugin for faststore with buyer portal",
   "main": "index.js",
   "files": [

package/src/features/credit-cards/services/tokenize-credit-card.service.ts

@@ -27,7 +27,9 @@ export const tokenizeCreditCardService = async ({
         complement: creditCard.address.streetAddress2,
         coutry: creditCard.address.countryCode,
         neighborhood: creditCard.address.neighborhood ?? "",
-        geoCoordinates: creditCard.address.geoCoordinates.split(",") ?? [],
+        geoCoordinates: creditCard.address.geoCoordinates
+          ? creditCard.address.geoCoordinates.split(",")
+          : [],
         postalCode: creditCard.address.zip,
         number: creditCard.address.streetNumber ?? "",
         receiverName: "NOT EMPTY",

package/src/features/shared/clients/Client.ts

@@ -1,9 +1,14 @@
+import { getApiUrl } from "../utils/api";
+import { CURRENT_VERSION } from "../utils/constants";
 import {
   getAuthFromCookie,
   getCookieWithoutSessionObjects,
 } from "../utils/cookie";
 import { toQueryParams } from "../utils/toQueryParams";
 
+const BUYER_PORTAL_CLIENT_HEADER = "x-buyer-portal-client";
+const BUYER_PORTAL_CLIENT = `organization-account/${CURRENT_VERSION}`;
+
 interface RequestConfig<Input = unknown> {
   url: string;
   method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
@@ -48,8 +53,13 @@ export class ClientError extends Error {
 class Client {
   private baseURL: string;
 
+  // Other hosts (saved cards, tokenization, postal code) would have to allow
+  // the header in their CORS preflight.
+  private isBffClient: boolean;
+
   constructor(baseURL = "") {
     this.baseURL = baseURL;
+    this.isBffClient = baseURL.startsWith(getApiUrl());
   }
 
   private createClientError(
@@ -86,11 +96,20 @@ class Client {
     cache = "no-cache",
     componentName,
   }: RequestConfig<Input>): Promise<Return> {
+    // fetch joins names that differ only in case into one comma-separated
+    // value, which the BFF rejects.
+    const callerSetsClientHeader = Object.keys(headers).some(
+      (name) => name.toLowerCase() === BUYER_PORTAL_CLIENT_HEADER
+    );
+
     const config: RequestInit = {
       method,
       credentials: "include",
       headers: {
         ...(ignoreContentType ? {} : { "Content-Type": "application/json" }),
+        ...(this.isBffClient && !callerSetsClientHeader
+          ? { [BUYER_PORTAL_CLIENT_HEADER]: BUYER_PORTAL_CLIENT }
+          : {}),
         ...(headers.Cookie
           ? getCookieWithoutSessionObjects(headers.Cookie ?? "")
           : {}),

package/src/features/shared/clients/__tests__/Client.test.ts

@@ -7,8 +7,18 @@ vi.mock("discovery.config", () => ({
   },
 }));
 
+import { getApiUrl } from "../../utils/api";
+import { CURRENT_VERSION } from "../../utils/constants";
 import { Client, ClientError } from "../Client";
 
+const CLIENT_HEADER = "x-buyer-portal-client";
+
+function sentHeaders(fetchMock: ReturnType<typeof makeFetchMock>) {
+  const [, init] = fetchMock.mock.calls[0] as [string, RequestInit];
+
+  return init.headers as Record<string, string>;
+}
+
 function makeFetchMock(
   body: unknown,
   status = 200,
@@ -65,4 +75,63 @@ describe("Client", () => {
       await expect(client.get("resource")).resolves.toEqual({ ok: true });
     });
   });
+
+  describe("x-buyer-portal-client", () => {
+    it("identifies the plugin on BFF requests", async () => {
+      const fetchMock = makeFetchMock({ ok: true });
+      vi.stubGlobal("fetch", fetchMock);
+
+      await new Client(getApiUrl()).get("units/unit-1/summary");
+
+      expect(sentHeaders(fetchMock)).toMatchObject({
+        "Content-Type": "application/json",
+        [CLIENT_HEADER]: `organization-account/${CURRENT_VERSION}`,
+      });
+    });
+
+    it("sends it next to the cookie and auth headers on server-side requests", async () => {
+      const fetchMock = makeFetchMock({ ok: true });
+      vi.stubGlobal("fetch", fetchMock);
+
+      await new Client(getApiUrl()).get("granted", {
+        headers: {
+          Cookie: "VtexIdclientAutCookie_test-store=token-value;other=1",
+        },
+      });
+
+      expect(sentHeaders(fetchMock)).toMatchObject({
+        [CLIENT_HEADER]: `organization-account/${CURRENT_VERSION}`,
+        "VtexIdclientAutCookie_test-store": "token-value",
+        Cookie: "VtexIdclientAutCookie_test-store=token-value;other=1",
+      });
+    });
+
+    it.each(["", "https://test.vtex.com/api/", "https://api.example.com/"])(
+      "is not sent to base URL %j",
+      async (baseURL) => {
+        const fetchMock = makeFetchMock({ ok: true });
+        vi.stubGlobal("fetch", fetchMock);
+
+        await new Client(baseURL).get("resource");
+
+        expect(sentHeaders(fetchMock)).not.toHaveProperty(CLIENT_HEADER);
+      }
+    );
+
+    it.each([CLIENT_HEADER, "X-Buyer-Portal-Client"])(
+      "lets a header passed by the caller as %s win",
+      async (name) => {
+        const fetchMock = makeFetchMock({ ok: true });
+        vi.stubGlobal("fetch", fetchMock);
+
+        await new Client(getApiUrl()).get("resource", {
+          headers: { [name]: "organization-account" },
+        });
+
+        expect(new Headers(sentHeaders(fetchMock)).get(CLIENT_HEADER)).toBe(
+          "organization-account"
+        );
+      }
+    );
+  });
 });

package/src/features/shared/utils/constants.ts

@@ -33,4 +33,4 @@ export const STOREFRONT_RESOURCE_NAMES = {
 export type StorefrontResourceName =
   (typeof STOREFRONT_RESOURCE_NAMES)[keyof typeof STOREFRONT_RESOURCE_NAMES];
 
-export const CURRENT_VERSION = "2.0.31";
+export const CURRENT_VERSION = "2.0.33";