More renaming

Author: FelixMalfait

packages/twenty-server/src/engine/core-modules/audit/README.md

@@ -6,7 +6,7 @@ This module provides analytics tracking functionality for the Twenty application
 
 ### Tracking Events
 
-The `AuditService` provides a `createAnalyticsContext` method that returns an object with a `track` method. The `track` method is used to track events.
+The `AuditService` provides a `createContext` method that returns an object with a `track` method. The `track` method is used to track events.
 
 ```typescript
 import { Injectable } from '@nestjs/common';
@@ -19,7 +19,7 @@ export class MyService {
 
   async doSomething() {
     // Create an analytics context
-    const analytics = this.auditService.createAnalyticsContext({
+    const analytics = this.auditService.createContext({
       workspaceId: 'workspace-id',
       userId: 'user-id',
     });
@@ -89,7 +89,7 @@ export type TrackEventProperties<T extends TrackEventName> = T extends keyof Tra
 
 ### AuditService
 
-#### createAnalyticsContext(context?)
+#### createContext(context?)
 
 Creates an analytics context with the given user ID and workspace ID.
 

packages/twenty-server/src/engine/core-modules/audit/audit.exception.ts

@@ -1,6 +1,6 @@
 import { CustomException } from 'src/utils/custom-exception';
 
-export class AnalyticsException extends CustomException {
+export class AuditException extends CustomException {
   constructor(message: string, code: AuditExceptionCode) {
     super(message, code);
   }

packages/twenty-server/src/engine/core-modules/audit/audit.module.ts

@@ -3,12 +3,12 @@ import { Module } from '@nestjs/common';
 import { ClickHouseModule } from 'src/database/clickHouse/clickHouse.module';
 import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';
 
-import { AnalyticsResolver } from './analytics.resolver';
+import { AuditResolver } from './audit.resolver';
 
 import { AuditService } from './services/audit.service';
 
 @Module({
-  providers: [AnalyticsResolver, AuditService],
+  providers: [AuditResolver, AuditService],
   imports: [JwtModule, ClickHouseModule],
   exports: [AuditService],
 })

packages/twenty-server/src/engine/core-modules/audit/analytics.resolver.spec.ts renamed to packages/twenty-server/src/engine/core-modules/audit/audit.resolver.spec.ts

@@ -1,36 +1,36 @@
 import { Test, TestingModule } from '@nestjs/testing';
 
 import {
-  AnalyticsException,
+  AuditException,
   AuditExceptionCode,
 } from 'src/engine/core-modules/audit/audit.exception';
 import { User } from 'src/engine/core-modules/user/user.entity';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
 
-import { AnalyticsResolver } from './analytics.resolver';
+import { AuditResolver } from './audit.resolver';
 
 import { AuditService } from './services/audit.service';
 
-describe('AnalyticsResolver', () => {
-  let resolver: AnalyticsResolver;
+describe('AuditResolver', () => {
+  let resolver: AuditResolver;
   let auditService: jest.Mocked<AuditService>;
 
   beforeEach(async () => {
     auditService = {
-      createAnalyticsContext: jest.fn(),
+      createContext: jest.fn(),
     } as any;
 
     const module: TestingModule = await Test.createTestingModule({
       providers: [
-        AnalyticsResolver,
+        AuditResolver,
         {
           provide: AuditService,
           useValue: auditService,
         },
       ],
     }).compile();
 
-    resolver = module.get<AnalyticsResolver>(AnalyticsResolver);
+    resolver = module.get<AuditResolver>(AuditResolver);
   });
 
   it('should be defined', () => {
@@ -40,7 +40,7 @@ describe('AnalyticsResolver', () => {
   it('should handle a valid pageview input', async () => {
     const mockPageview = jest.fn().mockResolvedValue('Pageview created');
 
-    auditService.createAnalyticsContext.mockReturnValue({
+    auditService.createContext.mockReturnValue({
       pageview: mockPageview,
       track: jest.fn(),
     });
@@ -56,7 +56,7 @@ describe('AnalyticsResolver', () => {
       { id: 'user-1' } as User,
     );
 
-    expect(auditService.createAnalyticsContext).toHaveBeenCalledWith({
+    expect(auditService.createContext).toHaveBeenCalledWith({
       workspaceId: 'workspace-1',
       userId: 'user-1',
     });
@@ -67,7 +67,7 @@ describe('AnalyticsResolver', () => {
   it('should handle a valid track input', async () => {
     const mockTrack = jest.fn().mockResolvedValue('Track created');
 
-    auditService.createAnalyticsContext.mockReturnValue({
+    auditService.createContext.mockReturnValue({
       track: mockTrack,
       pageview: jest.fn(),
     });
@@ -83,21 +83,21 @@ describe('AnalyticsResolver', () => {
       { id: 'user-2' } as User,
     );
 
-    expect(auditService.createAnalyticsContext).toHaveBeenCalledWith({
+    expect(auditService.createContext).toHaveBeenCalledWith({
       workspaceId: 'workspace-2',
       userId: 'user-2',
     });
     expect(mockTrack).toHaveBeenCalledWith('Custom Domain Activated', {});
     expect(result).toBe('Track created');
   });
 
-  it('should throw an AnalyticsException for invalid input', async () => {
+  it('should throw an AuditException for invalid input', async () => {
     const invalidInput = { type: 'invalid' };
 
     await expect(
       resolver.trackAnalytics(invalidInput as any, undefined, undefined),
     ).rejects.toThrowError(
-      new AnalyticsException(
+      new AuditException(
         'Invalid analytics input',
         AuditExceptionCode.INVALID_TYPE,
       ),

packages/twenty-server/src/engine/core-modules/audit/analytics.resolver.ts renamed to packages/twenty-server/src/engine/core-modules/audit/audit.resolver.ts

@@ -1,7 +1,7 @@
 import { Args, Mutation, Resolver } from '@nestjs/graphql';
 
 import {
-  AnalyticsException,
+  AuditException,
   AuditExceptionCode,
 } from 'src/engine/core-modules/audit/audit.exception';
 import { User } from 'src/engine/core-modules/user/user.entity';
@@ -18,7 +18,7 @@ import { Analytics } from './entities/analytics.entity';
 import { AuditService } from './services/audit.service';
 
 @Resolver(() => Analytics)
-export class AnalyticsResolver {
+export class AuditResolver {
   constructor(private readonly auditService: AuditService) {}
 
   // preparing for new name
@@ -38,7 +38,7 @@ export class AnalyticsResolver {
     @AuthWorkspace() workspace: Workspace | undefined,
     @AuthUser({ allowUndefined: true }) user: User | undefined,
   ) {
-    const analyticsContext = this.auditService.createAnalyticsContext({
+    const analyticsContext = this.auditService.createContext({
       workspaceId: workspace?.id,
       userId: user?.id,
     });
@@ -57,7 +57,7 @@ export class AnalyticsResolver {
       );
     }
 
-    throw new AnalyticsException(
+    throw new AuditException(
       'Invalid analytics input',
       AuditExceptionCode.INVALID_TYPE,
     );

packages/twenty-server/src/engine/core-modules/audit/services/audit.service.spec.ts

@@ -1,6 +1,6 @@
 import { Test, TestingModule } from '@nestjs/testing';
 
-import { AnalyticsContextMock } from 'test/utils/analytics-context.mock';
+import { AuditContextMock } from 'test/utils/audit-context.mock';
 
 import { ClickHouseService } from 'src/database/clickHouse/clickHouse.service';
 import { CUSTOM_DOMAIN_ACTIVATED_EVENT } from 'src/engine/core-modules/audit/utils/events/track/custom-domain/custom-domain-activated';
@@ -18,7 +18,7 @@ describe('AuditService', () => {
         {
           provide: AuditService,
           useValue: {
-            createAnalyticsContext: AnalyticsContextMock,
+            createAnalyticsContext: AuditContextMock,
           },
         },
         {
@@ -64,7 +64,7 @@ describe('AuditService', () => {
 
     it('should call track with correct parameters', async () => {
       const trackSpy = jest.fn().mockResolvedValue({ success: true });
-      const mockContext = AnalyticsContextMock({
+      const mockContext = AuditContextMock({
         track: trackSpy,
       });
 
@@ -81,7 +81,7 @@ describe('AuditService', () => {
 
     it('should call pageview with correct parameters', async () => {
       const pageviewSpy = jest.fn().mockResolvedValue({ success: true });
-      const mockContext = AnalyticsContextMock({
+      const mockContext = AuditContextMock({
         pageview: pageviewSpy,
       });
 

packages/twenty-server/src/engine/core-modules/audit/services/audit.service.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@nestjs/common';
 
 import { ClickHouseService } from 'src/database/clickHouse/clickHouse.service';
 import {
-  AnalyticsException,
+  AuditException,
   AuditExceptionCode,
 } from 'src/engine/core-modules/audit/audit.exception';
 import {
@@ -23,7 +23,7 @@ export class AuditService {
     private readonly clickHouseService: ClickHouseService,
   ) {}
 
-  createAnalyticsContext(context?: {
+  createContext(context?: {
     workspaceId?: string | null | undefined;
     userId?: string | null | undefined;
   }) {
@@ -39,44 +39,30 @@ export class AuditService {
         event: T,
         properties: TrackEventProperties<T>,
       ) =>
-        this.preventAnalyticsIfDisabled(() =>
+        this.preventIfDisabled(() =>
           this.clickHouseService.insert('auditEvent', [
             { ...userIdAndWorkspaceId, ...makeTrackEvent(event, properties) },
           ]),
         ),
       pageview: (name: string, properties: Partial<PageviewProperties>) =>
-        this.preventAnalyticsIfDisabled(() =>
+        this.preventIfDisabled(() =>
           this.clickHouseService.insert('pageview', [
             { ...userIdAndWorkspaceId, ...makePageview(name, properties) },
           ]),
         ),
     };
   }
 
-  private async pushEvent(
-    data: (
-      | ReturnType<typeof makeTrackEvent>
-      | ReturnType<typeof makePageview>
-    ) & { userId?: string | null; workspaceId?: string | null },
-  ) {
-    const { type, ...rest } = data;
-
-    return await this.clickHouseService.insert(
-      type === 'page' ? 'pageview' : 'auditEvent',
-      [rest],
-    );
-  }
-
-  private preventAnalyticsIfDisabled(
+  private preventIfDisabled(
     sendEventOrPageviewFunction: () => Promise<{ success: boolean }>,
   ) {
-    if (!this.twentyConfigService.get('ANALYTICS_ENABLED')) {
+    if (!this.twentyConfigService.get('CLICKHOUSE_URL')) {
       return { success: true };
     }
     try {
       return sendEventOrPageviewFunction();
     } catch (err) {
-      return new AnalyticsException(err, AuditExceptionCode.INVALID_INPUT);
+      return new AuditException(err, AuditExceptionCode.INVALID_INPUT);
     }
   }
 }

packages/twenty-server/src/engine/core-modules/domain-manager/controllers/cloudflare.spec.ts

@@ -2,7 +2,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { getRepositoryToken } from '@nestjs/typeorm';
 
 import { Request, Response } from 'express';
-import { AnalyticsContextMock } from 'test/utils/analytics-context.mock';
+import { AuditContextMock } from 'test/utils/audit-context.mock';
 import { Repository } from 'typeorm';
 
 import { AuditService } from 'src/engine/core-modules/audit/services/audit.service';
@@ -66,7 +66,7 @@ describe('CloudflareController - customHostnameWebhooks', () => {
         {
           provide: AuditService,
           useValue: {
-            createAnalyticsContext: AnalyticsContextMock,
+            createAnalyticsContext: AuditContextMock,
           },
         },
       ],

packages/twenty-server/src/engine/core-modules/domain-manager/services/custom-domain.service.spec.ts

@@ -2,7 +2,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 
 import Cloudflare from 'cloudflare';
 import { CustomHostnameCreateResponse } from 'cloudflare/resources/custom-hostnames/custom-hostnames';
-import { AnalyticsContextMock } from 'test/utils/analytics-context.mock';
+import { AuditContextMock } from 'test/utils/audit-context.mock';
 
 import { AuditService } from 'src/engine/core-modules/audit/services/audit.service';
 import { DomainManagerException } from 'src/engine/core-modules/domain-manager/domain-manager.exception';
@@ -30,7 +30,7 @@ describe('CustomDomainService', () => {
         {
           provide: AuditService,
           useValue: {
-            createAnalyticsContext: AnalyticsContextMock,
+            createAnalyticsContext: AuditContextMock,
           },
         },
         {

packages/twenty-server/src/engine/core-modules/twenty-config/enums/config-variables-group.enum.ts

@@ -16,6 +16,6 @@ export enum ConfigVariablesGroup {
   ServerlessConfig = 'serverless-config',
   SSL = 'ssl',
   SupportChatConfig = 'support-chat-config',
-  AnalyticsConfig = 'analytics-config',
+  AnalyticsConfig = 'audit-config',
   TokensDuration = 'tokens-duration',
 }

packages/twenty-server/src/engine/core-modules/user/user.resolver.ts

@@ -20,7 +20,6 @@ import { In, Repository } from 'typeorm';
 import { FileFolder } from 'src/engine/core-modules/file/interfaces/file-folder.interface';
 import { SupportDriver } from 'src/engine/core-modules/twenty-config/interfaces/support.interface';
 
-import { AuditService } from 'src/engine/core-modules/audit/services/audit.service';
 import {
   AuthException,
   AuthExceptionCode,
@@ -75,7 +74,6 @@ export class UserResolver {
     private readonly onboardingService: OnboardingService,
     private readonly userVarService: UserVarsService,
     private readonly fileService: FileService,
-    private readonly auditService: AuditService,
     private readonly domainManagerService: DomainManagerService,
     @InjectRepository(UserWorkspace, 'core')
     private readonly userWorkspaceRepository: Repository<UserWorkspace>,

packages/twenty-server/test/utils/analytics-context.mock.ts renamed to packages/twenty-server/test/utils/audit-context.mock.ts

@@ -1,6 +1,6 @@
 import { TrackEventName } from 'src/engine/core-modules/audit/types/events.type';
 
-export const AnalyticsContextMock = (params?: {
+export const AuditContextMock = (params?: {
   track?:
     | ((
         event: TrackEventName,