Feat: add project versioning api point

andraz maier · andraz maier · commit ef78f7694172 · 2025-01-20T14:45:03.000+01:00
diff --git a/Dockerfile b/Dockerfile
@@ -12,6 +12,11 @@ EXPOSE 3000
 
 USER node
 
+RUN git describe --tags --always > PROJECT_VERSION && \
+    date +%s > PROJECT_BUILD_DATE && \
+    git rev-parse HEAD > PROJECT_COMMIT_HASH && \
+    rm -rf .git
+
 ENV PATH="${PATH}:/app/verifier-indexer-api/docker/scripts"
 ENV NODE_ENV=production
 
diff --git a/src/controllers/health.controller.ts b/src/controllers/health.controller.ts
@@ -12,7 +12,7 @@ import {
   handleApiResponse,
 } from '../utils/api-models/ApiResponse';
 import { ApiResponseWrapperDec } from '../utils/open-api-utils';
-import { ApiDBVersion } from 'src/dtos/indexer/ApiDbVersion.dto';
+import { ApiDBVersion } from '../dtos/indexer/ApiDbVersion.dto';
 
 abstract class BaseHealthController {
   protected abstract indexerEngine: IIndexerEngineService;
diff --git a/src/dtos/indexer/ApiDbVersion.dto.ts b/src/dtos/indexer/ApiDbVersion.dto.ts
@@ -1,27 +1,27 @@
 /**
- * State table entry of the indexer database
+ * Project version entry in the database
  */
-export class ApiDBVersion {
-  /**
-   * Version of connected underlying node
-   */
-  nodeVersion: string;
-
+export class Version {
   /**
-   * Git tag of the indexer client
+   * Git tag of the project
    */
   gitTag: string;
 
   /**
-   * Git hash of the indexer client
+   * Git hash of the project
    */
   gitHash: string;
 
   /**
-   * Build date of the indexer client
+   * Build date of the project
    */
   buildDate: number;
+}
 
+/**
+ * Indexer version entry in the database
+ */
+export class IndexerVersion extends Version {
   /**
    * Number of confirmations setting for indexer client
    */
@@ -30,5 +30,25 @@ export class ApiDBVersion {
   /**
    * History drop setting for indexer client
    */
-  historySeconds;
+  historySeconds: number;
+}
+
+/**
+ * All version entries in the database
+ */
+export class ApiDBVersion {
+  /**
+   * Version of connected indexer
+   */
+  indexer: IndexerVersion;
+
+  /**
+   * Version of api server
+   */
+  apiServer: Version;
+
+  /**
+   * Version of connected underlying node
+   */
+  nodeVersion: string;
 }
diff --git a/src/entity/utxo-entity-definitions.ts b/src/entity/utxo-entity-definitions.ts
@@ -5,12 +5,6 @@ import {
   IUtxoVinTransactionPrevout,
   IUtxoVoutTransaction,
 } from '@flarenetwork/mcc';
-import { ApiDBBlock } from '../dtos/indexer/ApiDbBlock.dto';
-import { ApiDBTransaction } from '../dtos/indexer/ApiDbTransaction.dto';
-import {
-  BlockResult,
-  TransactionResult,
-} from '../indexed-query-manager/indexed-query-manager-types';
 import {
   Column,
   Entity,
@@ -19,7 +13,13 @@ import {
   OneToMany,
   PrimaryColumn,
 } from 'typeorm';
-import { ApiDBVersion } from 'src/dtos/indexer/ApiDbVersion.dto';
+import { ApiDBBlock } from '../dtos/indexer/ApiDbBlock.dto';
+import { ApiDBTransaction } from '../dtos/indexer/ApiDbTransaction.dto';
+import { ApiDBVersion, IndexerVersion } from '../dtos/indexer/ApiDbVersion.dto';
+import {
+  BlockResult,
+  TransactionResult,
+} from '../indexed-query-manager/indexed-query-manager-types';
 
 // External Postgres Database Entities (Utxo (BTC and DOGE)) (read only)
 
@@ -378,14 +378,18 @@ export class DBIndexerVersion {
   history_seconds: number;
 
   toApiDBVersion(): ApiDBVersion {
-    return {
-      nodeVersion: this.node_version,
+    const indexerVersion: IndexerVersion = {
       gitTag: this.git_tag,
       gitHash: this.git_hash,
       buildDate: this.build_date,
       numConfirmations: this.num_confirmations,
       historySeconds: this.history_seconds,
     };
+    return {
+      nodeVersion: this.node_version,
+      indexer: indexerVersion,
+      apiServer: null,
+    };
   }
 }
 
diff --git a/src/entity/xrp-entity-definitions.ts b/src/entity/xrp-entity-definitions.ts
@@ -8,7 +8,7 @@ import {
   TransactionResult,
 } from '../indexed-query-manager/indexed-query-manager-types';
 import { Column, Entity, PrimaryColumn } from 'typeorm';
-import { ApiDBVersion } from 'src/dtos/indexer/ApiDbVersion.dto';
+import { ApiDBVersion, IndexerVersion } from '../dtos/indexer/ApiDbVersion.dto';
 
 @Entity('blocks')
 export class DBXrpIndexerBlock {
@@ -170,7 +170,6 @@ export class DBXrpState {
 
 export type IDBXrpState = new () => DBXrpState;
 
-
 @Entity('versions')
 export class DBXrpIndexerVersion {
   @PrimaryColumn({ type: 'bigint' })
@@ -195,15 +194,19 @@ export class DBXrpIndexerVersion {
   history_seconds: number;
 
   toApiDBVersion(): ApiDBVersion {
-    return {
-      nodeVersion: this.node_version,
+    const indexerVersion: IndexerVersion = {
       gitTag: this.git_tag,
       gitHash: this.git_hash,
       buildDate: this.build_date,
       numConfirmations: this.num_confirmations,
       historySeconds: this.history_seconds,
-    }
+    };
+    return {
+      nodeVersion: this.node_version,
+      indexer: indexerVersion,
+      apiServer: null,
+    };
   }
 }
 
-export type IDBXrpIndexerVersion = new () => DBXrpIndexerVersion;
+export type IDBXrpIndexerVersion = new () => DBXrpIndexerVersion;
diff --git a/src/services/common/base-indexer-engine-service.ts b/src/services/common/base-indexer-engine-service.ts
@@ -1,4 +1,6 @@
-import { ApiDBVersion } from 'src/dtos/indexer/ApiDbVersion.dto';
+import { readFile } from 'fs/promises';
+import { join } from 'path';
+import { ApiDBVersion } from '../../dtos/indexer/ApiDbVersion.dto';
 import { ApiDBBlock } from '../../dtos/indexer/ApiDbBlock.dto';
 import { ApiDBState } from '../../dtos/indexer/ApiDbState.dto';
 import { ApiDBTransaction } from '../../dtos/indexer/ApiDbTransaction.dto';
@@ -10,7 +12,21 @@ import { PaginatedList } from '../../utils/api-models/PaginatedList';
 export abstract class IIndexerEngineService {
   public abstract getStateSetting(): Promise<ApiDBState | null>;
 
-  public abstract getIndexerServiceVersion(): Promise<ApiDBVersion>
+  public abstract getIndexerServiceVersion(): Promise<ApiDBVersion>;
+
+  /**
+   * Reads the version file from the file system.
+   */
+  public static async readVersionFile(filePath: string): Promise<string> {
+    return readFile(join(__dirname, filePath), 'utf-8')
+      .then((data) => data)
+      .catch((error) => {
+        if (error.code === 'ENOENT') {
+          return null;
+        }
+        throw error;
+      });
+  }
 
   /**
    * Gets the range of available confirmed blocks in the indexer database.
@@ -45,7 +61,9 @@ export abstract class IIndexerEngineService {
     blockNumber: number,
   ): Promise<ApiDBBlock | null>;
 
-  public abstract listBlock(props: QueryBlock): Promise<PaginatedList<ApiDBBlock>>;
+  public abstract listBlock(
+    props: QueryBlock,
+  ): Promise<PaginatedList<ApiDBBlock>>;
 
   public abstract getBlock(blockHash: string): Promise<ApiDBBlock>;
 
diff --git a/src/services/indexer-services/utxo-indexer.service.ts b/src/services/indexer-services/utxo-indexer.service.ts
@@ -1,31 +1,32 @@
 import { ChainType, unPrefix0x } from '@flarenetwork/mcc';
 import { Injectable } from '@nestjs/common';
+import { Version } from '../../dtos/indexer/ApiDbVersion.dto';
 
 import { EntityManager, SelectQueryBuilder } from 'typeorm';
 
 import { ApiDBBlock } from '../../dtos/indexer/ApiDbBlock.dto';
 import { ApiDBTransaction } from '../../dtos/indexer/ApiDbTransaction.dto';
 
 import { ConfigService } from '@nestjs/config';
+import { ApiDBVersion } from '../../dtos/indexer/ApiDbVersion.dto';
 import { IConfig, VerifierServerConfig } from '../../config/configuration';
 import { ApiDBState } from '../../dtos/indexer/ApiDbState.dto';
 import { QueryBlock } from '../../dtos/indexer/QueryBlock.dto';
 import { QueryTransaction } from '../../dtos/indexer/QueryTransaction.dto';
 import {
+  DBIndexerVersion,
+  DBPruneSyncState,
+  DBTipSyncState,
   DBUtxoIndexerBlock,
   DBUtxoTransaction,
-  IDBUtxoIndexerBlock,
-  IDBUtxoTransaction,
   IDBIndexerVersion,
-  DBIndexerVersion,
   IDBPruneSyncState,
   IDBTipSyncState,
-  DBPruneSyncState,
-  DBTipSyncState,
+  IDBUtxoIndexerBlock,
+  IDBUtxoTransaction,
 } from '../../entity/utxo-entity-definitions';
 import { PaginatedList } from '../../utils/api-models/PaginatedList';
 import { IIndexerEngineService } from '../common/base-indexer-engine-service';
-import { ApiDBVersion } from 'src/dtos/indexer/ApiDbVersion.dto';
 
 abstract class UtxoExternalIndexerEngineService extends IIndexerEngineService {
   // External utxo indexers specific tables
@@ -116,11 +117,33 @@ abstract class UtxoExternalIndexerEngineService extends IIndexerEngineService {
       this.versionTable,
       'version',
     );
+
     const resVersion = await queryVersion.getOne();
     if (!resVersion) {
       throw new Error('No versions state found in the indexer database');
     }
-    return resVersion.toApiDBVersion();
+
+    let versions = resVersion.toApiDBVersion();
+
+    const [gitTag, gitHash, buildDate] = await Promise.all([
+      UtxoExternalIndexerEngineService.readVersionFile(
+        '../../../PROJECT_VERSION',
+      ),
+      UtxoExternalIndexerEngineService.readVersionFile(
+        '../../../PROJECT_COMMIT_HASH',
+      ),
+      UtxoExternalIndexerEngineService.readVersionFile(
+        '../../../PROJECT_BUILD_DATE',
+      ),
+    ]);
+    const apiServerVersion: Version = {
+      gitTag: gitTag || 'local',
+      gitHash: gitHash || 'local',
+      buildDate: Number(buildDate) || Math.floor(Date.now() / 1000),
+    };
+    versions.apiServer = apiServerVersion;
+
+    return versions;
   }
 
   /**
diff --git a/src/services/indexer-services/xrp-indexer.service.ts b/src/services/indexer-services/xrp-indexer.service.ts
@@ -1,11 +1,13 @@
 import { unPrefix0x } from '@flarenetwork/mcc';
 import { Injectable } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
+import { ApiDBVersion } from '../../dtos/indexer/ApiDbVersion.dto';
 import { EntityManager } from 'typeorm';
 import { IConfig, VerifierServerConfig } from '../../config/configuration';
 import { ApiDBBlock } from '../../dtos/indexer/ApiDbBlock.dto';
 import { ApiDBState } from '../../dtos/indexer/ApiDbState.dto';
 import { ApiDBTransaction } from '../../dtos/indexer/ApiDbTransaction.dto';
+import { Version } from '../../dtos/indexer/ApiDbVersion.dto';
 import { QueryBlock } from '../../dtos/indexer/QueryBlock.dto';
 import { QueryTransaction } from '../../dtos/indexer/QueryTransaction.dto';
 import {
@@ -20,7 +22,6 @@ import {
 } from '../../entity/xrp-entity-definitions';
 import { PaginatedList } from '../../utils/api-models/PaginatedList';
 import { IIndexerEngineService } from '../common/base-indexer-engine-service';
-import { ApiDBVersion } from 'src/dtos/indexer/ApiDbVersion.dto';
 
 @Injectable()
 export class XrpExternalIndexerEngineService extends IIndexerEngineService {
@@ -72,16 +73,41 @@ export class XrpExternalIndexerEngineService extends IIndexerEngineService {
     return response;
   }
 
+  /**
+   * Gets the version of the indexer service.
+   */
   public async getIndexerServiceVersion(): Promise<ApiDBVersion> {
     const queryVersion = this.manager.createQueryBuilder(
       this.versionTable,
       'version',
     );
+
     const resVersion = await queryVersion.getOne();
     if (!resVersion) {
       throw new Error('No versions state found in the indexer database');
     }
-    return resVersion.toApiDBVersion();
+
+    let versions = resVersion.toApiDBVersion();
+
+    const [gitTag, gitHash, buildDate] = await Promise.all([
+      XrpExternalIndexerEngineService.readVersionFile(
+        '../../../PROJECT_VERSION',
+      ),
+      XrpExternalIndexerEngineService.readVersionFile(
+        '../../../PROJECT_COMMIT_HASH',
+      ),
+      XrpExternalIndexerEngineService.readVersionFile(
+        '../../../PROJECT_BUILD_DATE',
+      ),
+    ]);
+    const apiServerVersion: Version = {
+      gitTag: gitTag || 'local',
+      gitHash: gitHash || 'local',
+      buildDate: Number(buildDate) || Math.floor(Date.now() / 1000),
+    };
+    versions.apiServer = apiServerVersion;
+
+    return versions;
   }
 
   public async confirmedBlockAt(
diff --git a/src/verifier-modules/btc-verifier-server.module.ts b/src/verifier-modules/btc-verifier-server.module.ts
@@ -18,7 +18,7 @@ import { BTCConfirmedBlockHeightExistsVerifierService } from '../services/confir
 import { BtcExternalIndexerEngineService } from '../services/indexer-services/utxo-indexer.service';
 import { BTCPaymentVerifierService } from '../services/payment-verifier.service';
 import { BTCReferencedPaymentNonexistenceVerifierService } from '../services/referenced-payment-nonexistence-verifier.service';
-import { LoggerMiddleware } from 'src/middlware/LoggerMiddlwar';
+import { LoggerMiddleware } from '../middlware/LoggerMiddlwar';
 
 
 @Module({
diff --git a/src/verifier-modules/doge-verifier-server.module.ts b/src/verifier-modules/doge-verifier-server.module.ts
@@ -18,7 +18,7 @@ import { DOGEConfirmedBlockHeightExistsVerifierService } from '../services/confi
 import { DogeExternalIndexerEngineService } from '../services/indexer-services/utxo-indexer.service';
 import { DOGEPaymentVerifierService } from '../services/payment-verifier.service';
 import { DOGEReferencedPaymentNonexistenceVerifierService } from '../services/referenced-payment-nonexistence-verifier.service';
-import { LoggerMiddleware } from 'src/middlware/LoggerMiddlwar';
+import { LoggerMiddleware } from '../middlware/LoggerMiddlwar';
 
 @Module({
   imports: [
diff --git a/src/verifier-modules/xrp-verifier-server.module.ts b/src/verifier-modules/xrp-verifier-server.module.ts
@@ -18,7 +18,7 @@ import { XRPConfirmedBlockHeightExistsVerifierService } from '../services/confir
 import { XrpExternalIndexerEngineService } from '../services/indexer-services/xrp-indexer.service';
 import { XRPPaymentVerifierService } from '../services/payment-verifier.service';
 import { XRPReferencedPaymentNonexistenceVerifierService } from '../services/referenced-payment-nonexistence-verifier.service';
-import { LoggerMiddleware } from 'src/middlware/LoggerMiddlwar';
+import { LoggerMiddleware } from '../middlware/LoggerMiddlwar';
 
 @Module({
   imports: [
