feat: Support pnpm for firebase functions (#216)

* Update nx-firebase-versions.ts

* Add @google-cloud/functions-framework to plugin workspace

* Add googleCloudFunctionsFramework dependency

* Ensure auto generated dependencies are clean semvers

* Format cleanup

* Add @google-cloud/functions-framework dep if pnpm

* Add e2e tests

* Unit test

Author: simondotm

e2e/nx-firebase-e2e/tests/test-function.ts

@@ -88,6 +88,16 @@ export function testFunction() {
 
         validateFunctionConfig(functionData, appData)
 
+        // check that google-cloud/functions-framework is added to package.json if pnpm being used
+        const packageJson = readJson(
+          `${functionData.projectDir}/package.json`,
+        )
+        if (detectPackageManager() === 'pnpm') {
+          expect(packageJson.dependencies['@google-cloud/functions-framework']).toBeDefined()
+        }else{
+          expect(packageJson.dependencies['@google-cloud/functions-framework']).not.toBeDefined()
+        }
+
         // cleanup
         await cleanFunctionAsync(functionData)              
         await cleanAppAsync(appData)              
@@ -117,6 +127,17 @@ export function testFunction() {
             ),
         ).not.toThrow()   
 
+        // check that nx preserves the function `package.json` dependencies in the output `package.json`
+        const packageJson = readJson(
+          `dist/${functionData.projectDir}/package.json`,
+        )
+        if (detectPackageManager() === 'pnpm') {
+          expect(packageJson.dependencies['@google-cloud/functions-framework']).toBeDefined()
+        }else{
+          expect(packageJson.dependencies['@google-cloud/functions-framework']).not.toBeDefined()
+        }
+
+
         // cleanup
         await cleanFunctionAsync(functionData)              
         await cleanAppAsync(appData)             

e2e/nx-firebase-e2e/tests/test-workspace.ts

@@ -5,6 +5,7 @@ import {
 import {
   safeRunNxCommandAsync,
 } from '../test-utils'
+import { detectPackageManager } from '@nx/devkit'
 
 //--------------------------------------------------------------------------------------------------
 // Test the workspace setup & init generator
@@ -48,9 +49,23 @@ export function testWorkspace() {
         expect(
           packageJson.devDependencies['firebase-functions-test'],
         ).toBeDefined()
+
+        // check that plugin init generator adds @google-cloud/functions-framework if pnpm is being used
+        if (detectPackageManager() === 'pnpm') {
+          expect(
+            packageJson.dependencies['@google-cloud/functions-framework'],
+          ).toBeDefined()
+        } else {
+          expect(
+            packageJson.dependencies['@google-cloud/functions-framework'],
+          ).not.toBeDefined()
+        }
+
+        // test that generator adds dev dependencies to workspace package.json
         expect(packageJson.devDependencies['firebase-tools']).toBeDefined()
         //SM: Mar'24: our plugin init generator now only add @nx/node
         expect(packageJson.devDependencies['@nx/node']).toBeDefined()
+
     })
   })
 }

package.json

@@ -19,6 +19,7 @@
   },
   "private": true,
   "devDependencies": {
+    "@google-cloud/functions-framework": "^3.3.0",
     "@nx/devkit": "16.8.1",
     "@nx/eslint-plugin": "16.8.1",
     "@nx/jest": "16.8.1",

packages/nx-firebase/src/__generated__/nx-firebase-versions.ts

@@ -1,6 +1,12 @@
-import { offsetFromRoot, Tree } from '@nx/devkit'
+import {
+  detectPackageManager,
+  offsetFromRoot,
+  Tree,
+  updateJson,
+} from '@nx/devkit'
 import { generateFiles, joinPathFragments } from '@nx/devkit'
 import type { NormalizedSchema } from '../schema'
+import { packageVersions } from '../../../__generated__/nx-firebase-versions'
 
 /**
  * Generate the firebase app specific files
@@ -45,4 +51,23 @@ export function createFiles(host: Tree, options: NormalizedSchema): void {
     options.projectRoot,
     substitutions,
   )
+
+  // set dependencies for the firebase function
+  const firebasePackageDependencies = {}
+  if (detectPackageManager() === 'pnpm') {
+    firebasePackageDependencies[
+      '@google-cloud/functions-framework'
+    ] = `^${packageVersions.googleCloudFunctionsFramework}`
+  }
+
+  if (Object.keys(firebasePackageDependencies).length > 0) {
+    updateJson(
+      host,
+      joinPathFragments(options.projectRoot, 'package.json'),
+      (json) => {
+        json.dependencies = firebasePackageDependencies
+        return json
+      },
+    )
+  }
 }

packages/nx-firebase/src/generators/function/lib/create-files.ts

@@ -90,6 +90,17 @@ describe('init generator', () => {
       `^${packageVersions.killPort}`,
     )
 
+    // check that plugin init generator adds @google-cloud/functions-framework if pnpm is being used
+    if (devkit.detectPackageManager() === 'pnpm') {
+      expect(
+        packageJson.dependencies['@google-cloud/functions-framework'],
+      ).toBe(`^${packageVersions.googleCloudFunctionsFramework}`)
+    } else {
+      expect(
+        packageJson.dependencies['@google-cloud/functions-framework'],
+      ).not.toBeDefined()
+    }
+
     expect(packageJson.dependencies['tslib']).not.toBeDefined()
   })
 

packages/nx-firebase/src/generators/init/init.spec.ts

@@ -4,8 +4,8 @@ import { addGitIgnore, addNxIgnore } from './lib/add-git-ignore-entry'
 import type { InitGeneratorOptions } from './schema'
 
 /**
- * `nx g @simondotm/nx-firebase:init` 
- * 
+ * `nx g @simondotm/nx-firebase:init`
+ *
  * Ensures the necessary firebase packages are installed in the nx workspace
  * It also adds `@nx/node` if it is not already installed
  *
@@ -20,4 +20,3 @@ export async function initGenerator(
 }
 
 export default initGenerator
-

packages/nx-firebase/src/generators/init/init.ts

@@ -3,6 +3,8 @@ import {
   readJson,
   Tree,
   addDependenciesToPackageJson,
+  detectPackageManager,
+  logger,
 } from '@nx/devkit'
 import { workspaceNxVersion } from '../../../utils'
 import { packageVersions } from '../../../__generated__/nx-firebase-versions'
@@ -20,10 +22,12 @@ export function addDependencies(tree: Tree): GeneratorCallback {
   function addDependencyIfNotPresent(
     packageName: string,
     packageVersion: string,
-  ) {
+  ): boolean {
     if (!packageJson.dependencies || !packageJson.dependencies[packageName]) {
       dependencies[packageName] = packageVersion
+      return true
     }
+    return false
   }
   function addDevDependencyIfNotPresent(
     packageName: string,
@@ -34,7 +38,9 @@ export function addDependencies(tree: Tree): GeneratorCallback {
       !packageJson.devDependencies[packageName]
     ) {
       devDependencies[packageName] = packageVersion
+      return true
     }
+    return false
   }
 
   // Firebase packages are not managed by the plugin
@@ -49,8 +55,19 @@ export function addDependencies(tree: Tree): GeneratorCallback {
     `^${packageVersions.firebaseFunctions}`,
   )
 
-  //SM: not convinced we should be adding tslib in this plugin
-  //addDependencyIfNotPresent('tslib', tsLibVersion)
+  // if the workspace uses pnpm, we need to add the @google-cloud/functions-framework package
+  if (detectPackageManager() === 'pnpm') {
+    if (
+      addDependencyIfNotPresent(
+        '@google-cloud/functions-framework',
+        `^${packageVersions.googleCloudFunctionsFramework}`,
+      )
+    ) {
+      logger.info(
+        `This workspace is using pnpm, adding '@google-cloud/functions-framework' dependency for firebase functions compatibility\nSee https://github.com/firebase/firebase-tools/issues/5911#issuecomment-1730263400\n\n`,
+      )
+    }
+  }
 
   // firebase dev dependencies
   addDevDependencyIfNotPresent(