Skip to content

Commit 0a5a21d

Browse files
committed
Merge branch 'beta' into master
2 parents 3908d79 + 899a710 commit 0a5a21d

File tree

60 files changed

+5226
-5267
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+5226
-5267
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Top Level; Everything that is not convered by anything below
2-
* @nodkz @AJRdev @hasezoey
2+
* @nodkz @hasezoey
33

44
**/LICENSE.md @nodkz
55
website/ @hasezoey

.github/workflows/tests.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
runs-on: ubuntu-latest
1818
strategy:
1919
matrix:
20-
node-version: [12.x, 14.x, 16.x, 18.x]
20+
node-version: [14.x, 16.x, 18.x, 20.x]
2121
steps:
2222
- uses: actions/checkout@v4
2323
if: github.event.inputs.git-ref == ''
@@ -49,7 +49,7 @@ jobs:
4949
env:
5050
CI: true
5151
- name: Send codecov.io stats
52-
if: matrix.node-version == '12.x'
52+
if: matrix.node-version == '14.x'
5353
uses: codecov/codecov-action@v3
5454

5555
publish:
@@ -58,10 +58,10 @@ jobs:
5858
runs-on: ubuntu-latest
5959
steps:
6060
- uses: actions/checkout@v4
61-
- name: Use Node.js 12
61+
- name: Use Node.js 18
6262
uses: actions/setup-node@v3
6363
with:
64-
node-version: 12.x
64+
node-version: 18.x
6565
- name: Install node_modules
6666
run: yarn install
6767
- name: Build

.releaserc.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ module.exports = {
1414
{type: "perf", release: "patch"},
1515
{type: "test", release: false},
1616
{type: "chore", release: false},
17+
{type: "deps", release: "minor"},
18+
{type: "devdeps", release: false},
19+
// backwards compatability, remove after 9.0 has been published
1720
{type: "dependencies", release: "minor"},
1821
// dont trigger another release on release commit
1922
{type: "release", release: false}
@@ -37,6 +40,9 @@ module.exports = {
3740
{type: "perf", section: "Performance"},
3841
{type: "test", hidden: true},
3942
{type: "chore", hidden: true},
43+
{type: "deps", section: "Dependencies"},
44+
{type: "devdeps", section: "Dev-Dependencies"},
45+
// backwards compatability, remove after 9.0 has been published
4046
{type: "dependencies", section: "Dependencies"},
4147
{type: "revert", section: "Reverts"},
4248
{type: "release", hidden: true}
@@ -46,7 +52,7 @@ module.exports = {
4652
],
4753
[
4854
// Update versions in sub-packages dependencies
49-
"@google/semantic-release-replace-plugin",
55+
"semantic-release-replace-plugin",
5056
{
5157
"replacements": [
5258
{

CHANGELOG.md

Lines changed: 209 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ Choose any package, because they are the same. They differ only in the default c
6868

6969
### Requirements
7070

71-
- NodeJS: 12.22+
72-
- Typescript: 4.4+ (if used)
71+
- NodeJS: 14.20.1+
72+
- Typescript: 5.0+ (if used)
7373

7474
And one of those (on Linux):
7575

@@ -86,7 +86,7 @@ On Linux, you will also need `libcurl4` (or `libcurl3` on some older distro vers
8686

8787
### Configuring which mongod binary to use
8888

89-
The default behavior is that version `5.0.19` for your OS will be downloaded. By setting [Environment variables](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options) you are able to specify which version and binary will be downloaded:
89+
The default behavior is that version `6.0.9` for your OS will be downloaded. By setting [Environment variables](https://nodkz.github.io/mongodb-memory-server/docs/api/config-options) you are able to specify which version and binary will be downloaded:
9090

9191
```sh
9292
export MONGOMS_DOWNLOAD_URL=https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-4.2.8.tgz
@@ -122,13 +122,12 @@ const mongod = new MongoMemoryServer({
122122
ip?: string, // by default '127.0.0.1', for binding to all IP addresses set it to `::,0.0.0.0`,
123123
dbName?: string, // by default '' (empty string)
124124
dbPath?: string, // by default create in temp directory
125-
storageEngine?: string, // by default `ephemeralForTest`, available engines: [ 'ephemeralForTest', 'wiredTiger' ]
125+
storageEngine?: string, // by default `ephemeralForTest`(unless mongodb 7.0.0, where its `wiredTiger`), available engines: [ 'ephemeralForTest', 'wiredTiger' ]
126126
replSet?: string, // by default no replica set, replica set name
127-
auth?: boolean, // by default `mongod` is started with '--noauth', start `mongod` with '--auth'
128127
args?: string[], // by default no additional arguments, any additional command line arguments for `mongod` `mongod` (ex. ['--notablescan'])
129128
},
130129
binary?: {
131-
version?: string, // by default '5.0.19'
130+
version?: string, // by default '6.0.9'
132131
downloadDir?: string, // see the documentation on what is chosen by default https://nodkz.github.io/mongodb-memory-server/docs/api/config-options#download_dir
133132
platform?: string, // by default os.platform()
134133
arch?: string, // by default os.arch()

commitlint.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ module.exports = {
1616
'test',
1717
'chore',
1818
'revert',
19-
'dependencies',
19+
'deps',
20+
'devdeps',
2021
'release',
2122
],
2223
],

docs/api/config-options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Valid Options are `win32`, `darwin`, `linux`, ~~`sunos`~~(never actually support
4545

4646
Option `ARCH` is used to overwrite the Architecture to download for
4747

48-
Valid Options are `x64`, `arm64`, ~~`ia32`~~([will be removed in 9.0](../guides/error-warning-details.md#mms001))
48+
Valid Options are `x64`, `arm64`
4949

5050
[See here for what versions are available for what architectures](https://www.mongodb.com/download-center/community/releases/archive)
5151

@@ -171,7 +171,7 @@ Default: `true`
171171

172172
Option `MD5_CHECK` is used to enable an md5 check after download
173173

174-
Default: `false`
174+
Default: `true`
175175

176176
### ARCHIVE_NAME
177177

docs/api/interfaces/mongo-memory-instance-opts.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ This option will automatically be set with a directory generated by [`mkdtemp`](
7272
### storageEngine
7373

7474
Typings: `storageEngine?: StorageEngine`
75-
Default: `ephemeralForTest`
75+
Default: `ephemeralForTest` (unless mongodb version is `7.0.0`, where its `wiredTiger`)
7676

7777
Set which storage engine to use, uses [`StorageEngine`](#helper-type-storageengine).
7878

@@ -85,13 +85,19 @@ Only has a effect when started with [`MongoMemoryReplSet`](../classes/mongo-memo
8585

8686
## Helper Type `StorageEngine`
8787

88-
Typings: `StorageEngine = 'devnull' | 'ephemeralForTest' | 'mmapv1' | 'wiredTiger'`
88+
Typings: `StorageEngine = 'ephemeralForTest' | 'wiredTiger'`
8989

9090
Storage Engines supported by mongodb, see [MongoDB Storage Engines](https://www.mongodb.com/docs/manual/core/storage-engines/).
9191

9292
Custom Explanation:
9393

94-
- `devnull` is a storage engine which discards everything and cannot be read from.
9594
- `ephemeralForTest` is a in-memory storage engine, which stores everything in RAM, which is great to use when wanting a simple database testing backend, is not the same as the Enterprise In-Memory Engine
96-
- `mmapv1` is storage engine which stores data on disk, was removed in mongodb 4.2
9795
- `wiredTiger` is a storage engine which stores data on disk.
96+
97+
:::warning
98+
MongoDB has stated that storage-engine `ephemeralForTest` is unstable and has been deprecated, it will be removed with mongodb 7.
99+
100+
In MMS there has been no observation of `ephemeralForTest` being unstable (aside from some missing features) and will continue to be the default until mongodb-memory-server changes to a version where `ephemeralForTest` is not present anymore.
101+
102+
With mongodb-memory-server 9.0.0, if mongodb 7.0.0 or higher is used, `wiredTiger` is the default engine.
103+
:::

docs/api/interfaces/mongo-memory-server-automaticauth.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ API Documentation of `AutomaticAuth`-Interface
77

88
## Values
99

10-
### disable
10+
### enable
1111

12-
Typings: `disable?: boolean`
12+
Typings: `enable?: boolean`
1313
Default: `false`
1414

15-
Disable Authentication creation.
16-
Normally authentication is enabled when the `auth` field a object, but with this option it can be explicitly disabled.
15+
Enable or disable Authentication creation.
1716

1817
### extraUsers
1918

docs/api/interfaces/mongo-memory-server-opts.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ API Documentation of `MongoMemoryServerOpts`-Interface
99

1010
### instance
1111

12-
Typings: `instance?: MongoMemoryInstanceOpts`
12+
Typings: `instance?: MemoryServerInstanceOpts`
1313

14-
Set custom options for the instance, uses [`MongoMemoryInstanceOpts`](./mongo-memory-instance-opts.md).
14+
Set custom options based on [`MongoMemoryInstanceOpts`](./mongo-memory-instance-opts.md), but ignores some properties:
15+
16+
- `auth` is ignored because it is set via [auth](#auth) property.
1517

1618
### binary
1719

0 commit comments

Comments
 (0)