PIMS-531: Absolute Imports for Express API starting the absolute paths

express-api/Dockerfile

@@ -13,8 +13,8 @@ ENV CONTAINERIZED=true
 # Copy files, excluding those in .dockerignore
 COPY . .
 
-# Install TypeScript. Needed for build process.
-RUN npm i -D typescript
+# Install packages. Needed for build process.
+RUN npm i
 
 # Generate swagger-output
 RUN npm run swagger
@@ -34,6 +34,7 @@ ENV NODE_ENV=production
 ENV CONTAINERIZED=true
 
 # Install packages. Needed even for compiled build.
+# Only installs non-dev dependencies
 COPY package.json .
 RUN npm i
 
@@ -44,5 +45,5 @@ RUN apt-get install -y curl
 # Copy compiled build from base
 COPY --from=base /express-api/dist .
 
-CMD [ "node", "server.js" ]
+CMD [ "node", "src/server.js" ]
 

express-api/jest.config.ts

@@ -1,4 +1,6 @@
 import type { JestConfigWithTsJest } from 'ts-jest';
+import { pathsToModuleNameMapper } from 'ts-jest';
+import { compilerOptions } from './tsconfig.json';
 
 const jestConfig: JestConfigWithTsJest = {
   testEnvironment: 'node',
@@ -13,11 +15,11 @@ const jestConfig: JestConfigWithTsJest = {
   },
   collectCoverage: true,
   collectCoverageFrom: [
-    'controllers/**/*.ts',
-    'middleware/**/*.ts',
-    'utilities/**/*.ts',
-    'routes/**/*.ts',
-    'express.ts',
+    'src/controllers/**/*.ts',
+    'src/middleware/**/*.ts',
+    'src/utilities/**/*.ts',
+    'src/routes/**/*.ts',
+    'src/express.ts',
   ],
   coveragePathIgnorePatterns: ['index.ts'],
   coverageReporters: [['lcov', { projectRoot: '..' }]],
@@ -28,11 +30,14 @@ const jestConfig: JestConfigWithTsJest = {
       lines: 80,
       statements: 80,
     },
-    'express.ts': {
+    'src/express.ts': {
       branches: 0, // Because rate limiter is omitted when testing
     },
   },
   randomize: true, // Randomizes order of tests
+  roots: ['.'],
+  modulePaths: [compilerOptions.baseUrl], // <-- This will be set to 'baseUrl' value
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths),
 };
 
 export default jestConfig;

express-api/package.json

@@ -4,8 +4,8 @@
   "description": "",
   "main": "server.ts",
   "scripts": {
-    "dev": "nodemon --exec ts-node -r dotenv/config server.ts dotenv_config_path=../.env",
-    "build": "tsc",
+    "dev": "nodemon --exec ts-node -r tsconfig-paths/register -r dotenv/config ./src/server.ts dotenv_config_path=../.env",
+    "build": "tsc && tsc-alias",
     "lint": "eslint './' --ext .ts,.js",
     "lint:fix": "npm run lint -- --fix",
     "format": "prettier --write \"./**/*.{js,ts,json}\"",
@@ -14,7 +14,7 @@
     "coverage": "jest --coverage",
     "test:unit": "jest --testPathPattern=/tests/unit",
     "test:integration": "jest --testPathPattern=/tests/integration",
-    "swagger": "node ./swagger/swagger.mjs"
+    "swagger": "node ./src/swagger/swagger.mjs"
   },
   "author": "",
   "license": "ISC",
@@ -58,6 +58,8 @@
     "swagger-autogen": "2.23.7",
     "ts-jest": "29.1.1",
     "ts-node": "10.9.1",
+    "tsc-alias": "1.8.8",
+    "tsconfig-paths": "4.2.0",
     "typescript": "5.2.2"
   }
 }

express-api/appDataSource.ts → express-api/src/appDataSource.ts

@@ -1,5 +1,5 @@
 import { DataSource } from 'typeorm';
-import { CustomWinstonLogger } from './typeorm/utilities/CustomWinstonLogger';
+import { CustomWinstonLogger } from '@/typeorm/utilities/CustomWinstonLogger';
 
 const {
   POSTGRES_USER,

express-api/src/constants/index.ts

@@ -0,0 +1,8 @@
+import networking from '@/constants/networking';
+import switches from '@/constants/switches';
+
+const constants = {
+  ...networking,
+  ...switches,
+};
+export default constants;

express-api/src/controllers/index.ts

@@ -0,0 +1,9 @@
+import { healthCheck } from '@/controllers/healthController';
+import * as ltsa from '@/controllers/ltsa/ltsaController';
+import * as parcels from '@/controllers/parcels/parcelsController';
+
+export default {
+  healthCheck,
+  ...ltsa,
+  ...parcels,
+};

express-api/controllers/ltsa/ltsaController.ts → express-api/src/controllers/ltsa/ltsaController.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from 'express';
-import { stubResponse } from '../../utilities/stubResponse';
+import { stubResponse } from '@/utilities/stubResponse';
 
 /**
  * @description Used to retrieve property information from LTSA.

express-api/controllers/parcels/parcelsController.ts → express-api/src/controllers/parcels/parcelsController.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from 'express';
-import { stubResponse } from '../../utilities/stubResponse';
+import { stubResponse } from '@/utilities/stubResponse';
 
 /**
  * @description Gets information about a particular parcel by the Id provided in the URL parameter.

express-api/express.ts → express-api/src/express.ts

@@ -5,12 +5,12 @@ import compression from 'compression';
 import cors from 'cors';
 import rateLimit from 'express-rate-limit';
 import { keycloak, protectedRoute } from '@bcgov/citz-imb-kc-express';
-import router from './routes';
-import middleware from './middleware';
-import constants from './constants';
-import { KEYCLOAK_OPTIONS } from './middleware/keycloak/keycloakOptions';
+import router from '@/routes';
+import middleware from '@/middleware';
+import constants from '@/constants';
+import { KEYCLOAK_OPTIONS } from '@/middleware/keycloak/keycloakOptions';
 import swaggerUi from 'swagger-ui-express';
-import swaggerJSON from './swagger/swagger-output.json';
+import swaggerJSON from '@/swagger/swagger-output.json';
 
 const app: Application = express();
 
@@ -19,7 +19,7 @@ const { TESTING, FRONTEND_URL } = constants;
 // Express Rate Limiter Configuration
 export const limiter = rateLimit({
   windowMs: 15 * 60 * 1000, // 15 minutes
-  max: 1000, // Limit each IP to 100 requests per `window` (here, per 15 minutes)
+  max: 1000, // Limit each IP to 1000 requests per `window` (here, per 15 minutes)
   standardHeaders: true, // Return rate limit info in the `RateLimit-*` headers
   legacyHeaders: false, // Disable the `X-RateLimit-*` headers
 });

express-api/src/middleware/index.ts

@@ -0,0 +1,7 @@
+import headerHandler from '@/middleware/headerHandler';
+import morganMiddleware from '@/middleware/morganHttpLogging';
+
+export default {
+  headerHandler,
+  morganMiddleware,
+};

express-api/middleware/keycloak/keycloakOptions.ts → express-api/src/middleware/keycloak/keycloakOptions.ts

@@ -1,5 +1,5 @@
 import { KCOptions, KeycloakUser } from '@bcgov/citz-imb-kc-express';
-import logger from '../../utilities/winstonLogger';
+import logger from '@/utilities/winstonLogger';
 
 export const KEYCLOAK_OPTIONS: KCOptions = {
   afterUserLogin: (user: KeycloakUser) => {

express-api/middleware/morganHttpLogging.ts → express-api/src/middleware/morganHttpLogging.ts

@@ -1,5 +1,5 @@
 import morgan from 'morgan';
-import logger from '../utilities/winstonLogger';
+import logger from '@/utilities/winstonLogger';
 
 /**
  * Middleware function that configures Morgan to use a custom logger with the http severity.

express-api/routes/healthRouter.ts → express-api/src/routes/healthRouter.ts

@@ -1,4 +1,4 @@
-import controllers from '../controllers';
+import controllers from '@/controllers';
 import express from 'express';
 
 const router = express.Router();

express-api/src/routes/index.ts

@@ -0,0 +1,11 @@
+import ltsaRouter from '@/routes/ltsaRouter';
+import healthRouter from '@/routes/healthRouter';
+import parcelsRouter from '@/routes/parcelsRouter';
+
+const router = {
+  healthRouter,
+  ltsaRouter,
+  parcelsRouter,
+};
+
+export default router;

express-api/routes/ltsaRouter.ts → express-api/src/routes/ltsaRouter.ts

@@ -1,4 +1,4 @@
-import controllers from '../controllers';
+import controllers from '@/controllers';
 import express from 'express';
 
 const router = express.Router();

express-api/routes/parcelsRouter.ts → express-api/src/routes/parcelsRouter.ts

@@ -1,4 +1,4 @@
-import controllers from '../controllers';
+import controllers from '@/controllers';
 import express from 'express';
 
 export const PARCELS_ROUTE = '/properties/parcels';

express-api/server.ts → express-api/src/server.ts

@@ -1,7 +1,7 @@
-import logger from './utilities/winstonLogger';
-import constants from './constants';
-import app from './express';
-import { AppDataSource } from './appDataSource';
+import logger from '@/utilities/winstonLogger';
+import constants from '@/constants';
+import app from '@/express';
+import { AppDataSource } from '@/appDataSource';
 
 const { API_PORT } = constants;
 

express-api/typeorm/utilities/CustomWinstonLogger.ts → express-api/src/typeorm/utilities/CustomWinstonLogger.ts

@@ -1,5 +1,5 @@
 import { AbstractLogger, LogLevel, LogMessage } from 'typeorm';
-import logger from '../../utilities/winstonLogger';
+import logger from '@/utilities/winstonLogger';
 
 export class CustomWinstonLogger extends AbstractLogger {
   /**

express-api/utilities/winstonLogger.ts → express-api/src/utilities/winstonLogger.ts

@@ -1,5 +1,5 @@
 import { format, createLogger, transports } from 'winston';
-import constants from '../constants';
+import constants from '@/constants';
 
 const { timestamp, combine, json } = format;
 const { TESTING } = constants;

express-api/tests/integration/express/express.test.ts

@@ -1,4 +1,4 @@
-import app, { limiter } from '../../../express';
+import app, { limiter } from '@/express';
 import supertest from 'supertest';
 
 const request = supertest(app);

express-api/tests/integration/health/getHealth.test.ts

@@ -1,4 +1,4 @@
-import app from '../../../express';
+import app from '@/express';
 import supertest from 'supertest';
 
 const request = supertest(app);

express-api/tests/integration/ltsa/getLtsa.test.ts

@@ -1,5 +1,5 @@
-import { ILtsaOrder } from '../../../controllers/ltsa/ILtsaOrder';
-import app from '../../../express';
+import { ILtsaOrder } from '@/controllers/ltsa/ILtsaOrder';
+import app from '@/express';
 import supertest from 'supertest';
 
 const request = supertest(app);

express-api/tests/integration/middleware/headerHandler.test.ts

@@ -1,4 +1,4 @@
-import app from '../../../express';
+import app from '@/express';
 import supertest from 'supertest';
 
 const request = supertest(app);

express-api/tests/integration/parcels/parcels.test.ts

@@ -1,7 +1,7 @@
 import supertest from 'supertest';
-import app from '../../../express';
+import app from '@/express';
 import { faker } from '@faker-js/faker';
-import { IParcel } from '../../../controllers/parcels/IParcel';
+import { IParcel } from '@/controllers/parcels/IParcel';
 
 const request = supertest(app);
 const API_PATH = '/api/v2/properties/parcels';

express-api/tests/unit/controllers/healthController.test.ts

@@ -1,4 +1,4 @@
-import controllers from '../../../controllers';
+import controllers from '@/controllers';
 import { Request, Response } from 'express';
 
 describe('UNIT - Testing controller for /health routes', () => {

express-api/tests/unit/controllers/ltsa/ltsaController.test.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from 'express';
-import controllers from '../../../../controllers';
+import controllers from '@/controllers';
 
 describe('UNIT - Testing controllers for /ltsa routes', () => {
   const mockRequest = {

express-api/tests/unit/controllers/parcels/parcelsController.test.ts

@@ -1,6 +1,6 @@
-import { IParcel } from '../../../../controllers/parcels/IParcel';
+import { IParcel } from '@/controllers/parcels/IParcel';
 import { faker } from '@faker-js/faker';
-import controllers from '../../../../controllers';
+import controllers from '@/controllers';
 import { Request, Response } from 'express';
 import { MockReq, MockRes, getRequestHandlerMocks } from '../../../testUtils/factories';
 

express-api/tests/unit/middleware/keycloak/keycloakOptions.test.ts

@@ -1,6 +1,6 @@
 import { IdirIdentityProvider } from '@bcgov/citz-imb-kc-express';
-import { KEYCLOAK_OPTIONS } from '../../../../middleware/keycloak/keycloakOptions';
-import logger from '../../../../utilities/winstonLogger';
+import { KEYCLOAK_OPTIONS } from '@/middleware/keycloak/keycloakOptions';
+import logger from '@/utilities/winstonLogger';
 
 describe('UNIT - Keycloak Options', () => {
   const user = {

express-api/tests/unit/utilities/stubResponse.test.ts

@@ -1,4 +1,4 @@
-import { stubResponse } from '../../../utilities/stubResponse';
+import { stubResponse } from '@/utilities/stubResponse';
 import { Response } from 'express';
 
 // TODO: Remove this test, along with the stub controller when all routes are fully implemented.

express-api/tests/unit/utilities/winstonLogger.test.ts

@@ -1,4 +1,4 @@
-import logger from '../../../utilities/winstonLogger';
+import logger from '@/utilities/winstonLogger';
 
 describe('UNIT - winston logger', () => {
   it('should be created with the expected settings', () => {

express-api/tsconfig.json

@@ -1,5 +1,9 @@
 {
   "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    },
     "module": "commonjs",
     "esModuleInterop": true,
     "target": "es2022",
@@ -9,7 +13,7 @@
     "outDir": "dist",
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
-    "resolveJsonModule": true // Used for swagger-output.json
+    "resolveJsonModule": true
   },
   "include": ["./**/*"]
 }