Merge pull request #37 from BitGo/WP-00000-refactor-api-handlers-tests

mohammadalfaiyazbitgo · web-flow · commit 2b43409dfab3 · 2025-06-20T16:42:29.000-04:00
chore: reorganize the api and tests file structure
diff --git a/src/__tests__/api/enclaved/postIndependentKey.test.ts b/src/__tests__/api/enclaved/postIndependentKey.test.ts
@@ -2,12 +2,12 @@ import 'should';
 
 import * as request from 'supertest';
 import nock from 'nock';
-import { app as enclavedApp } from '../enclavedApp';
-import { AppMode, EnclavedConfig, TlsMode } from '../types';
+import { app as enclavedApp } from '../../../enclavedApp';
+import { AppMode, EnclavedConfig, TlsMode } from '../../../shared/types';
 import express from 'express';
 
 import * as sinon from 'sinon';
-import * as configModule from '../initConfig';
+import * as configModule from '../../../initConfig';
 
 describe('postIndependentKey', () => {
   let cfg: EnclavedConfig;
diff --git a/src/__tests__/api/enclaved/signMpcTransaction.test.ts b/src/__tests__/api/enclaved/signMpcTransaction.test.ts
@@ -2,11 +2,11 @@ import 'should';
 
 import * as request from 'supertest';
 import nock from 'nock';
-import { app as enclavedApp } from '../enclavedApp';
-import { AppMode, EnclavedConfig, TlsMode } from '../types';
+import { app as enclavedApp } from '../../../enclavedApp';
+import { AppMode, EnclavedConfig, TlsMode } from '../../../shared/types';
 import express from 'express';
 import * as sinon from 'sinon';
-import * as configModule from '../initConfig';
+import * as configModule from '../../../initConfig';
 import { Ed25519BIP32, Eddsa, SignatureShareType } from '@bitgo/sdk-core';
 
 describe('signMpcTransaction', () => {
diff --git a/src/__tests__/api/enclaved/signMultisigTransaction.test.ts b/src/__tests__/api/enclaved/signMultisigTransaction.test.ts
@@ -2,12 +2,12 @@ import 'should';
 
 import * as request from 'supertest';
 import nock from 'nock';
-import { app as enclavedApp } from '../enclavedApp';
-import { AppMode, EnclavedConfig, TlsMode } from '../types';
+import { app as enclavedApp } from '../../../enclavedApp';
+import { AppMode, EnclavedConfig, TlsMode } from '../../../shared/types';
 import express from 'express';
 
 import * as sinon from 'sinon';
-import * as configModule from '../initConfig';
+import * as configModule from '../../../initConfig';
 
 describe('signMultisigTransaction', () => {
   let cfg: EnclavedConfig;
diff --git a/src/__tests__/api/master/generateWallet.test.ts b/src/__tests__/api/master/generateWallet.test.ts
@@ -2,8 +2,8 @@ import 'should';
 
 import * as request from 'supertest';
 import nock from 'nock';
-import { app as expressApp } from '../../masterExpressApp';
-import { AppMode, MasterExpressConfig, TlsMode } from '../../types';
+import { app as expressApp } from '../../../masterExpressApp';
+import { AppMode, MasterExpressConfig, TlsMode } from '../../../shared/types';
 import { Environments } from '@bitgo/sdk-core';
 import assert from 'assert';
 
diff --git a/src/__tests__/api/master/sendMany.test.ts b/src/__tests__/api/master/sendMany.test.ts
@@ -3,8 +3,8 @@ import sinon from 'sinon';
 
 import * as request from 'supertest';
 import nock from 'nock';
-import { app as expressApp } from '../../masterExpressApp';
-import { AppMode, MasterExpressConfig, TlsMode } from '../../types';
+import { app as expressApp } from '../../../masterExpressApp';
+import { AppMode, MasterExpressConfig, TlsMode } from '../../../shared/types';
 import { Environments, Wallet } from '@bitgo/sdk-core';
 import { Coin } from 'bitgo';
 import assert from 'assert';
diff --git a/src/__tests__/routes.test.ts b/src/__tests__/routes.test.ts
@@ -1,8 +1,9 @@
 import 'should';
-import express from 'express';
+
 import request from 'supertest';
+import express from 'express';
+import { AppMode, TlsMode } from '../shared/types';
 import { setupRoutes } from '../routes/enclaved';
-import { AppMode, TlsMode } from '../types';
 
 describe('Routes', () => {
   let app: express.Application;
diff --git a/src/api/enclaved/handlers/postIndependentKey.ts b/src/api/enclaved/handlers/postIndependentKey.ts
@@ -1,6 +1,6 @@
 import { BitGo } from 'bitgo';
-import { KmsClient } from '../../kms/kmsClient';
-import { EnclavedApiSpecRouteRequest } from '../../enclavedBitgoExpress/routers/enclavedApiSpec';
+import { KmsClient } from '../../../kms/kmsClient';
+import { EnclavedApiSpecRouteRequest } from '../../../enclavedBitgoExpress/routers/enclavedApiSpec';
 
 export async function postIndependentKey(
   req: EnclavedApiSpecRouteRequest<'v1.key.independent', 'post'>,
diff --git a/src/api/enclaved/handlers/recoveryMultisigTransaction.ts b/src/api/enclaved/handlers/recoveryMultisigTransaction.ts
@@ -1,9 +1,9 @@
 import { SignFinalOptions } from '@bitgo/abstract-eth';
 import { MethodNotImplementedError } from 'bitgo';
-import { EnclavedApiSpecRouteRequest } from '../../enclavedBitgoExpress/routers/enclavedApiSpec';
-import logger from '../../logger';
-import { isEthLikeCoin } from '../../shared/coinUtils';
-import { retrieveKmsPrvKey } from './utils';
+import { EnclavedApiSpecRouteRequest } from '../../../enclavedBitgoExpress/routers/enclavedApiSpec';
+import logger from '../../../logger';
+import { isEthLikeCoin } from '../../../shared/coinUtils';
+import { retrieveKmsPrvKey } from '../utils';
 
 export async function recoveryMultisigTransaction(
   req: EnclavedApiSpecRouteRequest<'v1.multisig.recovery', 'post'>,
diff --git a/src/api/enclaved/handlers/signMpcTransaction.ts b/src/api/enclaved/handlers/signMpcTransaction.ts
@@ -1,6 +1,6 @@
-import { EnclavedApiSpecRouteRequest } from '../../enclavedBitgoExpress/routers/enclavedApiSpec';
-import { decryptDataKey, generateDataKey, retrieveKmsPrvKey } from './utils';
-import logger from '../../logger';
+import { EnclavedApiSpecRouteRequest } from '../../../enclavedBitgoExpress/routers/enclavedApiSpec';
+import { decryptDataKey, generateDataKey, retrieveKmsPrvKey } from '../utils';
+import logger from '../../../logger';
 import {
   TxRequest,
   EddsaUtils,
@@ -10,7 +10,7 @@ import {
   SignatureShareRecord,
   GShare,
 } from '@bitgo/sdk-core';
-import { EnclavedConfig } from '../../types';
+import { EnclavedConfig } from '../../../shared/types';
 import { BitGoBase, BaseCoin } from 'bitgo';
 
 // Define share types for different MPC algorithms
diff --git a/src/api/enclaved/handlers/signMultisigTransaction.ts b/src/api/enclaved/handlers/signMultisigTransaction.ts
@@ -1,7 +1,7 @@
-import { KmsClient } from '../../kms/kmsClient';
+import { KmsClient } from '../../../kms/kmsClient';
 import { TransactionPrebuild } from 'bitgo';
-import logger from '../../logger';
-import { EnclavedApiSpecRouteRequest } from '../../enclavedBitgoExpress/routers/enclavedApiSpec';
+import logger from '../../../logger';
+import { EnclavedApiSpecRouteRequest } from '../../../enclavedBitgoExpress/routers/enclavedApiSpec';
 
 export async function signMultisigTransaction(
   req: EnclavedApiSpecRouteRequest<'v1.multisig.sign', 'post'>,
diff --git a/src/api/enclaved/utils.ts b/src/api/enclaved/utils.ts
@@ -1,7 +1,8 @@
 // TODO: this function is duplicated in multisigTransactioSign.ts but as hardcoded. Replace that code later with this call (to avoid merge conflicts/duplication)
 import { KmsClient } from '../../kms/kmsClient';
 import { GenerateDataKeyResponse } from '../../kms/types/dataKey';
-import { EnclavedConfig } from '../../types';
+import { EnclavedConfig } from '../../shared/types';
+
 export async function retrieveKmsPrvKey({
   pub,
   source,
diff --git a/src/api/master/clients/enclavedExpressClient.ts b/src/api/master/clients/enclavedExpressClient.ts
@@ -6,10 +6,9 @@ import { SignedTransaction, TransactionPrebuild } from '@bitgo/sdk-core';
 import { superagentRequestFactory, buildApiClient, ApiClient } from '@api-ts/superagent-wrapper';
 import { OfflineVaultTxInfo, RecoveryInfo, UnsignedSweepTxMPCv2 } from '@bitgo/sdk-coin-eth';
 
-import { MasterExpressConfig } from '../types';
-import { TlsMode } from '../types';
-import { EnclavedApiSpec } from '../enclavedBitgoExpress/routers';
-import { PingResponseType, VersionResponseType } from '../types/health';
+import { MasterExpressConfig, TlsMode } from '../../../shared/types';
+import { EnclavedApiSpec } from '../../../enclavedBitgoExpress/routers';
+import { PingResponseType, VersionResponseType } from '../../../types/health';
 
 const debugLogger = debug('bitgo:express:enclavedExpressClient');
 
diff --git a/src/api/master/handlers/generateWallet.ts b/src/api/master/handlers/generateWallet.ts
@@ -9,7 +9,7 @@ import {
   AddKeychainOptions,
 } from '@bitgo/sdk-core';
 import _ from 'lodash';
-import { MasterApiSpecRouteRequest } from './routers/masterApiSpec';
+import { MasterApiSpecRouteRequest } from '../routers/masterApiSpec';
 
 /**
  * This route is used to generate a multisig wallet when enclaved express is enabled
diff --git a/src/api/master/handlers/handleSendMany.ts b/src/api/master/handlers/handleSendMany.ts
@@ -1,6 +1,6 @@
 import { RequestTracer, PrebuildTransactionOptions, Memo, KeyIndices } from '@bitgo/sdk-core';
-import logger from '../logger';
-import { MasterApiSpecRouteRequest } from './routers/masterApiSpec';
+import logger from '../../../logger';
+import { MasterApiSpecRouteRequest } from '../routers/masterApiSpec';
 
 /**
  * Defines the structure for a single recipient in a send-many transaction.
diff --git a/src/api/master/handlers/recoveryWallet.ts b/src/api/master/handlers/recoveryWallet.ts
@@ -1,6 +1,6 @@
 import { MethodNotImplementedError } from 'bitgo';
-import { isEthLikeCoin } from '../shared/coinUtils';
-import { MasterApiSpecRouteRequest } from './routers/masterApiSpec';
+import { isEthLikeCoin } from '../../../shared/coinUtils';
+import { MasterApiSpecRouteRequest } from '../routers/masterApiSpec';
 
 export async function handleRecoveryWalletOnPrem(
   req: MasterApiSpecRouteRequest<'v1.wallet.recovery', 'post'>,
diff --git a/src/api/master/middleware/middleware.ts b/src/api/master/middleware/middleware.ts
@@ -1,7 +1,7 @@
 import { Request, Response, NextFunction } from 'express';
-import { isMasterExpressConfig } from '../types';
-import { createEnclavedExpressClient } from './enclavedExpressClient';
-import { BitGoRequest } from '../types/request';
+import { isMasterExpressConfig } from '../../../shared/types';
+import { createEnclavedExpressClient } from '../clients/enclavedExpressClient';
+import { BitGoRequest } from '../../../types/request';
 
 /**
  * Middleware to validate master express configuration and enclaved express client
diff --git a/src/api/master/routers/enclavedExpressHealth.ts b/src/api/master/routers/enclavedExpressHealth.ts
@@ -2,11 +2,11 @@ import * as t from 'io-ts';
 import { apiSpec, httpRoute, httpRequest, HttpResponse } from '@api-ts/io-ts-http';
 import { createRouter, type WrappedRouter } from '@api-ts/typed-express-router';
 import { Response } from '@api-ts/response';
-import { MasterExpressConfig } from '../../initConfig';
-import logger from '../../logger';
-import { responseHandler } from '../../shared/middleware';
-import { EnclavedExpressClient } from '../enclavedExpressClient';
-import { PingResponseType, VersionResponseType } from '../../types/health';
+import { MasterExpressConfig } from '../../../shared/types';
+import logger from '../../../logger';
+import { responseHandler } from '../../../shared/middleware';
+import { EnclavedExpressClient } from '../clients/enclavedExpressClient';
+import { PingResponseType, VersionResponseType } from '../../../types/health';
 
 // Response type for /ping/enclavedExpress endpoint
 const PingEnclavedResponse: HttpResponse = {
diff --git a/src/api/master/routers/healthCheck.ts b/src/api/master/routers/healthCheck.ts
@@ -1,9 +1,9 @@
 import { apiSpec, httpRoute, httpRequest, HttpResponse } from '@api-ts/io-ts-http';
 import { createRouter, type WrappedRouter } from '@api-ts/typed-express-router';
 import { Response } from '@api-ts/response';
-import pjson from '../../../package.json';
-import { responseHandler } from '../../shared/middleware';
-import { PingResponseType, VersionResponseType } from '../../types/health';
+import pjson from '../../../../package.json';
+import { responseHandler } from '../../../shared/middleware';
+import { PingResponseType, VersionResponseType } from '../../../types/health';
 
 // API Response types
 const PingResponse: HttpResponse = {
diff --git a/src/api/master/routers/index.ts b/src/api/master/routers/index.ts
diff --git a/src/api/master/routers/masterApiSpec.ts b/src/api/master/routers/masterApiSpec.ts
@@ -13,13 +13,13 @@ import {
 } from '@api-ts/typed-express-router';
 import express from 'express';
 import * as t from 'io-ts';
-import { MasterExpressConfig } from '../../initConfig';
-import { prepareBitGo, responseHandler } from '../../shared/middleware';
-import { BitGoRequest } from '../../types/request';
-import { handleGenerateWalletOnPrem } from '../generateWallet';
-import { handleSendMany } from '../handleSendMany';
-import { validateMasterExpressConfig } from '../middleware';
-import { handleRecoveryWalletOnPrem } from '../recoveryWallet';
+import { MasterExpressConfig } from '../../../shared/types';
+import { prepareBitGo, responseHandler } from '../../../shared/middleware';
+import { BitGoRequest } from '../../../types/request';
+import { handleGenerateWalletOnPrem } from '../handlers/generateWallet';
+import { handleSendMany } from '../handlers/handleSendMany';
+import { validateMasterExpressConfig } from '../middleware/middleware';
+import { handleRecoveryWalletOnPrem } from '../handlers/recoveryWallet';
 
 // Middleware functions
 export function parseBody(req: express.Request, res: express.Response, next: express.NextFunction) {
diff --git a/src/app.ts b/src/app.ts
@@ -1,4 +1,5 @@
-import { determineAppMode, AppMode } from './initConfig';
+import { determineAppMode } from './initConfig';
+import { AppMode } from './shared/types';
 import * as enclavedApp from './enclavedApp';
 import * as masterExpressApp from './masterExpressApp';
 import logger from './logger';
diff --git a/src/enclavedApp.ts b/src/enclavedApp.ts
@@ -4,7 +4,8 @@ import http from 'http';
 import morgan from 'morgan';
 import { SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 } from 'constants';
 
-import { EnclavedConfig, initConfig, TlsMode, isEnclavedConfig } from './initConfig';
+import { EnclavedConfig, TlsMode, isEnclavedConfig } from './shared/types';
+import { initConfig } from './initConfig';
 import { setupRoutes } from './routes/enclaved';
 import {
   setupLogging,
diff --git a/src/enclavedBitgoExpress/routers/enclavedApiSpec.ts b/src/enclavedBitgoExpress/routers/enclavedApiSpec.ts
@@ -13,12 +13,12 @@ import {
 } from '@api-ts/typed-express-router';
 import express from 'express';
 import * as t from 'io-ts';
-import { postIndependentKey } from '../../api/enclaved/postIndependentKey';
-import { recoveryMultisigTransaction } from '../../api/enclaved/recoveryMultisigTransaction';
-import { signMultisigTransaction } from '../../api/enclaved/signMultisigTransaction';
-import { signMpcTransaction } from '../../api/enclaved/signMpcTransaction';
+import { postIndependentKey } from '../../api/enclaved/handlers/postIndependentKey';
+import { recoveryMultisigTransaction } from '../../api/enclaved/handlers/recoveryMultisigTransaction';
+import { signMultisigTransaction } from '../../api/enclaved/handlers/signMultisigTransaction';
+import { signMpcTransaction } from '../../api/enclaved/handlers/signMpcTransaction';
 import { prepareBitGo, responseHandler } from '../../shared/middleware';
-import { EnclavedConfig } from '../../types';
+import { EnclavedConfig } from '../../shared/types';
 import { BitGoRequest } from '../../types/request';
 
 // Request type for /key/independent endpoint
diff --git a/src/initConfig.ts b/src/initConfig.ts
@@ -6,7 +6,7 @@ import {
   TlsMode,
   AppMode,
   EnvironmentName,
-} from './types';
+} from './shared/types';
 import logger from './logger';
 import { validateTlsCertificates, validateMasterExpressConfig } from './shared/appUtils';
 
diff --git a/src/kms/kmsClient.ts b/src/kms/kmsClient.ts
@@ -1,6 +1,6 @@
 import debug from 'debug';
 import * as superagent from 'superagent';
-import { EnclavedConfig, isMasterExpressConfig } from '../initConfig';
+import { EnclavedConfig, isMasterExpressConfig } from '../shared/types';
 import { PostKeyKmsSchema, PostKeyParams, PostKeyResponse } from './types/postKey';
 import { GetKeyKmsSchema, GetKeyParams, GetKeyResponse } from './types/getKey';
 import {
diff --git a/src/masterExpressApp.ts b/src/masterExpressApp.ts
@@ -3,7 +3,8 @@ import https from 'https';
 import http from 'http';
 import { SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 } from 'constants';
 
-import { MasterExpressConfig, initConfig, isMasterExpressConfig, TlsMode } from './initConfig';
+import { MasterExpressConfig, isMasterExpressConfig, TlsMode } from './shared/types';
+import { initConfig } from './initConfig';
 import {
   setupLogging,
   setupCommonMiddleware,
diff --git a/src/routes/enclaved.ts b/src/routes/enclaved.ts
@@ -1,8 +1,8 @@
 import express from 'express';
 import debug from 'debug';
-import { createHealthCheckRouter } from '../enclavedBitgoExpress/routers/healthCheck';
+import { EnclavedConfig } from '../shared/types';
 import { createKeyGenRouter } from '../enclavedBitgoExpress/routers/enclavedApiSpec';
-import { EnclavedConfig } from '../types';
+import { createHealthCheckRouter } from '../enclavedBitgoExpress/routers/healthCheck';
 
 const debugLogger = debug('enclaved:routes');
 /**
diff --git a/src/routes/master.ts b/src/routes/master.ts
@@ -1,9 +1,9 @@
 import express from 'express';
-import { MasterExpressConfig } from '../types';
-import { createHealthCheckRouter } from '../masterBitgoExpress/routers/healthCheck';
-import { createEnclavedExpressRouter } from '../masterBitgoExpress/routers/enclavedExpressHealth';
+import { MasterExpressConfig } from '../shared/types';
+import { createHealthCheckRouter } from '../api/master/routers/healthCheck';
+import { createEnclavedExpressRouter } from '../api/master/routers/enclavedExpressHealth';
 import logger from '../logger';
-import { createMasterApiRouter } from '../masterBitgoExpress/routers/masterApiSpec';
+import { createMasterApiRouter } from '../api/master/routers/masterApiSpec';
 
 /**
  * Setup master express specific routes
diff --git a/src/shared/appUtils.ts b/src/shared/appUtils.ts
@@ -9,7 +9,7 @@ import bodyParser from 'body-parser';
 import pjson from '../../package.json';
 import logger from '../logger';
 
-import { Config, TlsMode } from '../initConfig';
+import { Config, TlsMode } from '../shared/types';
 
 /**
  * Set up the logging middleware provided by morgan
diff --git a/src/shared/bitgoUtils.ts b/src/shared/bitgoUtils.ts
diff --git a/src/shared/middleware.ts b/src/shared/middleware.ts
@@ -1,4 +1,4 @@
-import { Config, isMasterExpressConfig } from '../types';
+import { Config, isMasterExpressConfig } from '../shared/types';
 import express from 'express';
 import { BitGoRequest } from '../types/request';
 import { BitGo } from 'bitgo';
diff --git a/src/shared/responseHandler.ts b/src/shared/responseHandler.ts
@@ -1,5 +1,5 @@
 import { Request, Response as ExpressResponse, NextFunction } from 'express';
-import { Config } from '../types';
+import { Config } from '../shared/types';
 import { BitGoRequest } from '../types/request';
 import { EnclavedError } from '../errors';
 
diff --git a/src/shared/types/index.ts b/src/shared/types/index.ts
diff --git a/src/types/request.ts b/src/types/request.ts
@@ -1,7 +1,7 @@
 import express from 'express';
 import { type BitGo } from 'bitgo';
-import { Config } from '../types';
-import { EnclavedExpressClient } from '../masterBitgoExpress/enclavedExpressClient';
+import { Config } from '../shared/types';
+import { EnclavedExpressClient } from '../api/master/clients/enclavedExpressClient';
 
 // Extended request type for BitGo Express
 export interface BitGoRequest<T extends Config = Config> extends express.Request {
