test: added more onPostBuild test to check for header generation

Author: nickytonline

test/index.js

@@ -720,6 +720,245 @@ describe('onPostBuild', () => {
       },
     ])
   })
+
+  test('appends headers to existing headers in the Netlify configuration', async () => {
+    await moveNextDist()
+
+    netlifyConfig.headers = [
+      {
+        for: '/',
+        values: {
+          'x-existing-header-in-configuration': 'existing header in configuration value',
+        },
+      },
+    ]
+
+    const show = jest.fn()
+
+    await plugin.onPostBuild({
+      ...defaultArgs,
+
+      utils: { ...defaultArgs.utils, status: { show }, functions: { list: jest.fn().mockResolvedValue([]) } },
+    })
+
+    expect(netlifyConfig.headers).toEqual([
+      {
+        for: '/',
+        values: {
+          'x-existing-header-in-configuration': 'existing header in configuration value',
+        },
+      },
+      {
+        for: '/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/en/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/es/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/fr/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/en/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/es/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/fr/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+      {
+        for: '/en/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+      {
+        for: '/es/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+      {
+        for: '/fr/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+    ])
+  })
+
+  test('appends headers to existing headers in the Netlify configuration', async () => {
+    await moveNextDist()
+
+    netlifyConfig.headers = [
+      {
+        for: '/',
+        values: {
+          'x-existing-header-in-configuration': 'existing header in configuration value',
+        },
+      },
+    ]
+
+    const show = jest.fn()
+
+    await plugin.onPostBuild({
+      ...defaultArgs,
+
+      utils: { ...defaultArgs.utils, status: { show }, functions: { list: jest.fn().mockResolvedValue([]) } },
+    })
+
+    expect(netlifyConfig.headers).toEqual([
+      {
+        for: '/',
+        values: {
+          'x-existing-header-in-configuration': 'existing header in configuration value',
+        },
+      },
+      {
+        for: '/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/en/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/es/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/fr/',
+        values: {
+          'x-custom-header': 'my custom header value',
+        },
+      },
+      {
+        for: '/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/en/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/es/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/fr/api/*',
+        values: {
+          'x-custom-api-header': 'my custom api header value',
+        },
+      },
+      {
+        for: '/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+      {
+        for: '/en/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+      {
+        for: '/es/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+      {
+        for: '/fr/*',
+        values: {
+          'x-custom-header-for-everything': 'my custom header for everything value',
+        },
+      },
+    ])
+  })
+
+  test('appends no additional headers in the Netlify configuration when none are in the routes manifest', async () => {
+    await moveNextDist()
+
+    netlifyConfig.headers = [
+      {
+        for: '/',
+        values: {
+          'x-existing-header-in-configuration': 'existing header in configuration value',
+        },
+      },
+    ]
+
+    const show = jest.fn()
+
+    const manifestPath = path.resolve('.next/routes-manifest.json')
+    const routesManifest = await readJson(manifestPath)
+    delete routesManifest.headers
+    await writeJSON(manifestPath, routesManifest)
+
+    await plugin.onPostBuild({
+      ...defaultArgs,
+
+      utils: { ...defaultArgs.utils, status: { show }, functions: { list: jest.fn().mockResolvedValue([]) } },
+    })
+
+    expect(netlifyConfig.headers).toEqual([
+      {
+        for: '/',
+        values: {
+          'x-existing-header-in-configuration': 'existing header in configuration value',
+        },
+      },
+    ])
+  })
 })
 
 describe('utility functions', () => {