Fix segment enconding/handling (#502)

* Fix segment encoding

* Update changelog

* Improve segment handling

* Fix lint

Author: salesfelipe

CHANGELOG.md

@@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [1.85.0] - 2025-10-13
+### Fixed
+
+- Segment enconding while making PDP requests.
+
+## [1.85.0] - 2025-10-13 [YANKED]
 
 ### Changed
 

node/clients/intelligent-search-api.ts

@@ -3,6 +3,7 @@ import { ExternalClient } from '@vtex/api'
 
 import { parseState } from '../utils/searchState'
 import type { FetchBannersArgs, IIntelligentSearchClient, FetchProductArgs, FetchProductResponse  } from './intsch/types'
+import { Options, SearchResultArgs } from '../typings/Search'
 
 const isPathTraversal = (str: string) => str.indexOf('..') >= 0
 

node/resolvers/search/index.ts

@@ -46,6 +46,7 @@ import {
   fetchCorrection,
 } from '../../services/autocomplete'
 import { fetchBanners } from '../../services/banners'
+import { AdvertisementOptions, FacetsInput, ProductSearchInput, ProductsInput, SegmentData, SuggestionProductsArgs } from '../../typings/Search'
 
 enum CrossSellingInput {
   view = 'view',

node/services/product.test.ts

@@ -1,4 +1,4 @@
-import { fetchProduct } from './product'
+import { fetchProduct, buildVtexSegment } from './product'
 import { createContext } from '../mocks/contextFactory'
 
 describe('fetchProduct service', () => {
@@ -12,6 +12,44 @@ describe('fetchProduct service', () => {
     jest.clearAllMocks()
   })
 
+  it('should build vtex segment correctly', () => {
+    const vtexSegment = buildVtexSegment({
+      vtexSegment: {
+        campaigns: null,
+        channel: '1',
+        priceTables: null,
+        regionId: 'U1cjMQ==',
+        utm_campaign: null,
+        utm_source: null,
+        utmi_campaign: null,
+        currencyCode: 'ARS',
+        currencySymbol: '$',
+        countryCode: 'ARG',
+        cultureInfo: 'es-AR',
+        admin_cultureInfo: 'es-AR',
+        channelPrivacy: 'public',
+      },
+      salesChannel: '2',
+      regionId: '3',
+    })
+
+    const result = JSON.parse(Buffer.from(vtexSegment, 'base64').toString())
+
+    expect(result.regionId).toBe('3')
+    expect(result.countryCode).toBe('ARG')
+    expect(result.currencySymbol).toBe('$')
+    expect(result.currencyCode).toBe('ARS')
+    expect(result.channel).toBe('2')
+    expect(result.cultureInfo).toBe('es-AR')
+    expect(result.admin_cultureInfo).toBe('es-AR')
+    expect(result.channelPrivacy).toBe('public')
+    expect(result.campaigns).toBeNull()
+    expect(result.priceTables).toBeNull()
+    expect(result.utm_campaign).toBeNull()
+    expect(result.utm_source).toBeNull()
+    expect(result.utmi_campaign).toBeNull()
+  })
+
   it('should use intsch directly for b2bstoreqa account', async () => {
     const ctx = createContext({
       accountName: 'b2bstoreqa',

node/services/product.ts

@@ -1,4 +1,5 @@
 import { fetchAppSettings } from './settings'
+import type { SegmentData } from '../typings/Search'
 
 export type ProductIdentifier = {
   field: 'id' | 'slug' | 'ean' | 'reference' | 'sku'
@@ -127,18 +128,12 @@ export function buildVtexSegment({
   regionId?: string
 }): string {
   const cookie = {
+    ...vtexSegment,
     regionId: regionId ?? vtexSegment?.regionId,
-    channel: salesChannel || vtexSegment?.channel,
-    utm_campaign: vtexSegment?.utm_campaign || '',
-    utm_source: vtexSegment?.utm_source || '',
-    utmi_campaign: vtexSegment?.utmi_campaign || '',
-    currencyCode: vtexSegment?.currencyCode || '',
-    currencySymbol: vtexSegment?.currencySymbol || '',
-    countryCode: vtexSegment?.countryCode || '',
-    cultureInfo: vtexSegment?.cultureInfo || '',
+    channel: salesChannel ?? vtexSegment?.channel,
   }
 
-  return Buffer.from(JSON.stringify(cookie), 'base64').toString()
+  return Buffer.from(JSON.stringify(cookie)).toString('base64')
 }
 
 export async function fetchProduct(

node/typings/Search.ts

@@ -1,29 +1,21 @@
-interface SegmentData {
+export type SegmentData = {
   campaigns?: any
   channel: string
   priceTables?: any
-  utm_campaign: string
+  utm_campaign: string | null
   regionId?: string
-  utm_source: string
-  utmi_campaign: string
+  utm_source: string | null
+  utmi_campaign: string | null
   currencyCode: string
   currencySymbol: string
   countryCode: string
   cultureInfo: string
   [key: string]: any
 }
 
-interface ElasticImage {
-  name: string
-  value: string
-}
-
-enum IndexingType {
-  API = 'API',
-  XML = 'XML',
-}
+export type IndexingType = 'API' | 'XML'
 
-interface SearchResultArgs extends AdvertisementOptions {
+export interface SearchResultArgs extends AdvertisementOptions {
   attributePath?: string
   query?: string
   page?: number
@@ -48,17 +40,12 @@ interface SearchResultArgs extends AdvertisementOptions {
   showSponsored?: boolean
 }
 
-interface BannersArgs {
-  fullText: string
-  attributePath: string
-}
-
 interface RegionSeller {
   id: string
   name: string
 }
 
-interface SuggestionProductsArgs {
+export interface SuggestionProductsArgs {
   fullText: string
   facetKey?: string
   facetValue?: string
@@ -77,27 +64,23 @@ interface SuggestionProductsArgs {
   advertisementOptions: AdvertisementOptions
 }
 
-interface SuggestionSearchesArgs {
-  term: string
-}
-
 interface SelectedFacet {
   value: string
   key: string
 }
 
-interface Options {
+export interface Options {
   allowRedirect?: boolean
 }
 
-interface AdvertisementOptions {
+export interface AdvertisementOptions {
   showSponsored?: boolean
   sponsoredCount?: number
   repeatSponsoredProducts?: boolean
   advertisementPlacement?: string
 }
 
-interface FacetsInput {
+export interface FacetsInput {
   map: string
   selectedFacets: SelectedFacet[]
   fullText: string
@@ -109,11 +92,11 @@ interface FacetsInput {
   categoryTreeBehavior: 'default' | 'show' | 'hide'
 }
 
-interface ProductsInput extends SearchArgs {
+export interface ProductsInput extends SearchArgs {
   advertisementOptions?: AdvertisementOptions
 }
 
-interface ProductSearchInput {
+export interface ProductSearchInput {
   query: string
   from: number
   to: number
@@ -130,146 +113,4 @@ interface ProductSearchInput {
   options?: Options
   showSponsored?: boolean
   advertisementOptions?: AdvertisementOptions
-}
-
-interface ElasticAttribute {
-  visible: boolean
-  active: boolean
-  key: string
-  label: string
-  type: string
-  values: ElasticAttributeValue[]
-  originalKey: string
-  originalLabel: string
-  minValue?: number
-  maxValue?: number
-}
-
-interface ElasticAttributeValue {
-  count: number
-  active: boolean
-  key: string
-  label: string
-  id: string
-  originalKey?: string
-  originalLabel?: string
-}
-
-interface Breadcrumb {
-  href: string
-  name: string
-}
-
-interface BiggySearchProduct {
-  name: string
-  id: string
-  timestamp: number
-  product: string
-  description: string
-  reference: string
-  url: string
-  link: string
-  oldPrice: number
-  price: number
-  stock: number
-  brand: string
-  brandId: string
-  installment?: BiggyInstallment
-  measurementUnit: string
-  unitMultiplier: number
-  tax: number
-  images: BiggyProductImage[]
-  skus: BiggySearchSKU[]
-  categories: string[]
-  categoryIds: string[]
-  extraData: BiggyProductExtraData[]
-  productSpecifications: string[]
-  specificationGroups: string
-  textAttributes: BiggyTextAttribute[]
-  numberAttributes: BiggyTextAttribute[]
-  split: BiggySplit
-  categoryTrees: BiggyCategoryTree[]
-  clusterHighlights: Record<string, string>
-}
-
-interface BiggySplit {
-  labelKey: string
-  labelValue: string
-}
-
-interface BiggyProductImage {
-  name: string
-  value: string
-}
-
-interface BiggyProductExtraData {
-  key: string
-  value: string
-}
-
-interface BiggySearchSKU {
-  name: string
-  nameComplete: string
-  complementName?: string
-  id: string
-  ean?: string
-  reference: string
-  image: string
-  images: BiggyProductImage[]
-  videos?: string[]
-  stock: number
-  oldPrice: number
-  price: number
-  measurementUnit: string
-  unitMultiplier: number
-  link: string
-  attributes: BiggySKUAttribute[]
-  sellers: BiggySeller[]
-  policies: BiggyPolicy[]
-}
-
-interface BiggySKUAttribute {
-  key: string
-  value: string
-}
-
-interface BiggySeller {
-  id: string
-  name: string
-  oldPrice: number
-  price: number
-  stock: number
-  tax: number
-  default: boolean
-  teasers?: object[]
-  installment?: BiggyInstallment
-}
-
-interface BiggyInstallment {
-  value: number
-  count: number
-  interest: boolean
-}
-
-interface BiggyPolicy {
-  id: string
-  sellers: BiggySeller[]
-}
-
-interface BiggyTextAttribute {
-  labelKey: string
-  labelValue: string
-  key: string
-  value: string
-  isFilter: boolean
-  id: string
-  valueId: string
-  isSku: boolean
-  joinedKey: string
-  joinedValue: string
-}
-
-interface BiggyCategoryTree {
-  categoryNames: string[]
-  categoryIds: string[]
-}
+}