Repository navigation
feat(admin): add bounded NIP-66 probe history and timeline #814
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
Open
Ferryx349
wants to merge
3
commits into
main
Choose a base branch
from
feat/admin-network-health-history
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,5 @@ | ||
| --- | ||
| "nostream": minor | ||
| --- | ||
|
|
||
| Add bounded NIP-66 probe history API and Network Health dashboard timeline |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
49 changes: 49 additions & 0 deletions
49
src/controllers/admin/get-network-health-history-controller.ts
This file contains hidden or 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,49 @@ | ||
| import { Request, Response } from 'express' | ||
|
|
||
| import { IController } from '../../@types/controllers' | ||
| import { Settings } from '../../@types/settings' | ||
| import { | ||
| buildNetworkHealthMismatchContext, | ||
| enrichSnapshotWithMismatches, | ||
| } from '../../utils/network-health-mismatches' | ||
| import { getNip66HistoryRetention } from '../../utils/nip66-schedule' | ||
| import { MAX_PROBE_HISTORY_API_LIMIT, RelayProbeHistoryStore } from '../../utils/relay-probe-history' | ||
| import { loadMergedSettings } from '../../utils/settings-config' | ||
|
|
||
| export const DEFAULT_NETWORK_HEALTH_HISTORY_LIMIT = 24 | ||
|
|
||
| export const parseNetworkHealthHistoryLimit = (raw: unknown): number | null => { | ||
| if (raw === undefined) { | ||
| return DEFAULT_NETWORK_HEALTH_HISTORY_LIMIT | ||
| } | ||
|
|
||
| const parsed = Number(raw) | ||
| if (!Number.isFinite(parsed) || parsed < 1) { | ||
| return null | ||
| } | ||
|
|
||
| return Math.min(Math.floor(parsed), MAX_PROBE_HISTORY_API_LIMIT) | ||
| } | ||
|
|
||
| export class GetAdminNetworkHealthHistoryController implements IController { | ||
| public constructor( | ||
| private readonly historyStore: RelayProbeHistoryStore, | ||
| private readonly getSettings: () => Settings = loadMergedSettings, | ||
| ) {} | ||
|
|
||
| public async handleRequest(request: Request, response: Response): Promise<void> { | ||
| const limit = parseNetworkHealthHistoryLimit(request.query.limit) | ||
| if (limit === null) { | ||
| response.status(400).setHeader('content-type', 'application/json').send({ error: 'limit must be a positive integer' }) | ||
| return | ||
| } | ||
|
|
||
| const settings = this.getSettings() | ||
| const runs = await this.historyStore.list(limit, getNip66HistoryRetention(settings)) | ||
| const enriched = runs.map((snapshot) => | ||
| enrichSnapshotWithMismatches(snapshot, buildNetworkHealthMismatchContext(snapshot, settings)), | ||
| ) | ||
|
|
||
| response.status(200).setHeader('content-type', 'application/json').send({ runs: enriched }) | ||
| } | ||
| } |
11 changes: 11 additions & 0 deletions
11
src/factories/controllers/get-admin-network-health-history-controller-factory.ts
This file contains hidden or 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,11 @@ | ||
| import { RedisAdapter } from '../../adapters/redis-adapter' | ||
| import { IController } from '../../@types/controllers' | ||
| import { getCacheClient } from '../../cache/client' | ||
| import { GetAdminNetworkHealthHistoryController } from '../../controllers/admin/get-network-health-history-controller' | ||
| import { RelayProbeHistoryStore } from '../../utils/relay-probe-history' | ||
|
|
||
| export const createGetAdminNetworkHealthHistoryController = (): IController => { | ||
| const historyStore = new RelayProbeHistoryStore(new RedisAdapter(getCacheClient())) | ||
|
|
||
| return new GetAdminNetworkHealthHistoryController(historyStore) | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.