refactor: type global configuration file

Follow-up to a comment thread in #7199.

This changeset adds types for the global configuration file
(`$CONFIG_HOME/netlify/config.json`).

This is mainly a step forward in documenting the configuration format.
The type safety on it isn't ideal; e.g. you can try to read or write
properties that don't exist in the config schema. That said, it's an
improvement on the read side in the sense that any property you
read is typed--even unknown ones default to `undefined`.

This comes with two _potential_ breaking changes; I didn't find that
they actually broke anything in practice, but they're worth looking out
for in review:

1. We now set defaults for some values we did not previously set
   defaults for, e.g. `users[id: string].auth` defaults to an object.
   This could only break if a code path assumes e.g. the presence of
   `auth.github` means the user is authenticated; however, the way the
   types are structured marks all properties on that object as
   undefined, so this is a difficult error to make now.
2. We now validate that `users[id: string].id` is set. Failing to set it
   would make looking up user configuration impossible (we index into
   this object using the top-level `userId` field), so this prevents a
   class of mysterious logic errors.

Stronger typing caused some issues in tests that mock the global config
store; broke the `GlobalConfigStore`'s storage logic out into an adapter
and implemented an in-memory adapter for use in tests. There are better
ways to solve this problem--tests should be able to mock the global
config without resorting to module mocking--but this will do for now.

I think the global config store interface could use some work: at this
point I think the dot-prop style of setting and getting properties only
adds complexity vs something like a Proxy-wrapped object. That said,
this is a step forward without committing to a bigger change.

Author: ndhoule

package-lock.json

@@ -152,7 +152,8 @@
     "uuid": "11.1.0",
     "wait-port": "1.1.0",
     "write-file-atomic": "5.0.1",
-    "ws": "8.18.1"
+    "ws": "8.18.1",
+    "zod": "^3.24.3"
   },
   "devDependencies": {
     "@babel/preset-react": "7.26.3",
@@ -208,6 +209,7 @@
     "temp-dir": "3.0.0",
     "tree-kill": "1.2.2",
     "tsx": "^4.19.3",
+    "type-fest": "4.40.0",
     "typescript": "5.8.3",
     "typescript-eslint": "^8.26.0",
     "verdaccio": "6.1.2",

package.json

@@ -39,6 +39,11 @@ export const logsBuild = async (options: OptionValues, command: BaseCommand) =>
   const { id: siteId } = site
   const userId = command.netlify.globalConfig.get('userId')
 
+  if (!userId) {
+    log('You must authenticate before attempting to view deploy logs')
+    return
+  }
+
   if (!siteId) {
     log('You must link a site before attempting to view deploy logs')
     return

src/commands/logs/build.ts

@@ -16,7 +16,7 @@ import type BaseCommand from '../base-command.js'
 
 export const status = async (options: OptionValues, command: BaseCommand) => {
   const { accounts, api, globalConfig, site, siteInfo } = command.netlify
-  const currentUserId = globalConfig.get('userId') as string | undefined
+  const currentUserId = globalConfig.get('userId')
   const [accessToken] = await getToken()
 
   if (!accessToken) {
@@ -48,7 +48,7 @@ export const status = async (options: OptionValues, command: BaseCommand) => {
 
   const ghuser =
     currentUserId != null
-      ? (globalConfig.get(`users.${currentUserId}.auth.github.user`) as string | undefined)
+      ? (globalConfig.get(`users.${currentUserId}.auth.github.user`))
       : undefined
   const accountData = {
     Name: user.full_name,