return git info in /extended/v1/status

.github/workflows/stacks-blockchain-api.yml

@@ -114,6 +114,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Use Node.js
         uses: actions/setup-node@v2
@@ -144,6 +146,7 @@ jobs:
       - name: Setup integration environment
         run: |
           sudo ufw disable
+          npm run git-info
           npm run devenv:deploy -- -d
           npm run devenv:logs -- --no-color &> docker-compose-logs.txt &
 
@@ -166,6 +169,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Use Node.js
         uses: actions/setup-node@v2
@@ -196,6 +201,7 @@ jobs:
       - name: Setup integration environment
         run: |
           sudo ufw disable
+          npm run git-info
           npm run devenv:deploy -- -d
           npm run devenv:logs -- --no-color &> docker-compose-logs.txt &
 
@@ -218,6 +224,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Use Node.js
         uses: actions/setup-node@v2
@@ -248,6 +256,7 @@ jobs:
       - name: Setup integration environment
         run: |
           sudo ufw disable
+          npm run git-info
           npm run devenv:deploy -- -d
           npm run devenv:logs -- --no-color &> docker-compose-logs.txt &
 

.gitignore

@@ -123,3 +123,6 @@ openapitools.json
 
 .env.local
 yarn.lock
+
+# Git info output
+src/git-info.ts

docs/api/info/get-status.example.json

@@ -0,0 +1,4 @@
+{
+  "server_version": "stacks-blockchain-api v0.64.1 (master:439d4f46)",
+  "status": "ready"
+}

docs/api/info/get-status.schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "GET blockchain API status",
+  "title": "ServerStatusResponse",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "server_version",
+    "status"
+  ],
+  "properties": {
+    "server_version": {
+      "type": "string",
+      "description": "the server version that is currently running"
+    },
+    "status": {
+      "type": "string",
+      "description": "the current server status"
+    }
+  }
+}

docs/generated.d.ts

@@ -39,6 +39,7 @@ export type SchemaMergeRootStub =
   | RunFaucetResponse
   | NetworkBlockTimeResponse
   | NetworkBlockTimesResponse
+  | ServerStatusResponse
   | GetStxCirculatingSupplyPlainResponse
   | GetStxSupplyLegacyFormatResponse
   | GetStxTotalSupplyPlainResponse
@@ -1531,6 +1532,19 @@ export interface NetworkBlockTimesResponse {
     target_block_time: number;
   };
 }
+/**
+ * GET blockchain API status
+ */
+export interface ServerStatusResponse {
+  /**
+   * the server version that is currently running
+   */
+  server_version: string;
+  /**
+   * the current server status
+   */
+  status: string;
+}
 /**
  * GET request that returns network target block times
  */

docs/openapi.yaml

@@ -1399,9 +1399,10 @@ paths:
           description: Success
           content:
             application/json:
-              examples:
-                success:
-                  value: { status: 'ready' }
+              schema:
+                $ref: ./api/info/get-status.schema.json
+              example:
+                $ref: ./api/info/get-status.example.json
 
   /extended/v1/info/network_block_times:
     get:

package.json

@@ -16,7 +16,8 @@
     "test:integration:rosetta": "npm run devenv:deploy -- -d && cross-env NODE_ENV=development jest --config ./jest.config.rosetta.js --coverage --no-cache --runInBand; npm run devenv:stop",
     "test:integration:bns": "npm run devenv:deploy -- -d && cross-env NODE_ENV=development jest --config ./jest.config.bns.js --coverage --no-cache --runInBand; npm run devenv:stop",
     "test:integration:microblocks": "npm run devenv:deploy:pg -- -d && cross-env NODE_ENV=development jest --config ./jest.config.microblocks.js --coverage --no-cache --runInBand; npm run devenv:stop:pg",
-    "build": "rimraf ./lib && tsc -p tsconfig.build.json",
+    "git-info": "echo export default \"{\\\"branch\\\":\\\"$(git rev-parse --abbrev-ref HEAD)\\\",\\\"commit\\\":\\\"$(git log -1 --pretty=format:%h)\\\",\\\"tag\\\":\\\"$(git describe --tags --abbrev=0)\\\"}\" > ./src/git-info.ts",
+    "build": "npm run git-info && rimraf ./lib && tsc -p tsconfig.build.json",
     "build:tests": "tsc -p tsconfig.json",
     "build:docs": "npm i --prefix client && npm run generate:docs --prefix client && npm i --prefix docs && npm run generate:docs --prefix docs",
     "start": "node ./lib/index.js",

src/api/init.ts

@@ -40,6 +40,7 @@ import * as pathToRegex from 'path-to-regexp';
 import * as expressListEndpoints from 'express-list-endpoints';
 import { createMiddleware as createPrometheusMiddleware } from '@promster/express';
 import { createMicroblockRouter } from './routes/microblock';
+import { createStatusRouter } from './routes/status';
 
 export interface ApiServer {
   expressApp: ExpressWithAsync;
@@ -149,7 +150,7 @@ export async function startApiServer(opts: {
       router.use('/info', createInfoRouter(datastore));
       router.use('/stx_supply', createStxSupplyRouter(datastore));
       router.use('/debug', createDebugRouter(datastore));
-      router.use('/status', (req, res) => res.status(200).json({ status: 'ready' }));
+      router.use('/status', createStatusRouter(datastore));
       router.use('/faucets', createFaucetRouter(datastore));
       return router;
     })()

src/api/routes/status.ts

@@ -0,0 +1,19 @@
+import * as express from 'express';
+import { addAsync, RouterWithAsync } from '@awaitjs/express';
+import { DataStore } from 'src/datastore/common';
+import GitInfo from '../../git-info';
+import { ServerStatusResponse } from 'docs/generated';
+
+export function createStatusRouter(db: DataStore): RouterWithAsync {
+  const router = addAsync(express.Router());
+
+  router.get('/', (req, res) => {
+    const response: ServerStatusResponse = {
+      server_version: `stacks-blockchain-api ${GitInfo.tag} (${GitInfo.branch}:${GitInfo.commit})`,
+      status: 'ready',
+    };
+    res.json(response);
+  });
+
+  return router;
+}