feat(DTFS2-6892): move entra id to tfm api

azure-functions/acbs-function/.eslintrc.js

@@ -9,7 +9,19 @@ const baseRules = {
   'no-underscore-dangle': [
     'error',
     {
-      allow: ['_id', '_csrf', '_getBuffer', '_getData', '_getHeaders', '_getStatusCode', '_getRedirectUrl', '_getRenderData', '_getRenderView', '_isEndCalled'],
+      allow: [
+        '_id',
+        '_csrf',
+        '_getBuffer',
+        '_getData',
+        '_getJSONData',
+        '_getHeaders',
+        '_getStatusCode',
+        '_getRedirectUrl',
+        '_getRenderData',
+        '_getRenderView',
+        '_isEndCalled',
+      ],
     },
   ],
   'import/extensions': 'off',

dtfs-central-api/.eslintrc.js

@@ -9,7 +9,19 @@ const baseRules = {
   'no-underscore-dangle': [
     'error',
     {
-      allow: ['_id', '_csrf', '_getBuffer', '_getData', '_getHeaders', '_getStatusCode', '_getRedirectUrl', '_getRenderData', '_getRenderView', '_isEndCalled'],
+      allow: [
+        '_id',
+        '_csrf',
+        '_getBuffer',
+        '_getData',
+        '_getJSONData',
+        '_getHeaders',
+        '_getStatusCode',
+        '_getRedirectUrl',
+        '_getRenderData',
+        '_getRenderView',
+        '_isEndCalled',
+      ],
     },
   ],
   'import/extensions': 'off',

e2e-tests/.eslintrc.js

@@ -9,7 +9,19 @@ const baseRules = {
   'no-underscore-dangle': [
     'error',
     {
-      allow: ['_id', '_csrf', '_getBuffer', '_getData', '_getHeaders', '_getStatusCode', '_getRedirectUrl', '_getRenderData', '_getRenderView', '_isEndCalled'],
+      allow: [
+        '_id',
+        '_csrf',
+        '_getBuffer',
+        '_getData',
+        '_getJSONData',
+        '_getHeaders',
+        '_getStatusCode',
+        '_getRedirectUrl',
+        '_getRenderData',
+        '_getRenderView',
+        '_isEndCalled',
+      ],
     },
   ],
   'import/extensions': 'off',

external-api/.eslintrc.js

@@ -9,7 +9,19 @@ const baseRules = {
   'no-underscore-dangle': [
     'error',
     {
-      allow: ['_id', '_csrf', '_getBuffer', '_getData', '_getHeaders', '_getStatusCode', '_getRedirectUrl', '_getRenderData', '_getRenderView', '_isEndCalled'],
+      allow: [
+        '_id',
+        '_csrf',
+        '_getBuffer',
+        '_getData',
+        '_getJSONData',
+        '_getHeaders',
+        '_getStatusCode',
+        '_getRedirectUrl',
+        '_getRenderData',
+        '_getRenderView',
+        '_isEndCalled',
+      ],
     },
   ],
   'import/extensions': 'off',

gef-ui/.eslintrc.js

@@ -9,7 +9,19 @@ const baseRules = {
   'no-underscore-dangle': [
     'error',
     {
-      allow: ['_id', '_csrf', '_getBuffer', '_getData', '_getHeaders', '_getStatusCode', '_getRedirectUrl', '_getRenderData', '_getRenderView', '_isEndCalled'],
+      allow: [
+        '_id',
+        '_csrf',
+        '_getBuffer',
+        '_getData',
+        '_getJSONData',
+        '_getHeaders',
+        '_getStatusCode',
+        '_getRedirectUrl',
+        '_getRenderData',
+        '_getRenderView',
+        '_isEndCalled',
+      ],
     },
   ],
   'import/extensions': 'off',

libs/common/.eslintrc.js

@@ -9,7 +9,19 @@ const baseRules = {
   'no-underscore-dangle': [
     'error',
     {
-      allow: ['_id', '_csrf', '_getBuffer', '_getData', '_getHeaders', '_getStatusCode', '_getRedirectUrl', '_getRenderData', '_getRenderView', '_isEndCalled'],
+      allow: [
+        '_id',
+        '_csrf',
+        '_getBuffer',
+        '_getData',
+        '_getJSONData',
+        '_getHeaders',
+        '_getStatusCode',
+        '_getRedirectUrl',
+        '_getRenderData',
+        '_getRenderView',
+        '_isEndCalled',
+      ],
     },
   ],
   'import/extensions': 'off',

libs/common/package.json

@@ -47,6 +47,7 @@
     "unit-test-ff": "jest --coverage --verbose --config=unit.ff.jest.config.js --passWithNoTests"
   },
   "dependencies": {
+    "@azure/msal-node": "^2.16.2",
     "axios": "1.7.8",
     "big.js": "^6.2.2",
     "date-fns": "^3.3.1",

libs/common/src/errors/index.ts

@@ -18,5 +18,6 @@ export * from './user-session.error';
 export * from './user-session-not-defined.error';
 export * from './user-token-not-defined.error';
 export * from './multiple-users-found.error';
+export * from './user-partial-login-data-not-defined.error';
 export * from './amendment-not-found.error';
 export * from './eligibility-criteria-not-found.error';

libs/common/src/errors/user-partial-login-data-not-defined.error.test.ts

@@ -0,0 +1,62 @@
+import { HttpStatusCode } from 'axios';
+import { ApiError } from './api.error';
+import { UserSessionError } from './user-session.error';
+import { UserPartialLoginDataNotDefinedError } from './user-partial-login-data-not-defined.error';
+
+describe('UserPartialLoginDataNotDefinedError', () => {
+  it('should expose the message the error was created with', () => {
+    // Act
+    const exception = new UserPartialLoginDataNotDefinedError();
+
+    // Assert
+    expect(exception.message).toEqual('Expected session.loginData to be defined');
+  });
+
+  it('should expose the 401 (Unauthorised) status code', () => {
+    // Act
+    const exception = new UserPartialLoginDataNotDefinedError();
+
+    // Assert
+    expect(exception.status).toEqual(HttpStatusCode.Unauthorized);
+  });
+
+  it('should expose the INVALID_USER_SESSION code', () => {
+    // Act
+    const exception = new UserPartialLoginDataNotDefinedError();
+
+    // Assert
+    expect(exception.code).toEqual('INVALID_USER_SESSION');
+  });
+
+  it('should be an instance of UserPartialLoginDataNotDefinedError', () => {
+    // Act
+    const exception = new UserPartialLoginDataNotDefinedError();
+
+    // Assert
+    expect(exception).toBeInstanceOf(UserPartialLoginDataNotDefinedError);
+  });
+
+  it('should be an instance of UserSessionError', () => {
+    // Act
+    const exception = new UserPartialLoginDataNotDefinedError();
+
+    // Assert
+    expect(exception).toBeInstanceOf(UserSessionError);
+  });
+
+  it('should be an instance of ApiError', () => {
+    // Act
+    const exception = new UserPartialLoginDataNotDefinedError();
+
+    // Assert
+    expect(exception).toBeInstanceOf(ApiError);
+  });
+
+  it('should expose the name of the exception', () => {
+    // Act
+    const exception = new UserPartialLoginDataNotDefinedError();
+
+    // Assert
+    expect(exception.name).toEqual('UserPartialLoginDataNotDefinedError');
+  });
+});

libs/common/src/errors/user-partial-login-data-not-defined.error.ts

@@ -0,0 +1,16 @@
+import { HttpStatusCode } from 'axios';
+import { UserSessionError } from './user-session.error';
+
+/**
+ * Error to use when a partially logged in user's session does not contain the expected data
+ */
+export class UserPartialLoginDataNotDefinedError extends UserSessionError {
+  constructor() {
+    super({
+      status: HttpStatusCode.Unauthorized,
+      message: 'Expected session.loginData to be defined',
+    });
+
+    this.name = this.constructor.name;
+  }
+}

libs/common/src/schemas/audit-database-record.ts

@@ -1,12 +1,12 @@
 import z from 'zod';
 import { ISO_DATE_TIME_STAMP } from './iso-date-time-stamp';
-import { OBJECT_ID } from './object-id';
+import { OBJECT_ID_OR_OBJECT_ID_STRING } from './object-id';
 
 export const AUDIT_DATABASE_RECORD = z
   .object({
     lastUpdatedAt: ISO_DATE_TIME_STAMP,
-    lastUpdatedByPortalUserId: OBJECT_ID.nullable(),
-    lastUpdatedByTfmUserId: OBJECT_ID.nullable(),
+    lastUpdatedByPortalUserId: OBJECT_ID_OR_OBJECT_ID_STRING.nullable(),
+    lastUpdatedByTfmUserId: OBJECT_ID_OR_OBJECT_ID_STRING.nullable(),
     lastUpdatedByIsSystem: z.boolean().nullable(),
     noUserLoggedIn: z.boolean().nullable(),
   })

libs/common/src/schemas/index.ts

@@ -1,6 +1,6 @@
 export * as PORTAL_USER from './portal-user';
 export * as ISO_DATE_TIME_STAMP from './iso-date-time-stamp';
-export { OBJECT_ID } from './object-id';
+export * from './object-id';
 export * from './deal-cancellation';
 export * from './tfm';
 export * from './unix-timestamp.schema';

libs/common/src/schemas/object-id.test.ts

@@ -1,23 +1,72 @@
 import { ObjectId } from 'mongodb';
-import { OBJECT_ID } from './object-id';
+import { OBJECT_ID, OBJECT_ID_OR_OBJECT_ID_STRING, OBJECT_ID_STRING } from './object-id';
 import { withSchemaTests } from '../test-helpers';
 
 describe('OBJECT_ID', () => {
   withSchemaTests({
-    successTestCases: getSuccessTestCases(),
-    failureTestCases: getFailureTestCases(),
+    successTestCases: getObjectIdSuccessTestCases(),
+    failureTestCases: getObjectIdSharedFailureTestCases(),
     schema: OBJECT_ID,
   });
+
+  it('should transform a valid string ObjectId to an ObjectId', () => {
+    const stringObjectId = new ObjectId().toString();
+
+    const result = OBJECT_ID.parse(stringObjectId);
+
+    expect(result).toEqual(new ObjectId(stringObjectId));
+  });
 });
 
-function getSuccessTestCases() {
-  return [
-    { description: 'a valid ObjectId', aTestCase: () => new ObjectId() },
-    { description: 'a valid string ObjectId', aTestCase: () => '075bcd157dcb851180e02a7c' },
-  ];
+describe('OBJECT_ID_STRING', () => {
+  withSchemaTests({
+    successTestCases: getObjectIdStringSuccessTestCases(),
+    failureTestCases: getObjectIdSharedFailureTestCases(),
+    schema: OBJECT_ID_STRING,
+  });
+
+  it('should transform a valid ObjectId to a string', () => {
+    const objectId = new ObjectId();
+
+    const result = OBJECT_ID_STRING.parse(objectId);
+
+    expect(result).toEqual(objectId.toString());
+  });
+});
+
+describe('OBJECT_ID_OR_OBJECT_ID_STRING', () => {
+  withSchemaTests({
+    successTestCases: [...getObjectIdSuccessTestCases(), ...getObjectIdStringSuccessTestCases()],
+    failureTestCases: getObjectIdSharedFailureTestCases(),
+    schema: OBJECT_ID_OR_OBJECT_ID_STRING,
+  });
+
+  it('should not transform a valid ObjectId to a string', () => {
+    const objectId = new ObjectId();
+
+    const result = OBJECT_ID_OR_OBJECT_ID_STRING.parse(objectId);
+
+    expect(result).toEqual(objectId);
+  });
+
+  it('should not transform a valid string ObjectId to an ObjectId', () => {
+    const stringObjectId = new ObjectId().toString();
+
+    const result = OBJECT_ID_OR_OBJECT_ID_STRING.parse(stringObjectId);
+
+    expect(result).toEqual(stringObjectId);
+  });
+});
+
+function getObjectIdSuccessTestCases() {
+  return [{ description: 'a valid ObjectId', aTestCase: () => new ObjectId() }];
+}
+
+function getObjectIdStringSuccessTestCases() {
+  return [{ description: 'a valid string ObjectId', aTestCase: () => '075bcd157dcb851180e02a7c' }];
 }
 
-function getFailureTestCases() {
+function getObjectIdSharedFailureTestCases() {
   return [
     { description: 'a string', aTestCase: () => 'string' },
     { description: 'an object', aTestCase: () => ({ An: 'object' }) },

libs/common/src/schemas/object-id.ts

@@ -1,4 +1,28 @@
 import { ObjectId } from 'mongodb';
 import z from 'zod';
 
-export const OBJECT_ID = z.union([z.instanceof(ObjectId), z.string().refine((id) => ObjectId.isValid(id))]);
+/**
+ * A zod schema that represents a valid ObjectId as an ObjectId object
+ * This schema also transforms any valid string into an ObjectId object
+ */
+export const OBJECT_ID = z.union([
+  z.instanceof(ObjectId),
+  z
+    .string()
+    .refine((id) => ObjectId.isValid(id))
+    .transform((id) => new ObjectId(id)),
+]);
+
+/**
+ * A zod schema that represents a valid ObjectId as a string
+ * This schema also transforms any valid ObjectId object into a string
+ */
+export const OBJECT_ID_STRING = z.union([z.string().refine((id) => ObjectId.isValid(id)), z.instanceof(ObjectId).transform((id) => id.toString())]);
+
+/**
+ * A zod schema that represents a valid ObjectId as an ObjectId object or a string
+ * This schema does not do any transformation, only validates.
+ * This is because we check to see if the value is an ObjectId prior to applying the OBJECT_ID_STRING
+ * schema, and zod union returns the first valid schema
+ */
+export const OBJECT_ID_OR_OBJECT_ID_STRING = z.union([z.instanceof(ObjectId), OBJECT_ID_STRING]);

trade-finance-manager-ui/server/schemas/entra-id.schema.decoded-auth-code-request-state-schema.test.ts → libs/common/src/schemas/tfm/entra-id.schema.decoded-auth-code-request-state-schema.test.ts

@@ -1,5 +1,5 @@
-import { withSchemaTests } from '@ukef/dtfs2-common';
-import { DecodedAuthCodeRequestState } from '../types/entra-id';
+import { withSchemaTests } from '../../test-helpers';
+import { DecodedAuthCodeRequestState } from '../../types/tfm/entra-id';
 import { DECODED_AUTH_CODE_REQUEST_STATE_SCHEMA } from './entra-id.schema';
 
 describe('DECODED_AUTH_CODE_REQUEST_STATE_SCHEMA', () => {

trade-finance-manager-ui/server/schemas/entra-id.schema.entra-id-auth-code-redirect-response-body-schema.test.ts → libs/common/src/schemas/tfm/entra-id.schema.entra-id-auth-code-redirect-response-body-schema.test.ts

@@ -1,5 +1,5 @@
-import { withSchemaTests } from '@ukef/dtfs2-common';
-import { EntraIdAuthCodeRedirectResponseBody } from '../types/entra-id';
+import { withSchemaTests } from '../../test-helpers';
+import { EntraIdAuthCodeRedirectResponseBody } from '../../types/tfm/entra-id';
 import { ENTRA_ID_AUTH_CODE_REDIRECT_RESPONSE_BODY_SCHEMA } from './entra-id.schema';
 
 describe('ENTRA_ID_AUTH_CODE_REDIRECT_RESPONSE_BODY_SCHEMA', () => {

trade-finance-manager-ui/server/schemas/entra-id.schema.entra-id-authentication-result-schema.test.ts → libs/common/src/schemas/tfm/entra-id.schema.entra-id-authentication-result-schema.test.ts

@@ -1,5 +1,5 @@
-import { anEntraIdUser, withEntraIdUserSchemaTests, withSchemaTests } from '@ukef/dtfs2-common';
-import { EntraIdAuthenticationResult } from '../types/entra-id';
+import { anEntraIdUser, withEntraIdUserSchemaTests, withSchemaTests } from '../../test-helpers';
+import { EntraIdAuthenticationResult } from '../../types/tfm/entra-id';
 import { ENTRA_ID_AUTHENTICATION_RESULT_SCHEMA } from './entra-id.schema';
 
 describe('ENTRA_ID_AUTHENTICATION_RESULT_SCHEMA', () => {

trade-finance-manager-ui/server/schemas/entra-id.schema.ts → libs/common/src/schemas/tfm/entra-id.schema.ts

@@ -1,5 +1,5 @@
-import { ENTRA_ID_USER_SCHEMA } from '@ukef/dtfs2-common/schemas';
 import { z } from 'zod';
+import { ENTRA_ID_USER_SCHEMA } from './entra-id-user.schema';
 
 export const DECODED_AUTH_CODE_REQUEST_STATE_SCHEMA = z.object({
   csrfToken: z.string(),

libs/common/src/schemas/tfm/index.ts

@@ -1,6 +1,7 @@
 export * from './entra-id-user.schema';
+export * from './entra-id-user-to-upsert-tfm-user-request.schema';
+export * from './entra-id.schema';
 export * from './create-tfm-user-request.schema';
 export * from './update-tfm-user-request.schema';
 export * from './upsert-tfm-user-request.schema';
-export * from './entra-id-user-to-upsert-tfm-user-request.schema';
 export * from './tfm-team.schema';