keyv doesn't work in pnpm monorepo

[dandv]

Trying to use keyv and @keyv/mongo works with npm (duh), pnpm, but not if the project is a pnpm workspace. The error is "Error: Cannot find module '@keyv/mongo'".

Repro repo at https://github.com/dandv/pnpm-monorepo-keyv

Any idea what might cause this?

[lukechilds]

Sorry, I'm really not familiar with pnpm.

One idea might be that I try and auto-detect the correct module based on the connection string. Sounds like this might be where it's going wrong.

I see you're using @keyv/mongo. Could you try manually passing in the storage adapter instead of letting Keyv infer it from your connection string.

E.g instead of:

const Keyv = require('keyv');

const keyv = new Keyv('mongodb://user:pass@localhost:27017/dbname');

Can you try:

const Keyv = require('keyv');
const KeyvMongo = require('@keyv/mongo');

const keyvMongo = new KeyvMongo('mongodb://user:pass@localhost:27017/dbname');
const keyv = new Keyv({ store: keyvMongo });

[dandv]

Yes, requiring @keyv/mongo explicitly worked!

[lukechilds]

Ahh, so seems like pnpm is hijacking the Node.js dependency resolution algorithm somehow.

I wouldn't really consider this a bug in Keyv so I'll close this issue. Glad you got it sorted though. Thanks for reporting, hopefully this issue will help anyone else who gets stuck using Keyv with pnpm. 👍

[zkochan]

This issue should be solved with optional peer dependencies. We don't support them yet but we will. (I believe Yarn already has support in the latest version)

You basically have to add this to the package.json of keyv:

"peerDependencies": {
  "@keyv/mongo": "1"
},
"peerDependenciesMeta": {
  "@keyv/mongo": {
    "optional": true
  }
}

cc @arcanis

[matzkoh]

I saw this error when I deployed my app to vercel.
I simply added one line and it worked without any other changes.

import Keyv from 'keyv'
import '@keyv/mongo' // <===