Skip to content

Commit 29ef5bf

Browse files
committed
Fix: updating the versions doc and versions endpoints on version tables
1 parent ef78f76 commit 29ef5bf

File tree

5 files changed

+45
-55
lines changed

5 files changed

+45
-55
lines changed

src/entity/utxo-entity-definitions.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -377,19 +377,18 @@ export class DBIndexerVersion {
377377
@Column()
378378
history_seconds: number;
379379

380-
toApiDBVersion(): ApiDBVersion {
381-
const indexerVersion: IndexerVersion = {
380+
toIndexerVersion(): IndexerVersion {
381+
return {
382382
gitTag: this.git_tag,
383383
gitHash: this.git_hash,
384384
buildDate: this.build_date,
385385
numConfirmations: this.num_confirmations,
386386
historySeconds: this.history_seconds,
387387
};
388-
return {
389-
nodeVersion: this.node_version,
390-
indexer: indexerVersion,
391-
apiServer: null,
392-
};
388+
}
389+
390+
toNodeVersion(): string {
391+
return this.node_version;
393392
}
394393
}
395394

src/entity/xrp-entity-definitions.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -193,19 +193,18 @@ export class DBXrpIndexerVersion {
193193
@Column()
194194
history_seconds: number;
195195

196-
toApiDBVersion(): ApiDBVersion {
197-
const indexerVersion: IndexerVersion = {
196+
toIndexerVersion(): IndexerVersion {
197+
return {
198198
gitTag: this.git_tag,
199199
gitHash: this.git_hash,
200200
buildDate: this.build_date,
201201
numConfirmations: this.num_confirmations,
202202
historySeconds: this.history_seconds,
203203
};
204-
return {
205-
nodeVersion: this.node_version,
206-
indexer: indexerVersion,
207-
apiServer: null,
208-
};
204+
}
205+
206+
toNodeVersion(): string {
207+
return this.node_version;
209208
}
210209
}
211210

src/services/common/base-indexer-engine-service.ts

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { readFile } from 'fs/promises';
22
import { join } from 'path';
3-
import { ApiDBVersion } from '../../dtos/indexer/ApiDbVersion.dto';
3+
import { ApiDBVersion, Version } from '../../dtos/indexer/ApiDbVersion.dto';
44
import { ApiDBBlock } from '../../dtos/indexer/ApiDbBlock.dto';
55
import { ApiDBState } from '../../dtos/indexer/ApiDbState.dto';
66
import { ApiDBTransaction } from '../../dtos/indexer/ApiDbTransaction.dto';
@@ -17,7 +17,9 @@ export abstract class IIndexerEngineService {
1717
/**
1818
* Reads the version file from the file system.
1919
*/
20-
public static async readVersionFile(filePath: string): Promise<string> {
20+
public static async readVersionFile(
21+
filePath: string,
22+
): Promise<string | null> {
2123
return readFile(join(__dirname, filePath), 'utf-8')
2224
.then((data) => data)
2325
.catch((error) => {
@@ -28,6 +30,20 @@ export abstract class IIndexerEngineService {
2830
});
2931
}
3032

33+
public async getServiceVersion(): Promise<Version> {
34+
const [gitTag, gitHash, buildDate] = await Promise.all([
35+
IIndexerEngineService.readVersionFile('../../../PROJECT_VERSION'),
36+
IIndexerEngineService.readVersionFile('../../../PROJECT_COMMIT_HASH'),
37+
IIndexerEngineService.readVersionFile('../../../PROJECT_BUILD_DATE'),
38+
]);
39+
const apiServerVersion: Version = {
40+
gitTag: gitTag || 'local',
41+
gitHash: gitHash || 'local',
42+
buildDate: Number(buildDate) || Math.floor(Date.now() / 1000),
43+
};
44+
return apiServerVersion;
45+
}
46+
3147
/**
3248
* Gets the range of available confirmed blocks in the indexer database.
3349
* @returns

src/services/indexer-services/utxo-indexer.service.ts

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -123,27 +123,15 @@ abstract class UtxoExternalIndexerEngineService extends IIndexerEngineService {
123123
throw new Error('No versions state found in the indexer database');
124124
}
125125

126-
let versions = resVersion.toApiDBVersion();
126+
const nodeVersion = resVersion.toNodeVersion()
127+
const indexerVersion = resVersion.toIndexerVersion()
128+
const apiServerVersion = await this.getServiceVersion();
127129

128-
const [gitTag, gitHash, buildDate] = await Promise.all([
129-
UtxoExternalIndexerEngineService.readVersionFile(
130-
'../../../PROJECT_VERSION',
131-
),
132-
UtxoExternalIndexerEngineService.readVersionFile(
133-
'../../../PROJECT_COMMIT_HASH',
134-
),
135-
UtxoExternalIndexerEngineService.readVersionFile(
136-
'../../../PROJECT_BUILD_DATE',
137-
),
138-
]);
139-
const apiServerVersion: Version = {
140-
gitTag: gitTag || 'local',
141-
gitHash: gitHash || 'local',
142-
buildDate: Number(buildDate) || Math.floor(Date.now() / 1000),
130+
return {
131+
nodeVersion,
132+
indexer: indexerVersion,
133+
apiServer: apiServerVersion,
143134
};
144-
versions.apiServer = apiServerVersion;
145-
146-
return versions;
147135
}
148136

149137
/**

src/services/indexer-services/xrp-indexer.service.ts

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -87,27 +87,15 @@ export class XrpExternalIndexerEngineService extends IIndexerEngineService {
8787
throw new Error('No versions state found in the indexer database');
8888
}
8989

90-
let versions = resVersion.toApiDBVersion();
91-
92-
const [gitTag, gitHash, buildDate] = await Promise.all([
93-
XrpExternalIndexerEngineService.readVersionFile(
94-
'../../../PROJECT_VERSION',
95-
),
96-
XrpExternalIndexerEngineService.readVersionFile(
97-
'../../../PROJECT_COMMIT_HASH',
98-
),
99-
XrpExternalIndexerEngineService.readVersionFile(
100-
'../../../PROJECT_BUILD_DATE',
101-
),
102-
]);
103-
const apiServerVersion: Version = {
104-
gitTag: gitTag || 'local',
105-
gitHash: gitHash || 'local',
106-
buildDate: Number(buildDate) || Math.floor(Date.now() / 1000),
90+
const nodeVersion = resVersion.toNodeVersion()
91+
const indexerVersion = resVersion.toIndexerVersion()
92+
const apiServerVersion = await this.getServiceVersion();
93+
94+
return {
95+
nodeVersion,
96+
indexer: indexerVersion,
97+
apiServer: apiServerVersion,
10798
};
108-
versions.apiServer = apiServerVersion;
109-
110-
return versions;
11199
}
112100

113101
public async confirmedBlockAt(

0 commit comments

Comments
 (0)