docs(express): split pingExpress into v1 and v2

TICKET: WCI-188

Author: rishikeshdadam136

modules/express/src/clientRoutes.ts

@@ -83,7 +83,7 @@ function handlePing(
   return req.bitgo.ping();
 }
 
-function handlePingExpress(req: ExpressApiRouteRequest<'express.pingExpress', 'get'>) {
+function handlePingExpress(req: ExpressApiRouteRequest<'express.v1.pingexpress' | 'express.pingexpress', 'get'>) {
   return {
     status: 'express server is ok!',
   };
@@ -1687,13 +1687,14 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
   // V2 routes should be added to www/config/routesV2.js
 
   // ping
-  // /api/v[12]/pingexpress is the only exception to the rule above, as it explicitly checks the health of the
-  // express server without running into rate limiting with the BitGo server.
+  // /api/v1/pingexpress and /api/v2/pingexpress are the only exceptions to the rule above, as they explicitly check
+  // the health of the express server without running into rate limiting with the BitGo server.
   const router = createExpressRouter();
   app.use(router);
 
   router.get('express.ping', [prepareBitGo(config), typedPromiseWrapper(handlePing)]);
-  router.get('express.pingExpress', [typedPromiseWrapper(handlePingExpress)]);
+  router.get('express.v1.pingexpress', [typedPromiseWrapper(handlePingExpress)]);
+  router.get('express.pingexpress', [typedPromiseWrapper(handlePingExpress)]);
 
   // auth
   router.post('express.login', [prepareBitGo(config), typedPromiseWrapper(handleLogin)]);

modules/express/src/typedRoutes/api/index.ts

@@ -3,7 +3,8 @@ import { apiSpec } from '@api-ts/io-ts-http';
 import * as express from 'express';
 
 import { GetPing } from './common/ping';
-import { GetPingExpress } from './common/pingExpress';
+import { GetV1PingExpress } from './v1/pingExpress';
+import { GetV2PingExpress } from './v2/pingExpress';
 import { PostLogin } from './common/login';
 import { PostV1Decrypt } from './v1/decrypt';
 import { PostV2Decrypt } from './v2/decrypt';
@@ -71,8 +72,11 @@ export const ExpressPingApiSpec = apiSpec({
 });
 
 export const ExpressPingExpressApiSpec = apiSpec({
-  'express.pingExpress': {
-    get: GetPingExpress,
+  'express.v1.pingexpress': {
+    get: GetV1PingExpress,
+  },
+  'express.pingexpress': {
+    get: GetV2PingExpress,
   },
 });
 

modules/express/src/typedRoutes/api/v1/pingExpress.ts

@@ -0,0 +1,22 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+/**
+ * Ping BitGo Express (v1)
+ *
+ * Ping bitgo express to ensure that it is still running. Unlike /ping, this does not try connecting to bitgo.com.
+ *
+ * @operationId express.v1.pingexpress
+ * @tag Express
+ * @private
+ */
+export const GetV1PingExpress = httpRoute({
+  path: '/api/v1/pingexpress',
+  method: 'GET',
+  request: httpRequest({}),
+  response: {
+    200: t.type({ status: t.string }),
+    404: BitgoExpressError,
+  },
+});

…rc/typedRoutes/api/common/pingExpress.ts …ss/src/typedRoutes/api/v2/pingExpress.tsmodules/express/src/typedRoutes/api/common/pingExpress.ts renamed to modules/express/src/typedRoutes/api/v2/pingExpress.ts modules/express/src/typedRoutes/api/common/pingExpress.ts renamed to modules/express/src/typedRoutes/api/v2/pingExpress.ts

@@ -3,13 +3,16 @@ import { httpRoute, httpRequest } from '@api-ts/io-ts-http';
 import { BitgoExpressError } from '../../schemas/error';
 
 /**
- * Ping Express
+ * Ping BitGo Express
  *
- * @operationId express.pingExpress
- * @tag express
+ * Ping bitgo express to ensure that it is still running. Unlike /ping, this does not try connecting to bitgo.com.
+ *
+ * @operationId express.pingexpress
+ * @tag Express
+ * @public
  */
-export const GetPingExpress = httpRoute({
-  path: '/api/v[12]/pingexpress',
+export const GetV2PingExpress = httpRoute({
+  path: '/api/v2/pingexpress',
   method: 'GET',
   request: httpRequest({}),
   response: {

modules/express/test/unit/typedRoutes/pingExpress.ts

@@ -0,0 +1,67 @@
+import * as assert from 'assert';
+import { GetV1PingExpress } from '../../../src/typedRoutes/api/v1/pingExpress';
+import { GetV2PingExpress } from '../../../src/typedRoutes/api/v2/pingExpress';
+import { assertDecode } from './common';
+import 'should';
+import 'should-http';
+import { setupAgent } from '../../lib/testutil';
+
+describe('PingExpress route tests', function () {
+  describe('PostV1PingExpress route definition', function () {
+    it('should have the correct path', function () {
+      assert.strictEqual(GetV1PingExpress.path, '/api/v1/pingexpress');
+    });
+
+    it('should have the correct HTTP method', function () {
+      assert.strictEqual(GetV1PingExpress.method, 'GET');
+    });
+
+    it('should have the correct response types', function () {
+      assert.ok(GetV1PingExpress.response[200]);
+      assert.ok(GetV1PingExpress.response[404]);
+    });
+  });
+
+  describe('PostV2PingExpress route definition', function () {
+    it('should have the correct path', function () {
+      assert.strictEqual(GetV2PingExpress.path, '/api/v2/pingexpress');
+    });
+
+    it('should have the correct HTTP method', function () {
+      assert.strictEqual(GetV2PingExpress.method, 'GET');
+    });
+
+    it('should have the correct response types', function () {
+      assert.ok(GetV2PingExpress.response[200]);
+      assert.ok(GetV2PingExpress.response[404]);
+    });
+  });
+
+  describe('Supertest Integration Tests', function () {
+    const agent = setupAgent();
+
+    const expectedStatus = 'express server is ok!';
+
+    it('should resolve GET /api/v1/pingexpress with the expected payload', async function () {
+      const result = await agent.get('/api/v1/pingexpress');
+
+      assert.strictEqual(result.status, 200);
+      result.body.should.have.property('status');
+      assert.strictEqual(result.body.status, expectedStatus);
+
+      const decodedResponse = assertDecode(GetV1PingExpress.response[200], result.body);
+      assert.strictEqual(decodedResponse.status, expectedStatus);
+    });
+
+    it('should resolve GET /api/v2/pingexpress with the expected payload', async function () {
+      const result = await agent.get('/api/v2/pingexpress');
+
+      assert.strictEqual(result.status, 200);
+      result.body.should.have.property('status');
+      assert.strictEqual(result.body.status, expectedStatus);
+
+      const decodedResponse = assertDecode(GetV2PingExpress.response[200], result.body);
+      assert.strictEqual(decodedResponse.status, expectedStatus);
+    });
+  });
+});