Extend retrier to ErrorPagesService and make it configurable through env

Sitecore · Sep 25, 2023 · eaf805c · eaf805c
1 parent d8fa093
commit eaf805c
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 2 deletions.
diff --git a/packages/create-sitecore-jss/src/templates/nextjs-sxa/src/pages/404.tsx b/packages/create-sitecore-jss/src/templates/nextjs-sxa/src/pages/404.tsx
@@ -33,6 +33,10 @@ export const getStaticProps: GetStaticProps = async (context) => {
     apiKey: config.sitecoreApiKey,
     siteName: site.name,
     language: context.locale || config.defaultLanguage,
+    retries:
+      (process.env.GRAPH_QL_SERVICE_RETRIES &&
+        parseInt(process.env.GRAPH_QL_SERVICE_RETRIES, 10)) ||
+      0,
   });
   let resultErrorPages: ErrorPages | null = null;
 

diff --git a/packages/create-sitecore-jss/src/templates/nextjs-sxa/src/pages/500.tsx b/packages/create-sitecore-jss/src/templates/nextjs-sxa/src/pages/500.tsx
@@ -49,6 +49,10 @@ export const getStaticProps: GetStaticProps = async (context) => {
     apiKey: config.sitecoreApiKey,
     siteName: site.name,
     language: context.locale || context.defaultLocale || config.defaultLanguage,
+    retries:
+      (process.env.GRAPH_QL_SERVICE_RETRIES &&
+        parseInt(process.env.GRAPH_QL_SERVICE_RETRIES, 10)) ||
+      0,
   });
   let resultErrorPages: ErrorPages | null = null;
 

diff --git a/packages/create-sitecore-jss/src/templates/nextjs/.env b/packages/create-sitecore-jss/src/templates/nextjs/.env
@@ -42,6 +42,9 @@ JSS_APP_NAME=
 # Your default app language.
 DEFAULT_LANGUAGE=
 
+# How many times should GraphQL Layout, Dictionary and ErrorPages services retry a fetch when endpoint rate limit is reached
+GRAPH_QL_SERVICE_RETRIES=0
+
 # The way in which layout and dictionary data is fetched from Sitecore
 FETCH_WITH=<%- fetchWith %>
 

diff --git a/packages/create-sitecore-jss/src/templates/nextjs/src/lib/dictionary-service-factory.ts b/packages/create-sitecore-jss/src/templates/nextjs/src/lib/dictionary-service-factory.ts
@@ -34,6 +34,10 @@ export class DictionaryServiceFactory {
             It will only try the request once by default.
             retries: 'number' 
           */
+          retries:
+            (process.env.GRAPH_QL_SERVICE_RETRIES &&
+              parseInt(process.env.GRAPH_QL_SERVICE_RETRIES, 10)) ||
+            0,
         })
       : new RestDictionaryService({
           apiHost: config.sitecoreApiHost,

diff --git a/packages/create-sitecore-jss/src/templates/nextjs/src/lib/layout-service-factory.ts b/packages/create-sitecore-jss/src/templates/nextjs/src/lib/layout-service-factory.ts
@@ -27,6 +27,10 @@ export class LayoutServiceFactory {
             It will only try the request once by default.
             retries: 'number' 
           */
+          retries:
+            (process.env.GRAPH_QL_SERVICE_RETRIES &&
+              parseInt(process.env.GRAPH_QL_SERVICE_RETRIES, 10)) ||
+            0,
         })
       : new RestLayoutService({
           apiHost: config.sitecoreApiHost,

diff --git a/packages/sitecore-jss/src/site/graphql-error-pages-service.ts b/packages/sitecore-jss/src/site/graphql-error-pages-service.ts
@@ -1,4 +1,4 @@
-import { GraphQLClient, GraphQLRequestClient } from '../graphql';
+import { GraphQLClient, GraphQLRequestClient, GraphQLRequestClientConfig } from '../graphql';
 import { siteNameError } from '../constants';
 import debug from '../debug';
 import { LayoutServiceData } from '../layout';
@@ -23,7 +23,7 @@ const defaultQuery = /* GraphQL */ `
   }
 `;
 
-export type GraphQLErrorPagesServiceConfig = {
+export interface GraphQLErrorPagesServiceConfig extends Pick<GraphQLRequestClientConfig, 'retries'> {
   /**
    * Your Graphql endpoint
    */
@@ -110,6 +110,7 @@ export class GraphQLErrorPagesService {
     return new GraphQLRequestClient(this.options.endpoint, {
       apiKey: this.options.apiKey,
       debugger: debug.errorpages,
+      retries: this.options.retries,
     });
   }
 }