-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement (first approach) send dappmanager notification (#370)
* Implement send dappmanager notification * rename to insertPerformanceDataAndSendNotification and relocate
- Loading branch information
1 parent
2ce7722
commit 79faebe
Showing
9 changed files
with
219 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { ApiError } from "../error.js"; | ||
|
|
||
| export class DappmanagerApiError extends ApiError { | ||
| constructor(message: string) { | ||
| super(message); | ||
| this.name = "DappmanagerApiError"; | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
packages/brain/src/modules/apiClients/dappmanager/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import logger from "../../logger/index.js"; | ||
| import { StandardApi } from "../standard.js"; | ||
| import { NotificationType } from "./types.js"; | ||
|
|
||
| export class DappmanagerApi extends StandardApi { | ||
| /** | ||
| * Triggers a notification in the dappmanager. | ||
| */ | ||
| public async sendDappmanagerNotification({ | ||
| notificationType, | ||
| title, | ||
| body | ||
| }: { | ||
| notificationType: NotificationType; | ||
| title: string; | ||
| body: string; | ||
| }): Promise<void> { | ||
| try { | ||
| await this.request({ | ||
| method: "POST", | ||
| endpoint: `/notification-send?type=${encodeURIComponent(notificationType)}&title=${encodeURIComponent(title)}&body=${encodeURIComponent(body)}` | ||
| }); | ||
| } catch (error) { | ||
| logger.error("Failed to send notification to dappmanager", error); | ||
| throw error; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| // Must be in sync with dappmanager | ||
| export enum NotificationType { | ||
| Success = "success", | ||
| Info = "info", | ||
| Warning = "warning", | ||
| Danger = "danger" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
115 changes: 115 additions & 0 deletions
115
...ain/src/modules/cron/trackValidatorsPerformance/sendValidatorsPerformanceNotifications.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import { DappmanagerApi } from "../../apiClients/index.js"; | ||
| import { NotificationType } from "../../apiClients/dappmanager/types.js"; | ||
| import { BlockProposalStatus, ValidatorPerformanceError } from "../../apiClients/postgres/types.js"; | ||
| import logger from "../../logger/index.js"; | ||
| import { logPrefix } from "./logPrefix.js"; | ||
| import { TotalRewards } from "../../apiClients/types.js"; | ||
|
|
||
| /** | ||
| * Sends validator performance notification to the dappmanager. The notification will have the following format: | ||
| * ``` | ||
| * **Validator(s) performance notification for epoch ** | ||
| * - Blocks: | ||
| * - Proposed: Validator(s) proposed a block | ||
| * - Missed: Validator(s) missed a block | ||
| * - Attestations | ||
| * - Error | ||
| * ``` | ||
| */ | ||
| export async function sendValidatorsPerformanceNotifications({ | ||
| sendNotification, | ||
| dappmanagerApi, | ||
| currentEpoch, | ||
| validatorBlockStatusMap, | ||
| validatorsAttestationsTotalRewards, | ||
| error | ||
| }: { | ||
| sendNotification: boolean; | ||
| dappmanagerApi: DappmanagerApi; | ||
| currentEpoch: string; | ||
| validatorBlockStatusMap: Map<string, BlockProposalStatus>; | ||
| validatorsAttestationsTotalRewards: TotalRewards[]; | ||
| error?: ValidatorPerformanceError; | ||
| }): Promise<void> { | ||
| if (!sendNotification) return; | ||
| if (error) | ||
| await dappmanagerApi.sendDappmanagerNotification({ | ||
| title: "Failed to fetch performance data", | ||
| notificationType: NotificationType.Danger, | ||
| body: `Failed to fetch performance data for epoch ${currentEpoch}: ${error}` | ||
| }); | ||
| else { | ||
| await Promise.all([ | ||
| sendSuccessNotificationNotThrow({ dappmanagerApi, validatorBlockStatusMap, currentEpoch }), | ||
| sendWarningNotificationNotThrow({ | ||
| dappmanagerApi, | ||
| validatorBlockStatusMap, | ||
| validatorsAttestationsTotalRewards, | ||
| currentEpoch | ||
| }) | ||
| ]); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Triggers sending success notification in the dappmanager if any: | ||
| * - blocks proposed | ||
| */ | ||
| async function sendSuccessNotificationNotThrow({ | ||
| dappmanagerApi, | ||
| validatorBlockStatusMap, | ||
| currentEpoch | ||
| }: { | ||
| dappmanagerApi: DappmanagerApi; | ||
| validatorBlockStatusMap: Map<string, BlockProposalStatus>; | ||
| currentEpoch: string; | ||
| }): Promise<void> { | ||
| const validatorsProposedBlocks = Array.from(validatorBlockStatusMap).filter( | ||
| ([_, blockStatus]) => blockStatus === "Proposed" | ||
| ); | ||
|
|
||
| if (validatorsProposedBlocks.length === 0) return; | ||
| await dappmanagerApi | ||
| .sendDappmanagerNotification({ | ||
| title: `Validator(s) proposed a block in epoch ${currentEpoch}`, | ||
| notificationType: NotificationType.Success, | ||
| body: `Validator(s) ${validatorsProposedBlocks.join(", ")} proposed a block` | ||
| }) | ||
| .catch((error) => logger.error(`${logPrefix}Failed to send success notification to dappmanager`, error)); | ||
| } | ||
|
|
||
| /** | ||
| * Triggers sending warning notification in the dappmanager if any: | ||
| * - blocks missed | ||
| * - attestations missed | ||
| */ | ||
| async function sendWarningNotificationNotThrow({ | ||
| dappmanagerApi, | ||
| validatorBlockStatusMap, | ||
| validatorsAttestationsTotalRewards, | ||
| currentEpoch | ||
| }: { | ||
| dappmanagerApi: DappmanagerApi; | ||
| validatorBlockStatusMap: Map<string, BlockProposalStatus>; | ||
| validatorsAttestationsTotalRewards: TotalRewards[]; | ||
| currentEpoch: string; | ||
| }): Promise<void> { | ||
| // Send the warning notification together: block missed and att missed | ||
| const validatorsMissedBlocks = Array.from(validatorBlockStatusMap).filter( | ||
| ([_, blockStatus]) => blockStatus === "Missed" | ||
| ); | ||
| const validatorsMissedAttestations = validatorsAttestationsTotalRewards | ||
| .filter((validator) => parseInt(validator.source) === 0) | ||
| .map((validator) => validator.validator_index); | ||
|
|
||
| if (validatorsMissedBlocks.length === 0 && validatorsMissedAttestations.length === 0) return; | ||
| await dappmanagerApi | ||
| .sendDappmanagerNotification({ | ||
| title: `Validator(s) missed a block or attestation in epoch ${currentEpoch}`, | ||
| notificationType: NotificationType.Warning, | ||
| body: `Validator(s) ${validatorsMissedBlocks.join(", ")} missed a block. Validator(s) ${validatorsMissedAttestations.join( | ||
| ", " | ||
| )} missed an attestation` | ||
| }) | ||
| .catch((error) => logger.error(`${logPrefix}Failed to send warning notification to dappmanager`, error)); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
packages/brain/test/unit/modules/apiClients/dappmanagerApi.unit.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| import { Network } from "@stakingbrain/common"; | ||
| import { DappmanagerApi } from "../../../../src/modules/apiClients/index.js"; | ||
| import { NotificationType } from "../../../../src/modules/apiClients/dappmanager/types.js"; | ||
|
|
||
| describe.skip("Dappmanager API", () => { | ||
| const dappmanagerApi = new DappmanagerApi({ baseUrl: "http://my.dappnode" }, Network.Holesky); | ||
|
|
||
| it("should send a notification to the dappmanager", async () => { | ||
| const title = "Test title"; | ||
| const body = "Test body"; | ||
|
|
||
| await dappmanagerApi.sendDappmanagerNotification({ notificationType: NotificationType.Success, title, body }); | ||
| }); | ||
| }); |