Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add /v2/owners/:ownerAddress/safes to gracefully handle errors #2266

Merged
merged 6 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions src/domain/safe/safe.repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,8 @@ export class SafeRepository implements ISafeRepository {
ownerAddress: `0x${string}`;
}): Promise<{ [chainId: string]: Array<string> }> {
const chains = await this.chainsRepository.getAllChains();
const allSafeLists = await Promise.all(
// Gracefully handle errors in case singular Transaction Service throws
PooyaRaki marked this conversation as resolved.
Show resolved Hide resolved
const allSafeLists = await Promise.allSettled(
chains.map(async ({ chainId }) => {
const safeList = await this.getSafesByOwner({
chainId,
Expand All @@ -441,12 +442,20 @@ export class SafeRepository implements ISafeRepository {
}),
);

return allSafeLists.reduce((acc, { chainId, safeList }) => {
return {
...acc,
[chainId]: safeList.safes,
};
}, {});
const result: { [chainId: string]: Array<string> } = {};

for (const [index, allSafeList] of allSafeLists.entries()) {
if (allSafeList.status === 'fulfilled') {
result[allSafeList.value.chainId] = allSafeList.value.safeList.safes;
} else {
const chainId = chains[index].chainId;
this.loggingService.warn(
`Failed to fetch Safe owners. chainId=${chainId}`,
);
}
}

return result;
}

async getLastTransactionSortedByNonce(args: {
Expand Down
71 changes: 71 additions & 0 deletions src/routes/owners/owners.controller.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,14 @@ import { TestPostgresDatabaseModuleV2 } from '@/datasources/db/v2/test.postgres-
import { TestTargetedMessagingDatasourceModule } from '@/datasources/targeted-messaging/__tests__/test.targeted-messaging.datasource.module';
import { TargetedMessagingDatasourceModule } from '@/datasources/targeted-messaging/targeted-messaging.datasource.module';
import { rawify } from '@/validation/entities/raw.entity';
import { LoggingService } from '@/logging/logging.interface';
import type { ILoggingService } from '@/logging/logging.interface';

describe('Owners Controller (Unit)', () => {
let app: INestApplication<Server>;
let safeConfigUrl: string;
let networkService: jest.MockedObjectDeep<INetworkService>;
let loggingService: jest.MockedObjectDeep<ILoggingService>;

beforeEach(async () => {
jest.resetAllMocks();
Expand Down Expand Up @@ -66,6 +69,7 @@ describe('Owners Controller (Unit)', () => {
);
safeConfigUrl = configurationService.getOrThrow('safeConfig.baseUri');
networkService = moduleFixture.get(NetworkService);
loggingService = moduleFixture.get(LoggingService);

app = await new TestAppProvider().provide(moduleFixture);
await app.init();
Expand Down Expand Up @@ -370,6 +374,73 @@ describe('Owners Controller (Unit)', () => {
});
});

it('should gracefully handle chain-specific Transaction Service error', async () => {
jest.spyOn(loggingService, 'warn');
const ownerAddress = faker.finance.ethereumAddress();
const chainId1 = faker.string.numeric();
const chainId2 = faker.string.numeric({ exclude: [chainId1] });
const chain1 = chainBuilder().with('chainId', chainId1).build();
const chain2 = chainBuilder().with('chainId', chainId2).build();
const safesOnChain1 = [
faker.finance.ethereumAddress(),
faker.finance.ethereumAddress(),
faker.finance.ethereumAddress(),
];
networkService.get.mockImplementation(({ url }) => {
switch (url) {
case `${safeConfigUrl}/api/v1/chains`: {
return Promise.resolve({
data: rawify(
pageBuilder()
.with('results', [chain1, chain2])
.with('next', null)
.build(),
),
status: 200,
});
}
case `${safeConfigUrl}/api/v1/chains/${chainId1}`: {
return Promise.resolve({
data: rawify(chain1),
status: 200,
});
}
case `${safeConfigUrl}/api/v1/chains/${chainId2}`: {
return Promise.resolve({
data: rawify(chain2),
status: 200,
});
}
// ValidationPipe checksums ownerAddress param
case `${chain1.transactionService}/api/v1/owners/${getAddress(ownerAddress)}/safes/`: {
return Promise.resolve({
data: rawify({ safes: safesOnChain1 }),
status: 200,
});
}
case `${chain2.transactionService}/api/v1/owners/${getAddress(ownerAddress)}/safes/`: {
return Promise.reject(new Error('Test error'));
}
default: {
return Promise.reject(`No matching rule for url: ${url}`);
}
}
});

await request(app.getHttpServer())
.get(`/v1/owners/${ownerAddress}/safes`)
.expect(200)
.expect({
// Only "working" chain. Validation schema checksums addresses
[chainId1]: safesOnChain1.map((safe) => getAddress(safe)),
});
expect(loggingService.warn).toHaveBeenCalledTimes(1);
expect(loggingService.warn).toHaveBeenNthCalledWith(
1,
`Failed to fetch Safe owners. chainId=${chainId2}`,
);
});

it('Failure: Config API fails', async () => {
const ownerAddress = faker.finance.ethereumAddress();

Expand Down
Loading