adds support for mongodb caching

Author: ccasher-seagen

plugins/backend/README.md

@@ -65,6 +65,21 @@ cloudCarbonFootprint:
     tenantId: tenant id,
 ```
 
+### Caching
+
+See [here](https://www.cloudcarbonfootprint.org/docs/data-persistence-and-caching) for more detailed documentation on data persistence and caching.
+
+To use MongoDB (recommended and supported caching mode), here is an example of the configuration:
+
+```yaml
+# app-config.local.yaml
+cloudCarbonFootprint:
+  optional:
+    cacheMode: MONGODB
+    mongoDbUri: mongodb://localhost:27017
+    mongoDbCredentials: ~/keys/mongodb-certificate.pem
+```
+
 ---
 
 © 2022 Thoughtworks, Inc.

plugins/backend/config.d.ts

@@ -217,15 +217,25 @@ export interface Config {
 
     optional?: {
       /**
-       * Set with 'GCS' to store cache file in Google Cloud Storage or leave it empty to use the default.
+       * Set with 'GCS' or 'MONGODB' to store cache file in Google Cloud Storage or Mongo Database respectively, or leave it empty to use the default.
        * @visibility backend
        */
-      cacheMode?: 'GCP';
+      cacheMode?: 'GCP' | 'MONGODB';
       /**
-       * Is the name of you Google Cloud Storage bucket where the cache file will be stored.
+       * If cacheMode is set to 'GCS', you need to provide a Google Cloud Storage bucket where the cache file will be stored.
        * @visibility backend
        */
       gcsCacheBucketName?: string;
+      /**
+       *  If cacheMode is set to 'MONGODB', you need to provide a URI to your db.
+       * @visibility backend
+       */
+      mongoDbUri?: string;
+      /**
+       * If cacheMode is set to 'MONGODB', you need to provide a file path to your credentials file.
+       * @visibility backend
+       */
+      mongoDbCredentials?: string;
       /**
        * Value to set how the cloud provider queries should return data (e.g. day/week/month/quarter/year). Default to 'day'.
        * @visibility backend

plugins/backend/src/service/convertConfig.ts

@@ -19,6 +19,7 @@ export const convertConfig = (appConfig?: BackstageConfig): CCFConfig => {
   const awsConfig = backstageConfig.getOptionalConfig('aws');
   const azureConfig = backstageConfig.getOptionalConfig('azure');
   const onPremiseConfig = backstageConfig.getOptionalConfig('onPremise');
+  const mongoDbConfig = backstageConfig.getOptionalConfig('mongoDb');
   const optionalConfig = backstageConfig.getOptionalConfig('optional');
 
   return {
@@ -163,6 +164,18 @@ export const convertConfig = (appConfig?: BackstageConfig): CCFConfig => {
                 ccfDefaults.ON_PREMISE!.DESKTOP!.AVERAGE_WATTS,
             },
           },
+    MONGODB:
+      mongoDbConfig === undefined
+          ? ccfDefaults.MONGODB
+          : {
+              ...ccfDefaults.MONGODB,
+              URI:
+                  optionalConfig?.getOptionalString('mongoDbUri') ??
+                  ccfDefaults.MONGODB?.URI,
+              CREDENTIALS:
+                  optionalConfig?.getOptionalString('mongoDbCredentials') ??
+                  ccfDefaults.MONGODB?.CREDENTIALS,
+          },
     CACHE_MODE:
       optionalConfig?.getOptionalString('cacheMode') ?? ccfDefaults.CACHE_MODE,
   };