[sitecore-jss] [Dictionary] Return empty dictionary when siteInfo/dictionary is empty

Author: illiakovalenko

packages/sitecore-jss/src/editing/graphql-editing-service.test.ts

@@ -233,6 +233,55 @@ describe('GraphQLEditingService', () => {
     spy.restore(clientFactorySpy);
   });
 
+  it('should return empty dictionary when dictionary is not provided', async () => {
+    const editingData = mockEditingServiceResponse();
+
+    (editingData.data.site.siteInfo as any) = null;
+
+    nock(hostname, { reqheaders: { sc_editMode: 'true' } })
+      .post(endpointPath, /EditingQuery/gi)
+      .reply(200, editingData);
+
+    const clientFactorySpy = sinon.spy(clientFactory);
+
+    const service = new GraphQLEditingService({
+      clientFactory: clientFactorySpy,
+    });
+
+    spy.on(clientFactorySpy.returnValues[0], 'request');
+
+    const result = await service.fetchEditingData({
+      language,
+      version,
+      itemId,
+      siteName,
+    });
+
+    expect(clientFactorySpy.calledOnce).to.be.true;
+    expect(
+      clientFactorySpy.calledWith({
+        debugger: debug.editing,
+        headers: {
+          sc_editMode: 'true',
+        },
+      })
+    ).to.be.true;
+    expect(clientFactorySpy.returnValues[0].request).to.be.called.exactly(1);
+    expect(clientFactorySpy.returnValues[0].request).to.be.called.with(query, {
+      language,
+      version,
+      itemId,
+      siteName,
+    });
+
+    expect(result).to.deep.equal({
+      layoutData: layoutDataResponse,
+      dictionary: {},
+    });
+
+    spy.restore(clientFactorySpy);
+  });
+
   it('should throw an error when client factory is not provided', async () => {
     try {
       const service = new GraphQLEditingService({} as GraphQLEditingServiceConfig);

packages/sitecore-jss/src/editing/graphql-editing-service.ts

@@ -134,9 +134,13 @@ export class GraphQLEditingService {
       language,
     });
 
-    dictionaryResults = editingData.site.siteInfo.dictionary.results;
-    hasNext = editingData.site.siteInfo.dictionary.pageInfo.hasNext;
-    after = editingData.site.siteInfo.dictionary.pageInfo.endCursor;
+    if (editingData?.site?.siteInfo?.dictionary) {
+      dictionaryResults = editingData.site.siteInfo.dictionary.results;
+      hasNext = editingData.site.siteInfo.dictionary.pageInfo.hasNext;
+      after = editingData.site.siteInfo.dictionary.pageInfo.endCursor;
+    } else {
+      hasNext = false;
+    }
 
     while (hasNext) {
       const data = await this.graphQLClient.request<GraphQLDictionaryQueryResponse>(
@@ -147,9 +151,14 @@ export class GraphQLEditingService {
           after,
         }
       );
-      dictionaryResults = dictionaryResults.concat(data.site.siteInfo.dictionary.results);
-      hasNext = data.site.siteInfo.dictionary.pageInfo.hasNext;
-      after = data.site.siteInfo.dictionary.pageInfo.endCursor;
+
+      if (data?.site?.siteInfo?.dictionary) {
+        dictionaryResults = dictionaryResults.concat(data.site.siteInfo.dictionary.results);
+        hasNext = data.site.siteInfo.dictionary.pageInfo.hasNext;
+        after = data.site.siteInfo.dictionary.pageInfo.endCursor;
+      } else {
+        hasNext = false;
+      }
     }
 
     dictionaryResults.forEach((item) => (dictionary[item.key] = item.value));

packages/sitecore-jss/src/i18n/graphql-dictionary-service.test.ts

@@ -353,5 +353,27 @@ describe('GraphQLDictionaryService', () => {
         expect(error.response.error).to.equal('whoops');
       });
     });
+
+    it('should return empty result when no dictionary entries found', async () => {
+      nock(endpoint)
+        .post('/')
+        .reply(200, {
+          data: {
+            site: {
+              siteInfo: null,
+            },
+          },
+        });
+
+      const service = new GraphQLDictionaryService({
+        clientFactory,
+        siteName,
+        cacheEnabled: false,
+        useSiteQuery: true,
+      });
+
+      const result = await service.fetchDictionaryData('en');
+      expect(result).to.deep.equal({});
+    });
   });
 });

packages/sitecore-jss/src/i18n/graphql-dictionary-service.ts

@@ -236,10 +236,15 @@ export class GraphQLDictionaryService extends DictionaryServiceBase {
         }
       );
 
-      results = results.concat(fetchResponse?.site.siteInfo.dictionary.results);
-      hasNext = fetchResponse.site.siteInfo.dictionary.pageInfo.hasNext;
-      after = fetchResponse.site.siteInfo.dictionary.pageInfo.endCursor;
+      if (fetchResponse?.site?.siteInfo?.dictionary) {
+        results = results.concat(fetchResponse.site.siteInfo.dictionary.results);
+        after = fetchResponse.site.siteInfo.dictionary.pageInfo.endCursor;
+        hasNext = fetchResponse.site.siteInfo.dictionary.pageInfo.hasNext;
+      } else {
+        hasNext = false;
+      }
     }
+
     results.forEach((item) => (phrases[item.key] = item.value));
 
     return phrases;