@netlify/config 18.0.0 → 18.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/config",
-  "version": "18.0.0",
+  "version": "18.1.0",
   "description": "Netlify config module",
   "type": "module",
   "exports": "./src/main.js",
@@ -64,7 +64,7 @@
     "is-plain-obj": "^4.0.0",
     "js-yaml": "^4.0.0",
     "map-obj": "^5.0.0",
-    "netlify": "^11.0.1",
+    "netlify": "^11.0.2",
     "netlify-headers-parser": "^6.0.2",
     "netlify-redirect-parser": "13.0.5",
     "omit.js": "^2.0.2",

package/src/api/site_info.js

@@ -1,4 +1,6 @@
+import { getEnvelope } from '../env/envelope.js'
 import { throwUserError } from '../error.js'
+import { ERROR_CALL_TO_ACTION } from '../log/messages.js'
 
 // Retrieve Netlify Site information, if available.
 // Used to retrieve local build environment variables and UI build settings.
@@ -7,6 +9,7 @@ import { throwUserError } from '../error.js'
 // Requires knowing the `siteId` and having the access `token`.
 // Silently ignore API errors. For example the network connection might be down,
 // but local builds should still work regardless.
+// eslint-disable-next-line complexity
 export const getSiteInfo = async function ({ api, siteId, mode, testOpts: { env: testEnv = true } = {} }) {
   if (api === undefined || mode === 'buildbot' || !testEnv) {
     const siteInfo = siteId === undefined ? {} : { id: siteId }
@@ -18,6 +21,13 @@ export const getSiteInfo = async function ({ api, siteId, mode, testOpts: { env:
     getAccounts(api),
     getAddons(api, siteId),
   ])
+
+  if (siteInfo.use_envelope) {
+    const envelope = await getEnvelope({ api, accountId: siteInfo.account_slug, siteId })
+    // eslint-disable-next-line fp/no-mutation
+    siteInfo.build_settings.env = envelope
+  }
+
   return { siteInfo, accounts, addons }
 }
 
@@ -55,5 +65,3 @@ const getAddons = async function (api, siteId) {
     throwUserError(`Failed retrieving addons for site ${siteId}: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
   }
 }
-
-const ERROR_CALL_TO_ACTION = `Double-check your login status with 'netlify status' or contact support with details of your error.`

package/src/env/envelope.js

@@ -0,0 +1,27 @@
+import { throwUserError } from '../error.js'
+import { ERROR_CALL_TO_ACTION } from '../log/messages.js'
+
+export const getEnvelope = async function ({ api, accountId, siteId }) {
+  if (accountId === undefined) {
+    return {}
+  }
+  try {
+    const environmentVariables = await api.getEnvVars({ accountId, siteId })
+    // eslint-disable-next-line fp/no-mutating-methods
+    const sortedEnvVarsFromDevContext = environmentVariables
+      .sort((left, right) => (left.key.toLowerCase() < right.key.toLowerCase() ? -1 : 1))
+      .reduce((acc, cur) => {
+        const envVar = cur.values.find((val) => ['dev', 'all'].includes(val.context))
+        if (envVar && envVar.value) {
+          return {
+            ...acc,
+            [cur.key]: envVar.value,
+          }
+        }
+        return acc
+      }, {})
+    return sortedEnvVarsFromDevContext
+  } catch (error) {
+    throwUserError(`Failed retrieving envelope for site ${siteId}: ${error.message}. ${ERROR_CALL_TO_ACTION}`)
+  }
+}

package/src/env/main.js

@@ -2,6 +2,7 @@ import omit from 'omit.js'
 
 import { removeFalsy } from '../utils/remove_falsy.js'
 
+import { getEnvelope } from './envelope.js'
 import { getGitEnv } from './git.js'
 
 // Retrieve this site's environment variable. Also take into account team-wide
@@ -11,6 +12,7 @@ import { getGitEnv } from './git.js'
 // TODO: add `netlify.toml` `build.environment`, after normalization
 // TODO: add `CONTEXT` and others
 export const getEnv = async function ({
+  api,
   mode,
   config,
   siteInfo,
@@ -27,7 +29,7 @@ export const getEnv = async function ({
   }
 
   const generalEnv = await getGeneralEnv({ siteInfo, buildDir, branch, deployId, buildId, context })
-  const [accountEnv, addonsEnv, uiEnv, configFileEnv] = getUserEnv({ config, siteInfo, accounts, addons })
+  const [accountEnv, addonsEnv, uiEnv, configFileEnv] = await getUserEnv({ api, config, siteInfo, accounts, addons })
 
   // Sources of environment variables, in descending order of precedence.
   const sources = [
@@ -115,8 +117,8 @@ const NETLIFY_DEFAULT_DOMAIN = '.netlify.app'
 const DEFAULT_SITE_NAME = 'site-name'
 
 // Environment variables specified by the user
-const getUserEnv = function ({ config, siteInfo, accounts, addons }) {
-  const accountEnv = getAccountEnv({ siteInfo, accounts })
+const getUserEnv = async function ({ api, config, siteInfo, accounts, addons }) {
+  const accountEnv = await getAccountEnv({ api, siteInfo, accounts })
   const addonsEnv = getAddonsEnv(addons)
   const uiEnv = getUiEnv({ siteInfo })
   const configFileEnv = getConfigFileEnv({ config })
@@ -124,8 +126,12 @@ const getUserEnv = function ({ config, siteInfo, accounts, addons }) {
 }
 
 // Account-wide environment variables
-const getAccountEnv = function ({ siteInfo: { account_slug: accountSlug }, accounts }) {
-  const { site_env: siteEnv = {} } = accounts.find(({ slug }) => slug === accountSlug) || {}
+const getAccountEnv = async function ({ api, siteInfo, accounts }) {
+  if (siteInfo.use_envelope) {
+    const envelope = await getEnvelope({ api, accountId: siteInfo.account_slug })
+    return envelope
+  }
+  const { site_env: siteEnv = {} } = accounts.find(({ slug }) => slug === siteInfo.account_slug) || {}
   return siteEnv
 }
 

package/src/log/messages.js

@@ -2,6 +2,8 @@ import { throwUserError } from '../error.js'
 
 import { logWarning } from './logger.js'
 
+export const ERROR_CALL_TO_ACTION = `Double-check your login status with 'netlify status' or contact support with details of your error.`
+
 export const throwOnInvalidTomlSequence = function (invalidSequence) {
   throwUserError(
     `In netlify.toml, the following backslash should be escaped: ${invalidSequence}

package/src/main.js

@@ -84,6 +84,7 @@ export const resolveConfig = async function (opts) {
   })
 
   const env = await getEnv({
+    api,
     mode,
     config,
     siteInfo,

package/src/validate/validations.js

@@ -102,6 +102,17 @@ export const PRE_NORMALIZE_VALIDATIONS = [
       functions: { ignored_node_modules: ['module-one', 'module-two'] },
     }),
   },
+  {
+    property: 'edge_functions',
+    check: isArrayOfObjects,
+    message: 'must be an array of objects.',
+    example: () => ({
+      edge_functions: [
+        { path: '/hello', function: 'hello' },
+        { path: '/auth', function: 'auth' },
+      ],
+    }),
+  },
 ]
 
 const EXAMPLE_PORT = 80
@@ -242,5 +253,40 @@ export const POST_NORMALIZE_VALIDATIONS = [
       functions: { directory: 'my-functions' },
     }),
   },
+  {
+    property: 'edge_functions.*',
+    ...validProperties(['path', 'function'], []),
+    example: () => ({ edge_functions: [{ path: '/hello', function: 'hello' }] }),
+  },
+  {
+    property: 'edge_functions.*',
+    check: (edgeFunction) => edgeFunction.path !== undefined,
+    message: '"path" property is required.',
+    example: () => ({ edge_functions: [{ path: '/hello', function: 'hello' }] }),
+  },
+  {
+    property: 'edge_functions.*',
+    check: (edgeFunction) => edgeFunction.function !== undefined,
+    message: '"function" property is required.',
+    example: () => ({ edge_functions: [{ path: '/hello', function: 'hello' }] }),
+  },
+  {
+    property: 'edge_functions.*.path',
+    check: isString,
+    message: 'must be a string.',
+    example: () => ({ edge_functions: [{ path: '/hello', function: 'hello' }] }),
+  },
+  {
+    property: 'edge_functions.*.function',
+    check: isString,
+    message: 'must be a string.',
+    example: () => ({ edge_functions: [{ path: '/hello', function: 'hello' }] }),
+  },
+  {
+    property: 'edge_functions.*.path',
+    check: (pathName) => pathName.startsWith('/'),
+    message: 'must be a valid path.',
+    example: () => ({ edge_functions: [{ path: '/hello', function: 'hello' }] }),
+  },
 ]
 /* eslint-enable max-lines */