add test for OBPConsentsService

Author: nemozak1

server/services/OBPConsentsService.ts

@@ -1,10 +1,72 @@
 import { Service } from 'typedi'
+import { Configuration, ConsentApi} from 'obp-api-typescript'
+import OBPClientService from './OBPClientService'
 
 @Service()
 export default class OBPConsentsService {
+    private consentApiConfig: Configuration
+    public obpClientService: OBPClientService
+    public consentsClient: ConsentApi // This needs to be changed once we migrate away from the old OBP SDK
     constructor() {
+        this.obpClientService = new OBPClientService()
+    }
+    /**
+     * Function to create a OBP Consents API client
+     * at differnt times in the consent flow we will either need to be acting as the logged in user, or the API Explorer II consumer
+     * 
+     * @param path 
+     * @param method 
+     * @param as_client 
+     * @returns 
+     */
+    async createConsentClient(path: string, method: string, as_consumer: "logged_in_user" | "API_Explorer"): Promise<ConsentApi | undefined> {
+        // This function creates a Consents API client as the logged in user, using their OAuth1 headers
+        if (as_consumer === "logged_in_user") {
+            try {
+
+                // Get the OAuth1 headers for the logged in user to use in the API call
+                const oauth1Headers = await this.obpClientService.getOAuthHeader(path, method)
+                const authHeader = "OAuth " + oauth1Headers
+                // Set config for the Consents API client from the new typescript SDK
+                this.consentApiConfig = new Configuration({
+                    basePath: this.obpClientService.getOBPClientConfig().baseUri,
+                    accessToken: authHeader
+                })
+                
+                // Create the Consents API client
+                this.consentsClient = new ConsentApi(this.consentApiConfig)
+                return this.consentsClient
+
+            } catch (error) {
+                console.error(error)
+                throw new Error(`Could not create Consents API client for logged in user, ${error}`)
+            }
+
+        } else if (as_consumer === "API_Explorer") {
 
+            try {
+                // Get direct Login token from OBP for API Explorer II
+                const directLoginToken = await this.obpClientService.getDirectLoginToken()
+                const directLoginHeader = "DirectLogin token=" + directLoginToken
+                // Set config for the Consents API client from the new typescript SDK
+                this.consentApiConfig = new Configuration({
+                    basePath: this.obpClientService.getOBPClientConfig().baseUri,
+                    accessToken: directLoginHeader
+                })
+
+                this.consentsClient = new ConsentApi(this.consentApiConfig)
+                return this.consentsClient
+
+            } catch (error) {
+                console.error(error)
+                throw new Error(`Could not create Consents API client for API Explorer, ${error}`)
+            }
+        } else {
+            throw new Error("Invalid client type, must be 'logged_in_user' or 'API_Explorer'")
+        }
     }
+        
+        
     async createConsentRequest(): Promise<any> {
 
     }

server/test/OBPConsentsService.test.ts

@@ -0,0 +1,74 @@
+import {describe, beforeAll, it, vi, Mock } from 'vitest'
+import { ConsentApi } from 'obp-api-typescript'
+
+const mockGetOAuthHeader = vi.fn(async () => (`OAuth oauth_consumer_key="jgaawf2fnj4yixqdsfaq4gipt4v1wvgsxgre",oauth_nonce="JiGDBWA3MAyKtsd9qkfWCxfju36bMjsA",oauth_signature_method="HMAC-SHA1",oauth_timestamp="1741364123",oauth_version="1.0",oauth_signature="sa%2FRylnsdfLK8VPZI%2F2WkGFlTKs%3D"`));
+const mockGetDirectLoginToken = vi.fn(async () => {
+    return "eyJhbGciOisdReI1NiJ9.eyIiOiIifQ.neaNv-ltBoEEyErvmhmEbYIG8KLdjqRfT7hA7uKPdvs"
+});
+
+vi.mock('../services/OBPClientService', () => {
+    return {
+      default: vi.fn().mockImplementation(() => {
+        return {
+            // mock getOAuthHeader
+            getOBPClientConfig: vi.fn(() => ({baseUri: 'https://test.openbankproject.com'})),
+            getOAuthHeader: mockGetOAuthHeader,
+            getDirectLoginToken: mockGetDirectLoginToken,
+        }
+      }),
+    }
+})
+
+import OBPConsentsService from '../services/OBPConsentsService';
+
+describe('OBPConsentsService.createConsentClient', () => {
+    let obpConsentsService: OBPConsentsService;
+    let mockedOAuthHeaders: string;
+
+    beforeEach(async () => {
+        
+        vi.clearAllMocks();
+
+        mockGetOAuthHeader.mockImplementation(async () => `OAuth oauth_consumer_key="jgaawf2fnj4yixqdsfaq4gipt4v1wvgsxgre",oauth_nonce="JiGDBWA3MAyKtsd9qkfWCxfju36bMjsA",oauth_signature_method="HMAC-SHA1",oauth_timestamp="1741364123",oauth_version="1.0",oauth_signature="sa%2FRylnsdfLK8VPZI%2F2WkGFlTKs%3D"`);
+        // Mock the OBP Client service for getting the OAuth and direct login headers
+        obpConsentsService = new OBPConsentsService();
+    });
+
+    it('should return a ConsentApi client for logged in user', async () => {
+        const consentClient = await obpConsentsService.createConsentClient('/consents', 'POST', 'logged_in_user');
+        expect(consentClient).toBeDefined();
+        expect(obpConsentsService.consentsClient).toBe(consentClient);
+        expect(consentClient).toBeInstanceOf(ConsentApi);
+    })
+
+    it('should return a ConsentApi client for API Explorer', async () => {
+        const consentClient = await obpConsentsService.createConsentClient('/consents', 'POST', 'API_Explorer');
+        expect(consentClient).toBeDefined();
+        expect(obpConsentsService.consentsClient).toBe(consentClient);
+        expect(consentClient).toBeInstanceOf(ConsentApi);
+    })
+
+    it('should throw an error if the client type is not recognized', async () => {
+        await expect(obpConsentsService.createConsentClient('/consents', 'POST', 'unknown')).rejects.toThrow();
+    })
+
+    it('should throw correct error if OBPClientService.getOAuthHeader fails for logged in user', async () => {
+
+        mockGetOAuthHeader.mockImplementationOnce(async () => {
+            throw new Error('OAuth header error');
+        });
+
+        await expect(obpConsentsService.createConsentClient('/consents', 'POST', 'logged_in_user'))
+            .rejects.toThrow(`Could not create Consents API client for logged in user, Error: OAuth header error`);
+    })
+
+    it('should throw correct error if OBPClientService.getDirectLoginToken fails for API Explorer', async () => {
+
+        mockGetDirectLoginToken.mockImplementationOnce(async () => {
+            throw new Error('Direct login token error');
+        });
+
+        await expect(obpConsentsService.createConsentClient('/consents', 'POST', 'API_Explorer'))
+            .rejects.toThrow(`Could not create Consents API client for API Explorer, Error: Direct login token error`);
+    })
+})

server/test/opey-controller.test.ts

@@ -133,7 +133,6 @@ describe('OpeyController consents flow', () => {
     let opeyController: OpeyController
 
     beforeAll(() => {
-
         mockOBPClientService = {
             get: vi.fn(async () => {
                 Promise.resolve({})