The types of 'options.autoEncrypter' are incompatible

[guyellis]

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

When upgrading the mongodb dependency from 4.1.0 to 4.1.1 this is the TypeScript error:

Type 'import(".../node_modules/mongodb/mongodb").MongoClient' is 
not assignable to type 
'import(".../node_modules/connect-mongo/node_modules/mongodb/mongodb").MongoClient'.
  The types of 'options.autoEncrypter' are incompatible between these types.
    Type 'import(".../node_modules/mongodb/mongodb").AutoEncrypter |
     undefined' is not assignable to type 
     'import(".../node_modules/connect-mongo/node_modules/mongodb/mongodb").AutoEncrypter |
      undefined'.

I think that the fix is as simple as upgrading the dependency in package.json:

connect-mongo/package.json

Line 62 in 3e27376

"mongodb": "4.1.0"

[rfox12]

I'm not an expert on NPM libraries, but isn't it best to have mongodb specified as a peerDependency rather than a dependency pinned to a specific version? Wouldn't that prevent connect-mongo from breaking every time mongodb types are changed?

[guyellis]

@rfox12 yes and no.

Yes - it would stop it breaking in this context and in that way.

No - what if connect-mongo relies on the schema? Say 4.1.1 removes a property but connect-mongo relies on that property being there. Now as a peerDependency it will still break.

[rfox12]

If mongodb is abiding by good semver citizenship (which I think they will), the promise with minor and patch releases is that they do not break the interface...

I've added a pull request.

[guyellis]

If mongodb is abiding by good semver citizenship (which I think they will), the promise with minor and patch releases is that they do not break the interface...

My example wasn't very good - or deep enough.

Let's say that they removed an optional property from the type that should not have been there because it was not used. That might technically break the TypeScript schema but would not causing a functional breaking change.

[guyellis]

I've added a pull request.

Thank you! 💯

[mingchuno]

link to #433
I think I would tried the peerDependency approach first to see if it work. @rfox12 @guyellis Any idea on the drawback on moving mongodb to peerDependency? Will it break current user?

[mingchuno]

4.6.0 released

[rfox12]

I don't think we're going to break anyone's usage. I upgraded just now and my update moved me to mongodb@4.1.2 and connect-mongo@4.6.0 with no issues! Thanks

[guyellis]

Any idea on the drawback on moving mongodb to peerDependency? Will it break current user?

I think it works the way that you've done it with ^ optimistic.

[huineng]

it works, i just had to delete node_modules and package-lock.json and reinstall. thanks

[guyellis]

it works, i just had to delete node_modules and package-lock.json and reinstall. thanks

@huineng did you run into: TextEncoder is not defined that caused you to do that?

[huineng]

no sorry, i got "cannot find mongo"

[rfox12]

@huineng You'll simply want to ensure mongodb is in your package.json dependencies.
npm install mongodb or
yarn install mongodb