Refactor shared constants

narval-xyz · Nov 13, 2024 · 81771de · 81771de
1 parent 183737e
commit 81771de
Show file tree

Hide file tree

Showing 25 changed files with 53 additions and 46 deletions.
diff --git a/apps/armory/src/armory.constant.ts b/apps/armory/src/armory.constant.ts
@@ -1,4 +1,10 @@
-import { adminApiKeySecurity, clientIdSecurity, clientSecretSecurity } from '@narval/nestjs-shared'
+import {
+  REQUEST_HEADER_CLIENT_ID,
+  REQUEST_HEADER_CLIENT_SECRET,
+  adminApiKeySecurity,
+  clientIdSecurity,
+  clientSecretSecurity
+} from '@narval/nestjs-shared'
 import { AssetId } from '@narval/policy-engine-shared'
 import { ClassSerializerInterceptor, ValidationPipe } from '@nestjs/common'
 import { APP_FILTER, APP_INTERCEPTOR, APP_PIPE } from '@nestjs/core'
@@ -49,8 +55,6 @@ export const DEFAULT_HTTP_MODULE_PROVIDERS = [
 // Headers
 //
 
-export const REQUEST_HEADER_CLIENT_ID = 'x-client-id'
-export const REQUEST_HEADER_CLIENT_SECRET = 'x-client-secret'
 export const REQUEST_HEADER_API_KEY = 'x-api-key'
 
 //

diff --git a/apps/armory/src/managed-data-store/shared/guard/data-store.guard.ts b/apps/armory/src/managed-data-store/shared/guard/data-store.guard.ts
@@ -1,6 +1,5 @@
-import { secret } from '@narval/nestjs-shared'
+import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET, secret } from '@narval/nestjs-shared'
 import { CanActivate, ExecutionContext, HttpStatus, Injectable } from '@nestjs/common'
-import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET } from '../../../armory.constant'
 import { ClientService } from '../../../client/core/service/client.service'
 import { ApplicationException } from '../../../shared/exception/application.exception'
 

diff --git a/apps/armory/src/shared/decorator/__test__/unit/client-id.decorator.spec.ts b/apps/armory/src/shared/decorator/__test__/unit/client-id.decorator.spec.ts
@@ -1,5 +1,5 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { ExecutionContext } from '@nestjs/common'
-import { REQUEST_HEADER_CLIENT_ID } from '../../../../armory.constant'
 import { factory } from '../../../decorator/client-id.decorator'
 
 describe('clientId Decorator', () => {

diff --git a/apps/armory/src/shared/decorator/api-client-id-guard.decorator.ts b/apps/armory/src/shared/decorator/api-client-id-guard.decorator.ts
@@ -1,6 +1,7 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { UseGuards, applyDecorators } from '@nestjs/common'
 import { ApiHeader, ApiSecurity } from '@nestjs/swagger'
-import { CLIENT_ID_SECURITY, REQUEST_HEADER_CLIENT_ID } from '../../armory.constant'
+import { CLIENT_ID_SECURITY } from '../../armory.constant'
 import { ClientIdGuard } from '../guard/client-id.guard'
 
 export function ApiClientIdGuard() {

diff --git a/apps/armory/src/shared/decorator/client-id.decorator.ts b/apps/armory/src/shared/decorator/client-id.decorator.ts
@@ -1,5 +1,5 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { BadRequestException, ExecutionContext, createParamDecorator } from '@nestjs/common'
-import { REQUEST_HEADER_CLIENT_ID } from '../../armory.constant'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const factory = (value: any, ctx: ExecutionContext) => {

diff --git a/apps/armory/src/shared/guard/client-id.guard.ts b/apps/armory/src/shared/guard/client-id.guard.ts
@@ -1,5 +1,5 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { CanActivate, ExecutionContext, HttpStatus, Injectable } from '@nestjs/common'
-import { REQUEST_HEADER_CLIENT_ID } from '../../armory.constant'
 import { ClientService } from '../../client/core/service/client.service'
 import { ApplicationException } from '../exception/application.exception'
 

diff --git a/apps/armory/src/shared/guard/client-secret.guard.ts b/apps/armory/src/shared/guard/client-secret.guard.ts
@@ -1,6 +1,5 @@
-import { secret } from '@narval/nestjs-shared'
+import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET, secret } from '@narval/nestjs-shared'
 import { CanActivate, ExecutionContext, HttpStatus, Injectable } from '@nestjs/common'
-import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET } from '../../armory.constant'
 import { ClientService } from '../../client/core/service/client.service'
 import { ApplicationException } from '../exception/application.exception'
 

diff --git a/apps/policy-engine/src/engine/__test__/e2e/client.spec.ts b/apps/policy-engine/src/engine/__test__/e2e/client.spec.ts
@@ -1,6 +1,12 @@
 import { ConfigModule, ConfigService } from '@narval/config-module'
 import { EncryptionModuleOptionProvider } from '@narval/encryption-module'
-import { LoggerModule, OpenTelemetryModule, secret } from '@narval/nestjs-shared'
+import {
+  LoggerModule,
+  OpenTelemetryModule,
+  REQUEST_HEADER_CLIENT_ID,
+  REQUEST_HEADER_CLIENT_SECRET,
+  secret
+} from '@narval/nestjs-shared'
 import { DataStoreConfiguration, HttpSource, SourceType } from '@narval/policy-engine-shared'
 import {
   PrivateKey,
@@ -14,11 +20,7 @@ import request from 'supertest'
 import { v4 as uuid } from 'uuid'
 import { generatePrivateKey } from 'viem/accounts'
 import { Config, load } from '../../../policy-engine.config'
-import {
-  REQUEST_HEADER_API_KEY,
-  REQUEST_HEADER_CLIENT_ID,
-  REQUEST_HEADER_CLIENT_SECRET
-} from '../../../policy-engine.constant'
+import { REQUEST_HEADER_API_KEY } from '../../../policy-engine.constant'
 import { TestPrismaService } from '../../../shared/module/persistence/service/test-prisma.service'
 import { getTestRawAesKeyring } from '../../../shared/testing/encryption.testing'
 import { Client } from '../../../shared/type/domain.type'

diff --git a/apps/policy-engine/src/engine/__test__/e2e/evaluation.spec.ts b/apps/policy-engine/src/engine/__test__/e2e/evaluation.spec.ts
@@ -1,6 +1,11 @@
 import { ConfigModule, ConfigService } from '@narval/config-module'
 import { EncryptionModuleOptionProvider } from '@narval/encryption-module'
-import { LoggerModule, OpenTelemetryModule } from '@narval/nestjs-shared'
+import {
+  LoggerModule,
+  OpenTelemetryModule,
+  REQUEST_HEADER_CLIENT_ID,
+  REQUEST_HEADER_CLIENT_SECRET
+} from '@narval/nestjs-shared'
 import {
   Action,
   Criterion,
@@ -24,7 +29,6 @@ import { generatePrivateKey } from 'viem/accounts'
 import { sepolia } from 'viem/chains'
 import { EngineService } from '../../../engine/core/service/engine.service'
 import { Config, load } from '../../../policy-engine.config'
-import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET } from '../../../policy-engine.constant'
 import { KeyValueRepository } from '../../../shared/module/key-value/core/repository/key-value.repository'
 import { InMemoryKeyValueRepository } from '../../../shared/module/key-value/persistence/repository/in-memory-key-value.repository'
 import { TestPrismaService } from '../../../shared/module/persistence/service/test-prisma.service'

diff --git a/apps/policy-engine/src/policy-engine.constant.ts b/apps/policy-engine/src/policy-engine.constant.ts
@@ -1,13 +1,17 @@
 import { RawAesWrappingSuiteIdentifier } from '@aws-crypto/client-node'
-import { adminApiKeySecurity, clientIdSecurity, clientSecretSecurity } from '@narval/nestjs-shared'
+import {
+  REQUEST_HEADER_CLIENT_ID,
+  REQUEST_HEADER_CLIENT_SECRET,
+  adminApiKeySecurity,
+  clientIdSecurity,
+  clientSecretSecurity
+} from '@narval/nestjs-shared'
 
 //
 // Headers
 //
 
 export const REQUEST_HEADER_API_KEY = 'x-api-key'
-export const REQUEST_HEADER_CLIENT_ID = 'x-client-id'
-export const REQUEST_HEADER_CLIENT_SECRET = 'x-client-secret'
 export const REQUEST_HEADER_SESSION_ID = 'x-session-id'
 
 //
@@ -23,7 +27,7 @@ export const ENCRYPTION_WRAPPING_SUITE = RawAesWrappingSuiteIdentifier.AES256_GC
 //
 
 export const ADMIN_SECURITY = adminApiKeySecurity(REQUEST_HEADER_API_KEY)
-export const CLIENT_ID_SECURITY = clientIdSecurity(REQUEST_HEADER_CLIENT_SECRET)
+export const CLIENT_ID_SECURITY = clientIdSecurity(REQUEST_HEADER_CLIENT_ID)
 export const CLIENT_SECRET_SECURITY = clientSecretSecurity(REQUEST_HEADER_CLIENT_SECRET)
 
 //

diff --git a/apps/policy-engine/src/shared/decorator/__test__/unit/client-id.decorator.spec.ts b/apps/policy-engine/src/shared/decorator/__test__/unit/client-id.decorator.spec.ts
@@ -1,5 +1,5 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { ExecutionContext } from '@nestjs/common'
-import { REQUEST_HEADER_CLIENT_ID } from '../../../../policy-engine.constant'
 import { factory } from '../../client-id.decorator'
 
 describe('ClientId Decorator', () => {

diff --git a/apps/policy-engine/src/shared/decorator/client-guard.decorator.ts b/apps/policy-engine/src/shared/decorator/client-guard.decorator.ts
@@ -1,11 +1,7 @@
+import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET } from '@narval/nestjs-shared'
 import { UseGuards, applyDecorators } from '@nestjs/common'
 import { ApiHeader, ApiSecurity } from '@nestjs/swagger'
-import {
-  CLIENT_ID_SECURITY,
-  CLIENT_SECRET_SECURITY,
-  REQUEST_HEADER_CLIENT_ID,
-  REQUEST_HEADER_CLIENT_SECRET
-} from '../../policy-engine.constant'
+import { CLIENT_ID_SECURITY, CLIENT_SECRET_SECURITY } from '../../policy-engine.constant'
 import { ClientSecretGuard } from '../guard/client-secret.guard'
 
 export function ClientGuard() {

diff --git a/apps/policy-engine/src/shared/guard/__test__/unit/client-secret.guard.spec.ts b/apps/policy-engine/src/shared/guard/__test__/unit/client-secret.guard.spec.ts
@@ -1,11 +1,10 @@
-import { secret } from '@narval/nestjs-shared'
+import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET, secret } from '@narval/nestjs-shared'
 import { HttpSource, SourceType } from '@narval/policy-engine-shared'
 import { Alg, privateKeyToJwk } from '@narval/signature'
 import { ExecutionContext } from '@nestjs/common'
 import { mock } from 'jest-mock-extended'
 import { generatePrivateKey } from 'viem/accounts'
 import { ClientService } from '../../../../engine/core/service/client.service'
-import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET } from '../../../../policy-engine.constant'
 import { ApplicationException } from '../../../exception/application.exception'
 import { Client } from '../../../type/domain.type'
 import { ClientSecretGuard } from '../../client-secret.guard'

diff --git a/apps/policy-engine/src/shared/guard/client-secret.guard.ts b/apps/policy-engine/src/shared/guard/client-secret.guard.ts
@@ -1,7 +1,6 @@
-import { secret } from '@narval/nestjs-shared'
+import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET, secret } from '@narval/nestjs-shared'
 import { CanActivate, ExecutionContext, HttpStatus, Injectable } from '@nestjs/common'
 import { ClientService } from '../../engine/core/service/client.service'
-import { REQUEST_HEADER_CLIENT_ID, REQUEST_HEADER_CLIENT_SECRET } from '../../policy-engine.constant'
 import { ApplicationException } from '../exception/application.exception'
 
 @Injectable()

diff --git a/apps/vault/src/main.constant.ts b/apps/vault/src/main.constant.ts
@@ -2,7 +2,6 @@ import { RawAesWrappingSuiteIdentifier } from '@aws-crypto/client-node'
 import { adminApiKeySecurity, gnapSecurity } from '@narval/nestjs-shared'
 
 export const REQUEST_HEADER_API_KEY = 'x-api-key'
-export const REQUEST_HEADER_CLIENT_ID = 'x-client-id'
 export const REQUEST_HEADER_AUTHORIZATION = 'Authorization'
 
 export const ENCRYPTION_KEY_NAMESPACE = 'armory.vault'

diff --git a/apps/vault/src/shared/decorator/client-id.decorator.ts b/apps/vault/src/shared/decorator/client-id.decorator.ts
@@ -1,5 +1,5 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { createParamDecorator, ExecutionContext } from '@nestjs/common'
-import { REQUEST_HEADER_CLIENT_ID } from '../../main.constant'
 
 export const ClientId = createParamDecorator((_data: unknown, context: ExecutionContext): string => {
   const req = context.switchToHttp().getRequest()

diff --git a/apps/vault/src/shared/guard/__test__/unit/nonce.guard.spec.ts b/apps/vault/src/shared/guard/__test__/unit/nonce.guard.spec.ts
@@ -1,8 +1,8 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { ExecutionContext } from '@nestjs/common'
 import { Test } from '@nestjs/testing'
 import { Request } from 'express'
 import { MockProxy, mock } from 'jest-mock-extended'
-import { REQUEST_HEADER_CLIENT_ID } from '../../../../main.constant'
 import { NonceService } from '../../../../vault/core/service/nonce.service'
 import { ApplicationException } from '../../../exception/application.exception'
 import { NonceGuard } from '../../nonce.guard'

diff --git a/apps/vault/src/shared/guard/authorization.guard.ts b/apps/vault/src/shared/guard/authorization.guard.ts
@@ -1,11 +1,11 @@
 import { ConfigService } from '@narval/config-module'
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { JwtVerifyOptions, publicKeySchema, verifyJwsd, verifyJwt } from '@narval/signature'
 import { CanActivate, ExecutionContext, HttpStatus, Injectable } from '@nestjs/common'
 import { Reflector } from '@nestjs/core'
 import { z } from 'zod'
 import { ClientService } from '../../client/core/service/client.service'
 import { Config } from '../../main.config'
-import { REQUEST_HEADER_CLIENT_ID } from '../../main.constant'
 import { PermissionGuard } from '../decorator/permission-guard.decorator'
 import { ApplicationException } from '../exception/application.exception'
 import { Client } from '../type/domain.type'

diff --git a/apps/vault/src/shared/guard/nonce.guard.ts b/apps/vault/src/shared/guard/nonce.guard.ts
@@ -1,7 +1,7 @@
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { CanActivate, ExecutionContext, HttpStatus, Injectable } from '@nestjs/common'
 import { Request } from 'express'
 import { get } from 'lodash/fp'
-import { REQUEST_HEADER_CLIENT_ID } from '../../main.constant'
 import { NonceService } from '../../vault/core/service/nonce.service'
 import { ApplicationException } from '../exception/application.exception'
 

diff --git a/apps/vault/src/vault/http/rest/controller/account.controller.ts b/apps/vault/src/vault/http/rest/controller/account.controller.ts
@@ -1,7 +1,7 @@
 import { Permission } from '@narval/armory-sdk'
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { Body, Controller, Get, HttpStatus, Post } from '@nestjs/common'
 import { ApiHeader, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger'
-import { REQUEST_HEADER_CLIENT_ID } from '../../../../main.constant'
 import { ClientId } from '../../../../shared/decorator/client-id.decorator'
 import { PermissionGuard } from '../../../../shared/decorator/permission-guard.decorator'
 import { ApplicationException } from '../../../../shared/exception/application.exception'

diff --git a/apps/vault/src/vault/http/rest/controller/encryption-key.controller.ts b/apps/vault/src/vault/http/rest/controller/encryption-key.controller.ts
@@ -1,7 +1,7 @@
 import { Permission } from '@narval/armory-sdk'
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { Controller, HttpStatus, Post } from '@nestjs/common'
 import { ApiHeader, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger'
-import { REQUEST_HEADER_CLIENT_ID } from '../../../../main.constant'
 import { ClientId } from '../../../../shared/decorator/client-id.decorator'
 import { PermissionGuard } from '../../../../shared/decorator/permission-guard.decorator'
 import { ImportService } from '../../../core/service/import.service'

diff --git a/apps/vault/src/vault/http/rest/controller/sign.controller.ts b/apps/vault/src/vault/http/rest/controller/sign.controller.ts
@@ -1,8 +1,7 @@
-import { ApiGnapSecurity } from '@narval/nestjs-shared'
+import { ApiGnapSecurity, REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { SignableRequest } from '@narval/policy-engine-shared'
 import { Body, Controller, HttpStatus, Post, UseGuards } from '@nestjs/common'
 import { ApiHeader, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger'
-import { REQUEST_HEADER_CLIENT_ID } from '../../../../main.constant'
 import { ClientId } from '../../../../shared/decorator/client-id.decorator'
 import { AuthorizationGuard } from '../../../../shared/guard/authorization.guard'
 import { NonceGuard } from '../../../../shared/guard/nonce.guard'

diff --git a/apps/vault/src/vault/http/rest/controller/wallet.controller.ts b/apps/vault/src/vault/http/rest/controller/wallet.controller.ts
@@ -1,7 +1,7 @@
 import { Permission } from '@narval/armory-sdk'
+import { REQUEST_HEADER_CLIENT_ID } from '@narval/nestjs-shared'
 import { Body, Controller, Get, HttpStatus, Post } from '@nestjs/common'
 import { ApiHeader, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger'
-import { REQUEST_HEADER_CLIENT_ID } from '../../../../main.constant'
 import { ClientId } from '../../../../shared/decorator/client-id.decorator'
 import { PermissionGuard } from '../../../../shared/decorator/permission-guard.decorator'
 import { AdminService } from '../../../core/service/admin.service'

diff --git a/packages/nestjs-shared/src/index.ts b/packages/nestjs-shared/src/index.ts
@@ -1,3 +1,4 @@
+export * from './lib/constant'
 export * from './lib/decorator'
 export * from './lib/dto'
 export * from './lib/middleware'

diff --git a/packages/nestjs-shared/src/lib/middleware/track-client-id.middleware.ts b/packages/nestjs-shared/src/lib/middleware/track-client-id.middleware.ts
@@ -1,17 +1,18 @@
 import { Inject, Injectable, NestMiddleware } from '@nestjs/common'
 import { NextFunction, Request, Response } from 'express'
+import { OTEL_ATTR_CLIENT_ID, REQUEST_HEADER_CLIENT_ID } from '../constant'
 import { TraceService } from '../module/open-telemetry'
 
 @Injectable()
 export class TrackClientIdMiddleware implements NestMiddleware {
   constructor(@Inject(TraceService) private traceService: TraceService) {}
 
   use(request: Request, _response: Response, next: NextFunction): void {
-    const clientId = request.headers['x-client-id']
+    const clientId = request.headers[REQUEST_HEADER_CLIENT_ID]
 
     if (clientId) {
       this.traceService.setAttributesOnActiveSpan({
-        'domain.client.id': clientId
+        [OTEL_ATTR_CLIENT_ID]: clientId
       })
     }