21755174310

Committed 06 Feb 2026 02:59PM UTC coverage: 89.28% (-0.1%) from 89.401%

Build # 21755174310

Build Type

Pull #2909

github

Committed by

PooyaRaki

Commit Message

refactor(owners): improve formatting of filterPoisonedAddresses method

feat(blocklist): introduce BlocklistModule and BlocklistService for address management

- Added BlocklistModule to encapsulate blocklist functionality and provide IBlocklistService.
- Implemented BlocklistService to handle retrieval and caching of blocklisted addresses from encrypted configuration.
- Updated AppModule to include BlocklistModule for global access.
- Refactored existing code to utilize the new blocklist service, replacing direct calls to the deprecated getBlocklist function.
- Enhanced tests to mock the new blocklist service and ensure proper integration across modules.

fix: fix lint errors

Pull Request Pull Request #2909: Release 1.100.0

Run Details

2950 of 3742 branches covered (78.83%)

Branch coverage included in aggregate %.

139 of 167 new or added lines in 15 files covered. (83.23%)

2 existing lines in 2 files now uncovered.

14257 of 15531 relevant lines covered (91.8%)

542.23 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.24

/src/__tests__/testing-module.ts

import { Test, type TestingModule } from '@nestjs/testing';
import { AppModule } from '@/app.module';
import configuration from '@/config/entities/__tests__/configuration';
import { CacheModule } from '@/datasources/cache/cache.module';
import { TestCacheModule } from '@/datasources/cache/__tests__/test.cache.module';
import { RequestScopedLoggingModule } from '@/logging/logging.module';
import { TestLoggingModule } from '@/logging/__tests__/test.logging.module';
import { NetworkModule } from '@/datasources/network/network.module';
import { TestNetworkModule } from '@/datasources/network/__tests__/test.network.module';
import { QueuesApiModule } from '@/modules/queues/datasources/queues-api.module';
import { TestQueuesApiModule } from '@/modules/queues/datasources/__tests__/test.queues-api.module';
import { PostgresDatabaseModule } from '@/datasources/db/v1/postgres-database.module';
import { TestPostgresDatabaseModule } from '@/datasources/db/__tests__/test.postgres-database.module';
import { PostgresDatabaseModuleV2 } from '@/datasources/db/v2/postgres-database.module';
import { TestPostgresDatabaseModuleV2 } from '@/datasources/db/v2/test.postgres-database.module';
import { TargetedMessagingDatasourceModule } from '@/modules/targeted-messaging/datasources/targeted-messaging.datasource.module';
import { TestTargetedMessagingDatasourceModule } from '@/modules/targeted-messaging/datasources/__tests__/test.targeted-messaging.datasource.module';
import type { ModuleDefinition } from '@nestjs/core/interfaces/module-definition.interface';
import { CacheKeyPrefix } from '@/datasources/cache/constants';
import type { Provider } from '@nestjs/common';
import { CsvExportModule } from '@/modules/csv-export/csv-export.module';
import { TestCsvExportModule } from '@/modules/csv-export/v1/__tests__/test.csv-export.module';
import { TxAuthNetworkModule } from '@/datasources/network/tx-auth.network.module';
import { TestTxAuthNetworkModule } from '@/datasources/network/__tests__/test.tx-auth.network.module';
import type { Address } from 'viem';
import { IBlocklistService } from '@/config/entities/blocklist.interface';

// Create a mock blocklist service for tests
const testBlocklistService: IBlocklistService = {
  getBlocklist(): Array<Address> {
    return [];
  },
  clearCache(): void {
    // No-op in tests
  },
};

export interface CreateBaseTestModuleOptions {
  config?: typeof configuration;
  overridePostgresV2?: boolean;
  cacheKeyPrefix?: string;
  modules?: Array<ModuleOverride>;
  providers?: Array<Provider>;
  guards?: Array<GuardOverride>;
}

export interface ModuleOverride {
  originalModule: ModuleDefinition;
  testModule: ModuleDefinition;
}

export interface GuardOverride {
  originalGuard: unknown;
  testGuard: unknown;
}

export async function createTestModule(
  options: CreateBaseTestModuleOptions = {},
): Promise<TestingModule> {
  const {
    config,
    cacheKeyPrefix,
    overridePostgresV2,
    modules: additionalOverrides = [],
    guards: guards = [],
    providers = [],
  } = options;

  return createBaseTestModule({
    config,
    overridePostgresV2,
    cacheKeyPrefix,
    guards,
    providers,
    modules: [
      {
        originalModule: CacheModule,
        testModule: TestCacheModule,
      },
      {
        originalModule: RequestScopedLoggingModule,
        testModule: TestLoggingModule,
      },
      {
        originalModule: NetworkModule,
        testModule: TestNetworkModule,
      },
      {
        originalModule: TxAuthNetworkModule,
        testModule: TestTxAuthNetworkModule,
      },
      ...additionalOverrides,
    ],
  });
}

export async function createBaseTestModule(
  options: CreateBaseTestModuleOptions = {},
): Promise<TestingModule> {
  const {
    config = configuration,
    overridePostgresV2 = true, // Enable Postgres V2 by default
    cacheKeyPrefix = crypto.randomUUID(),
    modules: additionalOverrides = [],
    guards: guards = [],
    providers = [],
  } = options;

  const moduleBuilder = Test.createTestingModule({
    imports: [AppModule.register(config)],
    providers: providers,
  })
    .overrideProvider(CacheKeyPrefix)
    .useValue(cacheKeyPrefix)
    .overrideProvider(IBlocklistService)
    .useValue(testBlocklistService)
    .overrideModule(PostgresDatabaseModule)
    .useModule(TestPostgresDatabaseModule)
    .overrideModule(TargetedMessagingDatasourceModule)
    .useModule(TestTargetedMessagingDatasourceModule)
    .overrideModule(QueuesApiModule)
    .useModule(TestQueuesApiModule)
    .overrideModule(CsvExportModule)
    .useModule(TestCsvExportModule);

  if (overridePostgresV2) {
    moduleBuilder
      .overrideModule(PostgresDatabaseModuleV2)
      .useModule(TestPostgresDatabaseModuleV2);
  }

  for (const guard of guards) {
    moduleBuilder.overrideGuard(guard.originalGuard).useValue(guard.testGuard);
  }

  // Apply additional overrides
  for (const override of additionalOverrides) {
    moduleBuilder
      .overrideModule(override.originalModule)
      .useModule(override.testModule);
  }

  return moduleBuilder.compile();
}

1	import { Test, type TestingModule } from '@nestjs/testing';	90✔
2	import { AppModule } from '@/app.module';	90✔
3	import configuration from '@/config/entities/__tests__/configuration';	90✔
4	import { CacheModule } from '@/datasources/cache/cache.module';	90✔
5	import { TestCacheModule } from '@/datasources/cache/__tests__/test.cache.module';	90✔
6	import { RequestScopedLoggingModule } from '@/logging/logging.module';	90✔
7	import { TestLoggingModule } from '@/logging/__tests__/test.logging.module';	90✔
8	import { NetworkModule } from '@/datasources/network/network.module';	90✔
9	import { TestNetworkModule } from '@/datasources/network/__tests__/test.network.module';	90✔
10	import { QueuesApiModule } from '@/modules/queues/datasources/queues-api.module';	90✔
11	import { TestQueuesApiModule } from '@/modules/queues/datasources/__tests__/test.queues-api.module';	90✔
12	import { PostgresDatabaseModule } from '@/datasources/db/v1/postgres-database.module';	90✔
13	import { TestPostgresDatabaseModule } from '@/datasources/db/__tests__/test.postgres-database.module';	90✔
14	import { PostgresDatabaseModuleV2 } from '@/datasources/db/v2/postgres-database.module';	90✔
15	import { TestPostgresDatabaseModuleV2 } from '@/datasources/db/v2/test.postgres-database.module';	90✔
16	import { TargetedMessagingDatasourceModule } from '@/modules/targeted-messaging/datasources/targeted-messaging.datasource.module';	90✔
17	import { TestTargetedMessagingDatasourceModule } from '@/modules/targeted-messaging/datasources/__tests__/test.targeted-messaging.datasource.module';	90✔
18	import type { ModuleDefinition } from '@nestjs/core/interfaces/module-definition.interface';
19	import { CacheKeyPrefix } from '@/datasources/cache/constants';	90✔
20	import type { Provider } from '@nestjs/common';
21	import { CsvExportModule } from '@/modules/csv-export/csv-export.module';	90✔
22	import { TestCsvExportModule } from '@/modules/csv-export/v1/__tests__/test.csv-export.module';	90✔
23	import { TxAuthNetworkModule } from '@/datasources/network/tx-auth.network.module';	90✔
24	import { TestTxAuthNetworkModule } from '@/datasources/network/__tests__/test.tx-auth.network.module';	90✔
25	import type { Address } from 'viem';
26	import { IBlocklistService } from '@/config/entities/blocklist.interface';	90✔
27
28	// Create a mock blocklist service for tests
29	const testBlocklistService: IBlocklistService = {	90✔
30	getBlocklist(): Array<Address> {
NEW 31	return [];	×
32	},
33	clearCache(): void {
34	// No-op in tests
35	},
36	};
37
38	export interface CreateBaseTestModuleOptions {
39	config?: typeof configuration;
40	overridePostgresV2?: boolean;
41	cacheKeyPrefix?: string;
42	modules?: Array<ModuleOverride>;
43	providers?: Array<Provider>;
44	guards?: Array<GuardOverride>;
45	}
46
47	export interface ModuleOverride {
48	originalModule: ModuleDefinition;
49	testModule: ModuleDefinition;
50	}
51
52	export interface GuardOverride {
53	originalGuard: unknown;
54	testGuard: unknown;
55	}
56
57	export async function createTestModule(	90✔
58	options: CreateBaseTestModuleOptions = {},	126✔
59	): Promise<TestingModule> {
60	const {
61	config,
62	cacheKeyPrefix,
63	overridePostgresV2,
64	modules: additionalOverrides = [],	648✔
65	guards: guards = [],	848✔
66	providers = [],	753✔
67	} = options;	1,696✔
68
69	return createBaseTestModule({	1,696✔
70	config,
71	overridePostgresV2,
72	cacheKeyPrefix,
73	guards,
74	providers,
75	modules: [
76	{
77	originalModule: CacheModule,
78	testModule: TestCacheModule,
79	},
80	{
81	originalModule: RequestScopedLoggingModule,
82	testModule: TestLoggingModule,
83	},
84	{
85	originalModule: NetworkModule,
86	testModule: TestNetworkModule,
87	},
88	{
89	originalModule: TxAuthNetworkModule,
90	testModule: TestTxAuthNetworkModule,
91	},
92	...additionalOverrides,
93	],
94	});
95	}
96
97	export async function createBaseTestModule(	90✔
98	options: CreateBaseTestModuleOptions = {},	×
99	): Promise<TestingModule> {
100	const {
101	config = configuration,	153✔
102	overridePostgresV2 = true, // Enable Postgres V2 by default	843✔
103	cacheKeyPrefix = crypto.randomUUID(),	848✔
104	modules: additionalOverrides = [],	×
105	guards: guards = [],	×
106	providers = [],	×
107	} = options;	1,696✔
108
109	const moduleBuilder = Test.createTestingModule({	1,696✔
110	imports: [AppModule.register(config)],
111	providers: providers,
112	})
113	.overrideProvider(CacheKeyPrefix)
114	.useValue(cacheKeyPrefix)
115	.overrideProvider(IBlocklistService)
116	.useValue(testBlocklistService)
117	.overrideModule(PostgresDatabaseModule)
118	.useModule(TestPostgresDatabaseModule)
119	.overrideModule(TargetedMessagingDatasourceModule)
120	.useModule(TestTargetedMessagingDatasourceModule)
121	.overrideModule(QueuesApiModule)
122	.useModule(TestQueuesApiModule)
123	.overrideModule(CsvExportModule)
124	.useModule(TestCsvExportModule);
125
126	if (overridePostgresV2) {	1,696✔
127	moduleBuilder	1,686✔
128	.overrideModule(PostgresDatabaseModuleV2)
129	.useModule(TestPostgresDatabaseModuleV2);
130	}
131
132	for (const guard of guards) {	1,696✔
133	moduleBuilder.overrideGuard(guard.originalGuard).useValue(guard.testGuard);	×
134	}
135
136	// Apply additional overrides
137	for (const override of additionalOverrides) {	1,696✔
138	moduleBuilder	7,330✔
139	.overrideModule(override.originalModule)
140	.useModule(override.testModule);
141	}
142
143	return moduleBuilder.compile();	1,696✔
144	}

safe-global / safe-client-gateway / 21755174310

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous