Expose commit hash and version in the about service (#27)

* Expose commit hash and version in the about service

* Fix paths

.env.example

@@ -1,3 +1,6 @@
+# Version: Used in the /about endpoint. Useful to expose the Docker image version.
+VESION=1.0.0
+
 # Port
 PORT=8080
 

.github/workflows/docker.yml

@@ -24,6 +24,10 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: yarn install
+
+      - name: Write commit hash
+        run: echo "${{ github.sha }}" > dist/git-commit-hash.txt
+
       - run: yarn build
 
       - name: Set up Docker Buildx

apps/api/src/app/routes/about/index.ts

@@ -1,18 +1,42 @@
+import { log } from 'console';
 import { FastifyPluginAsync } from 'fastify';
-import { version } from '../../../../../../package.json';
+
+import { readFileSync } from 'fs';
+const GIT_COMMIT_HASH_FILE = 'git-commit-hash.txt';
+const VERSION = process.env.VERSION || 'UNKNOWN, please set the environment variable';
+const COMMIT_HASH = getCommitHash();
+import { join } from 'path';
+
+
 
 interface AboutResponse {
   name: string;
   version: string;
+  gitCommitHash?: string | undefined;
 }
 
 const example: FastifyPluginAsync = async (fastify): Promise<void> => {
   fastify.get<{ Reply: AboutResponse }>('/', async function (_request, reply) {
     return reply.send({
       name: 'BFF API',
-      version,
+      version: VERSION,
+      gitCommitHash: COMMIT_HASH,
     });
   });
 };
 
+/**
+ * Read a file with the git commit hash (generated for example using github actions)
+ */
+function getCommitHash(): string | undefined {
+  const filePath = join(__dirname, '../../../../../../../../', GIT_COMMIT_HASH_FILE)
+  try {    
+    return readFileSync(filePath, 'utf-8')
+  } catch (error) {
+    // Not a big deal, if the file is not present, the about won't 
+    console.warn(`Unable to read the commit hash file ${filePath}, therefore won't be exported in the about endpoint`);  
+    return undefined
+  }
+}
+
 export default example;