Getting a ERR_MODULE_NOT_FOUND during firebase deploy about isolate-package HOT 9 CLOSED

I don't have time to look into it now, but I suspect it has something to do with the fact that you reference the source from @repo/sftp directly without building/bundling. I didn't test this method extensively, because my own projects use bundling on all packages.

What you could try as a workaround maybe is to add "ssh2-sftp-client" as a dependency to the firebase service that uses @repo/sftp, or add bundling to @repo/sftp.

from isolate-package.

I think there must be something wrong with the way you configured things. Please read the section on prerequisites

If you then still can't make it work, please share some additional info about how you declared it as a dependency, and share your package manifest.

from isolate-package.

In addition, you can follow the troubleshooting instructions and inspect the output in the isolate directory.

from isolate-package.

Thanks for the quick reply, I'm pretty sure its all set up right. I've tried with the firebase-tools-with-isolate package too, and same result.

It works fine so long as my @repo/sftp method doesn't reference the dependent package (ssh2-sftp-client) but as soon as it does firebase won't deploy.

Firebase manifest

{
  "name": "functions",
  "version": "0.0.0",
  "type": "module",
  "main": "./dist/index.js",
  "module": "./dist/index.js",
  "files": [
    "dist",
    ".env.*"
  ],
  "scripts": {
    "type:check": "tsc --noEmit",
    "build": "tsup-node",
    "build:watch": "tsup-node --watch",
    "emulate": "firebase emulators:start --only functions",
    "dev": "run-p build:watch emulate",
    "lint": "eslint . --max-warnings 0",
    "deploy": "firebase deploy --only functions"
  },
  "engines": {
    "node": "20"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.3.0",
    "@repo/sftp": "workspace:*",
    "firebase-admin": "^11.8.0",
    "firebase-functions": "^4.3.1"
  },
  "devDependencies": {
    "@repo/eslint-config": "workspace:*",
    "@repo/typescript-config": "workspace:*",
    "@types/node": "^20.11.17",
    "@typescript-eslint/eslint-plugin": "^5.12.0",
    "@typescript-eslint/parser": "^5.12.0",
    "eslint": "^8.9.0",
    "eslint-config-google": "^0.14.0",
    "eslint-plugin-import": "^2.25.4",
    "firebase-functions-test": "^3.1.0",
    "firebase-tools": "^13.3.0",
    "isolate-package": "^1.9.4",
    "tsup": "^8.0.2",
    "typescript": "^5.3.3"
  },
  "private": true
}

@repo/sftp

{
  "name": "@repo/sftp",
  "version": "0.0.0",
  "type": "module",
  "types": "./src/index.ts",
  "exports": {
    ".": "./src/index.ts"
  },
  "files": [
    "src"
  ],
  "scripts": {
    "?build": "This package is links directly to its source files",
    "type-check": "tsc --noEmit",
    "test": "vitest",
    "coverage": "vitest run --coverage ",
    "lint": "eslint . --max-warnings 0"
  },
  "license": "MIT",
  "dependencies": {
    "firebase-admin": "12.0.0",
    "ssh2-sftp-client": "^10.0.3"
  },
  "devDependencies": {
    "@types/node": "^20.11.16",
    "@types/ssh2-sftp-client": "^9.0.3",
    "dotenv": "^16.4.1",
    "npm-run-all": "^4.1.5",
    "ts-node": "^10.9.2",
    "typescript": "^5.3.3"
  }
}

packages/sftp/src/index.ts
export const echo = (what: string) => you said ${what}; works and deploys fine

adding import Client from "ssh2-sftp-client"; causes the ERR_MODULE_NOT_FOUND during firebase deploy

from isolate-package.

apologies, that has confused things.

In my fns firebase project, I import like this:

import {
  type ConnectionInfo,
  echo,
  fetchSftpFiles,
} from "@repo/sftp";

export const helloWorld = onRequest((request, response) => {
  const connectionInfo: ConnectionInfo = {...};
  fetchSftpFiles(connectionInfo);
  response.send(echo("Hello from Firebase!"));
});

adding import Client from "ssh2-sftp-client"; and a method to call it to my packages/sftp/src/index.ts causes the ERR_MODULE_NOT_FOUND during firebase deploy

from isolate-package.

Weird. I don't see the problem yet. But isolate deals with internal dependencies and not external, so I don't know yet how it can be related.

Did you inspect the output of the isolate directory? Is the package.json file there (in ./package/sftp listing the "ssh2-sftp-client" dependency?

from isolate-package.

Yes, it's showing that dependency in the isolate directory.

from isolate-package.

I managed to recreate a working and non-working example in your mono-ts. I think it's to do with the build that backend does but common doesnt because it's linked directly.

So, adding the following code to @repo/backend results in a working deployable firebase functions:

modify packages/backend/src/utils/index.ts

import Client from "ssh2-sftp-client";
export function getClient() {
  return new Client();
}

and import it into the services/api/src/server.ts

import { getClient } from "@repo/backend";
const test = getClient();

Works...

But modify,
packages/common/src/index.ts

import Client from "ssh2-sftp-client";
export const getClient = () => new Client();

and import it into the services/api/src/server.ts

import { getClient } from "@repo/common";
const test = getClient();

Does NOT work....

It's re-createable with any external package like dayjs for example.

from isolate-package.

@1jmj I was able to reproduce the problem, and it seems the internal packages strategy is mainly interesting if your consuming app is something like Next.js which has a transpilePackages setting that will transpile the source and bundle its dependencies .

If the consuming app is using TSUP like services/api, then the import is merely treated as a folder of source files, and dependencies from common also need to be installed there, which makes the strategy a lot less attractive I think.

I've updated the code and the readme. See 0x80/mono-ts@d0186fe

from isolate-package.