Merge pull request #200 from opengovsg/release-v4.31.0

feat: merge release v4.31.0 into master branch

README.md

@@ -68,6 +68,10 @@ We provide a [`.template-env`](./.template-env) file with the secrets blanked ou
 paste the variables described into a self-created `.env` file, replacing the
 required values with your own.
 
+### Trouble-shooting
+
+You can consult [TROUBLESHOOTING.md](/docs/TROUBLESHOOTING.md) for common issues that developers face and how to resolve them.
+
 ## Testing
 
 The docker environment has not been configured to run tests. Thus, you will need

docs/TROUBLESHOOTING.md

@@ -0,0 +1,24 @@
+# Troubleshooting issues on local development
+
+A list of common issues that developers face and how to resolve them.
+
+## `Error: Module did not self-register.`
+
+This could happen if node modules were compiled with a different version of node, or if node modules fail to compile due to other configuration errors.
+
+### [Configuration Errors](https://stackoverflow.com/questions/21656420/failed-to-load-c-bson-extension)
+
+Some modules such as `node-gyp` require Python 2.x and if your system's Python points to 3.x, it will fail to compile bson, without warning. Fix this by setting Python 2.x to be the default on your system or ensuring that the Python global key in your npm config points to the 2.x executable on your system.
+
+### [Node Versioning Error](https://stackoverflow.com/questions/28486891/uncaught-error-module-did-not-self-register)
+
+Run the following commands to set the node version and then re-install the node modules:
+
+```
+nvm use 12.18.0
+rm -r node_modules
+npm install
+```
+
+## JavaScript out of memory error
+On your Docker application, go to Preferences > Resources and increase the amount of memory allocated for Docker.

jest-mongodb-config.js

@@ -1,12 +1,11 @@
+// This file is used to instantiate `@shelf/jest-db`'s setup.
 module.exports = {
   mongodbMemoryServerOptions: {
     binary: {
       version: process.env.MONGO_BINARY_VERSION || '3.6.12',
       checkMD5: true,
     },
-    instance: {
-      dbName: 'jest',
-    },
+    instance: {},
     autoStart: false,
   },
 }

jest.config.js

@@ -2,7 +2,6 @@ const { defaults: tsJestPreset } = require('ts-jest/presets')
 
 module.exports = {
   preset: '@shelf/jest-mongodb',
-  testEnvironment: 'node',
   testMatch: ['**/?(*.)+(spec|test).[t]s?(x)'],
   modulePaths: ['<rootDir>'],
   transform: {