GraphQL sitemap now parses personalize data from site queries and adds it into returned paths

Author: art-alexeyenko

packages/sitecore-jss-nextjs/src/index.ts

@@ -5,7 +5,6 @@ export {
   HttpResponse,
   AxiosDataFetcher,
   AxiosDataFetcherConfig,
-  enableDebug,
 } from '@sitecore-jss/sitecore-jss';
 export {
   isEditorActive,

packages/sitecore-jss-nextjs/src/services/graphql-sitemap-service.test.ts

@@ -170,6 +170,84 @@ describe('GraphQLSitemapService', () => {
       ]);
     });
 
+    it('should return personalized paths when personalize data is returned', async () => {
+      const lang1 = 'ua';
+
+      nock(endpoint)
+        .post('/')
+        .reply(200, {
+          data: {
+            site: {
+              siteInfo: {
+                routes: {
+                  total: 4,
+                  pageInfo: {
+                    hasNext: false,
+                  },
+                  results: [
+                    {
+                      path: '/',
+                      personalize: {
+                        variantIds: ['green'],
+                      },
+                    },
+                    {
+                      path: '/y1/y2/y3/y4',
+                      personalize: {
+                        variantIds: ['green', 'red', 'purple'],
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+          },
+        });
+
+      const service = new GraphQLSitemapService({ endpoint, apiKey, siteName });
+      const sitemap = await service.fetchSSGSitemap([lang1]);
+
+      expect(sitemap).to.deep.equal([
+        {
+          params: {
+            path: [''],
+          },
+          locale: 'ua',
+        },
+        {
+          params: {
+            path: ['green'],
+          },
+          locale: 'ua',
+        },
+        {
+          params: {
+            path: ['y1', 'y2', 'y3', 'y4'],
+          },
+          locale: 'ua',
+        },
+        {
+          params: {
+            path: ['green', 'y1', 'y2', 'y3', 'y4'],
+          },
+          locale: 'ua',
+        },
+        {
+          params: {
+            path: ['red', 'y1', 'y2', 'y3', 'y4'],
+          },
+          locale: 'ua',
+        },
+        {
+          params: {
+            path: ['purple', 'y1', 'y2', 'y3', 'y4'],
+          },
+          locale: 'ua',
+        },
+      ]);
+      return expect(nock.isDone()).to.be.true;
+    });
+
     it('should work when multiple languages are requested', async () => {
       const lang1 = 'ua';
       const lang2 = 'da-DK';

packages/sitecore-jss-nextjs/src/services/graphql-sitemap-service.ts

@@ -31,6 +31,9 @@ query SitemapQuery(
         }
         results: routesResult{
           path: routePath 
+          personalize: {
+            variantIds
+          }
         }
       }
     }
@@ -89,6 +92,10 @@ export interface SiteRouteQueryResult<T> {
  */
 export type RouteListQueryResult = {
   path: string;
+
+  personalize: {
+    variantIds: string[];
+  };
 };
 
 /**
@@ -208,8 +215,18 @@ export class GraphQLSitemapService {
         debug.sitemap('fetching sitemap data for %s', language);
 
         return this.fetchLanguageSitePaths(this.query, args).then((results) => {
-          return results.map((item) =>
-            formatStaticPath(item.path.replace(/^\/|\/$/g, '').split('/'), language)
+          const aggregatedPaths: string[] = [];
+          results.forEach((item) => {
+            aggregatedPaths.push(item.path);
+            if (item.personalize?.variantIds.length) {
+              aggregatedPaths.push(
+                ...item.personalize?.variantIds.map((varId) => `/${varId}${item.path}`)
+              );
+            }
+          });
+
+          return aggregatedPaths.map((item) =>
+            formatStaticPath(item.replace(/^\/|\/$/g, '').split('/'), language)
           );
         });
       })