test(api): added variable e2e tests

apps/api/src/common/cleanup.ts

@@ -11,6 +11,7 @@ export default async function cleanUp(prisma: PrismaClient) {
     prisma.project.deleteMany(),
     prisma.user.deleteMany(),
     prisma.event.deleteMany(),
-    prisma.apiKey.deleteMany()
+    prisma.apiKey.deleteMany(),
+    prisma.variable.deleteMany()
   ])
 }

apps/api/src/event/controller/event.controller.ts

@@ -22,6 +22,7 @@ export class EventController {
     @Query('projectId') projectId: string,
     @Query('environmentId') environmentId: string,
     @Query('secretId') secretId: string,
+    @Query('variableId') variableId: string,
     @Query('apiKeyId') apiKeyId: string,
     @Query('workspaceRoleId') workspaceRoleId: string
   ) {
@@ -32,6 +33,7 @@ export class EventController {
         projectId,
         environmentId,
         secretId,
+        variableId,
         apiKeyId,
         workspaceRoleId
       },

apps/api/src/event/event.e2e.spec.ts

@@ -36,6 +36,8 @@ import { EnvironmentModule } from '../environment/environment.module'
 import { ApiKeyModule } from '../api-key/api-key.module'
 import createEvent from '../common/create-event'
 import fetchEvents from '../common/fetch-events'
+import { VariableService } from '../variable/service/variable.service'
+import { VariableModule } from '../variable/variable.module'
 
 describe('Event Controller Tests', () => {
   let app: NestFastifyApplication
@@ -48,6 +50,7 @@ describe('Event Controller Tests', () => {
   let workspaceRoleService: WorkspaceRoleService
   let projectService: ProjectService
   let secretService: SecretService
+  let variableService: VariableService
 
   let user: User
   let workspace: Workspace
@@ -67,7 +70,8 @@ describe('Event Controller Tests', () => {
         SecretModule,
         ProjectModule,
         EnvironmentModule,
-        ApiKeyModule
+        ApiKeyModule,
+        VariableModule
       ]
     })
       .overrideProvider(MAIL_SERVICE)
@@ -85,6 +89,7 @@ describe('Event Controller Tests', () => {
     workspaceRoleService = moduleRef.get(WorkspaceRoleService)
     projectService = moduleRef.get(ProjectService)
     secretService = moduleRef.get(SecretService)
+    variableService = moduleRef.get(VariableService)
 
     await app.init()
     await app.getHttpAdapter().getInstance().ready()
@@ -294,6 +299,43 @@ describe('Event Controller Tests', () => {
     expect(response.json()).toEqual([event])
   })
 
+  it('should be able to fetch a variable event', async () => {
+    const newVariable = await variableService.createVariable(
+      user,
+      {
+        name: 'My variable',
+        value: 'My value',
+        environmentId: environment.id
+      },
+      project.id
+    )
+
+    expect(newVariable).toBeDefined()
+
+    const response = await fetchEvents(
+      app,
+      user,
+      `variableId=${newVariable.id}`
+    )
+
+    const event = {
+      id: expect.any(String),
+      title: expect.any(String),
+      description: expect.any(String),
+      source: EventSource.VARIABLE,
+      triggerer: EventTriggerer.USER,
+      severity: EventSeverity.INFO,
+      type: EventType.VARIABLE_ADDED,
+      timestamp: expect.any(String),
+      metadata: expect.any(Object)
+    }
+
+    totalEvents.push(event)
+
+    expect(response.statusCode).toBe(200)
+    expect(response.json()).toEqual([event])
+  })
+
   it('should be able to fetch a workspace role event', async () => {
     const newWorkspaceRole = await workspaceRoleService.createWorkspaceRole(
       user,

apps/api/src/event/service/event.service.ts

@@ -5,6 +5,7 @@ import getProjectWithAuthority from '../../common/get-project-with-authority'
 import getEnvironmentWithAuthority from '../../common/get-environment-with-authority'
 import getSecretWithAuthority from '../../common/get-secret-with-authority'
 import { PrismaService } from '../../prisma/prisma.service'
+import getVariableWithAuthority from '../../common/get-variable-with-authority'
 
 @Injectable()
 export class EventService {
@@ -17,6 +18,7 @@ export class EventService {
       projectId?: string
       environmentId?: string
       secretId?: string
+      variableId?: string
       apiKeyId?: string
       workspaceRoleId?: string
     },
@@ -69,6 +71,14 @@ export class EventService {
         this.prisma
       )
       whereCondition['sourceSecretId'] = context.secretId
+    } else if (context.variableId) {
+      await getVariableWithAuthority(
+        user.id,
+        context.variableId,
+        Authority.READ_VARIABLE,
+        this.prisma
+      )
+      whereCondition['sourceVariableId'] = context.variableId
     } else if (context.apiKeyId) {
       whereCondition['sourceApiKeyId'] = context.apiKeyId
     } else if (context.workspaceRoleId) {

apps/api/src/variable/controller/variable.controller.spec.ts

@@ -1,11 +1,23 @@
 import { Test, TestingModule } from '@nestjs/testing'
 import { VariableController } from './variable.controller'
+import { PrismaService } from '../../prisma/prisma.service'
+import { MAIL_SERVICE } from '../../mail/services/interface.service'
+import { MockMailService } from '../../mail/services/mock.service'
+import { VariableService } from '../service/variable.service'
 
 describe('VariableController', () => {
   let controller: VariableController
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        PrismaService,
+        {
+          provide: MAIL_SERVICE,
+          useClass: MockMailService
+        },
+        VariableService
+      ],
       controllers: [VariableController]
     }).compile()
 

apps/api/src/variable/service/variable.service.spec.ts

@@ -1,12 +1,22 @@
 import { Test, TestingModule } from '@nestjs/testing'
 import { VariableService } from './variable.service'
+import { PrismaService } from '../../prisma/prisma.service'
+import { MAIL_SERVICE } from '../../mail/services/interface.service'
+import { MockMailService } from '../../mail/services/mock.service'
 
 describe('VariableService', () => {
   let service: VariableService
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
-      providers: [VariableService]
+      providers: [
+        PrismaService,
+        {
+          provide: MAIL_SERVICE,
+          useClass: MockMailService
+        },
+        VariableService
+      ]
     }).compile()
 
     service = module.get<VariableService>(VariableService)

apps/api/src/variable/service/variable.service.ts

@@ -5,7 +5,6 @@ import {
   Logger,
   NotFoundException
 } from '@nestjs/common'
-import { SecretService } from '../../secret/service/secret.service'
 import { PrismaService } from '../../prisma/prisma.service'
 import {
   Authority,
@@ -27,7 +26,7 @@ import getVariableWithAuthority from '../../common/get-variable-with-authority'
 
 @Injectable()
 export class VariableService {
-  private readonly logger = new Logger(SecretService.name)
+  private readonly logger = new Logger(VariableService.name)
 
   constructor(private readonly prisma: PrismaService) {}
 
@@ -114,7 +113,7 @@ export class VariableService {
         source: EventSource.VARIABLE,
         title: `Variable created`,
         metadata: {
-          secretId: variable.id,
+          variableId: variable.id,
           name: variable.name,
           projectId,
           projectName: project.name,
@@ -171,7 +170,7 @@ export class VariableService {
         take: 1
       })
 
-      result = await this.prisma.secret.update({
+      result = await this.prisma.variable.update({
         where: {
           id: variableId
         },
@@ -207,7 +206,7 @@ export class VariableService {
         source: EventSource.VARIABLE,
         title: `Variable updated`,
         metadata: {
-          secretId: variable.id,
+          variableId: variable.id,
           name: variable.name,
           projectId: variable.projectId,
           projectName: variable.project.name
@@ -283,7 +282,7 @@ export class VariableService {
         source: EventSource.VARIABLE,
         title: `Variable environment updated`,
         metadata: {
-          secretId: variable.id,
+          variableId: variable.id,
           name: variable.name,
           projectId: variable.projectId,
           projectName: variable.project.name,
@@ -338,7 +337,7 @@ export class VariableService {
         source: EventSource.VARIABLE,
         title: `Variable rolled back`,
         metadata: {
-          secretId: variable.id,
+          variableId: variable.id,
           name: variable.name,
           projectId: variable.projectId,
           projectName: variable.project.name,
@@ -370,12 +369,11 @@ export class VariableService {
     createEvent(
       {
         triggeredBy: user,
-        entity: variable,
         type: EventType.VARIABLE_DELETED,
         source: EventSource.VARIABLE,
         title: `Variable deleted`,
         metadata: {
-          secretId: variable.id,
+          variableId: variable.id,
           name: variable.name,
           projectId: variable.projectId,
           projectName: variable.project.name