@friggframework/core 1.0.1-v1-alpha.0 → 1.0.1-v1-alpha.2

package/encrypt/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v1.1.8 (Fri Feb 02 2024)
+
+#### 🐛 Bug Fix
+
+- Added variable BYPASS_ENCRYPTION_STAGE to encrypt module [#248](https://github.com/friggframework/frigg/pull/248) ([@leofmds](https://github.com/leofmds))
+- Added variable BYPASS_ENCRYPTION_STAGE to encrypt module ([@leofmds](https://github.com/leofmds))
+
+#### Authors: 1
+
+- Leonardo Ferreira ([@leofmds](https://github.com/leofmds))
+
+---
+
 # v1.1.7 (Tue Apr 04 2023)
 
 :tada: This release contains work from a new contributor! :tada:

package/encrypt/README.md

@@ -1,3 +1,13 @@
 # encrypt
 
 This package exports the `encrypt` mongoose plugin used in [Frigg](https://friggframework.org). You can find its documentation [on Frigg's website](https://docs.friggframework.org/packages/encrypt).
+
+## Configuration
+
+| Environment variable    | Description                                                                                                |
+|-------------------------|------------------------------------------------------------------------------------------------------------|
+| KMS_KEY_ARN             | The AWS KMS Key ARN, if using it to encryption/decryption.                                                 |
+| AES_KEY                 | AES key, used in conjunction with AES_KEY_ID. AES option is mutually exclusive with KMS_KEY_ARN.           |
+| AES_KEY_ID              | AES key ID, used in conjunction with AES_KEY.                                                              |
+| STAGE                   | The stage in which the application is running. It is usually defined in Serverless configuration, if used. |
+| BYPASS_ENCRYPTION_STAGE | Stages to bypass encryption/decryption, separated by comma.                                                |

package/encrypt/encrypt.js

@@ -14,14 +14,20 @@ const findOneEvents = [
     'findOneAndReplace',
 ];
 
+const shouldBypassEncryption = (STAGE) => {
+    if (!process.env.BYPASS_ENCRYPTION_STAGE) {
+        return false;
+    }
+
+    const bypassStages = process.env.BYPASS_ENCRYPTION_STAGE.split(',').map((stage) => stage.trim());
+    return bypassStages.indexOf(STAGE) > -1;
+};
+
 // The Mongoose plug-in function
 function Encrypt(schema, options) {
     const { STAGE, KMS_KEY_ARN, AES_KEY_ID } = process.env;
-    const isEnabledForStage =
-        ['staging', 'QA', 'prod', 'encryption-test'].indexOf(STAGE) > -1;
 
-    // No-op if not enabled
-    if (!isEnabledForStage) {
+    if (shouldBypassEncryption(STAGE)) {
         return;
     }
 

package/encrypt/encrypt.test.js

@@ -34,6 +34,7 @@ describe('Encrypt', () => {
             process.env = {
                 ...originalEnv,
                 STAGE: 'not-encryption-test',
+                BYPASS_ENCRYPTION_STAGE: 'not-encryption-test',
             };
 
             try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "1.0.1-v1-alpha.0",
+  "version": "1.0.1-v1-alpha.2",
   "dependencies": {
     "@hapi/boom": "^10.0.1",
     "aws-sdk": "^2.1200.0",
@@ -15,7 +15,7 @@
     "node-fetch": "^2.6.7"
   },
   "devDependencies": {
-    "@friggframework/devtools": "1.0.1-v1-alpha.0",
+    "@friggframework/devtools": "1.0.1-v1-alpha.2",
     "@types/lodash": "^4.14.191",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
     "chai": "^4.3.6",
@@ -47,5 +47,5 @@
   },
   "homepage": "https://github.com/friggframework/frigg#readme",
   "description": "",
-  "gitHead": "31dd6aab556a2fe9e930fa89630dee46925289af"
+  "gitHead": "be81c23e498aa754340786c3e81c23880360ec71"
 }