feat: database backup script

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

docker-compose.prod.yml

@@ -86,6 +86,16 @@ services:
       - GOTENBERG_URL=${GOTENBERG_URL}
       - GOTENBERG_DOCS_URL=${GOTENBERG_DOCS_URL}
 
+      # Bank Sync
+      - BANKING_CONNECT=${BANKING_CONNECT}
+
+      # Plaid
+      - PLAID_ENV=${PLAID_ENV}
+      - PLAID_CLIENT_ID=${PLAID_CLIENT_ID}
+      - PLAID_SECRET_DEVELOPMENT=${PLAID_SECRET_DEVELOPMENT}
+      - PLAID_SECRET_SANDBOX=${b8cf42b441e110451e2f69ad7e1e9f}
+      - PLAID_LINK_WEBHOOK=${PLAID_LINK_WEBHOOK}
+
       # Lemon Squeez
       - LEMONSQUEEZY_API_KEY=${LEMONSQUEEZY_API_KEY}
       - LEMONSQUEEZY_STORE_ID=${LEMONSQUEEZY_STORE_ID}

packages/server/src/api/controllers/Dashboard/index.ts

@@ -8,10 +8,10 @@ export default class DashboardMetaController {
   dashboardService: DashboardService;
 
   /**
-   *
+   * Constructor router.
    * @returns
    */
-  router() {
+  public router() {
     const router = Router();
 
     router.get('/boot', this.getDashboardBoot);
@@ -25,7 +25,7 @@ export default class DashboardMetaController {
    * @param {Response} res - 
    * @param {NextFunction} next -
    */
-  getDashboardBoot = async (
+  private getDashboardBoot = async (
     req: Request,
     res: Response,
     next: NextFunction

packages/server/src/config/index.ts

@@ -180,6 +180,14 @@ module.exports = {
     },
   },
 
+  /**
+   * Bank Synchronization.
+   */
+  bankSync: {
+    enabled: parseBoolean(defaultTo(process.env.BANKING_CONNECT, false), false),
+    provider: 'plaid',
+  },
+
   /**
    * Plaid.
    */

packages/server/src/interfaces/Features.ts

@@ -1,6 +1,7 @@
 export enum Features {
   WAREHOUSES = 'warehouses',
   BRANCHES = 'branches',
+  BankSyncing = 'BankSyncing'
 }
 
 export interface IFeatureAllItem {

packages/server/src/lib/Metable/MetableStore.ts

@@ -62,13 +62,13 @@ export default class MetableStore implements IMetableStore {
    * @param {String} key -
    * @param {Mixied} defaultValue -
    */
-  get(query: string | IMetaQuery, defaultValue: any): any | false {
+  get(query: string | IMetaQuery, defaultValue: any): any | null {
     const metadata = this.find(query);
     return metadata
       ? metadata.value
       : typeof defaultValue !== 'undefined'
       ? defaultValue
-      : false;
+      : null;
   }
 
   /**

packages/server/src/services/Features/FeaturesManager.ts

@@ -1,8 +1,5 @@
-import { defaultTo } from 'lodash';
 import { Inject, Service } from 'typedi';
-import { omit } from 'lodash';
 import { FeaturesSettingsDriver } from './FeaturesSettingsDriver';
-import { FeaturesConfigureManager } from './FeaturesConfigureManager';
 import { IFeatureAllItem } from '@/interfaces';
 
 @Service()
@@ -10,9 +7,6 @@ export class FeaturesManager {
   @Inject()
   private drive: FeaturesSettingsDriver;
 
-  @Inject()
-  private configure: FeaturesConfigureManager;
-
   /**
    * Turns-on the given feature name.
    * @param   {number} tenantId
@@ -40,35 +34,15 @@ export class FeaturesManager {
    * @returns {Promise<void>}
    */
   public async accessible(tenantId: number, feature: string) {
-    // Retrieves the feature default accessible value.
-    const defaultValue = this.configure.getFeatureConfigure(
-      feature,
-      'defaultValue'
-    );
-    const isAccessible = await this.drive.accessible(tenantId, feature);
-
-    return defaultTo(isAccessible, defaultValue);
+    return this.drive.accessible(tenantId, feature);
   }
 
   /**
    * Retrieves the all features and their accessible value and default value.
    * @param   {number} tenantId
-   * @returns
+   * @returns {Promise<IFeatureAllItem[]>}
    */
   public async all(tenantId: number): Promise<IFeatureAllItem[]> {
-    const all = await this.drive.all(tenantId);
-
-    return all.map((feature: IFeatureAllItem) => {
-      const defaultAccessible = this.configure.getFeatureConfigure(
-        feature.name,
-        'defaultValue'
-      );
-      const isAccessible = feature.isAccessible;
-
-      return {
-        ...feature,
-        isAccessible: defaultTo(isAccessible, defaultAccessible),
-      };
-    });
+    return this.drive.all(tenantId);
   }
 }

packages/server/src/services/Features/FeaturesSettingsDriver.ts

@@ -2,11 +2,15 @@ import { Service, Inject } from 'typedi';
 import HasTenancyService from '@/services/Tenancy/TenancyService';
 import { FeaturesConfigure } from './constants';
 import { IFeatureAllItem } from '@/interfaces';
+import { FeaturesConfigureManager } from './FeaturesConfigureManager';
 
 @Service()
 export class FeaturesSettingsDriver {
   @Inject()
-  tenancy: HasTenancyService;
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private configure: FeaturesConfigureManager;
 
   /**
    * Turns-on the given feature name.
@@ -41,7 +45,15 @@ export class FeaturesSettingsDriver {
   async accessible(tenantId: number, feature: string) {
     const settings = this.tenancy.settings(tenantId);
 
-    return !!settings.get({ group: 'features', key: feature });
+    const defaultValue = this.configure.getFeatureConfigure(
+      feature,
+      'defaultValue'
+    );
+    const settingValue = settings.get(
+      { group: 'features', key: feature },
+      defaultValue
+    );
+    return settingValue;
   }
 
   /**

packages/server/src/services/Features/constants.ts

@@ -1,4 +1,6 @@
 import { Features, IFeatureConfiugration } from '@/interfaces';
+import config from '@/config';
+import { defaultTo } from 'lodash';
 
 export const FeaturesConfigure: IFeatureConfiugration[] = [
   {
@@ -9,4 +11,8 @@ export const FeaturesConfigure: IFeatureConfiugration[] = [
     name: Features.WAREHOUSES,
     defaultValue: false,
   },
+  {
+    name: Features.BankSyncing,
+    defaultValue: defaultTo(config.bankSync.enabled, false),
+  }
 ];

packages/server/src/services/Subscription/LemonSqueezyWebhooks.ts

@@ -70,7 +70,7 @@ export class LemonSqueezyWebhooks {
         const variantId = attributes.variant_id as string;
 
         // We assume that the Plan table is up to date.
-        const plan = await Plan.query().findOne('slug', 'essentials-yearly');
+        const plan = await Plan.query().findOne('slug', 'early-adaptor');
 
         if (!plan) {
           throw new Error(`Plan with variantId ${variantId} not found.`);

packages/webapp/src/constants/features.tsx

@@ -5,5 +5,6 @@ export const Features = {
   Warehouses: 'warehouses',
   Branches: 'branches',
   ManualJournal: 'manualJournal',
-  Projects:'Projects'
+  Projects:'Projects',
+  BankSyncing: 'BankSyncing',
 }

packages/webapp/src/containers/CashFlow/CashFlowAccounts/CashFlowAccountsActionsBar.tsx

@@ -12,6 +12,7 @@ import {
   Can,
   Icon,
   FormattedMessage as T,
+  FeatureCan,
 } from '@/components';
 import { useRefreshCashflowAccounts } from '@/hooks/query';
 import { CashflowAction, AbilitySubject } from '@/constants/abilityOption';
@@ -21,7 +22,7 @@ import withCashflowAccountsTableActions from '../AccountTransactions/withCashflo
 
 import { AccountDialogAction } from '@/containers/Dialogs/AccountDialog/utils';
 
-import { ACCOUNT_TYPE } from '@/constants';
+import { ACCOUNT_TYPE, Features } from '@/constants';
 import { DialogsName } from '@/constants/dialogs';
 
 import { compose } from '@/utils';
@@ -110,12 +111,14 @@ function CashFlowAccountsActionsBar({
       </NavbarGroup>
 
       <NavbarGroup align={Alignment.RIGHT}>
-        <Button
-          className={Classes.MINIMAL}
-          text={'Connect to Bank / Credit Card'}
-          onClick={handleConnectToBank}
-        />
+        <FeatureCan feature={Features.BankSyncing}>
+          <Button
+            className={Classes.MINIMAL}
+            text={'Connect to Bank / Credit Card'}
+            onClick={handleConnectToBank}
+          />
         <NavbarDivider />
+        </FeatureCan>
         <Button
           className={Classes.MINIMAL}
           icon={<Icon icon="refresh-16" iconSize={14} />}

scripts/backup.sh

@@ -0,0 +1,24 @@
+# Takes a backup of database Docker volume and compress into one .tar.gz
+# file and upload to s3 package through s3cmd.
+S3_BUCKET="s3://bigcapital-backup"
+
+# Generate the current date and time formatted as YYYY-MM-DD-HH-MM-SS
+CURRENT_DATETIME=$(date +"%Y-%m-%d-%H-%M-%S")
+
+# Define the filename with the current date and time
+FILE_NAME="bigcapital-mariadb-${CURRENT_DATETIME}.tar.gz"
+
+# Create a sample file (replace this with your actual file creation process)
+echo "This is a sample file created on ${CURRENT_DATETIME}" > "$FILE_NAME"
+
+docker run --rm \
+  --mount source=bigcapital_prod_mysql,target=/data/db \
+  -v $(pwd):/backup \
+  busybox \
+  tar -czvf "/backup/$FILE_NAME" /data/db
+
+# Upload the file to S3 using s3cmd
+s3cmd put "$FILE_NAME" "$S3_BUCKET/"
+
+# Remove the temporary file
+rm "$FILE_NAME"

scripts/store-backup.sh

@@ -0,0 +1,7 @@
+
+# Store the backup.
+docker run --rm \
+  --mount source=bigcapital_dev_mysql,target=/data/db \
+  -v $(pwd):/backup \
+  busybox \
+  tar -xzvf /backup/bigcapital-mariadb-2024-04-24-15-14-40.tar.gz -C /