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

feat: network notification badges #1484

Merged
merged 24 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Expose } from 'class-transformer';

import { NotificationType } from '@entities';
import { NotificationAdditionalData, NotificationType } from '@entities';

export class NotificationDto {
@Expose()
Expand All @@ -18,6 +18,9 @@ export class NotificationDto {
@Expose()
actorId?: number;

@Expose()
additionalData?: NotificationAdditionalData;

@Expose()
isEmailSent?: boolean;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,7 @@ describe('ApproversService', () => {
id: 1,
creatorKey: { userId: user.id },
status: TransactionStatus.EXPIRED,
mirrorNetwork: 'testnet',
};

beforeEach(() => {
Expand Down Expand Up @@ -375,6 +376,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});

Expand Down Expand Up @@ -482,6 +484,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});

Expand Down Expand Up @@ -713,6 +716,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});
});
Expand All @@ -722,6 +726,7 @@ describe('ApproversService', () => {
id: 1,
creatorKey: { userId: user.id },
status: TransactionStatus.WAITING_FOR_EXECUTION,
mirrorNetwork: 'testnet',
};

const basicApprover: TransactionApprover = {
Expand Down Expand Up @@ -832,6 +837,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});

Expand Down Expand Up @@ -974,6 +980,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});

Expand Down Expand Up @@ -1144,6 +1151,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});

Expand Down Expand Up @@ -1181,6 +1189,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});

Expand Down Expand Up @@ -1209,6 +1218,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
expect.anything(),
{ network: transaction.mirrorNetwork },
);
});

Expand Down Expand Up @@ -1285,6 +1295,7 @@ describe('ApproversService', () => {
id: 1,
status: TransactionStatus.WAITING_FOR_EXECUTION,
transactionBytes: sdkTransaction.toBytes(),
mirrorNetwork: 'testnet',
};

mockTransaction();
Expand Down Expand Up @@ -1318,6 +1329,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
transaction.status,
{ network: transaction.mirrorNetwork },
);
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);
});
Expand Down Expand Up @@ -1661,6 +1673,7 @@ describe('ApproversService', () => {
const transaction = {
id: 1,
status: TransactionStatus.WAITING_FOR_EXECUTION,
mirrorNetwork: 'testnet',
};

dataSource.manager.findOne.mockResolvedValueOnce(transaction);
Expand All @@ -1671,6 +1684,7 @@ describe('ApproversService', () => {
notificationsService,
transaction.id,
transaction.status,
{ network: transaction.mirrorNetwork },
);
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -606,7 +606,9 @@ export class ApproversService {
});

notifyTransactionAction(this.notificationsService);
notifySyncIndicators(this.notificationsService, transaction.id, transaction.status);
notifySyncIndicators(this.notificationsService, transaction.id, transaction.status, {
network: transaction.mirrorNetwork,
});

return true;
}
Expand Down Expand Up @@ -664,7 +666,9 @@ export class ApproversService {

if (!transaction) return;

notifySyncIndicators(this.notificationsService, transactionId, transaction.status);
notifySyncIndicators(this.notificationsService, transactionId, transaction.status, {
network: transaction.mirrorNetwork,
});
}

/* Get the tree structure of the approvers */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ describe('SignaturesService', () => {
id: transactionId,
transactionBytes: sdkTransaction.toBytes(),
status: TransactionStatus.WAITING_FOR_EXECUTION,
mirrorNetwork: 'testnet',
};

await sdkTransaction.sign(privateKey);
Expand Down Expand Up @@ -235,6 +236,7 @@ describe('SignaturesService', () => {
notificationService,
transactionId,
transaction.status,
{ network: transaction.mirrorNetwork },
);

user.keys[0].publicKey = originalPublicKey;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,9 @@ export class SignersService {

emitUpdateTransactionStatus(this.chainService, transactionId);
notifyTransactionAction(this.notificationService);
notifySyncIndicators(this.notificationService, transactionId, transaction.status);
notifySyncIndicators(this.notificationService, transactionId, transaction.status, {
network: transaction.mirrorNetwork,
});

return signers;
}
Expand Down
15 changes: 12 additions & 3 deletions back-end/apps/api/src/transactions/transactions.service.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,9 @@ describe('TransactionsService', () => {
await service.createTransaction(dto, user as User);

expect(transactionsRepo.save).toHaveBeenCalled();
expect(notifyWaitingForSignatures).toHaveBeenCalledWith(notificationsService, 1);
expect(notifyWaitingForSignatures).toHaveBeenCalledWith(notificationsService, 1, {
network: dto.mirrorNetwork,
});
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);

client.close();
Expand Down Expand Up @@ -474,7 +476,9 @@ describe('TransactionsService', () => {
expect(transactionsRepo.save).toHaveBeenCalledWith(
expect.objectContaining({ isManual: true }),
);
expect(notifyWaitingForSignatures).toHaveBeenCalledWith(notificationsService, 1);
expect(notifyWaitingForSignatures).toHaveBeenCalledWith(notificationsService, 1, {
network: dto.mirrorNetwork,
});
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);

client.close();
Expand Down Expand Up @@ -600,7 +604,7 @@ describe('TransactionsService', () => {
});

describe('removeTransaction', () => {
const transaction = { id: 123, creatorKey: { userId: user.id } };
const transaction = { id: 123, creatorKey: { userId: user.id }, mirrorNetwork: 'testnet' };

beforeEach(() => {
jest.resetAllMocks();
Expand All @@ -614,6 +618,7 @@ describe('TransactionsService', () => {
notificationsService,
transaction.id,
TransactionStatus.CANCELED,
{ network: transaction.mirrorNetwork },
);
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);
});
Expand Down Expand Up @@ -654,6 +659,7 @@ describe('TransactionsService', () => {
id: 123,
creatorKey: { userId: 1 },
status: TransactionStatus.WAITING_FOR_SIGNATURES,
mirrorNetwork: 'testnet',
};

jest
Expand All @@ -671,6 +677,7 @@ describe('TransactionsService', () => {
notificationsService,
transaction.id,
TransactionStatus.CANCELED,
{ network: transaction.mirrorNetwork },
);
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);
});
Expand Down Expand Up @@ -726,6 +733,7 @@ describe('TransactionsService', () => {
creatorKey: { userId: 1 },
isManual: true,
status: TransactionStatus.WAITING_FOR_EXECUTION,
mirrorNetwork: 'testnet',
};

jest
Expand All @@ -743,6 +751,7 @@ describe('TransactionsService', () => {
notificationsService,
transaction.id,
TransactionStatus.ARCHIVED,
{ network: transaction.mirrorNetwork },
);
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);
});
Expand Down
16 changes: 12 additions & 4 deletions back-end/apps/api/src/transactions/transactions.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,9 @@ export class TransactionsService {
throw new BadRequestException(ErrorCodes.FST);
}

notifyWaitingForSignatures(this.notificationsService, transaction.id);
notifyWaitingForSignatures(this.notificationsService, transaction.id, {
network: transaction.mirrorNetwork,
});
notifyTransactionAction(this.notificationsService);

return transaction;
Expand All @@ -410,7 +412,9 @@ export class TransactionsService {
await this.repo.remove(transaction);
}

notifySyncIndicators(this.notificationsService, transaction.id, TransactionStatus.CANCELED);
notifySyncIndicators(this.notificationsService, transaction.id, TransactionStatus.CANCELED, {
network: transaction.mirrorNetwork,
});
notifyTransactionAction(this.notificationsService);

return true;
Expand All @@ -432,7 +436,9 @@ export class TransactionsService {

await this.repo.update({ id }, { status: TransactionStatus.CANCELED });

notifySyncIndicators(this.notificationsService, transaction.id, TransactionStatus.CANCELED);
notifySyncIndicators(this.notificationsService, transaction.id, TransactionStatus.CANCELED, {
network: transaction.mirrorNetwork,
});
notifyTransactionAction(this.notificationsService);

/* Send email notification to all the participants */
Expand Down Expand Up @@ -468,7 +474,9 @@ export class TransactionsService {

await this.repo.update({ id }, { status: TransactionStatus.ARCHIVED });

notifySyncIndicators(this.notificationsService, transaction.id, TransactionStatus.ARCHIVED);
notifySyncIndicators(this.notificationsService, transaction.id, TransactionStatus.ARCHIVED, {
network: transaction.mirrorNetwork,
});
notifyTransactionAction(this.notificationsService);

return true;
Expand Down
4 changes: 3 additions & 1 deletion back-end/apps/chain/src/execute/execute.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,9 @@ export class ExecuteService {

client.close();

notifySyncIndicators(this.notificationsService, transaction.id, transaction.status);
notifySyncIndicators(this.notificationsService, transaction.id, transaction.status, {
network: transaction.mirrorNetwork,
});
notifyTransactionAction(this.notificationsService);

this.sideEffect(sdkTransaction, transaction.mirrorNetwork);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,9 +257,9 @@ describe('TransactionStatusService', () => {
mockTransaction();

const expiredTransactions = [
{ id: 1, status: TransactionStatus.NEW },
{ id: 2, status: TransactionStatus.REJECTED },
{ id: 3, status: TransactionStatus.WAITING_FOR_EXECUTION },
{ id: 1, status: TransactionStatus.NEW, mirrorNetwork: 'testnet' },
{ id: 2, status: TransactionStatus.REJECTED, mirrorNetwork: 'testnet' },
{ id: 3, status: TransactionStatus.WAITING_FOR_EXECUTION, mirrorNetwork: 'testnet' },
];

transactionRepo.manager.find.mockResolvedValue(expiredTransactions as Transaction[]);
Expand All @@ -274,6 +274,7 @@ describe('TransactionStatusService', () => {
notificationsService,
transaction.id,
TransactionStatus.EXPIRED,
{ network: transaction.mirrorNetwork },
);
}
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);
Expand Down Expand Up @@ -305,6 +306,7 @@ describe('TransactionStatusService', () => {
creatorKey: {
userId: 24,
},
mirrorNetwork: 'testnet',
},
];

Expand Down Expand Up @@ -341,22 +343,26 @@ describe('TransactionStatusService', () => {
notificationsService,
transactions[0].id,
TransactionStatus.WAITING_FOR_EXECUTION,
{ network: transactions[0].mirrorNetwork },
);
expect(notificationsService.emit).toHaveBeenCalledWith(NOTIFY_GENERAL, {
entityId: transactions[0].id,
type: NotificationType.TRANSACTION_READY_FOR_EXECUTION,
actorId: null,
content: `Transaction is ready for execution!\nTransaction ID: ${transactions[0].transactionId}\nNetwork: ${networkString}`,
userIds: [transactions[0].creatorKey?.userId],
additionalData: { network: transactions[0].mirrorNetwork },
});
expect(notifySyncIndicators).toHaveBeenCalledWith(
notificationsService,
transactions[1].id,
TransactionStatus.WAITING_FOR_SIGNATURES,
{ network: transactions[1].mirrorNetwork },
);
expect(notifyWaitingForSignatures).toHaveBeenCalledWith(
notificationsService,
transactions[1].id,
{ network: transactions[1].mirrorNetwork },
);
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);
expect(notifyTransactionAction).toHaveBeenCalledTimes(1);
Expand Down Expand Up @@ -433,13 +439,15 @@ describe('TransactionStatusService', () => {
notificationsService,
transaction.id,
TransactionStatus.WAITING_FOR_EXECUTION,
{ network: transaction.mirrorNetwork },
);
expect(notificationsService.emit).toHaveBeenCalledWith(NOTIFY_GENERAL, {
entityId: transaction.id,
type: NotificationType.TRANSACTION_READY_FOR_EXECUTION,
actorId: null,
content: `Transaction is ready for execution!\nTransaction ID: ${transaction.transactionId}\nNetwork: ${networkString}`,
userIds: [transaction.creatorKey?.userId],
additionalData: { network: transaction.mirrorNetwork },
});
expect(notifyTransactionAction).toHaveBeenCalledWith(notificationsService);
});
Expand Down
Loading
Loading