Add filters and functions when the environment is ready

Author: BenSurgisonGDS

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- [#2378: Add filters and functions when the environment is ready](https://github.com/alphagov/govuk-prototype-kit/pull/2378)
+
 ## 13.15.1
 
 ### Fixes

lib/filters/api.js

@@ -55,5 +55,6 @@ module.exports = {
     addFilter,
     getFilter
   },
-  setEnvironment
+  setEnvironment,
+  runWhenEnvIsAvailable
 }

lib/filters/core-filters.js

@@ -1,7 +1,6 @@
 // local dependencies
-const { addFilter, getFilter } = require('../../').views
-
-const nunjucksSafe = getFilter('safe')
+const { runWhenEnvIsAvailable, external } = require('./api')
+const { addFilter, getFilter } = external
 
 /**
  * Logs an object in the template to the console in the browser.
@@ -10,4 +9,7 @@ const nunjucksSafe = getFilter('safe')
  * @example {{ "hello world" | log }}
  * @example {{ "hello world" | log | safe }}  [for environments with autoescaping turned on]
  */
-addFilter('log', a => nunjucksSafe('<script>console.log(' + JSON.stringify(a, null, '\t') + ');</script>'))
+runWhenEnvIsAvailable(() => {
+  const nunjucksSafe = getFilter('safe')
+  addFilter('log', a => nunjucksSafe('<script>console.log(' + JSON.stringify(a, null, '\t') + ');</script>'))
+})

lib/functions/api.js

@@ -62,5 +62,6 @@ module.exports = {
     addFunction,
     getFunction
   },
-  setEnvironment
+  setEnvironment,
+  runWhenEnvIsAvailable
 }

lib/utils/index.js

@@ -18,6 +18,8 @@ const plugins = require('../plugins/plugins')
 const routes = require('../routes/api')
 const { appDir, projectDir } = require('./paths')
 const { asyncSeriesMap } = require('./asyncSeriesMap')
+const { runWhenEnvIsAvailable: runWhenFiltersEnvIsAvailable } = require('../filters/api')
+const { runWhenEnvIsAvailable: runWhenFunctionsEnvIsAvailable } = require('../functions/api')
 
 // Tweak the Markdown renderer
 const defaultMarkedRenderer = marked.defaults.renderer || new marked.Renderer()
@@ -53,8 +55,10 @@ function addNunjucksFilters (env) {
   if (fs.existsSync(filtersPath)) {
     additionalFilters.push(filtersPath)
   }
-  const filterFiles = plugins.getFileSystemPaths('nunjucksFilters').concat(additionalFilters)
-  filterFiles.forEach(x => require(x))
+  runWhenFiltersEnvIsAvailable(() => {
+    const filterFiles = plugins.getFileSystemPaths('nunjucksFilters').concat(additionalFilters)
+    filterFiles.forEach(x => require(x))
+  })
 }
 
 // Require core and custom functions, merges to one object
@@ -66,8 +70,10 @@ function addNunjucksFunctions (env) {
   if (fs.existsSync(functionsPath)) {
     additionalFunctions.push(functionsPath)
   }
-  const globalFiles = plugins.getFileSystemPaths('nunjucksFunctions').concat(additionalFunctions)
-  globalFiles.forEach(x => require(x))
+  runWhenFunctionsEnvIsAvailable(() => {
+    const globalFiles = plugins.getFileSystemPaths('nunjucksFunctions').concat(additionalFunctions)
+    globalFiles.forEach(x => require(x))
+  })
 }
 
 function addRouters (app) {