feat: do not pre-warm lambdas if DEPLOY_PRIME_URL is not set (#435)

* feat: do not pre-warm lambdas if url is not set

* test: forgot to remove the focus on a test

* refactor: move DEPLOY_PRIME_URL check into shouldSkipBundlingDatastore

Author: ericapisani

plugin/src/helpers/config.ts

@@ -22,7 +22,10 @@ import type { FunctionList } from './functions'
  * Checks to see if GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE is enabled
  */
 export function shouldSkipBundlingDatastore(): boolean {
-  return isEnvSet('GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE')
+  return (
+    isEnvSet('GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE') &&
+    Boolean(process.env.DEPLOY_PRIME_URL)
+  )
 }
 
 export async function spliceConfig({

plugin/src/index.ts

@@ -102,7 +102,7 @@ export async function onSuccess() {
     }, FETCH_TIMEOUT)
 
     for (const func of ['api', 'dsg', 'ssr']) {
-      const url = `${process.env.URL}/.netlify/functions/__${func}`
+      const url = `${process.env.DEPLOY_PRIME_URL}/.netlify/functions/__${func}`
       console.log(`Sending pre-warm request to: ${url}`)
 
       try {

plugin/test/helpers.js

@@ -1,5 +1,8 @@
+const Chance = require('chance')
 const execa = require('execa')
 
+const chance = new Chance()
+
 module.exports.buildSite = async () => {
   const { exitCode, stdout, stderr } = await execa(
     'netlify',
@@ -12,3 +15,8 @@ module.exports.buildSite = async () => {
     severityCode: exitCode,
   }
 }
+
+module.exports.enableGatsbyExcludeDatastoreFromBundle = () => {
+  process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE = 'true'
+  process.env.DEPLOY_PRIME_URL = chance.url()
+}

plugin/test/unit/helpers/config.spec.ts

@@ -1,6 +1,8 @@
+/* eslint-disable ava/no-import-test-files */
 import { resolve, join } from 'path'
 import process from 'process'
 
+import Chance from 'chance'
 import { remove, copy, readJSON, readdir } from 'fs-extra'
 import { dir as getTmpDir } from 'tmp-promise'
 import { validate } from 'uuid'
@@ -10,7 +12,9 @@ import {
   mutateConfig,
   shouldSkipBundlingDatastore,
 } from '../../../src/helpers/config'
+import { enableGatsbyExcludeDatastoreFromBundle } from '../../helpers'
 
+const chance = new Chance()
 const SAMPLE_PROJECT_DIR = `${__dirname}/../../../../demo`
 const TEST_TIMEOUT = 60_000
 
@@ -35,8 +39,12 @@ const moveGatsbyDir = async () => {
 }
 
 describe('shouldSkipBundlingDatastore', () => {
+  beforeEach(() => {
+    process.env.DEPLOY_PRIME_URL = chance.url()
+  })
   afterEach(() => {
     delete process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE
+    delete process.env.DEPLOY_PRIME_URL
   })
 
   it('returns true', () => {
@@ -56,6 +64,11 @@ describe('shouldSkipBundlingDatastore', () => {
 
     delete process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE
     expect(shouldSkipBundlingDatastore()).toEqual(false)
+
+    // Commonly occurs in a CI context as a DEPLOY_PRIME_URL is not set
+    process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE = 'true'
+    delete process.env.DEPLOY_PRIME_URL
+    expect(shouldSkipBundlingDatastore()).toEqual(false)
   })
 })
 
@@ -85,7 +98,7 @@ describe('mutateConfig', () => {
   })
 
   it('includes the dataMetadata file containing gatsby datastore info when GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE is enabled', () => {
-    process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE = 'true'
+    enableGatsbyExcludeDatastoreFromBundle()
     mutateConfig(defaultArgs)
 
     expect(netlifyConfig.functions.__api).toStrictEqual({
@@ -259,3 +272,4 @@ describe('createMetadataFileAndCopyDatastore', () => {
     TEST_TIMEOUT,
   )
 })
+/* eslint-enable ava/no-import-test-files */

plugin/test/unit/index.spec.ts

@@ -1,4 +1,4 @@
-/* eslint-disable max-nested-callbacks */
+/* eslint-disable max-nested-callbacks, ava/no-import-test-files */
 import process from 'process'
 
 import {
@@ -8,6 +8,7 @@ import {
 import Chance from 'chance'
 
 import { onBuild, onSuccess } from '../../src/index'
+import { enableGatsbyExcludeDatastoreFromBundle } from '../helpers'
 
 jest.mock('node-fetch', () => ({
   __esModule: true,
@@ -158,7 +159,8 @@ describe('plugin', () => {
     } = require('../../src/helpers/config')
 
     it('creates the metadata file for the Gatsby datastore when GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE is enabled', async () => {
-      process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE = 'true'
+      enableGatsbyExcludeDatastoreFromBundle()
+
       createMetadataFileAndCopyDatastore.mockImplementation(() =>
         Promise.resolve(),
       )
@@ -211,31 +213,30 @@ describe('plugin', () => {
 
     beforeEach(() => {
       fetch.mockImplementation(mockFetchMethod)
-      process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE = 'true'
-      process.env.URL = chance.url()
+      enableGatsbyExcludeDatastoreFromBundle()
     })
 
     afterEach(() => {
       delete process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE
-      delete process.env.URL
+      delete process.env.DEPLOY_PRIME_URL
     })
 
     it('makes requests to pre-warm the lambdas if GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE is enabled', async () => {
       await onSuccess()
       const controller = new AbortController()
       expect(fetch).toHaveBeenNthCalledWith(
         1,
-        `${process.env.URL}/.netlify/functions/__api`,
+        `${process.env.DEPLOY_PRIME_URL}/.netlify/functions/__api`,
         { signal: controller.signal },
       )
       expect(fetch).toHaveBeenNthCalledWith(
         2,
-        `${process.env.URL}/.netlify/functions/__dsg`,
+        `${process.env.DEPLOY_PRIME_URL}/.netlify/functions/__dsg`,
         { signal: controller.signal },
       )
       expect(fetch).toHaveBeenNthCalledWith(
         3,
-        `${process.env.URL}/.netlify/functions/__ssr`,
+        `${process.env.DEPLOY_PRIME_URL}/.netlify/functions/__ssr`,
         { signal: controller.signal },
       )
     })
@@ -255,6 +256,14 @@ describe('plugin', () => {
 
       expect(fetch).toBeCalledTimes(0)
     })
+
+    it('does not make requests to pre-warm the lambdas if process.env.DEPLOY_PRIME_URL is not defined', async () => {
+      delete process.env.DEPLOY_PRIME_URL
+
+      await onSuccess()
+
+      expect(fetch).toBeCalledTimes(0)
+    })
   })
 })
-/* eslint-enable max-nested-callbacks */
+/* eslint-enable max-nested-callbacks, ava/no-import-test-files */

plugin/test/unit/templates/utils.spec.ts

@@ -1,3 +1,4 @@
+/* eslint-disable ava/no-import-test-files */
 import { tmpdir } from 'os'
 import { resolve, join, dirname } from 'path'
 
@@ -14,6 +15,7 @@ import { dir as getTmpDir } from 'tmp-promise'
 
 // eslint-disable-next-line import/no-namespace
 import * as templateUtils from '../../../src/templates/utils'
+import { enableGatsbyExcludeDatastoreFromBundle } from '../../helpers'
 
 const chance = new Chance()
 const SAMPLE_PROJECT_DIR = `${__dirname}/../../../../demo`
@@ -63,7 +65,7 @@ describe('prepareFilesystem', () => {
   it(
     'downloads file from the CDN when GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE is enabled',
     async () => {
-      process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE = 'true'
+      enableGatsbyExcludeDatastoreFromBundle()
       await moveGatsbyDir()
 
       const cacheDir = resolve('.cache')
@@ -80,7 +82,7 @@ describe('prepareFilesystem', () => {
       const domain = chance.url({ path: '' })
       const url = `${domain}${chance.word()}/${chance.word()}`
 
-      process.env.GATSBY_EXCLUDE_DATASTORE_FROM_BUNDLE = 'true'
+      enableGatsbyExcludeDatastoreFromBundle()
       await moveGatsbyDir()
 
       const cacheDir = resolve('.cache')
@@ -157,3 +159,4 @@ describe('downloadFile', () => {
     )
   })
 })
+/* eslint-enable ava/no-import-test-files */