feat: move posthog cli call to core (#2419)

Co-authored-by: Hugues Pouillot <[email protected]>

Author: ablaszkiewicz

.changeset/fresh-needles-draw.md

@@ -0,0 +1,6 @@
+---
+'@posthog/nextjs-config': patch
+'@posthog/core': patch
+---
+
+move binary calling logic to core package

examples/example-nextjs/pnpm-lock.yaml

@@ -49,6 +49,11 @@
       "types": "./dist/utils/index.d.ts",
       "require": "./dist/utils/index.js",
       "import": "./dist/utils/index.mjs"
+    },
+    "./process": {
+      "types": "./dist/process/index.d.ts",
+      "require": "./dist/process/index.js",
+      "import": "./dist/process/index.mjs"
     }
   },
   "devDependencies": {

packages/core/package.json

@@ -0,0 +1 @@
+export * from './spawn-local'

packages/core/src/process/index.ts

@@ -0,0 +1,47 @@
+import { spawn } from 'node:child_process'
+import { resolveBinaryPath } from './utils'
+
+export async function spawnLocal(
+  binaryName: string,
+  args: string[],
+  options: {
+    env: NodeJS.ProcessEnv
+    stdio: 'inherit' | 'ignore'
+    // We start traversing the file system tree from this directory and we go up until we find the binary
+    resolveFrom: string
+    cwd: string
+    onBinaryFound: (binaryLocation: string) => void
+  }
+): Promise<void> {
+  let binaryLocation
+  try {
+    binaryLocation = resolveBinaryPath(options.env.PATH ?? '', options.resolveFrom, binaryName)
+    options.onBinaryFound(binaryLocation)
+  } catch (e) {
+    console.error(e)
+    throw new Error(
+      `Binary ${binaryName} not found. Make sure postinstall script was allowed if it installs the binary`
+    )
+  }
+
+  const child = spawn(binaryLocation, [...args], {
+    shell: true,
+    stdio: options?.stdio ?? 'inherit',
+    env: options.env,
+    cwd: options.cwd,
+  })
+
+  await new Promise<void>((resolve, reject) => {
+    child.on('close', (code) => {
+      if (code === 0) {
+        resolve()
+      } else {
+        reject(new Error(`Command failed with code ${code}`))
+      }
+    })
+
+    child.on('error', (error) => {
+      reject(error)
+    })
+  })
+}

packages/core/src/process/spawn-local.ts

@@ -0,0 +1,41 @@
+import path from 'node:path'
+import fs from 'node:fs'
+
+const getLocalPaths = (startPath: string): string[] => {
+  const paths: string[] = []
+  let currentPath = startPath
+
+  while (true) {
+    paths.push(currentPath)
+    const parentPath = path.resolve(currentPath, '..')
+
+    // If we've reached the root directory, stop
+    if (parentPath === currentPath) {
+      break
+    }
+
+    currentPath = parentPath
+  }
+
+  return paths
+}
+
+export const buildLocalBinaryPaths = (cwd: string): string[] => {
+  const localPaths = getLocalPaths(path.resolve(cwd)).map((localPath: string) =>
+    path.join(localPath, 'node_modules/.bin')
+  )
+  return localPaths
+}
+
+export function resolveBinaryPath(envPath: string, cwd: string, binName: string): string {
+  const envLocations = envPath.split(path.delimiter)
+  const localLocations = buildLocalBinaryPaths(cwd)
+  const directories = [...new Set([...localLocations, ...envLocations])]
+  for (const directory of directories) {
+    const binaryPath = path.join(directory, binName)
+    if (fs.existsSync(binaryPath)) {
+      return binaryPath
+    }
+  }
+  throw new Error(`Binary ${binName} not found`)
+}

packages/nextjs-config/src/utils.spec.ts renamed to packages/core/src/process/utils.spec.ts

@@ -21,7 +21,7 @@
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "build": "rslib build",
-    "test:unit": "jest",
+    "test:unit": "jest --passWithNoTests",
     "dev": "rslib build --watch",
     "package": "pnpm pack --out $PACKAGE_DEST/%s.tgz"
   },
@@ -43,7 +43,8 @@
   "license": "MIT",
   "dependencies": {
     "@posthog/cli": "^0.4.7",
-    "semver": "^7.7.2"
+    "semver": "^7.7.2",
+    "@posthog/core": "workspace:*"
   },
   "keywords": [
     "posthog",

packages/core/src/process/utils.ts

@@ -1,48 +1,7 @@
-import path from 'path'
-import fs from 'fs'
-import { spawn } from 'child_process'
 import nextPackage from 'next/package.json' with { type: 'json' }
 import semver from 'semver'
 import { PostHogNextConfigComplete } from './config'
-
-export function resolveBinaryPath(envPath: string, cwd: string, binName: string): string {
-  const envLocations = envPath.split(path.delimiter)
-  const localLocations = buildLocalBinaryPaths(cwd)
-  const directories = [...new Set([...localLocations, ...envLocations])]
-  for (const directory of directories) {
-    const binaryPath = path.join(directory, binName)
-    if (fs.existsSync(binaryPath)) {
-      return binaryPath
-    }
-  }
-  throw new Error(`Binary ${binName} not found`)
-}
-
-export const buildLocalBinaryPaths = (cwd: string): string[] => {
-  const localPaths = getLocalPaths(path.resolve(cwd)).map((localPath: string) =>
-    path.join(localPath, 'node_modules/.bin')
-  )
-  return localPaths
-}
-
-const getLocalPaths = (startPath: string): string[] => {
-  const paths: string[] = []
-  let currentPath = startPath
-
-  while (true) {
-    paths.push(currentPath)
-    const parentPath = path.resolve(currentPath, '..')
-
-    // If we've reached the root directory, stop
-    if (parentPath === currentPath) {
-      break
-    }
-
-    currentPath = parentPath
-  }
-
-  return paths
-}
+import { spawnLocal } from '@posthog/core/process'
 
 export function getNextJsVersion(): string {
   return nextPackage.version
@@ -79,37 +38,15 @@ export async function processSourceMaps(posthogOptions: PostHogNextConfigComplet
 }
 
 async function callPosthogCli(args: string[], env: NodeJS.ProcessEnv, verbose: boolean): Promise<void> {
-  let binaryLocation
-  try {
-    binaryLocation = resolveBinaryPath(process.env.PATH ?? '', __dirname, 'posthog-cli')
-  } catch (e) {
-    throw new Error(`Binary ${e} not found. Make sure postinstall script has been allowed for @posthog/cli`)
-  }
-
-  if (verbose) {
-    console.log('running posthog-cli from ', binaryLocation)
-  }
-
-  const child = spawn(binaryLocation, [...args], {
-    shell: true,
-    stdio: verbose ? 'inherit' : 'ignore',
+  await spawnLocal('posthog-cli', args, {
     env,
+    stdio: verbose ? 'inherit' : 'ignore',
+    onBinaryFound: (binaryPath) => {
+      console.log(`running posthog-cli binary from ${binaryPath}`)
+    },
+    resolveFrom: __dirname,
     cwd: process.cwd(),
   })
-
-  await new Promise<void>((resolve, reject) => {
-    child.on('close', (code) => {
-      if (code === 0) {
-        resolve()
-      } else {
-        reject(new Error(`Command failed with code ${code}`))
-      }
-    })
-
-    child.on('error', (error) => {
-      reject(error)
-    })
-  })
 }
 
 // Helper to detect if Turbopack is enabled