ORV2 2299 LOA

database/mssql/scripts/versions/revert/v_32_ddl_revert.sql

@@ -0,0 +1,28 @@
+SET ANSI_NULLS ON
+GO
+SET QUOTED_IDENTIFIER ON
+GO
+SET NOCOUNT ON
+GO
+
+SET XACT_ABORT ON
+
+BEGIN TRY
+ BEGIN TRANSACTION
+ DROP TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS]
+ DROP TABLE [permit].[ORBC_LOA_VEHICLES]
+ DROP TABLE [permit].[ORBC_LOA_DETAILS]
+ DROP SEQUENCE [permit].[ORBC_LOA_NUMBER_SEQ]
+ COMMIT
+END TRY
+
+BEGIN CATCH
+ IF @@TRANCOUNT > 0 
+ ROLLBACK;
+ THROW
+END CATCH
+
+DECLARE @VersionDescription VARCHAR(255)
+SET @VersionDescription = 'Reverting initial creation of LOA tables.'
+
+INSERT [dbo].[ORBC_SYS_VERSION] ([VERSION_ID], [DESCRIPTION], [RELEASE_DATE]) VALUES (31, @VersionDescription, getutcdate())

database/mssql/scripts/versions/v_32_ddl.sql

@@ -0,0 +1,213 @@
+SET ANSI_NULLS ON
+GO
+
+SET QUOTED_IDENTIFIER ON
+GO
+
+SET NOCOUNT ON
+GO
+
+SET XACT_ABORT ON
+GO
+
+SET TRANSACTION ISOLATION LEVEL SERIALIZABLE
+GO
+
+BEGIN TRANSACTION
+GO
+
+IF @@ERROR <> 0
+ SET NOEXEC ON
+GO
+CREATE SEQUENCE permit.ORBC_LOA_NUMBER_SEQ
+ START WITH 100000
+ INCREMENT BY 1 ;
+GO
+
+CREATE TABLE [permit].[ORBC_LOA_DETAILS] (
+ LOA_ID [bigint] IDENTITY(1,1) NOT NULL,
+ LOA_NUMBER [bigint] NOT NULL DEFAULT (NEXT VALUE FOR permit.ORBC_LOA_NUMBER_SEQ),
+ [COMPANY_ID] [int] NULL,
+ START_DATE [varchar](10) NOT NULL,
+ EXPIRY_DATE [varchar](10),
+ DOCUMENT_ID [bigint],
+ COMMENTS [nvarchar](4000),
+ [IS_ACTIVE] [bit] NOT NULL DEFAULT(1),
+ [APP_CREATE_TIMESTAMP] [datetime2](7) DEFAULT(getutcdate()),
+ [APP_CREATE_USERID] [nvarchar](30) DEFAULT(user_name()),
+ [APP_CREATE_USER_GUID] [char](32) NULL,
+ [APP_CREATE_USER_DIRECTORY] [nvarchar](30) DEFAULT(user_name()),
+ [APP_LAST_UPDATE_TIMESTAMP] [datetime2](7) DEFAULT(getutcdate()),
+ [APP_LAST_UPDATE_USERID] [nvarchar](30) DEFAULT(user_name()),
+ [APP_LAST_UPDATE_USER_GUID] [char](32) NULL,
+ [APP_LAST_UPDATE_USER_DIRECTORY] [nvarchar](30) DEFAULT(user_name()),
+ [CONCURRENCY_CONTROL_NUMBER] [int] NULL,
+ [DB_CREATE_USERID] [varchar](63) NOT NULL,
+ [DB_CREATE_TIMESTAMP] [datetime2](7) NOT NULL,
+ [DB_LAST_UPDATE_USERID] [varchar](63) NOT NULL,
+ [DB_LAST_UPDATE_TIMESTAMP] [datetime2](7) NOT NULL,
+ CONSTRAINT [PK_ORBC_LOA_DETAILS] PRIMARY KEY CLUSTERED ([LOA_ID] ASC) WITH (
+ PAD_INDEX = OFF,
+ STATISTICS_NORECOMPUTE = OFF,
+ IGNORE_DUP_KEY = OFF,
+ ALLOW_ROW_LOCKS = ON,
+ ALLOW_PAGE_LOCKS = ON
+ ) ON [PRIMARY]
+ ) ON [PRIMARY];
+
+CREATE TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS] (
+ LOA_PERMIT_TYPE_ID [bigint] IDENTITY(1,1) NOT NULL,
+ LOA_ID [bigint] NOT NULL,
+ PERMIT_TYPE_ID [varchar](10) NOT NULL,
+ [APP_CREATE_TIMESTAMP] [datetime2](7) DEFAULT(getutcdate()),
+ [APP_CREATE_USERID] [nvarchar](30) DEFAULT(user_name()),
+ [APP_CREATE_USER_GUID] [char](32) NULL,
+ [APP_CREATE_USER_DIRECTORY] [nvarchar](30) DEFAULT(user_name()),
+ [APP_LAST_UPDATE_TIMESTAMP] [datetime2](7) DEFAULT(getutcdate()),
+ [APP_LAST_UPDATE_USERID] [nvarchar](30) DEFAULT(user_name()),
+ [APP_LAST_UPDATE_USER_GUID] [char](32) NULL,
+ [APP_LAST_UPDATE_USER_DIRECTORY] [nvarchar](30) DEFAULT(user_name()),
+ [CONCURRENCY_CONTROL_NUMBER] [int] NULL,
+ [DB_CREATE_USERID] [varchar](63) NOT NULL,
+ [DB_CREATE_TIMESTAMP] [datetime2](7) NOT NULL,
+ [DB_LAST_UPDATE_USERID] [varchar](63) NOT NULL,
+ [DB_LAST_UPDATE_TIMESTAMP] [datetime2](7) NOT NULL,
+ CONSTRAINT [PK_ORBC_LOA_PERMIT_TYPE_DETAILS] PRIMARY KEY CLUSTERED ([LOA_PERMIT_TYPE_ID] ASC) WITH (
+ PAD_INDEX = OFF,
+ STATISTICS_NORECOMPUTE = OFF,
+ IGNORE_DUP_KEY = OFF,
+ ALLOW_ROW_LOCKS = ON,
+ ALLOW_PAGE_LOCKS = ON
+ ) ON [PRIMARY]
+ ) ON [PRIMARY];
+
+CREATE TABLE [permit].[ORBC_LOA_VEHICLES] (
+ LOA_VEHICLE_ID [bigint] IDENTITY(1,1) NOT NULL,
+ LOA_ID [bigint] NOT NULL,
+ POWER_UNIT_ID [bigint],
+ TRAILER_ID [bigint],
+ [APP_CREATE_TIMESTAMP] [datetime2](7) DEFAULT(getutcdate()),
+ [APP_CREATE_USERID] [nvarchar](30) DEFAULT(user_name()),
+ [APP_CREATE_USER_GUID] [char](32) NULL,
+ [APP_CREATE_USER_DIRECTORY] [nvarchar](30) DEFAULT(user_name()),
+ [APP_LAST_UPDATE_TIMESTAMP] [datetime2](7) DEFAULT(getutcdate()),
+ [APP_LAST_UPDATE_USERID] [nvarchar](30) DEFAULT(user_name()),
+ [APP_LAST_UPDATE_USER_GUID] [char](32) NULL,
+ [APP_LAST_UPDATE_USER_DIRECTORY] [nvarchar](30) DEFAULT(user_name()),
+ [CONCURRENCY_CONTROL_NUMBER] [int] NULL,
+ [DB_CREATE_USERID] [varchar](63) NOT NULL,
+ [DB_CREATE_TIMESTAMP] [datetime2](7) NOT NULL,
+ [DB_LAST_UPDATE_USERID] [varchar](63) NOT NULL,
+ [DB_LAST_UPDATE_TIMESTAMP] [datetime2](7) NOT NULL,
+ CONSTRAINT [PK_ORBC_LOA_VEHICLES] PRIMARY KEY CLUSTERED ([LOA_VEHICLE_ID] ASC) WITH (
+ PAD_INDEX = OFF,
+ STATISTICS_NORECOMPUTE = OFF,
+ IGNORE_DUP_KEY = OFF,
+ ALLOW_ROW_LOCKS = ON,
+ ALLOW_PAGE_LOCKS = ON
+ ) ON [PRIMARY]
+ ) ON [PRIMARY];
+
+ALTER TABLE [permit].[ORBC_LOA_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_DETAILS_DB_CREATE_USERID] DEFAULT(user_name())
+FOR [DB_CREATE_USERID]
+
+ALTER TABLE [permit].[ORBC_LOA_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_DETAILS_DB_CREATE_TIMESTAMP] DEFAULT(getutcdate())
+FOR [DB_CREATE_TIMESTAMP]
+
+ALTER TABLE [permit].[ORBC_LOA_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_DETAILS_DB_LAST_UPDATE_USERID] DEFAULT(user_name())
+FOR [DB_LAST_UPDATE_USERID]
+
+ALTER TABLE [permit].[ORBC_LOA_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_DETAILS_DB_LAST_UPDATE_TIMESTAMP] DEFAULT(getutcdate())
+FOR [DB_LAST_UPDATE_TIMESTAMP]
+
+ALTER TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_PERMIT_TYPE_DETAILS_DB_CREATE_USERID] DEFAULT(user_name())
+FOR [DB_CREATE_USERID]
+
+ALTER TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_PERMIT_TYPE_DETAILS_DB_CREATE_TIMESTAMP] DEFAULT(getutcdate())
+FOR [DB_CREATE_TIMESTAMP]
+
+ALTER TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_PERMIT_TYPE_DETAILS_DB_LAST_UPDATE_USERID] DEFAULT(user_name())
+FOR [DB_LAST_UPDATE_USERID]
+
+ALTER TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS] ADD CONSTRAINT [DF_ORBC_LOA_PERMIT_TYPE_DETAILS_DB_LAST_UPDATE_TIMESTAMP] DEFAULT(getutcdate())
+FOR [DB_LAST_UPDATE_TIMESTAMP]
+
+ALTER TABLE [permit].[ORBC_LOA_VEHICLES] ADD CONSTRAINT [DF_ORBC_LOA_VEHICLES_DB_CREATE_USERID] DEFAULT(user_name())
+FOR [DB_CREATE_USERID]
+
+ALTER TABLE [permit].[ORBC_LOA_VEHICLES] ADD CONSTRAINT [DF_ORBC_LOA_VEHICLES_DB_CREATE_TIMESTAMP] DEFAULT(getutcdate())
+FOR [DB_CREATE_TIMESTAMP]
+
+ALTER TABLE [permit].[ORBC_LOA_VEHICLES] ADD CONSTRAINT [DF_ORBC_LOA_VEHICLES_DB_LAST_UPDATE_USERID] DEFAULT(user_name())
+FOR [DB_LAST_UPDATE_USERID]
+
+ALTER TABLE [permit].[ORBC_LOA_VEHICLES] ADD CONSTRAINT [DF_ORBC_LOA_VEHICLES_DB_LAST_UPDATE_TIMESTAMP] DEFAULT(getutcdate())
+FOR [DB_LAST_UPDATE_TIMESTAMP]
+
+ALTER TABLE [permit].[ORBC_LOA_VEHICLES]
+ WITH CHECK ADD CONSTRAINT [ORBC_LOA_VEHICLES_LOA_ID_FK] FOREIGN KEY ([LOA_ID]) REFERENCES [permit].[ORBC_LOA_DETAILS]([LOA_ID]) ON DELETE CASCADE
+
+ALTER TABLE [permit].[ORBC_LOA_VEHICLES]
+ WITH CHECK ADD CONSTRAINT [ORBC_LOA_VEHICLES_POWER_UNIT_ID_FK] FOREIGN KEY ([POWER_UNIT_ID]) REFERENCES [dbo].[ORBC_POWER_UNIT]([POWER_UNIT_ID])
+
+ALTER TABLE [permit].[ORBC_LOA_VEHICLES]
+ WITH CHECK ADD CONSTRAINT [ORBC_LOA_VEHICLES_TRAILER_ID_FK] FOREIGN KEY ([TRAILER_ID]) REFERENCES [dbo].[ORBC_TRAILER]([TRAILER_ID])
+
+ALTER TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS]
+ WITH CHECK ADD CONSTRAINT [ORBC_LOA_PERMIT_TYPES_PERMIT_TYPE_ID_FK] FOREIGN KEY ([PERMIT_TYPE_ID]) REFERENCES [permit].[ORBC_PERMIT_TYPE]([PERMIT_TYPE])
+
+ALTER TABLE [permit].[ORBC_LOA_PERMIT_TYPE_DETAILS]
+ WITH CHECK ADD CONSTRAINT [ORBC_LOA_PERMIT_TYPE_LOA_ID_FK] FOREIGN KEY ([LOA_ID]) REFERENCES [permit].[ORBC_LOA_DETAILS]([LOA_ID]) ON DELETE CASCADE
+
+ALTER TABLE [permit].[ORBC_LOA_DETAILS]
+ WITH CHECK ADD CONSTRAINT [ORBC_LOA_DETAILS_DOCUMENT_ID_FK] FOREIGN KEY ([DOCUMENT_ID]) REFERENCES [dops].[ORBC_DOCUMENT]([ID])
+
+IF @@ERROR <> 0
+ SET NOEXEC ON
+GO
+
+DECLARE @VersionDescription VARCHAR(255)
+
+SET @VersionDescription = '-- Add Serive Account diretory type to ORBC_DIRECTORY_TYPE'
+
+INSERT [dbo].[ORBC_SYS_VERSION] (
+ [VERSION_ID],
+ [DESCRIPTION],
+ [UPDATE_SCRIPT],
+ [REVERT_SCRIPT],
+ [RELEASE_DATE]
+ )
+VALUES (
+ 31,
+ @VersionDescription,
+ '$(UPDATE_SCRIPT)',
+ '$(REVERT_SCRIPT)',
+ getutcdate()
+ )
+
+IF @@ERROR <> 0
+ SET NOEXEC ON
+GO
+
+COMMIT TRANSACTION
+GO
+
+IF @@ERROR <> 0
+ SET NOEXEC ON
+GO
+
+DECLARE @Success AS BIT
+
+SET @Success = 1
+SET NOEXEC OFF
+
+IF (@Success = 1)
+ PRINT 'The database update succeeded'
+ELSE
+BEGIN
+ IF @@TRANCOUNT > 0
+ ROLLBACK TRANSACTION
+
+ PRINT 'The database update failed'
+END
+GO

database/mssql/test/versions/v_32_1_test.sql

@@ -0,0 +1,7 @@
+SET NOCOUNT ON
+IF OBJECT_ID('[$(DB_NAME)].[permit].[ORBC_LOA_PERMIT_TYPE_DETAILS]', 'U') IS NOT NULL 
+AND OBJECT_ID('[$(DB_NAME)].[permit].[ORBC_LOA_VEHICLES]', 'U') IS NOT NULL 
+AND OBJECT_ID('[$(DB_NAME)].[permit].[ORBC_LOA_DETAILS]', 'U') IS NOT NULL 
+ SELECT 1 
+ELSE
+ SELECT 0

database/mssql/test/versions/v_32_test.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Retrieve arguments
+source ${SCRIPT_DIR}/utility/getopt.sh
+USAGE="-u USER -p PASS -s SERVER -d DATABASE"
+parse_options "${USAGE}" ${@}
+
+# All database tests for database version 32 are run from this shell script.
+# TESTS_DIR variable set by the calling test-runner script.
+
+TEST_32_1_RESULT=$(/opt/mssql-tools/bin/sqlcmd -U ${USER} -P "${PASS}" -S ${SERVER} -v DB_NAME=${DATABASE} -h -1 -i ${TESTS_DIR}/v_32_1_test.sql | xargs)
+if [[ $TEST_32_1_RESULT -eq 1 ]]; then
+ echo "Test 32.1 passed: LOA tables are created correctly"
+else
+ echo "******** Test 32.1 failed: LOA tables are created correctly"
+fi
+

dops/src/helper/response-header.helper.ts

@@ -0,0 +1,15 @@
+import { Response } from 'express';
+import { ClsServiceManager } from 'nestjs-cls';
+
+/**
+ * Sets the 'x-correlation-id' header in the response if it is not already set.
+ *
+ * @param {Response} response - The HTTP response object.
+ */
+export const setResHeaderCorrelationId = (response: Response) => {
+ const cls = ClsServiceManager.getClsService();
+ const correlationId = cls.getId();
+ if (!response.getHeader('x-correlation-id') && correlationId) {
+ response.setHeader('x-correlation-id', correlationId);
+ }
+};

dops/src/interceptor/correlationId.interceptor.ts

@@ -7,7 +7,7 @@ import {
 import { Observable } from 'rxjs';
 import { tap } from 'rxjs/operators';
 import { Response } from 'express';
-import { ClsServiceManager } from 'nestjs-cls';
+import { setResHeaderCorrelationId } from '../helper/response-header.helper';
 
 @Injectable()
 export class CorrelationIdInterceptor implements NestInterceptor {
@@ -16,11 +16,7 @@ export class CorrelationIdInterceptor implements NestInterceptor {
  const response = context.switchToHttp().getResponse<Response>();
  return next.handle().pipe(
  tap(() => {
- const cls = ClsServiceManager.getClsService();
- const correlationId = cls.getId();
- if (!response.getHeader('x-correlation-id') && correlationId) {
- response.setHeader('x-correlation-id', correlationId);
- }
+ setResHeaderCorrelationId(response);
  }),
  );
  }

dops/src/modules/dms/dms.controller.ts

@@ -37,6 +37,7 @@ import { IDP } from '../../enum/idp.enum';
 import { Roles } from '../../decorator/roles.decorator';
 import { Role } from '../../enum/roles.enum';
 import { GetDocumentQueryParamsDto } from './dto/request/queryParam/getDocument.query-params.dto';
+import { setResHeaderCorrelationId } from '../../helper/response-header.helper';
 
 @ApiTags('DMS')
 @ApiBadRequestResponse({
@@ -193,8 +194,10 @@ export class DmsController {
  s3Object.pipe(res);
  } else {
  if (getDocumentQueryParamsDto.download === FileDownloadModes.URL) {
+ setResHeaderCorrelationId(res);
  res.status(201).send(file);
  } else {
+ setResHeaderCorrelationId(res);
  res.status(302).set('Location', file.preSignedS3Url).end();
  }
  }

vehicles/package.json

@@ -63,6 +63,7 @@
  "class-validator": "^0.14.1",
  "dayjs": "^1.11.11",
  "dotenv": "^16.4.5",
+ "form-data": "^4.0.0",
  "handlebars": "^4.7.8",
  "helmet": "^7.1.0",
  "jwks-rsa": "^3.1.0",

vehicles/src/app.module.ts

@@ -37,6 +37,7 @@ import { PaymentModule } from './modules/permit-application-payment/payment/paym
 import { PermitReceiptDocumentModule } from './modules/permit-application-payment/permit-receipt-document/permit-receipt-document.module';
 import { ShoppingCartModule } from './modules/shopping-cart/shopping-cart.module';
 import { CreditAccountModule } from './modules/credit-account/credit-account.module';
+import { LoaModule } from './modules/loa/loa.module';
 
 const envPath = path.resolve(process.cwd() + '/../');
 
@@ -100,6 +101,7 @@ const envPath = path.resolve(process.cwd() + '/../');
  PermitModule,
  CreditAccountModule,
  FeatureFlagsModule,
+ LoaModule,
  ],
  controllers: [AppController],
  providers: [AppService],

vehicles/src/common/helper/response-header.helper.ts

@@ -0,0 +1,15 @@
+import { Response } from 'express';
+import { ClsServiceManager } from 'nestjs-cls';
+
+/**
+ * Sets the 'x-correlation-id' header in the response if it is not already set.
+ *
+ * @param {Response} response - The HTTP response object.
+ */
+export const setResHeaderCorrelationId = (response: Response) => {
+ const cls = ClsServiceManager.getClsService();
+ const correlationId = cls.getId();
+ if (!response.getHeader('x-correlation-id') && correlationId) {
+ response.setHeader('x-correlation-id', correlationId);
+ }
+};