Endpoint to report curator-service version #2289

globaldothealth · Feb 21, 2022 · 8837c94 · 8837c94
1 parent 31b510e
commit 8837c94
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 11 deletions.
diff --git a/verification/curator-service/api/src/index.ts b/verification/curator-service/api/src/index.ts
@@ -134,7 +134,10 @@ if (env.SERVICE_ENV == 'locale2e') {
         s3ForcePathStyle: true,
     });
 } else {
-    s3Client = new S3({ region: env.AWS_SERVICE_REGION, signatureVersion: 'v4' });
+    s3Client = new S3({
+        region: env.AWS_SERVICE_REGION,
+        signatureVersion: 'v4',
+    });
 }
 
 // Configure Email Client
@@ -183,10 +186,12 @@ const sourcesController = new SourcesController(
     awsEventsClient,
     env.DATASERVER_URL,
 );
-apiRouter.get('/sources',
+apiRouter.get(
+    '/sources',
     authenticateByAPIKey,
     mustHaveAnyRole(['curator']),
-    sourcesController.list);
+    sourcesController.list,
+);
 apiRouter.get(
     '/sources/:id([a-z0-9]{24})',
     authenticateByAPIKey,
@@ -247,10 +252,12 @@ apiRouter.put(
 
 // Configure cases controller proxying to data service.
 const casesController = new CasesController(env.DATASERVER_URL, s3Client);
-apiRouter.get('/cases',
+apiRouter.get(
+    '/cases',
     authenticateByAPIKey,
     mustBeAuthenticated,
-    casesController.list);
+    casesController.list,
+);
 apiRouter.get(
     '/cases/symptoms',
     authenticateByAPIKey,
@@ -343,7 +350,8 @@ apiRouter.get(
     '/users',
     authenticateByAPIKey,
     mustHaveAnyRole(['admin']),
-    usersController.list);
+    usersController.list,
+);
 apiRouter.put(
     '/users/:id',
     authenticateByAPIKey,
@@ -388,6 +396,11 @@ app.get('/health', (req: Request, res: Response) => {
     return res.sendStatus(503);
 });
 
+// version handler.
+app.get('/version', (req: Request, res: Response) => {
+    res.status(200).send(env.CURATOR_VERSION);
+});
+
 // API documentation.
 const swaggerDocument = YAML.load('./openapi/openapi.yaml');
 app.use(

diff --git a/verification/curator-service/api/src/util/validate-env.ts b/verification/curator-service/api/src/util/validate-env.ts
@@ -5,6 +5,7 @@ export default function validateEnv(): Readonly<{
     AWS_ACCESS_KEY_ID: string;
     AWS_SECRET_ACCESS_KEY: string;
     AWS_SERVICE_REGION: string;
+    CURATOR_VERSION: string;
     DATASERVER_URL: string;
     DB_CONNECTION_STRING: string;
     EMAIL_USER_ADDRESS: string;
@@ -20,11 +21,10 @@ export default function validateEnv(): Readonly<{
     SERVICE_ENV: string;
     SESSION_COOKIE_KEY: string;
     STATIC_DIR: string;
-}> &
-    {
-        readonly [varName: string]: string | boolean | number | undefined;
-        // eslint-disable-next-line indent
-    } {
+}> & {
+    readonly [varName: string]: string | boolean | number | undefined;
+    // eslint-disable-next-line indent
+} {
     return cleanEnv(process.env, {
         AFTER_LOGIN_REDIRECT_URL: str({
             desc: 'URL to redirect to after the oauth consent screen',
@@ -44,6 +44,10 @@ export default function validateEnv(): Readonly<{
             desc: 'AWS region in which to interact with services/resources',
             default: 'us-east-1',
         }),
+        CURATOR_VERSION: str({
+            desc: 'version string to display in UI for bug reports etc.',
+            devDefault: '(local testing)',
+        }),
         DATASERVER_URL: url({
             desc: 'URL at which to make requests to the data-service API',
             devDefault: 'http://localhost:3000',