kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-01-12 22:43:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: add API version in response header (#1216)

Browse Source 
* feat: added stacks version in header

* fix: resolved error on reading from git-info

* fix: refactored file reading to read only once

* fix: append cors header, read .git-info only once

Co-authored-by: Rafael Cárdenas <rafael@rafaelcr.com>
This commit is contained in:
M Hassan Tariq
2022-08-08 19:43:32 +05:00
committed by GitHub
parent 9482238599
commit 1e998db7d1
2 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/api/init.ts
View File

@@ -58,6 +58,9 @@ export interface ApiServer {
forceKill: () => Promise<void>;
}
/** API version as given by .git-info */
export const API_VERSION: { branch?: string; commit?: string; tag?: string } = {};
export async function startApiServer(opts: {
datastore: PgStore;
writeDatastore?: PgWriteStore;
@@ -70,6 +73,15 @@ export async function startApiServer(opts: {
}): Promise<ApiServer> {
const { datastore, writeDatastore, chainId, serverHost, serverPort, httpLogLevel } = opts;
try {
const [branch, commit, tag] = fs.readFileSync('.git-info', 'utf-8').split('\n');
API_VERSION.branch = branch;
API_VERSION.commit = commit;
API_VERSION.tag = tag;
} catch (error) {
logger.error(`Unable to read API version from .git-info`, error);
}
const app = express();
const apiHost = serverHost ?? process.env['STACKS_BLOCKCHAIN_API_HOST'];
const apiPort = serverPort ?? parseInt(process.env['STACKS_BLOCKCHAIN_API_PORT'] ?? '');
@@ -128,6 +140,15 @@ export async function startApiServer(opts: {
});
app.use(promMiddleware);
}
// Add API version to header
app.use((_, res, next) => {
res.setHeader(
'X-API-Version',
`${API_VERSION.tag} (${API_VERSION.branch}:${API_VERSION.commit})`
);
res.append('Access-Control-Expose-Headers', 'X-API-Version');
next();
});
// Setup request logging
app.use(
expressWinston.logger({

5
src/api/routes/status.ts
View File

@@ -4,15 +4,15 @@ import { ServerStatusResponse } from '@stacks/stacks-blockchain-api-types';
import { logger } from '../../helpers';
import { getETagCacheHandler, setETagCacheHeaders } from '../controllers/cache-controller';
import { PgStore } from '../../datastore/pg-store';
import { API_VERSION } from '../init';
export function createStatusRouter(db: PgStore): express.Router {
const router = express.Router();
const cacheHandler = getETagCacheHandler(db);
const statusHandler = async (_: Request, res: any) => {
try {
const [branch, commit, tag] = fs.readFileSync('.git-info', 'utf-8').split('\n');
const response: ServerStatusResponse = {
server_version: `stacks-blockchain-api ${tag} (${branch}:${commit})`,
server_version: `stacks-blockchain-api ${API_VERSION.tag} (${API_VERSION.branch}:${API_VERSION.commit})`,
status: 'ready',
};
const chainTip = await db.getUnanchoredChainTip();
@@ -28,7 +28,6 @@ export function createStatusRouter(db: PgStore): express.Router {
setETagCacheHeaders(res);
res.json(response);
} catch (error) {
logger.error(`Unable to read git info`, error);
const response: ServerStatusResponse = {
status: 'ready',
};