Merge pull request #997 from bigcapitalhq/fix/model-timestamps-missing-columns

fix(models): remove timestamps from models where tables lack createdAt/updatedAt columns

packages/server/src/models/Model.ts

@@ -1,5 +1,6 @@
-import { QueryBuilder, Model } from 'objection';
+import { QueryBuilder, Model, mixin } from 'objection';
 import { ModelHasRelationsError } from '@/common/exceptions/ModelHasRelations.exception';
+import { withDateSessionMixin } from './withDateSessionMixin';
 
 interface PaginationResult<M extends Model> {
   results: M[];
@@ -69,6 +70,7 @@ export class PaginationQueryBuilder<
     dependentRelationNames.forEach((relationName: string) => {
       recordQuery.withGraphFetched(relationName);
     });
+
     const record = await recordQuery;
 
     const hasRelations = dependentRelationNames.some((name) => {
@@ -97,7 +99,7 @@ export class BaseQueryBuilder<
   }
 }
 
-export class BaseModel extends Model {
+export class BaseModel extends mixin(Model, [withDateSessionMixin]) {
   public readonly id: number;
   public readonly tableName: string;
 

packages/server/src/models/withDateSessionMixin.ts

@@ -0,0 +1,40 @@
+import * as moment from 'moment';
+import { Model } from 'objection';
+
+type Constructor<T = {}> = new (...args: any[]) => T;
+
+export const withDateSessionMixin = <T extends Constructor<Model>>(BaseModel: T) => {
+  return class DateSession extends BaseModel {
+    constructor(...args: any[]) {
+      super(...args);
+    }
+
+    get timestamps() {
+      return [];
+    }
+    
+    $beforeUpdate(opt, context) {
+      const maybePromise = super.$beforeUpdate(opt, context);
+
+      return Promise.resolve(maybePromise).then(() => {
+        const key = this.timestamps[1];
+
+        if (key && !this[key]) {
+          this[key] = moment().format('YYYY/MM/DD HH:mm:ss');
+        }
+      });
+    }
+
+    $beforeInsert(context) {
+      const maybePromise = super.$beforeInsert(context);
+
+      return Promise.resolve(maybePromise).then(() => {
+        const key = this.timestamps[0];
+
+        if (key && !this[key]) {
+          this[key] = moment().format('YYYY/MM/DD HH:mm:ss');
+        }
+      });
+    }
+  }
+}

packages/server/src/modules/BankingTransactions/BankingTransactions.module.ts

@@ -24,6 +24,7 @@ import { GetBankAccountsService } from './queries/GetBankAccounts.service';
 import { DynamicListModule } from '../DynamicListing/DynamicList.module';
 import { BankAccount } from './models/BankAccount';
 import { LedgerModule } from '../Ledger/Ledger.module';
+import { TenancyModule } from '../Tenancy/Tenancy.module';
 import { GetBankAccountTransactionsService } from './queries/GetBankAccountTransactions/GetBankAccountTransactions.service';
 import { GetBankAccountTransactionsRepository } from './queries/GetBankAccountTransactions/GetBankAccountTransactionsRepo.service';
 import { GetUncategorizedTransactions } from './queries/GetUncategorizedTransactions';
@@ -46,6 +47,7 @@ const models = [
     LedgerModule,
     BranchesModule,
     DynamicListModule,
+    TenancyModule,
     ...models,
   ],
   controllers: [

packages/server/src/modules/BankingTransactions/queries/GetBankAccountTransactions/GetBankAccountTransactions.service.ts

@@ -4,12 +4,14 @@ import { GetBankAccountTransactionsRepository } from './GetBankAccountTransactio
 import { GetBankAccountTransactions } from './GetBankAccountTransactions';
 import { GetBankTransactionsQueryDto } from '../../dtos/GetBankTranasctionsQuery.dto';
 import { I18nService } from 'nestjs-i18n';
+import { TenancyContext } from '@/modules/Tenancy/TenancyContext.service';
 
 @Injectable()
 export class GetBankAccountTransactionsService {
   constructor(
     private readonly getBankAccountTransactionsRepository: GetBankAccountTransactionsRepository,
-    private readonly i18nService: I18nService
+    private readonly i18nService: I18nService,
+    private readonly tenancyContext: TenancyContext,
   ) {}
 
   /**
@@ -28,11 +30,16 @@ export class GetBankAccountTransactionsService {
 
     await this.getBankAccountTransactionsRepository.asyncInit();
 
+    // Retrieve the tenant metadata to get the date format.
+    const tenantMetadata = await this.tenancyContext.getTenantMetadata();
+    const dateFormat = tenantMetadata?.dateFormat;
+
     // Retrieve the computed report.
     const report = new GetBankAccountTransactions(
       this.getBankAccountTransactionsRepository,
       parsedQuery,
-      this.i18nService
+      this.i18nService,
+      dateFormat,
     );
     const transactions = report.reportData();
     const pagination = this.getBankAccountTransactionsRepository.pagination;

packages/server/src/modules/BankingTransactions/queries/GetBankAccountTransactions/GetBankAccountTransactions.ts

@@ -24,17 +24,20 @@ export class GetBankAccountTransactions extends FinancialSheet {
    * @param {IAccountTransaction[]} transactions -
    * @param {number} openingBalance -
    * @param {ICashflowAccountTransactionsQuery} query -
+   * @param {string} dateFormat - The date format from organization settings.
    */
   constructor(
     repo: GetBankAccountTransactionsRepository,
     query: ICashflowAccountTransactionsQuery,
     i18n: I18nService,
+    dateFormat?: string,
   ) {
     super();
 
     this.repo = repo;
     this.query = query;
     this.i18n = i18n;
+    this.dateFormat = dateFormat || this.dateFormat;
 
     this.runningBalance = runningBalance(this.repo.openingBalance);
   }
@@ -98,7 +101,7 @@ export class GetBankAccountTransactions extends FinancialSheet {
 
     return {
       date: transaction.date,
-      formattedDate: moment(transaction.date).format('YYYY-MM-DD'),
+      formattedDate: this.getDateFormatted(transaction.date),
 
       withdrawal: transaction.credit,
       deposit: transaction.debit,

packages/server/src/modules/BillLandedCosts/models/BillLandedCostEntry.ts

@@ -13,6 +13,13 @@ export class BillLandedCostEntry extends BaseModel {
     return 'bill_located_cost_entries';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relationship mapping.
    */

packages/server/src/modules/Branches/models/Branch.model.ts

@@ -29,7 +29,7 @@ export class Branch extends BaseModel{
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/CreditNoteRefunds/models/RefundCreditNote.ts

@@ -34,7 +34,7 @@ export class RefundCreditNote extends BaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/CreditNotes/models/CreditNote.ts

@@ -56,7 +56,7 @@ export class CreditNote extends TenantBaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/CreditNotesApplyInvoice/models/CreditNoteAppliedInvoice.ts

@@ -26,7 +26,7 @@ export class CreditNoteAppliedInvoice extends BaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/FinancialStatements/common/FinancialSheet.ts

@@ -149,6 +149,11 @@ export class FinancialSheet {
     };
   }
 
+  protected getDateFormatted(date: moment.MomentInput, format?: string) {
+    const dateFormat = format || this.dateFormat || 'YYYY MMM DD';
+    return moment(date).format(dateFormat);
+  }
+
   getPercentageBasis = (base, amount) => {
     return base ? amount / base : 0;
   };

packages/server/src/modules/FinancialStatements/modules/TransactionsByReference/TransactionsByReference.service.ts

@@ -38,7 +38,7 @@ export class TransactionsByReferenceService {
     const report = new TransactionsByReference(
       transactions,
       filter,
-      tenantMetadata.baseCurrency
+      { baseCurrency: tenantMetadata.baseCurrency, dateFormat: tenantMetadata.dateFormat }
     );
 
     return {

packages/server/src/modules/FinancialStatements/modules/TransactionsByReference/TransactionsByReferenceReport.ts

@@ -4,7 +4,7 @@ import {
 import { FinancialSheet } from '../../common/FinancialSheet';
 import { ModelObject } from 'objection';
 import { AccountTransaction } from '@/modules/Accounts/models/AccountTransaction.model';
-import { INumberFormatQuery } from '../../types/Report.types';
+import { INumberFormatQuery, IFinancialReportMeta, DEFAULT_REPORT_META } from '../../types/Report.types';
 import { TransactionsByReferenceQueryDto } from './TransactionsByReferenceQuery.dto';
 
 export class TransactionsByReference extends FinancialSheet {
@@ -17,18 +17,19 @@ export class TransactionsByReference extends FinancialSheet {
    * Constructor method.
    * @param {ModelObject<AccountTransaction>[]} transactions
    * @param {TransactionsByVendorQueryDto} query
-   * @param {string} baseCurrency
+   * @param {IFinancialReportMeta} meta
    */
   constructor(
     transactions: ModelObject<AccountTransaction>[],
     query: TransactionsByReferenceQueryDto,
-    baseCurrency: string
+    meta: IFinancialReportMeta,
   ) {
     super();
 
     this.transactions = transactions;
     this.query = query;
-    this.baseCurrency = baseCurrency;
+    this.baseCurrency = meta.baseCurrency;
+    this.dateFormat = meta.dateFormat || DEFAULT_REPORT_META.dateFormat;
     // this.numberFormat = this.query.numberFormat;
   }
 

packages/server/src/modules/InventoryAdjutments/models/InventoryAdjustment.ts

@@ -32,7 +32,7 @@ export class InventoryAdjustment extends TenantBaseModel {
    * Timestamps columns.
    */
   get timestamps(): Array<string> {
-    return ['created_at'];
+    return ['createdAt'];
   }
 
   /**

packages/server/src/modules/InventoryAdjutments/models/InventoryAdjustmentEntry.ts

@@ -20,6 +20,13 @@ export class InventoryAdjustmentEntry extends BaseModel {
     return 'inventory_adjustments_entries';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relationship mapping.
    */

packages/server/src/modules/InventoryCost/models/InventoryTransactionMeta.ts

@@ -13,6 +13,13 @@ export class InventoryTransactionMeta extends BaseModel {
     return 'inventory_transaction_meta';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relationship mapping.
    */

packages/server/src/modules/Items/models/Item.ts

@@ -44,6 +44,13 @@ export class Item extends TenantBaseModel {
     return 'items';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return ['createdAt', 'updatedAt'];
+  }
+
   /**
    * Model modifiers.
    */

packages/server/src/modules/PaymentReceived/models/PaymentReceived.ts

@@ -43,7 +43,7 @@ export class PaymentReceived extends TenantBaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/Roles/models/Role.model.ts

@@ -16,6 +16,13 @@ export class Role extends TenantBaseModel {
     return 'roles';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relationship mapping.
    */

packages/server/src/modules/Roles/models/RolePermission.model.ts

@@ -13,6 +13,13 @@ export class RolePermission extends TenantBaseModel {
     return 'role_permissions';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relationship mapping.
    */

packages/server/src/modules/SaleInvoices/models/SaleInvoice.ts

@@ -74,7 +74,7 @@ export class SaleInvoice extends TenantBaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/SaleReceipts/models/SaleReceipt.ts

@@ -72,7 +72,7 @@ export class SaleReceipt extends ExtendedModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/Settings/models/Setting.ts

@@ -10,6 +10,10 @@ export class Setting extends BaseModel {
     return 'settings';
   }
 
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Extra metadata query to query with the current authenticate user.
    * @param {Object} query

packages/server/src/modules/System/models/TenantMetadataModel.ts

@@ -50,6 +50,13 @@ export class TenantMetadata extends BaseModel {
    */
   static tableName = 'tenants_metadata';
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Virtual attributes.
    */

packages/server/src/modules/Tenancy/TenancyModels/models/TenantUser.model.ts

@@ -24,7 +24,7 @@ export class TenantUser extends TenantBaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/TransactionItemEntry/models/ItemEntry.ts

@@ -53,7 +53,7 @@ export class ItemEntry extends BaseModel {
    * @returns {string[]}
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/VendorCreditsApplyBills/models/VendorCreditAppliedBill.ts

@@ -26,7 +26,7 @@ export class VendorCreditAppliedBill extends BaseModel {
    * Timestamps columns.
    */
   public get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/VendorCreditsRefund/models/RefundVendorCredit.ts

@@ -32,7 +32,7 @@ export class RefundVendorCredit extends BaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /*

packages/server/src/modules/Views/models/ViewColumn.model.ts

@@ -8,6 +8,13 @@ export class ViewColumn extends BaseModel {
     return 'view_has_columns';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relationship mapping.
    */

packages/server/src/modules/Views/models/ViewRole.model.ts

@@ -25,6 +25,13 @@ export class ViewRole extends BaseModel {
     return 'view_roles';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relationship mapping.
    */

packages/server/src/modules/Warehouses/models/ItemWarehouseQuantity.ts

@@ -9,6 +9,13 @@ export class ItemWarehouseQuantity extends BaseModel{
     return 'items_warehouses_quantity';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Relation mappings.
    */

packages/server/src/modules/Warehouses/models/Warehouse.model.ts

@@ -24,7 +24,7 @@ export class Warehouse extends BaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/WarehousesTransfers/models/WarehouseTransfer.ts

@@ -28,7 +28,7 @@ export class WarehouseTransfer extends TenantBaseModel {
    * Timestamps columns.
    */
   get timestamps() {
-    return ['created_at', 'updated_at'];
+    return ['createdAt', 'updatedAt'];
   }
 
   /**

packages/server/src/modules/WarehousesTransfers/models/WarehouseTransferEntry.ts

@@ -19,6 +19,13 @@ export class WarehouseTransferEntry extends TenantBaseModel {
     return 'warehouses_transfers_entries';
   }
 
+  /**
+   * Timestamps columns.
+   */
+  get timestamps() {
+    return [];
+  }
+
   /**
    * Virtual attributes.
    */

packages/webapp/src/containers/CashFlow/AccountTransactions/components.tsx

@@ -2,7 +2,7 @@
 import React from 'react';
 import intl from 'react-intl-universal';
 import { Intent, Menu, MenuItem, Tag } from '@blueprintjs/core';
-import { FormatDateCell, Icon } from '@/components';
+import { Icon } from '@/components';
 import { safeCallback } from '@/utils';
 import { useAccountTransactionsContext } from './AccountTransactionsProvider';
 import FinancialLoadingBar from '@/containers/FinancialStatements/FinancialLoadingBar';
@@ -75,8 +75,7 @@ export function useAccountTransactionsColumns() {
       {
         id: 'date',
         Header: intl.get('date'),
-        accessor: 'date',
+        accessor: 'formatted_date',
-        Cell: FormatDateCell,
         width: 110,
         className: 'date',
         clickable: true,

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

@@ -82,7 +82,7 @@ function CashflowBankAccount({
   const handleEditAccount = () => {
     openDialog(DialogsName.AccountForm, {
       action: AccountDialogAction.Edit,
-      id: account.id,
+      accountId: account.id,
     });
   };
   // Handle money in menu item actions.

packages/webapp/src/containers/Drawers/AccountDrawer/utils.tsx

@@ -2,7 +2,6 @@
 import intl from 'react-intl-universal';
 import React from 'react';
 
-import { FormatDateCell } from '@/components';
 import { useAccountDrawerTableOptionsContext } from './AccountDrawerTableOptionsProvider';
 
 /**
@@ -15,8 +14,7 @@ export const useAccountReadEntriesColumns = () => {
     () => [
       {
         Header: intl.get('transaction_date'),
-        accessor: 'date',
+        accessor: 'formatted_date',
-        Cell: FormatDateCell,
         width: 110,
         textOverview: true,
       },