Merge branch 'master' into beta

Author: hasezoey

.eslintignore

@@ -1,3 +1,7 @@
-flow-typed/*
-lib/*
-.eslintrc.js
+**/flow-typed/*
+**/lib/*
+**/build/*
+#website/* #dont ignore website (like sidebars.js)
+website/build/*
+**/coverage/*
+#*.js # dont ignore top-level js files

.eslintrc.js

@@ -1,19 +1,14 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 const path = require('path');
 
 module.exports = {
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint', 'prettier'],
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
-  ],
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
   parserOptions: {
     sourceType: 'module',
     useJSXTextNode: true,
-    project: [
-      path.resolve(__dirname, 'tsconfig.test.json'),
-      path.resolve(__dirname, 'packages/mongodb-memory-server-core/tsconfig.json'),
-    ],
+    project: [path.resolve(__dirname, 'tsconfig.test.json')],
   },
   rules: {
     'no-underscore-dangle': 0,
@@ -42,37 +37,55 @@ module.exports = {
     '@typescript-eslint/explicit-function-return-type': 0,
     '@typescript-eslint/no-use-before-define': 0,
     '@typescript-eslint/no-empty-function': 0,
-    'curly': ['error', 'all'],
+    curly: ['error', 'all'],
     'padding-line-between-statements': [
-      "warn",
+      'warn',
       {
-        blankLine: 'always', prev: '*', next: 'return' // add blank line *before* all returns (if there are statements before)
+        blankLine: 'always',
+        prev: '*',
+        next: 'return', // add blank line *before* all returns (if there are statements before)
       },
       {
-        blankLine: 'always', prev: '*', next: 'if' // add blank line *before* all ifs
+        blankLine: 'always',
+        prev: '*',
+        next: 'if', // add blank line *before* all ifs
       },
       {
-        blankLine: 'always', prev: 'if', next: '*' // add blank line *after* all ifs
+        blankLine: 'always',
+        prev: 'if',
+        next: '*', // add blank line *after* all ifs
       },
       {
-        blankLine: 'any', prev: 'if', next: 'if' // allow blank line between ifs, but not enforce either
+        blankLine: 'any',
+        prev: 'if',
+        next: 'if', // allow blank line between ifs, but not enforce either
       },
       {
-        blankLine: 'always', prev: '*', next: ['function', 'class'] // add blank line *before* all functions and classes
+        blankLine: 'always',
+        prev: '*',
+        next: ['function', 'class'], // add blank line *before* all functions and classes
       },
       {
-        blankLine: 'always', prev: ['function', 'class'], next: '*' // add blank line *after* all functions and classes
+        blankLine: 'always',
+        prev: ['function', 'class'],
+        next: '*', // add blank line *after* all functions and classes
       },
       {
-        blankLine: 'always', prev: '*', next: 'import' // add blank line *before* all imports
+        blankLine: 'always',
+        prev: '*',
+        next: 'import', // add blank line *before* all imports
       },
       {
-        blankLine: 'always', prev: 'import', next: '*' // add blank line *after* all imports
+        blankLine: 'always',
+        prev: 'import',
+        next: '*', // add blank line *after* all imports
       },
       {
-        blankLine: 'never', prev: 'import', next: 'import' // dont allow blank line between imports
+        blankLine: 'never',
+        prev: 'import',
+        next: 'import', // dont allow blank line between imports
       },
-    ]
+    ],
   },
   env: {
     node: true,

.github/ISSUE_TEMPLATE/distribution-support.md

@@ -14,8 +14,13 @@ List of currently [Supported Systems](https://nodkz.github.io/mongodb-memory-ser
 
 ## Versions
 
-- Wanted System: `Linux Mint 20.1`
-- Architecture: `x86_64`
+<!--
+"Wanted System" formatting like: "Windows 10 1804" / "Ubuntu 20.04" / "MacOS 10"
+Possible "Architecture": "x86_64" / "aarch64" / "arm64"
+-->
+
+- Wanted System: `Distro / System here`
+- Architecture: `arch here`
 
 ## Detection
 

.github/workflows/tests.yml

@@ -37,7 +37,7 @@ jobs:
       - name: TSCheck
         run: yarn --cwd packages/mongodb-memory-server-core run tscheck
       - name: ESLint
-        run: yarn --cwd packages/mongodb-memory-server-core run eslint
+        run: yarn run lint
       - name: Tests
         run: yarn --cwd packages/mongodb-memory-server-core run coverage --colors
         env:

CHANGELOG.md

@@ -67,6 +67,40 @@
 * **tslib:** upgrade to version 2.3.1 ([1a36352](https://github.com/nodkz/mongodb-memory-server/commit/1a36352fcaaa6c45796cb1d1c2a0e4b509acbfdd))
 * **typescript:** upgrade to version 4.4.3 ([84e407b](https://github.com/nodkz/mongodb-memory-server/commit/84e407b6b14ae986ab9d4ac6a1d5caa3f694861b))
 
+### [7.4.5](https://github.com/nodkz/mongodb-memory-server/compare/v7.4.4...v7.4.5) (2021-10-19)
+
+
+### Fixes
+
+* add "@types/mongodb" to dependencies, because of exposing a mongodb type ([6346922](https://github.com/nodkz/mongodb-memory-server/commit/634692225201ed38e4fa306e40497a434ad6a4be)), closes [#558](https://github.com/nodkz/mongodb-memory-server/issues/558)
+
+### [7.4.4](https://github.com/nodkz/mongodb-memory-server/compare/v7.4.3...v7.4.4) (2021-10-14)
+
+
+### Fixes
+
+* **MongoMemoryServer:** change that "instance.auth" is not required to be set for enabling auth ([4e4a41d](https://github.com/nodkz/mongodb-memory-server/commit/4e4a41d8d9975f8739ac0e92cdce040917e4d9cd))
+* **MongoMemoryServer:** change to log value "createAuth" ([9c3fea0](https://github.com/nodkz/mongodb-memory-server/commit/9c3fea0f08e875382c0c1e9dfd62a315aee8a2e1))
+
+
+### Style
+
+* **MongoInstance:** add more tsdoc ([36c1971](https://github.com/nodkz/mongodb-memory-server/commit/36c19715e7820a902f6533899b4a9ecd3cb91348))
+
+### [7.4.3](https://github.com/nodkz/mongodb-memory-server/compare/v7.4.2...v7.4.3) (2021-10-05)
+
+
+### Fixes
+
+* **resolveConfig::findPackageJson:** actually apply processing to path options ([25c4119](https://github.com/nodkz/mongodb-memory-server/commit/25c41195a245a0c22bba65c91b798cb088c5e885)), closes [#548](https://github.com/nodkz/mongodb-memory-server/issues/548)
+
+### [7.4.2](https://github.com/nodkz/mongodb-memory-server/compare/v7.4.1...v7.4.2) (2021-09-29)
+
+
+### Fixes
+
+* **resolveConfig:** fix debug enable ([aff6838](https://github.com/nodkz/mongodb-memory-server/commit/aff68382cb681b55516c053e9d4864d0b590ab25))
+
 ### [7.4.1](https://github.com/nodkz/mongodb-memory-server/compare/v7.4.0...v7.4.1) (2021-09-20)
 
 

commitlint.config.js

@@ -1,11 +1,25 @@
 module.exports = {
-  "extends": [
-    "@commitlint/config-conventional"
-  ],
-  "rules": {
-    "scope-case": [0, "never"],
-    "body-min-length": [2, "always", 3],
-    "type-enum": [2, "always", ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'revert', 'dependencies', 'release']],
-    "subject-case": [0, "never"]
-  }
-}
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'scope-case': [0, 'never'],
+    'body-min-length': [2, 'always', 3],
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',
+        'fix',
+        'docs',
+        'style',
+        'refactor',
+        'perf',
+        'test',
+        'chore',
+        'revert',
+        'dependencies',
+        'release',
+      ],
+    ],
+    'subject-case': [0, 'never'],
+  },
+};

docs/guides/enable-debug-mode.md

@@ -25,3 +25,16 @@ MONGOMS_DEBUG=1 npm run command
   }
 }
 ```
+
+## Extra Notes
+
+### npm quirks
+
+Starting with NPM 7, scripts (like `postinstall`) will run in parallel and will not output any logging, but sometimes in `mongodb-memory-server` it is required to provide the Debug Log from a `postinstall` script.
+
+Temporarly this can be change to use:
+
+```sh
+# Change scripts to be executed on the NPM main proccess instead of workers AND log script output
+MONGOMS_DEBUG=1 npm install --foreground-scripts
+```

docs/guides/integration-examples/docker.md

@@ -0,0 +1,97 @@
+---
+id: docker
+title: 'Integration with Docker'
+---
+
+This Guide will show how `mongodb-memory-server` can be used with Docker & dockefiles.
+
+## Important Notes before Starting
+
+:::caution
+It is common that images like `node:16-alpine` are used, which will not work with this package, because mongodb does not provide binaries for Alpine yet.
+It is recommended to switch to images like `node:16` (or `node:16-buster`) for Debian builds.
+
+See [No Build available for Alpine Linux](../known-issues.md#no-build-available-for-alpine-linux).
+:::
+
+:::caution
+Docker Debian builds (at least with `debian:11`), extra packages have to be installed:
+
+```sh
+apt-get install libcurl4 # for Debian 10+ to fix CURL_OPENSSL_4
+# OR
+apt-get install libcurl3 # for Debian 9 (and before) to fix CURL_OPENSSL_3
+```
+
+:::
+
+## Writing a dockerfile with mongodb binary caching
+
+Sometimes you want to have the tests isolated from the host system and also have caching working for mongodb-memory-server.
+
+### `.dockerignore`
+
+If no `.dockerignore` is specified or the following instructions added to the `dockerfile`, some cases may happen:
+
+- Best case is just added bloat if the host system is not debian (like having the host's mongodb binary copied into the image)
+- If the host system is Debian (and to that not matching version), then the host's mongodb binary is copied in and will be used instead of downloading the actual required mongodb binary
+
+It is not required to have, but preferred over having a additional step in the dockerfile:
+
+```dockerignore
+# ignore all node_modules, no matter where, like when having a monorepo
+**/node_modules
+```
+
+If a dockerignore is not specified, a additional instruction can be used instead:
+
+```dockerfile
+# ...
+COPY node:node . /project
+
+# Put this Instruction between the 2 other instructions mentioned in this example
+# The following deleted all directories it finds that are a directory AND have a name matching "node_modules" (also removes nested directories)
+RUN find . -type d -iname "node_modules" -exec rm -rf {} \;
+
+RUN npm install
+# ...
+```
+
+### `dockefile`
+
+The following is the recommended way to make a image with mongodb-memory-server
+
+:::note
+The following `dockerfile` has examples for 2 package managers: `npm` and `yarn`, be sure to remove the one that will not be used.
+:::
+
+```dockerfile
+# Using a Debian build
+FROM node:16
+
+# Installing "libcurl4" because some Debian images may not come with this package installed, but is required by the mongodb binaries
+RUN apt-get install libcurl4
+
+# Settings the CWD (Current Work Directory) to "/project" to have a isolated folder for the project
+# Note: it is not recommended to set it to "/home/dockeruser", but to use "/home/dockeruser/project"
+WORKDIR /project
+
+# Copy the project (all files) into the image into "/project" as user "node:node"
+# User "node:node" is the default nodejs user in the docker images
+COPY node:node . /project
+
+# Explicitly set the user that will be used for the next Instructions and ENTRYPOINT
+USER node
+
+# Install all required dependencies locked to the package-lock (or yarn.lock)
+# Replace "npm install" with your package manager command of choice
+RUN npm install --ci
+# OR
+RUN yarn install --frozen-lockfile
+
+# Set the default command that will be used when running the image
+# Replace this with your command / package manager command of choice
+ENTRYPOINT ["npm", "run", "test"]
+# OR
+ENTRYPOINT ["yarn", "run", "test"]
+```

docs/guides/integration-examples.md renamed to docs/guides/integration-examples/test-runners.md

@@ -1,6 +1,6 @@
 ---
-id: integration-examples
-title: 'Integration Examples'
+id: test-runners
+title: 'Integration with Test Runners'
 ---
 
 This Guide will show how `mongodb-memory-server` can be used with different frameworks

docs/guides/migrate7.md

@@ -24,11 +24,11 @@ Example:
 ```ts
 // this no longer works
 const mongo = new MongoMemoryServer();
-const uri = await getUri(); // ERROR: instance not started
+const uri = await mongo.getUri(); // ERROR: instance not started
 
 // it is now
 const mongo = await MongoMemoryServer.create();
-const uri = getUri();
+const uri = mongo.getUri();
 ```
 
 ### getUri is no longer async