Skip to content

Commit ebbd33a

Browse files
nbbeekennbbeeken
committed
docs(NODE-2329): write upgrade and migration guide
1 parent fe71106 commit ebbd33a

File tree

2 files changed

+267
-19
lines changed

2 files changed

+267
-19
lines changed

‎docs/CHANGES_4.0.0.md‎

Lines changed: 229 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,249 @@
1-
# Changes in 4.x
1+
# Changes in 4.x (and how to migrate!)
22

3-
WIP
3+
_Hello dear reader, **thank you** for adopting version 4.x of the mongodb driver, from the bottom of our developer hearts we thank you so much for taking the time to upgrade to our latest and greatest offering of a stunning database experience.
4+
We hope you enjoy your upgrade experience and this guide gives you all the answers you are searching for.
5+
If anything, and we mean anything, hinders you upgrade experience please let us know via [JIRA](https://jira.mongodb.org/browse/NODE).
6+
We know breaking changes are hard but they are sometimes for the best.
7+
Anyway, enjoy the guide, see you at the end!_
48

5-
## Versioned API
9+
## Key Changes
610

7-
Versioned API is a new feature in MongoDB 5.0 that allows user-selectable API versions, subsets of MongoDB server semantics, to be declared on a client. During communication with a server, clients with a declared API version will force the server to behave in a manner compatible with the API version. Declaring an API version on a client can be used to ensure consistent responses from a server, providing long term API stability for an application. The declared API version is applied to all commands run through the client, including those sent through the generic RunCommand helper. Specifying versioned API options in the command document AND declaring an API version on the client is not supported and will lead to undefined behaviour.
11+
### Typescript
812

9-
### Declare an API version on a client:
13+
We've migrated the driver to Typescript! Users can now harness the power of type hinting and intellisense in editors that support it to develop their MongoDB applications. Users don't even have to adopt Typescript to get the benefits. Along with the type hinting there's consistent docs formatting that editors should be able to display while developing.
14+
Recently we migrated our BSON library to TypeScript as well, this version of the driver pulls in those changes.
15+
16+
#### Community Types users (@types/mongodb)
17+
18+
If you are a user of the community types (@types/mongodb) there will likely be compilation errors while adopting the types from our codebase.
19+
Unfortunately we could not achieve a one to one match in types due to the details of writing the codebase in Typescript vs definitions for the user layer API along with the breaking changes of this major version. Please let us know if there's anything that is a blocker to upgrading [on JIRA](https://jira.mongodb.org/browse/NODE).
20+
21+
### NodeJS Version
22+
23+
We now require node 12.9 or greater for version 4 of the driver.
24+
If that's outside your support matrix at this time, that's okay!
25+
Bug fix support for our 3.x branch will not be ending until summer 2022!
26+
27+
### Cursor changes
28+
29+
#### AbstractCursor, FindCursor, AggregationCursor, ChangeStreamCursor, ListCollectionsCursor
30+
31+
Our Cursor implementation has been updated to make more clear what is possible before and after execution of an operation. Take this example:
32+
33+
```javascript
34+
const cursor = collection.find({ a: 2.3 }).skip(1)
35+
for await (const doc of cursor) {
36+
console.log(doc);
37+
fc.limit(1) // bad.
38+
}
39+
```
40+
41+
Prior to the this release there was inconsistency surrounding how the cursor would error if a setting like limit was applied after cursor execution had begun. Now, an error along the lines of: `Cursor is already initialized` is thrown.
42+
43+
#### Stream API
44+
45+
The Cursor no longer extends Readable directly, it must be transformed into a stream by calling cursor.stream(), for example:
46+
47+
```javascript
48+
const cursor = collection.find({});
49+
const stream = cursor.stream()
50+
stream.on("data", data => console.log(data));
51+
stream.on("end", () => client.close());
52+
```
53+
54+
### MongoClientOptions interface
55+
56+
With type hinting users should find that the options passed to a MongoClient are completely enumerated and easily discoverable.
57+
In 3.x there were options, like `maxPoolSize`, that were only respected when `useUnifiedTopology=true` was enabled, vs `poolSize` when `useUnifiedTopology=false`.
58+
We've de-duped these options and put together some hefty validation to help process all options upfront to give early warnings about incompatible settings in order to help your app get up and running correctly quicker!
59+
60+
#### Unified Topology Only
61+
62+
We internally now only manage a Unified Topology when you connect to your MongoDB.
63+
The [differences are described in detail here](https://mongodb.github.io/node-mongodb-native/3.6/reference/unified-topology/).
64+
65+
Feel free to remove the `useUnifiedTopology` and `useNewUrlParser` options at your leisure, they are no longer used by the driver.
66+
67+
**NOTE:** With the unified topology, in order to connect to replicaSet nodes that have not been initialized you must use the new `directConnection` option.
68+
69+
#### Authentication
70+
71+
Specifying username and password as options are supported in only these two formats:
72+
73+
- `new MongoClient(url, { auth: { username: '', password: '' } })`
74+
- `new MongoClient('mongodb://username:[email protected]')`
75+
76+
#### Check Server Identity Inconsistency
77+
78+
Specifying `checkServerIdentity === false` (along with enabling tls) is different from it being leaving it `undefined`.
79+
The 3.x version intercepted `checkServerIdentity: false` and turned it into a no-op function which is the required way to skip checking the server identity by nodejs.
80+
Setting this option to `false` is only for testing anyway as it disables essential verification to TLS.
81+
So it made sense for our library to directly expose the option validation from nodejs.
82+
If you need to test TLS connections without verifying server identity pass in `{ checkServerIdentity: () => {} }`.
83+
84+
#### Kerberos / GSSAPI
85+
86+
`gssapiServiceName` has been removed.
87+
Users should use authMechanismProperties.SERVICE_NAME like so:
88+
89+
- In a URI query param: `?authMechanismProperties=SERVICE_NAME:alternateServiceName`
90+
- Or as an option: `{ authMechanismProperties: { SERVICE_NAME: 'alternateServiceName' } }`
91+
92+
### db.collection no longer accepts a callback
93+
94+
The only option that required the use of the callback was strict mode and that option can still be used in `db.createCollection`.
95+
The strict option would return an error if the collection does not exist.
96+
97+
Another way to assert a collections existence is using this snippet below:
1098

1199
```javascript
12-
// Declare API version "1" for the client
13-
client = new MongoClient(uri, { serverApi: { version: '1' } });
100+
const collections = (await db.listCollections({}, { nameOnly: true })
101+
.toArray())
102+
.map(({name}) => name); // map to get string[]
103+
if (!collections.includes(myNewCollectionName)) {
104+
await db.createCollection(myNewCollectionName)
105+
}
106+
```
107+
108+
### BulkWriteError renamed to MongoBulkWriteError
109+
110+
In 3.x we exported both the names above, we now only export `MongoBulkWriteError`.
111+
Users testing for `BulkWriteError`s should be sure to import the new class name `MongoBulkWriteError`.
112+
113+
### Db no longer emits events
114+
115+
The Db instance is no longer an EventEmitter, all events your application is concerned with can be listened to directly from the `MongoClient` instance.
14116

15-
cursor = client.db('database').collection('coll').find(...);
117+
### Collection.group() removed
118+
119+
The collection `group()` helper has been deprecated in MongoDB since 3.4 and is now removed from the Driver.
120+
The same functionality can be achieved using the aggregation pipeline's `$group` operator.
121+
122+
### GridStore removed
123+
124+
The deprecated GirdStore API has been removed from the driver.
125+
For more information on GridFS [see the mongodb manual](https://docs.mongodb.com/manual/core/gridfs/).
126+
127+
Below are some snippets that represent equivalent operations:
128+
129+
#### Construction
130+
131+
```javascript
132+
// old way
133+
const gs = new GridStore(db, filename, mode[, options])
134+
// new way
135+
const bucket = new GridFSBucket(client.db('test')[, options])
16136
```
17137

18-
### Strict mode
138+
#### File seeking
19139

20-
Declaring a `strict` API version will cause the MongoDB server to reject all commands that are not part of the declared API version. This includes command options and aggregation pipeline stages. For example, the following `find` call would fail because the `tailable` option is not part of version 1:
140+
Since GridFSBucket uses NodeJS Stream API you can replicate file seek-ing by using the start and end options creating a downloadStream from your GridFSBucket
21141

22142
```javascript
23-
// Declare API version "1" for the client, with strict on
24-
client = new MongoClient(uri, { serverApi: { version: '1', strict: true } });
143+
bucket.openDownloadStreamByName(filename, { start: 23, end: 52 })
144+
```
145+
146+
#### File Upload & File Download
147+
148+
``` javascript
149+
await client.connect();
150+
const filename = 'test.txt' // whatever local file name you want
151+
const db = client.db()
152+
const bucket = new GridFSBucket(db)
153+
154+
fs.createReadStream(filename)
155+
.pipe(bucket.openUploadStream(filename))
156+
.on('error', console.error)
157+
.on('finish', () => {
158+
console.log('done writing to db!')
25159

26-
// Fails with an error
27-
cursor = client.db('database').collection('coll').find({ ... }, { tailable: true });
160+
bucket.find().toArray().then((files) => {
161+
console.log(files)
162+
163+
bucket.openDownloadStreamByName(filename)
164+
.pipe(fs.createWriteStream('downloaded_' + filename))
165+
.on('error', console.error)
166+
.on('finish', () => {
167+
console.log('done downloading!')
168+
client.close()
169+
})
170+
})
171+
})
28172
```
29173

30-
### Deprecation Errors
174+
Notably, **GridFSBucket does not need to be closed like GridStore.**
175+
176+
#### File Deletion
31177

32-
The `deprecationErrors` option can be used to enable command failures when using functionality that is deprecated from version 1. Note that at the time of this writing, no deprecations in version 1 exist.
178+
Deleting files hasn't changed much:
33179

34180
```javascript
35-
// Declare API version "1" for the client, with deprecationErrors on
36-
client = new MongoClient(uri, { serverApi: { version: '1', deprecationErrors: true } });
181+
GridStore.unlink(db, name, callback) // Old way
182+
bucket.delete(file_id) // New way!
183+
```
184+
185+
#### Finding File Metadata
37186

38-
// Note: since API version "1" is the initial version, there are no deprecated commands to provide as an example yet.
187+
File metadata that used to be accessible on the GridStore instance can be found by querying the bucket
188+
189+
```typescript
190+
const fileMetaDataList: GridFSFile[] = bucket.find({}).toArray()
39191
```
192+
193+
## Intentional Breaking Changes
194+
195+
- [`NODE-3368`](https://jira.mongodb.org/browse/NODE-3368): make name prop on error classes read-only ([#2879](https://github.com/mongodb/node-mongodb-native/pull/2879))
196+
- [`NODE-3291`](https://jira.mongodb.org/browse/NODE-3291): standardize error representation in the driver ([#2824](https://github.com/mongodb/node-mongodb-native/pull/2824))
197+
- [`NODE-3272`](https://jira.mongodb.org/browse/NODE-3272): emit correct event type when SRV Polling ([#2825](https://github.com/mongodb/node-mongodb-native/pull/2825))
198+
- [`NODE-2752`](https://jira.mongodb.org/browse/NODE-2752): remove strict/callback mode from Db.collection helper ([#2817](https://github.com/mongodb/node-mongodb-native/pull/2817))
199+
- [`NODE-1812`](https://jira.mongodb.org/browse/NODE-1812): replace returnOriginal with returnDocument option ([#2803](https://github.com/mongodb/node-mongodb-native/pull/2803))
200+
- [`NODE-3157`](https://jira.mongodb.org/browse/NODE-3157): update find and modify interfaces for 4.0 ([#2799](https://github.com/mongodb/node-mongodb-native/pull/2799))
201+
- [`NODE-2978`](https://jira.mongodb.org/browse/NODE-2978): remove deprecated bulk ops ([#2794](https://github.com/mongodb/node-mongodb-native/pull/2794))
202+
- [`NODE-2317`](https://jira.mongodb.org/browse/NODE-2317): remove deprecated items ([#2740](https://github.com/mongodb/node-mongodb-native/pull/2740)) ([listed below](#removed-deprecations))
203+
- [`NODE-2961`](https://jira.mongodb.org/browse/NODE-2961): clarify empty BulkOperation error message ([#2697](https://github.com/mongodb/node-mongodb-native/pull/2697))
204+
- [`NODE-1709`](https://jira.mongodb.org/browse/NODE-1709): stop emitting topology events from `Db` ([#2251](https://github.com/mongodb/node-mongodb-native/pull/2251))
205+
- [`NODE-2704`](https://jira.mongodb.org/browse/NODE-2704): integrate MongoOptions parser into driver ([#2680](https://github.com/mongodb/node-mongodb-native/pull/2680))
206+
- [`NODE-2757`](https://jira.mongodb.org/browse/NODE-2757): add collation to FindOperators ([#2679](https://github.com/mongodb/node-mongodb-native/pull/2679))
207+
- [`NODE-1722`](https://jira.mongodb.org/browse/NODE-1722): remove top-level write concern options ([#2642](https://github.com/mongodb/node-mongodb-native/pull/2642))
208+
- [`NODE-2602`](https://jira.mongodb.org/browse/NODE-2602): createIndexOp returns string, CreateIndexesOp returns array ([#2666](https://github.com/mongodb/node-mongodb-native/pull/2666))
209+
- [`NODE-2936`](https://jira.mongodb.org/browse/NODE-2936): conform CRUD result types to specification ([#2651](https://github.com/mongodb/node-mongodb-native/pull/2651))
210+
- [`NODE-1487`](https://jira.mongodb.org/browse/NODE-1487): remove deprecated Collection.group helper ([#2609](https://github.com/mongodb/node-mongodb-native/pull/2609))
211+
- [`NODE-2590`](https://jira.mongodb.org/browse/NODE-2590): adds async iterator for custom promises ([#2578](https://github.com/mongodb/node-mongodb-native/pull/2578))
212+
- [`NODE-2458`](https://jira.mongodb.org/browse/NODE-2458): format sort in cursor and in sort builder ([#2573](https://github.com/mongodb/node-mongodb-native/pull/2573))
213+
- [`NODE-2324`](https://jira.mongodb.org/browse/NODE-2324): remove Cursor#transformStream ([#2574](https://github.com/mongodb/node-mongodb-native/pull/2574))
214+
- [`NODE-2816`](https://jira.mongodb.org/browse/NODE-2816): remove deprecated find options ([#2571](https://github.com/mongodb/node-mongodb-native/pull/2571))
215+
- [`NODE-2820`](https://jira.mongodb.org/browse/NODE-2820): pull CursorStream out of Cursor ([#2543](https://github.com/mongodb/node-mongodb-native/pull/2543))
216+
- [`NODE-2320`](https://jira.mongodb.org/browse/NODE-2320): remove deprecated GridFS API ([#2290](https://github.com/mongodb/node-mongodb-native/pull/2290))
217+
- [`NODE-2850`](https://jira.mongodb.org/browse/NODE-2850): only store topology on MongoClient ([#2594](https://github.com/mongodb/node-mongodb-native/pull/2594))
218+
219+
## Removed deprecations
220+
221+
- `Collection.prototype.find / findOne options:`
222+
- `fields` - use `projection` instead
223+
- `Collection.prototype.save` - use `insertOne` instead
224+
- `Collection.prototype.dropAllIndexes`
225+
- `Collection.prototype.ensureIndex`
226+
- `Collection.prototype.findAndModify` - use `findOneAndUpdate`/`findOneAndReplace`
227+
- `Collection.prototype.findAndRemove` - use `findOneAndDelete` instead
228+
- `Collection.prototype.parallelCollectionScan`
229+
- `MongoError.create`
230+
- `Topology.destroy`
231+
- `Cursor.prototype.each` - `forEach`
232+
- `Db.prototype.eval`
233+
- `Db.prototype.ensureIndex`
234+
- `Db.prototype.profilingInfo`
235+
- `MongoClient.prototype.logout`
236+
- `MongoClient.prototype.addUser: Creating a user without roles`
237+
- `MongoClient.prototype.connect`
238+
- `Remove MongoClient.isConnected` - calling connect is a no-op if already connected
239+
- `Remove MongoClient.logOut`
240+
- `require('mongodb').instrument`
241+
- Use command monitoring: `client.on('commandStarted', (ev) => {})`
242+
- Top-Level export no longer a function: `typeof require('mongodb') !== 'function'`
243+
- Must construct a MongoClient and call `.connect()` on it.
244+
- No more `Symbol` export, now `BSONSymbol` which is a deprecated BSON type
245+
- No more `connect` export, use `MongoClient` construction
246+
247+
---
248+
249+
_And that's a wrap, thanks for upgrading! You've been a great audience!_

‎docs/features.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Versioned API
2+
3+
Versioned API is a new feature in MongoDB 5.0 that allows user-selectable API versions, subsets of MongoDB server semantics, to be declared on a client.
4+
During communication with a server, clients with a declared API version will force the server to behave in a manner compatible with the API version.
5+
Declaring an API version on a client can be used to ensure consistent responses from a server, providing long term API stability for an application. The declared API version is applied to all commands run through the client, including those sent through the generic RunCommand helper.
6+
Specifying versioned API options in the command document AND declaring an API version on the client is not supported and will lead to undefined behavior.
7+
8+
## Declare an API version on a client
9+
10+
```javascript
11+
// Declare API version "1" for the client
12+
client = new MongoClient(uri, { serverApi: { version: '1' } });
13+
14+
cursor = client.db('database').collection('coll').find(...);
15+
```
16+
17+
## Strict mode
18+
19+
Declaring a `strict` API version will cause the MongoDB server to reject all commands that are not part of the declared API version. This includes command options and aggregation pipeline stages. For example, the following `find` call would fail because the `tailable` option is not part of version 1:
20+
21+
```javascript
22+
// Declare API version "1" for the client, with strict on
23+
client = new MongoClient(uri, { serverApi: { version: '1', strict: true } });
24+
25+
// Fails with an error
26+
cursor = client.db('database').collection('coll').find({ ... }, { tailable: true });
27+
```
28+
29+
## Deprecation Errors
30+
31+
The `deprecationErrors` option can be used to enable command failures when using functionality that is deprecated from version 1. Note that at the time of this writing, no deprecations in version 1 exist.
32+
33+
```javascript
34+
// Declare API version "1" for the client, with deprecationErrors on
35+
client = new MongoClient(uri, { serverApi: { version: '1', deprecationErrors: true } });
36+
37+
// Note: since API version "1" is the initial version, there are no deprecated commands to provide as an example yet.
38+
```

0 commit comments

Comments
 (0)