@graphcommerce/next-config 9.0.0-canary.57 → 9.0.0-canary.58

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 9.0.0-canary.58
+
+### Minor Changes
+
+- [#2330](https://github.com/graphcommerce-org/graphcommerce/pull/2330) [`5701e71`](https://github.com/graphcommerce-org/graphcommerce/commit/5701e71454ffb52880cd15c3341826d9502284d0) - Added support for boolean `ifConfig: ['customerXMagentoCacheIdDisable', true]` values in plugin configurations ([@paales](https://github.com/paales))
+
 ## 9.0.0-canary.57
 
 ## 9.0.0-canary.56

package/__tests__/config/utils/__snapshots__/mergeEnvIntoConfig.ts.snap

@@ -40,6 +40,7 @@ exports[`traverses a schema and returns a list of env variables that match 1`] =
   "GC_CUSTOMER_ADDRESS_NOTE_ENABLE",
   "GC_CUSTOMER_COMPANY_FIELDS_ENABLE",
   "GC_CUSTOMER_DELETE_ENABLED",
+  "GC_CUSTOMER_X_MAGENTO_CACHE_ID_DISABLE",
   "GC_DATA_LAYER",
   "GC_DATA_LAYER_CORE_WEB_VITALS",
   "GC_DEBUG",

package/__tests__/interceptors/findPlugins.ts

@@ -227,6 +227,18 @@ it('finds plugins', () => {
         "targetModule": "@graphcommerce/graphql",
         "type": "function",
       },
+      {
+        "enabled": true,
+        "ifConfig": [
+          "customerXMagentoCacheIdDisable",
+          false,
+        ],
+        "sourceExport": "GraphQLProvider",
+        "sourceModule": "@graphcommerce/magento-customer/plugins/XMagentoCacheIdGraphQLProvider",
+        "targetExport": "GraphQLProvider",
+        "targetModule": "@graphcommerce/graphql",
+        "type": "component",
+      },
       {
         "enabled": true,
         "sourceExport": "GraphQLProvider",

package/__tests__/interceptors/parseStructure.ts

@@ -206,3 +206,83 @@ export const Plugin = AddAdyenMethods
   `)
   expect(plugins[1]).toMatchInlineSnapshot(`undefined`)
 })
+
+it('correctly allows false value in the ifConfig', () => {
+  const src = `
+import { PluginConfig, PluginProps } from '@graphcommerce/next-config'
+import { xMagentoCacheIdHeader } from '../link/xMagentoCacheIdHeader'
+import { GraphQLProviderProps } from '@graphcommerce/graphql'
+
+export const config: PluginConfig = {
+  type: 'component',
+  module: '@graphcommerce/graphql',
+  ifConfig: ['customerXMagentoCacheIdDisable', false],
+}
+
+export function GraphQLProvider(props: PluginProps<GraphQLProviderProps>) {
+  const { Prev, links = [], ...rest } = props
+  return <Prev {...rest} links={[...links, xMagentoCacheIdHeader]} />
+}
+`
+  const ast = parseSync(src)
+
+  expect(
+    parseStructure(ast, {} as GraphCommerceConfig, './plugins/MyReplace')[0].enabled,
+  ).toBeTruthy()
+
+  expect(
+    parseStructure(
+      ast,
+      { customerXMagentoCacheIdDisable: true } as GraphCommerceConfig,
+      './plugins/MyReplace',
+    )[0].enabled,
+  ).toBeFalsy()
+
+  expect(
+    parseStructure(
+      ast,
+      { customerXMagentoCacheIdDisable: false } as GraphCommerceConfig,
+      './plugins/MyReplace',
+    )[0].enabled,
+  ).toBeTruthy()
+})
+
+it('correctly allows true value in the ifConfig', () => {
+  const src = `
+import { PluginConfig, PluginProps } from '@graphcommerce/next-config'
+import { xMagentoCacheIdHeader } from '../link/xMagentoCacheIdHeader'
+import { GraphQLProviderProps } from '@graphcommerce/graphql'
+
+export const config: PluginConfig = {
+  type: 'component',
+  module: '@graphcommerce/graphql',
+  ifConfig: ['customerXMagentoCacheIdDisable', true],
+}
+
+export function GraphQLProvider(props: PluginProps<GraphQLProviderProps>) {
+  const { Prev, links = [], ...rest } = props
+  return <Prev {...rest} links={[...links, xMagentoCacheIdHeader]} />
+}
+`
+  const ast = parseSync(src)
+
+  expect(
+    parseStructure(ast, {} as GraphCommerceConfig, './plugins/MyReplace')[0].enabled,
+  ).toBeFalsy()
+
+  expect(
+    parseStructure(
+      ast,
+      { customerXMagentoCacheIdDisable: true } as GraphCommerceConfig,
+      './plugins/MyReplace',
+    )[0].enabled,
+  ).toBeTruthy()
+
+  expect(
+    parseStructure(
+      ast,
+      { customerXMagentoCacheIdDisable: false } as GraphCommerceConfig,
+      './plugins/MyReplace',
+    )[0].enabled,
+  ).toBeFalsy()
+})

package/dist/generated/config.js

@@ -36,6 +36,7 @@ function GraphCommerceConfigSchema() {
         customerAddressNoteEnable: zod_1.z.boolean().nullish(),
         customerCompanyFieldsEnable: zod_1.z.boolean().nullish(),
         customerDeleteEnabled: zod_1.z.boolean().nullish(),
+        customerXMagentoCacheIdDisable: zod_1.z.boolean().nullish(),
         dataLayer: DatalayerConfigSchema().nullish(),
         debug: GraphCommerceDebugConfigSchema().nullish(),
         demoMode: zod_1.z.boolean().default(true).nullish(),

package/dist/interceptors/parseStructure.js

@@ -11,7 +11,7 @@ const pluginConfigParsed = zod_1.z.object({
     type: zod_1.z.enum(['component', 'function', 'replace']),
     module: zod_1.z.string(),
     export: zod_1.z.string(),
-    ifConfig: zod_1.z.union([zod_1.z.string(), zod_1.z.tuple([zod_1.z.string(), zod_1.z.string()])]).optional(),
+    ifConfig: zod_1.z.union([zod_1.z.string(), zod_1.z.tuple([zod_1.z.string(), zod_1.z.unknown()])]).optional(),
 });
 function nonNullable(value) {
     return value !== null && value !== undefined;
@@ -51,9 +51,15 @@ function parseStructure(ast, gcConfig, sourceModule) {
         }
         let enabled = true;
         if (parsed.data.ifConfig) {
-            enabled = Array.isArray(parsed.data.ifConfig)
-                ? (0, get_1.default)(gcConfig, parsed.data.ifConfig[0]) === parsed.data.ifConfig[1]
-                : Boolean((0, get_1.default)(gcConfig, parsed.data.ifConfig));
+            if (Array.isArray(parsed.data.ifConfig)) {
+                const isBoolean = typeof parsed.data.ifConfig[1] === 'boolean';
+                let confValue = (0, get_1.default)(gcConfig, parsed.data.ifConfig[0]);
+                confValue = isBoolean ? Boolean(confValue) : confValue;
+                enabled = confValue === parsed.data.ifConfig[1];
+            }
+            else {
+                enabled = Boolean((0, get_1.default)(gcConfig, parsed.data.ifConfig));
+            }
         }
         const val = {
             targetExport: exports.component || exports.func || parsed.data.export,

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/next-config",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "9.0.0-canary.57",
+  "version": "9.0.0-canary.58",
   "type": "commonjs",
   "main": "dist/index.js",
   "types": "src/index.ts",

package/src/generated/config.ts

@@ -169,6 +169,12 @@ export type GraphCommerceConfig = {
   customerCompanyFieldsEnable?: InputMaybe<Scalars['Boolean']['input']>;
   /** Enable customer account deletion through the account section */
   customerDeleteEnabled?: InputMaybe<Scalars['Boolean']['input']>;
+  /**
+   * X-Magento-Cache-Id allows Varnish to cache requests that are made in the browser while users are logged in. For example the products query can now be cached for logged in users.
+   *
+   * This can be disabled when Varnish is running out of available memory.
+   */
+  customerXMagentoCacheIdDisable?: InputMaybe<Scalars['Boolean']['input']>;
   /** Datalayer config */
   dataLayer?: InputMaybe<DatalayerConfig>;
   /** Debug configuration for GraphCommerce */
@@ -498,6 +504,7 @@ export function GraphCommerceConfigSchema(): z.ZodObject<Properties<GraphCommerc
     customerAddressNoteEnable: z.boolean().nullish(),
     customerCompanyFieldsEnable: z.boolean().nullish(),
     customerDeleteEnabled: z.boolean().nullish(),
+    customerXMagentoCacheIdDisable: z.boolean().nullish(),
     dataLayer: DatalayerConfigSchema().nullish(),
     debug: GraphCommerceDebugConfigSchema().nullish(),
     demoMode: z.boolean().default(true).nullish(),

package/src/interceptors/generateInterceptor.ts

@@ -14,7 +14,7 @@ type PluginBaseConfig = {
   sourceModule: string
   targetExport: string
   enabled: boolean
-  ifConfig?: string | [string, string]
+  ifConfig?: string | [string, any]
 }
 
 export function isPluginBaseConfig(plugin: Partial<PluginBaseConfig>): plugin is PluginBaseConfig {

package/src/interceptors/parseStructure.ts

@@ -9,7 +9,7 @@ const pluginConfigParsed = z.object({
   type: z.enum(['component', 'function', 'replace']),
   module: z.string(),
   export: z.string(),
-  ifConfig: z.union([z.string(), z.tuple([z.string(), z.string()])]).optional(),
+  ifConfig: z.union([z.string(), z.tuple([z.string(), z.unknown()])]).optional(),
 })
 
 function nonNullable<T>(value: T): value is NonNullable<T> {
@@ -62,10 +62,17 @@ export function parseStructure(ast: Module, gcConfig: GraphCommerceConfig, sourc
       }
 
       let enabled = true
+
       if (parsed.data.ifConfig) {
-        enabled = Array.isArray(parsed.data.ifConfig)
-          ? get(gcConfig, parsed.data.ifConfig[0]) === parsed.data.ifConfig[1]
-          : Boolean(get(gcConfig, parsed.data.ifConfig))
+        if (Array.isArray(parsed.data.ifConfig)) {
+          const isBoolean = typeof parsed.data.ifConfig[1] === 'boolean'
+          let confValue = get(gcConfig, parsed.data.ifConfig[0])
+          confValue = isBoolean ? Boolean(confValue) : confValue
+
+          enabled = confValue === parsed.data.ifConfig[1]
+        } else {
+          enabled = Boolean(get(gcConfig, parsed.data.ifConfig))
+        }
       }
 
       const val: PluginConfig = {