From 1e9a8c4b94cf1d7eff6f552e024f125c56b8e925 Mon Sep 17 00:00:00 2001
From: Konstantin Tsabolov <konstantin.tsabolov@spherity.com>
Date: Mon, 18 Dec 2023 15:25:22 +0100
Subject: [PATCH] feat(credential-manager): add credential offers module
---
apps/credential-manager/src/application.ts | 26 ++-
.../src/common/constants.ts | 2 +
.../credential-offers.controller.spec.ts | 88 ++++++++++
.../credential-offers.module.spec.ts | 41 +++++
.../credential-offers.service.spec.ts | 91 +++++++++++
.../credential-offers.controller.ts | 154 ++++++++++++++++++
.../credential-offers.module.ts | 10 ++
.../credential-offers.service.ts | 42 +++++
.../credential-offers/dto/get-by-id.dto.ts | 12 ++
9 files changed, 465 insertions(+), 1 deletion(-)
create mode 100644 apps/credential-manager/src/credential-offers/__tests__/credential-offers.controller.spec.ts
create mode 100644 apps/credential-manager/src/credential-offers/__tests__/credential-offers.module.spec.ts
create mode 100644 apps/credential-manager/src/credential-offers/__tests__/credential-offers.service.spec.ts
create mode 100644 apps/credential-manager/src/credential-offers/credential-offers.controller.ts
create mode 100644 apps/credential-manager/src/credential-offers/credential-offers.module.ts
create mode 100644 apps/credential-manager/src/credential-offers/credential-offers.service.ts
create mode 100644 apps/credential-manager/src/credential-offers/dto/get-by-id.dto.ts
diff --git a/apps/credential-manager/src/application.ts b/apps/credential-manager/src/application.ts
index fb1bd0e..c0ad214 100644
--- a/apps/credential-manager/src/application.ts
+++ b/apps/credential-manager/src/application.ts
@@ -3,12 +3,15 @@ import type { ConfigType } from '@nestjs/config';
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { RouterModule } from '@nestjs/core';
+import { ClientsModule, Transport } from '@nestjs/microservices';
import { HealthModule } from '@ocm/shared';
+import { NATS_CLIENT } from './common/constants.js';
import { httpConfig } from './config/http.config.js';
import { natsConfig } from './config/nats.config.js';
import { ssiConfig } from './config/ssi.config.js';
import { validationSchema } from './config/validation.js';
+import { CredentialOffersModule } from './credential-offers/credential-offers.module.js';
@Module({
imports: [
@@ -24,6 +27,22 @@ import { validationSchema } from './config/validation.js';
},
}),
+ ClientsModule.registerAsync({
+ isGlobal: true,
+ clients: [
+ {
+ name: NATS_CLIENT,
+ inject: [natsConfig.KEY],
+ useFactory: (config: ConfigType<typeof natsConfig>) => ({
+ transport: Transport.NATS,
+ options: {
+ url: config.url as string,
+ },
+ }),
+ },
+ ],
+ }),
+
HealthModule.registerAsync({
inject: [natsConfig.KEY],
useFactory: (config: ConfigType<typeof natsConfig>) => {
@@ -39,7 +58,12 @@ import { validationSchema } from './config/validation.js';
},
}),
- RouterModule.register([{ module: HealthModule, path: '/health' }]),
+ CredentialOffersModule,
+
+ RouterModule.register([
+ { module: HealthModule, path: '/health' },
+ { module: CredentialOffersModule, path: '/credential-offers' },
+ ]),
],
})
export class Application {}
diff --git a/apps/credential-manager/src/common/constants.ts b/apps/credential-manager/src/common/constants.ts
index bad6a5f..d8529df 100644
--- a/apps/credential-manager/src/common/constants.ts
+++ b/apps/credential-manager/src/common/constants.ts
@@ -1 +1,3 @@
export const SERVICE_NAME = 'CREDENTIAL_MANAGER_SERVICE';
+
+export const NATS_CLIENT = Symbol('NATS_CLIENT');
diff --git a/apps/credential-manager/src/credential-offers/__tests__/credential-offers.controller.spec.ts b/apps/credential-manager/src/credential-offers/__tests__/credential-offers.controller.spec.ts
new file mode 100644
index 0000000..99f6dba
--- /dev/null
+++ b/apps/credential-manager/src/credential-offers/__tests__/credential-offers.controller.spec.ts
@@ -0,0 +1,88 @@
+import type { TestingModule } from '@nestjs/testing';
+import type {
+ EventAnonCredsCredentialOfferGetAll,
+ EventAnonCredsCredentialOfferGetById,
+} from '@ocm/shared';
+
+import { Test } from '@nestjs/testing';
+import { Subject, of, takeUntil } from 'rxjs';
+
+import { NATS_CLIENT } from '../../common/constants.js';
+import { CredentialOffersController } from '../credential-offers.controller.js';
+import { CredentialOffersService } from '../credential-offers.service.js';
+
+describe('CredentialOffersController', () => {
+ const natsClientMock = {};
+
+ let controller: CredentialOffersController;
+ let service: CredentialOffersService;
+
+ beforeEach(async () => {
+ const module: TestingModule = await Test.createTestingModule({
+ controllers: [CredentialOffersController],
+ providers: [
+ { provide: NATS_CLIENT, useValue: natsClientMock },
+ CredentialOffersService,
+ ],
+ }).compile();
+
+ controller = module.get<CredentialOffersController>(
+ CredentialOffersController,
+ );
+ service = module.get<CredentialOffersService>(CredentialOffersService);
+ });
+
+ describe('find', () => {
+ it('should return a list of credential offers', (done) => {
+ const unsubscribe$ = new Subject<void>();
+ const tenantId = 'exampleTenantId';
+ const expectedResult: EventAnonCredsCredentialOfferGetAll['data'] = [];
+
+ jest
+ .spyOn(service, 'findCredentialOffers')
+ .mockReturnValueOnce(of(expectedResult));
+
+ controller
+ .find({ tenantId })
+ .pipe(takeUntil(unsubscribe$))
+ .subscribe((result) => {
+ expect(result).toStrictEqual(expectedResult);
+
+ unsubscribe$.next();
+ unsubscribe$.complete();
+
+ done();
+ });
+ });
+ });
+
+ describe('getById', () => {
+ it('should return a credential offer', (done) => {
+ const unsubscribe$ = new Subject<void>();
+ const tenantId = 'exampleTenantId';
+ const credentialOfferId = 'exampleCredentialOfferId';
+ const expectedResult: EventAnonCredsCredentialOfferGetById['data'] = {
+ cred_def_id: 'exampleCredDefId',
+ key_correctness_proof: {},
+ nonce: 'exampleNonce',
+ schema_id: 'exampleSchemaId',
+ };
+
+ jest
+ .spyOn(service, 'getCredentialOfferById')
+ .mockReturnValueOnce(of(expectedResult));
+
+ controller
+ .getById({ credentialOfferId }, { tenantId })
+ .pipe(takeUntil(unsubscribe$))
+ .subscribe((result) => {
+ expect(result).toStrictEqual(expectedResult);
+
+ unsubscribe$.next();
+ unsubscribe$.complete();
+
+ done();
+ });
+ });
+ });
+});
diff --git a/apps/credential-manager/src/credential-offers/__tests__/credential-offers.module.spec.ts b/apps/credential-manager/src/credential-offers/__tests__/credential-offers.module.spec.ts
new file mode 100644
index 0000000..470ed9e
--- /dev/null
+++ b/apps/credential-manager/src/credential-offers/__tests__/credential-offers.module.spec.ts
@@ -0,0 +1,41 @@
+import { ClientsModule } from '@nestjs/microservices';
+import { Test } from '@nestjs/testing';
+
+import { NATS_CLIENT } from '../../common/constants.js';
+import { CredentialOffersController } from '../credential-offers.controller.js';
+import { CredentialOffersModule } from '../credential-offers.module.js';
+import { CredentialOffersService } from '../credential-offers.service.js';
+
+describe('CredentialOffersModule', () => {
+ let credentialOffersController: CredentialOffersController;
+ let credentialOffersService: CredentialOffersService;
+
+ beforeEach(async () => {
+ const moduleRef = await Test.createTestingModule({
+ imports: [
+ ClientsModule.registerAsync({
+ isGlobal: true,
+ clients: [{ name: NATS_CLIENT, useFactory: () => ({}) }],
+ }),
+ CredentialOffersModule,
+ ],
+ }).compile();
+
+ credentialOffersController = moduleRef.get<CredentialOffersController>(
+ CredentialOffersController,
+ );
+ credentialOffersService = moduleRef.get<CredentialOffersService>(
+ CredentialOffersService,
+ );
+ });
+
+ it('should be defined', () => {
+ expect(credentialOffersController).toBeDefined();
+ expect(credentialOffersController).toBeInstanceOf(
+ CredentialOffersController,
+ );
+
+ expect(credentialOffersService).toBeDefined();
+ expect(credentialOffersService).toBeInstanceOf(CredentialOffersService);
+ });
+});
diff --git a/apps/credential-manager/src/credential-offers/__tests__/credential-offers.service.spec.ts b/apps/credential-manager/src/credential-offers/__tests__/credential-offers.service.spec.ts
new file mode 100644
index 0000000..d568df6
--- /dev/null
+++ b/apps/credential-manager/src/credential-offers/__tests__/credential-offers.service.spec.ts
@@ -0,0 +1,91 @@
+import type { TestingModule } from '@nestjs/testing';
+
+import { Test } from '@nestjs/testing';
+import {
+ EventAnonCredsCredentialOfferGetAll,
+ EventAnonCredsCredentialOfferGetById,
+} from '@ocm/shared';
+import { Subject, of, takeUntil } from 'rxjs';
+
+import { NATS_CLIENT } from '../../common/constants.js';
+import { CredentialOffersService } from '../credential-offers.service.js';
+
+describe('CredentialOffersService', () => {
+ const natsClientMock = { send: jest.fn() };
+ let service: CredentialOffersService;
+
+ beforeEach(async () => {
+ const module: TestingModule = await Test.createTestingModule({
+ providers: [
+ { provide: NATS_CLIENT, useValue: natsClientMock },
+ CredentialOffersService,
+ ],
+ }).compile();
+
+ service = module.get<CredentialOffersService>(CredentialOffersService);
+ });
+
+ describe('findCredentialOffers', () => {
+ it('should call natsClient.send with the correct arguments', (done) => {
+ const unsubscribe$ = new Subject<void>();
+ const tenantId = 'tenantId';
+ const expectedResult: EventAnonCredsCredentialOfferGetAll['data'] = [];
+
+ natsClientMock.send.mockReturnValueOnce(
+ of(new EventAnonCredsCredentialOfferGetAll(expectedResult, tenantId)),
+ );
+
+ service
+ .findCredentialOffers(tenantId)
+ .pipe(takeUntil(unsubscribe$))
+ .subscribe((result) => {
+ expect(natsClientMock.send).toHaveBeenCalledWith(
+ EventAnonCredsCredentialOfferGetAll.token,
+ { tenantId },
+ );
+
+ expect(result).toStrictEqual(expectedResult);
+
+ unsubscribe$.next();
+ unsubscribe$.complete();
+
+ done();
+ });
+ });
+ });
+
+ describe('getCredentialOfferById', () => {
+ it('should call natsClient.send with the correct arguments', (done) => {
+ const unsubscribe$ = new Subject<void>();
+ const tenantId = 'tenantId';
+ const credentialOfferId = 'id';
+ const expectedResult: EventAnonCredsCredentialOfferGetById['data'] = {
+ cred_def_id: 'exampleCredDefId',
+ key_correctness_proof: {},
+ nonce: 'exampleNonce',
+ schema_id: 'exampleSchemaId',
+ };
+
+ natsClientMock.send.mockReturnValueOnce(
+ of(new EventAnonCredsCredentialOfferGetById(expectedResult, tenantId)),
+ );
+
+ service
+ .getCredentialOfferById(tenantId, credentialOfferId)
+ .pipe(takeUntil(unsubscribe$))
+ .subscribe((result) => {
+ expect(natsClientMock.send).toHaveBeenCalledWith(
+ EventAnonCredsCredentialOfferGetById.token,
+ { tenantId, credentialOfferId },
+ );
+
+ expect(result).toStrictEqual(expectedResult);
+
+ unsubscribe$.next();
+ unsubscribe$.complete();
+
+ done();
+ });
+ });
+ });
+});
diff --git a/apps/credential-manager/src/credential-offers/credential-offers.controller.ts b/apps/credential-manager/src/credential-offers/credential-offers.controller.ts
new file mode 100644
index 0000000..882d08a
--- /dev/null
+++ b/apps/credential-manager/src/credential-offers/credential-offers.controller.ts
@@ -0,0 +1,154 @@
+import {
+ Controller,
+ Get,
+ HttpStatus,
+ Param,
+ Query,
+ UseInterceptors,
+ UsePipes,
+ ValidationPipe,
+} from '@nestjs/common';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { MultitenancyParams, ResponseFormatInterceptor } from '@ocm/shared';
+
+import { CredentialOffersService } from './credential-offers.service.js';
+import { GetByIdParams } from './dto/get-by-id.dto.js';
+
+@Controller()
+@UsePipes(new ValidationPipe({ transform: true, whitelist: true }))
+@UseInterceptors(ResponseFormatInterceptor)
+@ApiTags('Credential Offers')
+export class CredentialOffersController {
+ public constructor(private readonly service: CredentialOffersService) {}
+
+ @Get()
+ @ApiOperation({
+ summary: 'Fetch a list of credential offers',
+ description:
+ 'This call provides a list of credential offers for a given tenant',
+ })
+ @ApiResponse({
+ status: HttpStatus.OK,
+ description: 'Credential offers fetched successfully',
+ content: {
+ 'application/json': {
+ schema: {},
+ examples: {
+ 'Credential offers fetched successfully': {
+ value: {
+ statusCode: 200,
+ message: 'Credential offers fetched successfully',
+ data: [
+ {
+ id: '71b784a3',
+ },
+ ],
+ },
+ },
+ 'Tenant not found': {
+ value: {
+ statusCode: 404,
+ message: 'Tenant not found',
+ data: null,
+ },
+ },
+ },
+ },
+ },
+ })
+ @ApiResponse({
+ status: HttpStatus.INTERNAL_SERVER_ERROR,
+ description: 'Something went wrong',
+ content: {
+ 'application/json': {
+ schema: {},
+ examples: {
+ 'Something went wrong': {
+ value: {
+ statusCode: 500,
+ message: 'Something went wrong',
+ error: 'Internal Server Error',
+ },
+ },
+ },
+ },
+ },
+ })
+ public find(@Query() { tenantId }: MultitenancyParams) {
+ return this.service.findCredentialOffers(tenantId);
+ }
+
+ @Get(':credentialOfferId')
+ @ApiOperation({
+ summary: 'Fetch a credential offer by ID',
+ description: 'This call provides a credential offer for a given ID',
+ })
+ @ApiResponse({
+ status: HttpStatus.OK,
+ description: 'Credential offer fetched successfully',
+ content: {
+ 'application/json': {
+ schema: {},
+ examples: {
+ 'Credential offer fetched successfully': {
+ value: {
+ statusCode: 200,
+ message: 'Credential offer fetched successfully',
+ data: {
+ id: '71b784a3',
+ },
+ },
+ },
+ },
+ },
+ },
+ })
+ @ApiResponse({
+ status: HttpStatus.NOT_FOUND,
+ content: {
+ 'application/json': {
+ schema: {},
+ examples: {
+ 'Credential offer not found': {
+ value: {
+ statusCode: 404,
+ message: 'Credential offer not found',
+ data: null,
+ },
+ },
+ 'Tenant not found': {
+ value: {
+ statusCode: 404,
+ message: 'Tenant not found',
+ data: null,
+ },
+ },
+ },
+ },
+ },
+ })
+ @ApiResponse({
+ status: HttpStatus.INTERNAL_SERVER_ERROR,
+ description: 'Something went wrong',
+ content: {
+ 'application/json': {
+ schema: {},
+ examples: {
+ 'Something went wrong': {
+ value: {
+ statusCode: 500,
+ message: 'Something went wrong',
+ error: 'Internal Server Error',
+ },
+ },
+ },
+ },
+ },
+ })
+ public getById(
+ @Param() { credentialOfferId }: GetByIdParams,
+ @Query() { tenantId }: MultitenancyParams,
+ ) {
+ return this.service.getCredentialOfferById(tenantId, credentialOfferId);
+ }
+}
diff --git a/apps/credential-manager/src/credential-offers/credential-offers.module.ts b/apps/credential-manager/src/credential-offers/credential-offers.module.ts
new file mode 100644
index 0000000..2b42e4c
--- /dev/null
+++ b/apps/credential-manager/src/credential-offers/credential-offers.module.ts
@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+
+import { CredentialOffersController } from './credential-offers.controller.js';
+import { CredentialOffersService } from './credential-offers.service.js';
+
+@Module({
+ providers: [CredentialOffersService],
+ controllers: [CredentialOffersController],
+})
+export class CredentialOffersModule {}
diff --git a/apps/credential-manager/src/credential-offers/credential-offers.service.ts b/apps/credential-manager/src/credential-offers/credential-offers.service.ts
new file mode 100644
index 0000000..30c3ff6
--- /dev/null
+++ b/apps/credential-manager/src/credential-offers/credential-offers.service.ts
@@ -0,0 +1,42 @@
+import type {
+ EventAnonCredsCredentialOfferGetAllInput,
+ EventAnonCredsCredentialOfferGetByIdInput,
+} from '@ocm/shared';
+
+import { Inject, Injectable } from '@nestjs/common';
+import { ClientProxy } from '@nestjs/microservices';
+import {
+ EventAnonCredsCredentialOfferGetAll,
+ EventAnonCredsCredentialOfferGetById,
+} from '@ocm/shared';
+import { map } from 'rxjs';
+
+import { NATS_CLIENT } from '../common/constants.js';
+
+@Injectable()
+export class CredentialOffersService {
+ public constructor(
+ @Inject(NATS_CLIENT) private readonly natsClient: ClientProxy,
+ ) {}
+
+ public findCredentialOffers(tenantId: string) {
+ return this.natsClient
+ .send<
+ EventAnonCredsCredentialOfferGetAll,
+ EventAnonCredsCredentialOfferGetAllInput
+ >(EventAnonCredsCredentialOfferGetAll.token, { tenantId })
+ .pipe(map(({ data }) => data));
+ }
+
+ public getCredentialOfferById(tenantId: string, credentialOfferId: string) {
+ return this.natsClient
+ .send<
+ EventAnonCredsCredentialOfferGetById,
+ EventAnonCredsCredentialOfferGetByIdInput
+ >(EventAnonCredsCredentialOfferGetById.token, {
+ tenantId,
+ credentialOfferId,
+ })
+ .pipe(map(({ data }) => data));
+ }
+}
diff --git a/apps/credential-manager/src/credential-offers/dto/get-by-id.dto.ts b/apps/credential-manager/src/credential-offers/dto/get-by-id.dto.ts
new file mode 100644
index 0000000..26cdc1b
--- /dev/null
+++ b/apps/credential-manager/src/credential-offers/dto/get-by-id.dto.ts
@@ -0,0 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class GetByIdParams {
+ @IsString()
+ @IsNotEmpty()
+ @ApiProperty({
+ description: 'The credential offer ID to retrieve',
+ format: 'string',
+ })
+ public credentialOfferId: string;
+}
--
GitLab