feat: add header to installing extension with the build mode so we know where the installation is coming from (#6478)

* feat: add header to installing extension with the build mode so we know where the installation is coming from * fix: use useragent for extensioninstallsource * fix: log netlify config and version * fix: expose package json as file for netlify config * fix: use other way to get package version for config * fix: use readfile to read package.json --------- Co-authored-by: Karin <=> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: khendrikse

package-lock.json

@@ -2,7 +2,6 @@ import { readFile } from 'fs/promises'
 import { fileURLToPath } from 'url'
 
 import type { PackageJson } from 'read-package-up'
-
 // We know how our package.json looks like, so we can be very specific with the type
 // and only add the properties we want to use
 export type RootPackageJson = { name: string; version: string }
@@ -14,7 +13,7 @@ const ROOT_PACKAGE_JSON_PATH = fileURLToPath(new URL('../../package.json', impor
 export const importJsonFile = async function (filePath: string): Promise<PackageJson> {
  const fileContents = await readFile(filePath, 'utf-8')
 
- return JSON.parse(fileContents)
+ return JSON.parse(fileContents) as PackageJson
 }
 
 export const ROOT_PACKAGE_JSON = (await importJsonFile(ROOT_PACKAGE_JSON_PATH)) as RootPackageJson

packages/build/src/utils/json.ts

@@ -3,7 +3,9 @@
  "version": "23.0.11",
  "description": "Netlify config module",
  "type": "module",
- "exports": "./lib/index.js",
+ "exports": {
+ ".": "./lib/index.js"
+ },
  "main": "./lib/index.js",
  "types": "./lib/index.d.ts",
  "bin": {
@@ -77,6 +79,7 @@
  "omit.js": "^2.0.2",
  "p-locate": "^6.0.0",
  "path-type": "^6.0.0",
+ "read-package-up": "^11.0.0",
  "tomlify-j0.4": "^3.0.0",
  "validate-npm-package-name": "^5.0.0",
  "yaml": "^2.8.0",

packages/config/package.json

@@ -110,6 +110,7 @@ export async function handleAutoInstallExtensions({
  netlifyToken: token,
  slug: ext.slug,
  hostSiteUrl: ext.hostSiteUrl,
+ extensionInstallationSource: mode,
  })
  }),
  )

packages/config/src/utils/extensions/auto-install-extensions.ts

@@ -1,5 +1,8 @@
 import { EXTENSION_API_BASE_URL } from '../../integrations.js'
+import { ModeOption } from '../../types/options.js'
+import { ROOT_PACKAGE_JSON } from '../json.js'
 
+const configVersion = ROOT_PACKAGE_JSON.version
 export type InstallExtensionResult =
  | {
  slug: string
@@ -18,12 +21,15 @@ export const installExtension = async ({
  accountId,
  slug,
  hostSiteUrl,
+ extensionInstallationSource,
 }: {
  netlifyToken: string
  accountId: string
  slug: string
  hostSiteUrl: string
+ extensionInstallationSource: ModeOption
 }): Promise<InstallExtensionResult> => {
+ const userAgent = `Netlify Config (mode:${extensionInstallationSource}) / ${configVersion}`
  const extensionOnInstallUrl = new URL('/.netlify/functions/handler/on-install', hostSiteUrl)
  const installedResponse = await fetch(extensionOnInstallUrl, {
  method: 'POST',
@@ -32,6 +38,7 @@ export const installExtension = async ({
  }),
  headers: {
  'netlify-token': netlifyToken,
+ 'User-Agent': userAgent,
  },
  })
 

packages/config/src/utils/extensions/utils.ts

@@ -0,0 +1,19 @@
+import { readFile } from 'fs/promises'
+import { fileURLToPath } from 'url'
+
+import type { PackageJson } from 'read-package-up'
+// We know how our package.json looks like, so we can be very specific with the type
+// and only add the properties we want to use
+export type RootPackageJson = { name: string; version: string }
+
+const ROOT_PACKAGE_JSON_PATH = fileURLToPath(new URL('../../package.json', import.meta.url))
+
+// TODO: Replace with dynamic `import()` once it is supported without
+// experimental flags
+export const importJsonFile = async function (filePath: string): Promise<PackageJson> {
+ const fileContents = await readFile(filePath, 'utf-8')
+
+ return JSON.parse(fileContents) as PackageJson
+}
+
+export const ROOT_PACKAGE_JSON = (await importJsonFile(ROOT_PACKAGE_JSON_PATH)) as RootPackageJson