Compare commits
65 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a74106d665 | |||
| d34b398eed | |||
| b402d95e47 | |||
| 8309a89ba7 | |||
| 9ed1d80b7f | |||
| 4bd8663126 | |||
| f7ff3a4bd7 | |||
| 8f22eb2097 | |||
| 6b59fa6328 | |||
| 070464f2eb | |||
| bbcaa00f0b | |||
| 28c47ab435 | |||
| 6bd0143de4 | |||
| 8b5231fa0d | |||
| a15856bdac | |||
| b22fe98ab0 | |||
| a4ded3c008 | |||
| c446b8596a | |||
| be9d348660 | |||
| 046f80591b | |||
| 57c2c0b822 | |||
| e02bd99a43 | |||
| c45dbadd78 | |||
| f86b1deff8 | |||
| 64d03f0b2d | |||
| a410e07425 | |||
| 07953a7608 | |||
| e7a7460191 | |||
| 833c85f4ac | |||
| f0ef42fe3f | |||
| 9947635855 | |||
| f70d50933d | |||
| edf139d488 | |||
| 101a506eda | |||
| 7c0ad28f6e | |||
| 3e5bf462e9 | |||
| fc3d121599 | |||
| 970cee2c0e | |||
| 7a43ebd395 | |||
| 4c40edfd83 | |||
| f60b8ba02a | |||
| 2225dfdc9e | |||
| 9014912e9d | |||
| c30449b318 | |||
| c377ed4b62 | |||
| dce473662f | |||
| a2bdf11139 | |||
| bc66dfcbbe | |||
| f732d9cf24 | |||
| f2856d000e | |||
| dc5f0c1e5d | |||
| b56925f413 | |||
| 05718d4b91 | |||
| 1fef184f50 | |||
| 57fdb4ed85 | |||
| 8dbf05b7fe | |||
| 7b2d92b714 | |||
| a19b7d97f0 | |||
| 65b47ec191 | |||
| e13c08fd5a | |||
| 101ded43cb | |||
| f4d94c9fcb | |||
| 35c8d50db0 | |||
| 4d169c23ae | |||
| a1a8b30d12 |
123
.claude/skills/nostr-nip-sync.md
Normal file
123
.claude/skills/nostr-nip-sync.md
Normal file
@@ -0,0 +1,123 @@
|
||||
---
|
||||
name: nostr-nip-sync
|
||||
description: Check upstream NIP changes in ./docs/nips and assess required updates to our Elixir Nostr server implementation.
|
||||
scope: project
|
||||
disable-model-invocation: false
|
||||
tags:
|
||||
- elixir
|
||||
- nostr
|
||||
- protocol
|
||||
- maintenance
|
||||
triggers:
|
||||
- "nostr nips"
|
||||
- "sync with upstream nips"
|
||||
- "check for protocol changes"
|
||||
- "review nip updates"
|
||||
---
|
||||
|
||||
You are an assistant responsible for keeping this Elixir-based Nostr server aligned with the upstream Nostr Implementation Possibilities (NIPs) specification.
|
||||
|
||||
## Goal
|
||||
|
||||
When invoked, you will:
|
||||
1. Detect upstream changes to the NIPs repository mirrored as a git submodule at `./docs/nips/`.
|
||||
2. Understand what those changes mean for a Nostr relay implementation.
|
||||
3. Decide whether they require updates to our Elixir server code, configuration, or documentation.
|
||||
4. Propose concrete implementation tasks (modules to touch, new tests, migrations, etc.) or explicitly state that no changes are required.
|
||||
|
||||
The user may optionally pass additional arguments describing context or constraints. Treat all trailing arguments as a free-form description of extra requirements or focus areas.
|
||||
|
||||
## Repository assumptions
|
||||
|
||||
- This project is an Elixir Nostr relay / server.
|
||||
- The upstream NIPs repository is included as a git submodule at `./docs/nips/`, tracking `nostr-protocol/nips` on GitHub.[web:27]
|
||||
- Our implementation aims to conform to all NIPs listed in our project documentation and `CLAUDE.md`, not necessarily every NIP in existence.
|
||||
- Our project uses standard Elixir project structure (`mix.exs`, `lib/`, `test/`, etc.).
|
||||
|
||||
If any of these assumptions appear false based on the actual repository layout, first correct your mental model and explicitly call that out to the user before proceeding.
|
||||
|
||||
## High-level workflow
|
||||
|
||||
When this skill is invoked, follow this procedure:
|
||||
|
||||
1. **Gather local context**
|
||||
- Read `CLAUDE.md` for an overview of the server’s purpose, supported NIPs, architecture, and key modules.
|
||||
- Inspect `mix.exs` and the `lib/` directory to understand the main supervision tree, key contexts, and modules related to Nostr protocol handling (parsing, persistence, filters, subscriptions, etc.).
|
||||
- Look for any existing documentation about supported NIPs (e.g. `docs/`, `README.md`, `SUPPORT.md`, or `NIPS.md`).
|
||||
|
||||
2. **Inspect the NIPs submodule**
|
||||
- Open `./docs/nips/` and identify:
|
||||
- The current git commit (`HEAD`) of the submodule.
|
||||
- The previous commit referenced by the parent repo (if accessible via diff or git history).
|
||||
- If you cannot run `git` commands directly, approximate by:
|
||||
- Listing recently modified NIP files in `./docs/nips/`.
|
||||
- Comparing file contents where possible (old vs new) if the repository history is available locally.
|
||||
- Summarize which NIPs have changed:
|
||||
- New NIPs added.
|
||||
- Existing NIPs significantly modified.
|
||||
- NIPs deprecated, withdrawn, or marked as superseded.
|
||||
|
||||
3. **Map NIP changes to implementation impact**
|
||||
For each changed NIP:
|
||||
|
||||
- Identify the NIP’s purpose (e.g. basic protocol flow, new event kinds, tags, message types, relay behaviours).[web:27]
|
||||
- Determine which aspects of our server may be affected:
|
||||
- Event validation and data model (schemas, changesets, database schema and migrations).
|
||||
- Message types and subscription protocol (WebSocket handlers, filters, back-pressure logic).
|
||||
- Authentication, rate limiting, and relay policy configuration.
|
||||
- New or changed tags, fields, or event kinds that must be supported or rejected.
|
||||
- Operational behaviours like deletions, expirations, and command results.
|
||||
- Check our codebase for references to the relevant NIP ID (e.g. `NIP-01`, `NIP-11`, etc.), related constants, or modules named after the feature (e.g. `Deletion`, `Expiration`, `RelayInfo`, `DMs`).
|
||||
|
||||
4. **Decide if changes are required**
|
||||
For each NIP change, decide between:
|
||||
|
||||
- **No action required**
|
||||
- The change is editorial, clarificatory, or fully backward compatible.
|
||||
- Our current behaviour already matches or exceeds the new requirements.
|
||||
|
||||
- **Implementation update recommended**
|
||||
- The NIP introduces a new mandatory requirement for compliant relays.
|
||||
- The NIP deprecates or changes behaviour we currently rely on.
|
||||
- The NIP adds new event kinds, tags, fields, or message flows that we intend to support.
|
||||
|
||||
- **Design decision required**
|
||||
- The NIP is optional or experimental and may not align with our goals.
|
||||
- The change requires non-trivial architectural decisions or policy updates.
|
||||
|
||||
Be explicit about your reasoning, citing concrete NIP sections and relevant code locations when possible.
|
||||
|
||||
5. **Produce an actionable report**
|
||||
|
||||
Output a structured report with these sections:
|
||||
|
||||
1. `Summary of upstream NIP changes`
|
||||
- Bullet list of changed NIPs with short descriptions.
|
||||
2. `Impact on our server`
|
||||
- For each NIP: whether it is **No action**, **Update recommended**, or **Design decision required**, with a brief justification.
|
||||
3. `Proposed implementation tasks`
|
||||
- Concrete tasks formatted as a checklist with suggested modules/files, e.g.:
|
||||
- `[ ] Add support for new event kind XYZ from NIP-XX in \`lib/nostr/events/\`.`
|
||||
- `[ ] Extend validation for tag ABC per NIP-YY in \`lib/nostr/validation/\` and tests in \`test/nostr/\`.`
|
||||
4. `Open questions / assumptions`
|
||||
- Items where you are not confident and need human confirmation.
|
||||
|
||||
When relevant, include short Elixir code skeletons or diff-style snippets to illustrate changes, but keep them focused and idiomatic.
|
||||
|
||||
## Behavioural guidelines
|
||||
|
||||
- **Be conservative with breaking changes.** If a NIP change might break existing clients or stored data, call that out clearly and recommend a migration strategy.
|
||||
- **Prefer incremental steps.** Propose small, well-scoped PR-sized tasks rather than a monolithic refactor.
|
||||
- **Respect project conventions.** Match the existing style, naming, and architectural patterns described in `CLAUDE.md` and evident in `lib/` and `test/`.
|
||||
- **Keep humans in the loop.** When unsure about how strictly to adhere to a new or optional NIP, surface the tradeoffs and suggest options instead of silently choosing one.
|
||||
|
||||
## Invocation examples
|
||||
|
||||
The skill should handle invocations like:
|
||||
|
||||
- `/nostr-nip-sync`
|
||||
- `/nostr-nip-sync check for new NIPs that affect DMs or deletion semantics`
|
||||
- `/nostr-nip-sync review changes since last submodule update and propose concrete tasks`
|
||||
|
||||
When the user provides extra text after the command, treat it as guidance for what to prioritize in your analysis (e.g. performance, privacy, specific NIPs, or components).
|
||||
|
||||
@@ -13,6 +13,7 @@ POOL_SIZE=20
|
||||
# PARRHESIA_POLICIES_AUTH_REQUIRED_FOR_WRITES=false
|
||||
# PARRHESIA_POLICIES_AUTH_REQUIRED_FOR_READS=false
|
||||
# PARRHESIA_POLICIES_MIN_POW_DIFFICULTY=0
|
||||
# PARRHESIA_SYNC_RELAY_GUARD=false
|
||||
# PARRHESIA_FEATURES_VERIFY_EVENT_SIGNATURES=true
|
||||
# PARRHESIA_METRICS_ENABLED_ON_MAIN_ENDPOINT=true
|
||||
# PARRHESIA_METRICS_PRIVATE_NETWORKS_ONLY=true
|
||||
|
||||
19
.github/workflows/ci.yaml
vendored
19
.github/workflows/ci.yaml
vendored
@@ -25,7 +25,7 @@ jobs:
|
||||
otp: "27.2"
|
||||
elixir: "1.18.2"
|
||||
main: false
|
||||
- name: Test (OTP 28.4 / Elixir 1.19.4 + Marmot E2E)
|
||||
- name: Test (OTP 28.4 / Elixir 1.19.4 + E2E)
|
||||
otp: "28.4"
|
||||
elixir: "1.19.4"
|
||||
main: true
|
||||
@@ -55,8 +55,11 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- name: Init submodules
|
||||
run: |
|
||||
git submodule init marmot-ts
|
||||
git submodule update --recursive
|
||||
|
||||
- name: Set up Elixir + OTP
|
||||
uses: erlef/setup-beam@v1
|
||||
@@ -69,6 +72,11 @@ jobs:
|
||||
with:
|
||||
node-version: 24
|
||||
|
||||
- name: Install just
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y just
|
||||
|
||||
# Cache deps/ directory — keyed on mix.lock
|
||||
- name: Cache Mix deps
|
||||
uses: actions/cache@v4
|
||||
@@ -115,7 +123,8 @@ jobs:
|
||||
|
||||
- name: Run Node Sync E2E tests
|
||||
if: ${{ matrix.main }}
|
||||
run: mix test.node_sync_e2e
|
||||
run: just e2e node-sync
|
||||
|
||||
- name: Run Marmot E2E tests
|
||||
run: mix test.marmot_e2e
|
||||
if: ${{ matrix.main }}
|
||||
run: just e2e marmot
|
||||
|
||||
16
.github/workflows/release.yaml
vendored
16
.github/workflows/release.yaml
vendored
@@ -54,8 +54,11 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- name: Init submodules
|
||||
run: |
|
||||
git submodule init marmot-ts
|
||||
git submodule update --recursive
|
||||
|
||||
- name: Set up Elixir + OTP
|
||||
uses: erlef/setup-beam@v1
|
||||
@@ -68,6 +71,11 @@ jobs:
|
||||
with:
|
||||
node-version: 24
|
||||
|
||||
- name: Install just
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y just
|
||||
|
||||
- name: Cache Mix deps
|
||||
uses: actions/cache@v4
|
||||
id: deps-cache
|
||||
@@ -113,10 +121,10 @@ jobs:
|
||||
run: mix test --color
|
||||
|
||||
- name: Run Node Sync E2E
|
||||
run: mix test.node_sync_e2e
|
||||
run: just e2e node-sync
|
||||
|
||||
- name: Run Marmot E2E
|
||||
run: mix test.marmot_e2e
|
||||
run: just e2e marmot
|
||||
|
||||
- name: Check for unused locked deps
|
||||
run: |
|
||||
|
||||
6
.gitmodules
vendored
6
.gitmodules
vendored
@@ -1,3 +1,9 @@
|
||||
[submodule "marmot-ts"]
|
||||
path = marmot-ts
|
||||
url = https://github.com/marmot-protocol/marmot-ts.git
|
||||
[submodule "docs/nips"]
|
||||
path = docs/nips
|
||||
url = https://github.com/nostr-protocol/nips.git
|
||||
[submodule "nix/nostr-bench"]
|
||||
path = nix/nostr-bench
|
||||
url = ssh://gitea@git.teralink.net:10322/self/nostr-bench.git
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
This is a Nostr server written using Elixir and PostgreSQL.
|
||||
|
||||
NOTE: Nostr and NIP specs are available in `~/nostr/` and `~/nips/`.
|
||||
NOTE: NIP specs are available in `./docs/nips/`.
|
||||
|
||||
## Project guidelines
|
||||
|
||||
- Use `mix precommit` alias when you are done with all changes and fix any pending issues
|
||||
- Use the already included and available `:req` (`Req`) library for HTTP requests, **avoid** `:httpoison`, `:tesla`, and `:httpc`.
|
||||
- Use semantic prefixes in commit messages (feat:, fix:, docs:, chore:, test:, build:, ci:, bench:, dev:)
|
||||
|
||||
<!-- usage-rules-start -->
|
||||
|
||||
|
||||
33
BENCHMARK.md
33
BENCHMARK.md
@@ -1,33 +0,0 @@
|
||||
Running 2 comparison run(s)...
|
||||
Versions:
|
||||
parrhesia 0.4.0
|
||||
strfry 1.0.4 (nixpkgs)
|
||||
nostr-rs-relay 0.9.0
|
||||
nostr-bench 0.4.0
|
||||
|
||||
[run 1/2] Parrhesia
|
||||
[run 1/2] strfry
|
||||
[run 1/2] nostr-rs-relay
|
||||
|
||||
[run 2/2] Parrhesia
|
||||
[run 2/2] strfry
|
||||
[run 2/2] nostr-rs-relay
|
||||
|
||||
=== Bench comparison (averages) ===
|
||||
metric parrhesia strfry nostr-rs-relay strfry/parrhesia nostr-rs/parrhesia
|
||||
-------------------------- --------- -------- -------------- ---------------- ------------------
|
||||
connect avg latency (ms) ↓ 10.50 4.00 3.00 0.38x 0.29x
|
||||
connect max latency (ms) ↓ 19.50 7.50 4.00 0.38x 0.21x
|
||||
echo throughput (TPS) ↑ 78520.00 60353.00 164420.50 0.77x 2.09x
|
||||
echo throughput (MiB/s) ↑ 43.00 33.75 90.05 0.78x 2.09x
|
||||
event throughput (TPS) ↑ 1919.50 3520.50 781.00 1.83x 0.41x
|
||||
event throughput (MiB/s) ↑ 1.25 2.25 0.50 1.80x 0.40x
|
||||
req throughput (TPS) ↑ 4608.50 1809.50 875.50 0.39x 0.19x
|
||||
req throughput (MiB/s) ↑ 26.20 11.75 2.40 0.45x 0.09x
|
||||
|
||||
Legend: ↑ higher is better, ↓ lower is better.
|
||||
Ratio columns are server/parrhesia (for ↓ metrics, <1.00x means that server is faster).
|
||||
|
||||
Run details:
|
||||
run 1: parrhesia(echo_tps=78892, event_tps=1955, req_tps=4671, connect_avg_ms=10) | strfry(echo_tps=59132, event_tps=3462, req_tps=1806, connect_avg_ms=4) | nostr-rs-relay(echo_tps=159714, event_tps=785, req_tps=873, connect_avg_ms=3)
|
||||
run 2: parrhesia(echo_tps=78148, event_tps=1884, req_tps=4546, connect_avg_ms=11) | strfry(echo_tps=61574, event_tps=3579, req_tps=1813, connect_avg_ms=4) | nostr-rs-relay(echo_tps=169127, event_tps=777, req_tps=878, connect_avg_ms=3)
|
||||
18
CHANGELOG.md
Normal file
18
CHANGELOG.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [0.7.0] - 2026-03-20
|
||||
|
||||
First beta release!
|
||||
|
||||
### Added
|
||||
- Configurable WebSocket keepalive support in `Parrhesia.Web.Connection`:
|
||||
- server-initiated `PING` frames
|
||||
- `PONG` timeout handling with connection close on timeout
|
||||
- New runtime limit settings:
|
||||
- `:websocket_ping_interval_seconds` (`PARRHESIA_LIMITS_WEBSOCKET_PING_INTERVAL_SECONDS`)
|
||||
- `:websocket_pong_timeout_seconds` (`PARRHESIA_LIMITS_WEBSOCKET_PONG_TIMEOUT_SECONDS`)
|
||||
|
||||
### Changed
|
||||
- NIP-42 challenge validation now uses constant-time comparison via `Plug.Crypto.secure_compare/2`.
|
||||
279
README.md
279
README.md
@@ -2,9 +2,16 @@
|
||||
|
||||
<img alt="Parrhesia Logo" src="./docs/logo.svg" width="150" align="right">
|
||||
|
||||
Parrhesia is a Nostr relay server written in Elixir/OTP with PostgreSQL storage.
|
||||
Parrhesia is a Nostr relay server written in Elixir/OTP.
|
||||
|
||||
**ALPHA CONDITION – BREAKING CHANGES MIGHT HAPPEN!**
|
||||
**BETA CONDITION – BREAKING CHANGES MAY STILL HAPPEN!**
|
||||
|
||||
Supported storage backends:
|
||||
|
||||
- PostgreSQL, which is the primary and production-oriented backend
|
||||
- in-memory storage, which is useful for tests, local experiments, and benchmarks
|
||||
|
||||
Advanced Nostr features:
|
||||
|
||||
- Advanced Querying: Full-text search (NIP-50) and COUNT queries (NIP-45).
|
||||
- Secure Messaging: First-class support for Marmot MLS-encrypted groups and NIP-17/44/59 gift-wrapped DMs.
|
||||
@@ -32,15 +39,34 @@ Current `supported_nips` list:
|
||||
|
||||
`1, 9, 11, 13, 17, 40, 42, 43, 44, 45, 50, 59, 62, 66, 70, 77, 86, 98`
|
||||
|
||||
`43` is advertised when the built-in NIP-43 relay access flow is enabled. Parrhesia generates relay-signed `28935` invite responses on `REQ`, validates join and leave requests locally, and publishes the resulting signed `8000`, `8001`, and `13534` relay membership events into its own local event store.
|
||||
|
||||
`50` uses ranked PostgreSQL full-text search over event `content` by default. Parrhesia applies the filter `limit` after ordering by match quality, and falls back to trigram-backed substring matching for short or symbol-heavy queries such as search-as-you-type prefixes, domains, and punctuation-rich tokens.
|
||||
|
||||
`66` is advertised when the built-in NIP-66 publisher is enabled and has at least one relay target. The default config enables it for the `public` relay URL. Parrhesia probes those target relays, collects the resulting NIP-11 / websocket liveness data, and then publishes the signed `10166` and `30166` events locally on this relay.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Elixir `~> 1.19`
|
||||
- Elixir `~> 1.18`
|
||||
- Erlang/OTP 28
|
||||
- PostgreSQL (18 used in the dev environment; 16+ recommended)
|
||||
- [`just`](https://github.com/casey/just) for the command runner used in this repo
|
||||
- Docker or Podman plus Docker Compose support if you want to run the published container image
|
||||
|
||||
---
|
||||
|
||||
## Command runner (`just`)
|
||||
|
||||
This repo includes a `justfile` that provides a grouped command/subcommand CLI over common mix tasks and scripts.
|
||||
|
||||
```bash
|
||||
just
|
||||
just help bench
|
||||
just help e2e
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Run locally
|
||||
|
||||
### 1) Prepare the database
|
||||
@@ -86,9 +112,9 @@ ws://localhost:4413/relay
|
||||
Primary test entrypoints:
|
||||
|
||||
- `mix test` for the ExUnit suite
|
||||
- `mix test.marmot_e2e` for the Marmot client end-to-end suite
|
||||
- `mix test.node_sync_e2e` for the two-node relay sync end-to-end suite
|
||||
- `mix test.node_sync_docker_e2e` for the release-image Docker two-node relay sync suite
|
||||
- `just e2e marmot` for the Marmot client end-to-end suite
|
||||
- `just e2e node-sync` for the two-node relay sync end-to-end suite
|
||||
- `just e2e node-sync-docker` for the release-image Docker two-node relay sync suite
|
||||
|
||||
The node-sync harnesses are driven by:
|
||||
|
||||
@@ -97,12 +123,59 @@ The node-sync harnesses are driven by:
|
||||
- [`scripts/node_sync_e2e.exs`](./scripts/node_sync_e2e.exs)
|
||||
- [`compose.node-sync-e2e.yaml`](./compose.node-sync-e2e.yaml)
|
||||
|
||||
`mix test.node_sync_e2e` runs two real Parrhesia nodes against separate PostgreSQL databases, verifies catch-up and live sync, restarts one node, and verifies persisted resume behavior. `mix test.node_sync_docker_e2e` runs the same scenario against the release Docker image.
|
||||
`just e2e node-sync` runs two real Parrhesia nodes against separate PostgreSQL databases, verifies catch-up and live sync, restarts one node, and verifies persisted resume behavior. `just e2e node-sync-docker` runs the same scenario against the release Docker image.
|
||||
|
||||
GitHub CI currently runs the non-Docker node-sync e2e on the main Linux matrix job. The Docker node-sync e2e remains an explicit/manual check because it depends on release-image build/runtime fidelity and a working Docker host.
|
||||
|
||||
---
|
||||
|
||||
## Embedding in another Elixir app
|
||||
|
||||
Parrhesia is usable as an embedded OTP dependency, not just as a standalone relay process.
|
||||
The intended in-process surface is `Parrhesia.API.*`, especially:
|
||||
|
||||
- `Parrhesia.API.Events` for publish, query, and count
|
||||
- `Parrhesia.API.Stream` for local REQ-like subscriptions
|
||||
- `Parrhesia.API.Admin` for management operations
|
||||
- `Parrhesia.API.Identity`, `Parrhesia.API.ACL`, and `Parrhesia.API.Sync` for relay identity, protected sync ACLs, and outbound relay sync
|
||||
|
||||
For host-managed HTTP/WebSocket ingress mounting, use `Parrhesia.Plug`.
|
||||
|
||||
Start with:
|
||||
|
||||
- [`docs/LOCAL_API.md`](./docs/LOCAL_API.md) for the embedding model and a minimal host setup
|
||||
- generated ExDoc for the `Embedded API` module group when running `mix docs`
|
||||
|
||||
Important caveats for host applications:
|
||||
|
||||
- Parrhesia is beta software; expect some API and config churn as the runtime stabilizes.
|
||||
- Parrhesia currently assumes a single runtime per BEAM node and uses globally registered process names.
|
||||
- The defaults in this repo's `config/*.exs` are not imported automatically when Parrhesia is used as a dependency. A host app must set `config :parrhesia, ...` explicitly.
|
||||
- The host app is responsible for migrating Parrhesia's schema, for example with `Parrhesia.Release.migrate()` or `mix ecto.migrate -r Parrhesia.Repo`.
|
||||
|
||||
### Official embedding boundary
|
||||
|
||||
For embedded use, the stable boundaries are:
|
||||
|
||||
- `Parrhesia.API.*` for in-process publish/query/admin/sync operations
|
||||
- `Parrhesia.Plug` for host-managed HTTP/WebSocket ingress mounting
|
||||
|
||||
If your host app owns the public HTTPS endpoint, keep this as the baseline runtime config:
|
||||
|
||||
```elixir
|
||||
config :parrhesia, :listeners, %{}
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- `listeners: %{}` disables Parrhesia-managed HTTP/WebSocket ingress (`/relay`, `/management`, `/metrics`, etc.).
|
||||
- Mount `Parrhesia.Plug` in your host endpoint/router when you still want Parrhesia ingress under the host's single HTTPS surface.
|
||||
- `Parrhesia.Web.*` modules remain internal runtime wiring. Use `Parrhesia.Plug` as the documented mount API.
|
||||
|
||||
The config reference below still applies when embedded. That is the primary place to document basic setup and runtime configuration changes.
|
||||
|
||||
---
|
||||
|
||||
## Production configuration
|
||||
|
||||
### Minimal setup
|
||||
@@ -112,6 +185,9 @@ Before a Nostr client can publish its first event successfully, make sure these
|
||||
1. PostgreSQL is reachable from Parrhesia.
|
||||
Set `DATABASE_URL` and create/migrate the database with `Parrhesia.Release.migrate()` or `mix ecto.migrate`.
|
||||
|
||||
PostgreSQL is the supported production datastore. The in-memory backend is intended for
|
||||
non-persistent runs such as tests and benchmarks.
|
||||
|
||||
2. Parrhesia listeners are configured for your deployment.
|
||||
The default config exposes a `public` listener on plain HTTP port `4413`, and a reverse proxy can terminate TLS and forward WebSocket traffic to `/relay`. Additional listeners can be defined in `config/*.exs`.
|
||||
|
||||
@@ -129,7 +205,7 @@ In `prod`, these environment variables are used:
|
||||
- `DATABASE_URL` (**required**), e.g. `ecto://USER:PASS@HOST/parrhesia_prod`
|
||||
- `POOL_SIZE` (optional, default `32`)
|
||||
- `PORT` (optional, default `4413`)
|
||||
- `PARRHESIA_*` runtime overrides for relay config, limits, policies, listener-related metrics helpers, and features
|
||||
- `PARRHESIA_*` runtime overrides for relay config, metadata, identity, sync, ACL, limits, policies, listeners, retention, and features
|
||||
- `PARRHESIA_EXTRA_CONFIG` (optional path to an extra runtime config file)
|
||||
|
||||
`config/runtime.exs` reads these values at runtime in production releases.
|
||||
@@ -139,12 +215,20 @@ In `prod`, these environment variables are used:
|
||||
For runtime overrides, use the `PARRHESIA_...` prefix:
|
||||
|
||||
- `PARRHESIA_RELAY_URL`
|
||||
- `PARRHESIA_METADATA_HIDE_VERSION`
|
||||
- `PARRHESIA_IDENTITY_*`
|
||||
- `PARRHESIA_SYNC_*`
|
||||
- `PARRHESIA_ACL_*`
|
||||
- `PARRHESIA_TRUSTED_PROXIES`
|
||||
- `PARRHESIA_PUBLIC_MAX_CONNECTIONS`
|
||||
- `PARRHESIA_MODERATION_CACHE_ENABLED`
|
||||
- `PARRHESIA_ENABLE_EXPIRATION_WORKER`
|
||||
- `PARRHESIA_ENABLE_PARTITION_RETENTION_WORKER`
|
||||
- `PARRHESIA_STORAGE_BACKEND`
|
||||
- `PARRHESIA_LIMITS_*`
|
||||
- `PARRHESIA_POLICIES_*`
|
||||
- `PARRHESIA_METRICS_*`
|
||||
- `PARRHESIA_METRICS_ENDPOINT_MAX_CONNECTIONS`
|
||||
- `PARRHESIA_RETENTION_*`
|
||||
- `PARRHESIA_FEATURES_*`
|
||||
- `PARRHESIA_METRICS_ENDPOINT_*`
|
||||
@@ -153,12 +237,11 @@ Examples:
|
||||
|
||||
```bash
|
||||
export PARRHESIA_POLICIES_AUTH_REQUIRED_FOR_WRITES=true
|
||||
export PARRHESIA_FEATURES_VERIFY_EVENT_SIGNATURES=true
|
||||
export PARRHESIA_METRICS_ALLOWED_CIDRS="10.0.0.0/8,192.168.0.0/16"
|
||||
export PARRHESIA_LIMITS_OUTBOUND_OVERFLOW_STRATEGY=drop_oldest
|
||||
```
|
||||
|
||||
Listeners themselves are primarily configured under `config :parrhesia, :listeners, ...`. The current runtime env helpers tune the default public listener and the optional dedicated metrics listener.
|
||||
Listeners themselves are primarily configured under `config :parrhesia, :listeners, ...`. The current runtime env helpers tune the default public listener and the optional dedicated metrics listener, including their connection ceilings.
|
||||
|
||||
For settings that are awkward to express as env vars, mount an extra config file and set `PARRHESIA_EXTRA_CONFIG` to its path inside the container.
|
||||
|
||||
@@ -171,8 +254,17 @@ CSV env vars use comma-separated values. Boolean env vars accept `1/0`, `true/fa
|
||||
| Atom key | ENV | Default | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| `:relay_url` | `PARRHESIA_RELAY_URL` | `ws://localhost:4413/relay` | Advertised relay URL and auth relay tag target |
|
||||
| `:metadata.hide_version?` | `PARRHESIA_METADATA_HIDE_VERSION` | `true` | Hides the relay version from outbound `User-Agent` and NIP-11 when enabled |
|
||||
| `:acl.protected_filters` | `PARRHESIA_ACL_PROTECTED_FILTERS` | `[]` | JSON-encoded protected filter list for sync ACL checks |
|
||||
| `:identity.path` | `PARRHESIA_IDENTITY_PATH` | `nil` | Optional path for persisted relay identity material |
|
||||
| `:identity.private_key` | `PARRHESIA_IDENTITY_PRIVATE_KEY` | `nil` | Optional inline relay private key |
|
||||
| `:moderation_cache_enabled` | `PARRHESIA_MODERATION_CACHE_ENABLED` | `true` | Toggle moderation cache |
|
||||
| `:enable_expiration_worker` | `PARRHESIA_ENABLE_EXPIRATION_WORKER` | `true` | Toggle background expiration worker |
|
||||
| `:nip43` | config-file driven | see table below | Built-in NIP-43 relay access invite / membership flow |
|
||||
| `:nip66` | config-file driven | see table below | Built-in NIP-66 discovery / monitor publisher |
|
||||
| `:sync.path` | `PARRHESIA_SYNC_PATH` | `nil` | Optional path to sync peer config |
|
||||
| `:sync.start_workers?` | `PARRHESIA_SYNC_START_WORKERS` | `true` | Start outbound sync workers on boot |
|
||||
| `:sync.relay_guard` | `PARRHESIA_SYNC_RELAY_GUARD` | `false` | Suppress multi-node re-fanout for sync-originated events |
|
||||
| `:limits` | `PARRHESIA_LIMITS_*` | see table below | Runtime override group |
|
||||
| `:policies` | `PARRHESIA_POLICIES_*` | see table below | Runtime override group |
|
||||
| `:listeners` | config-file driven | see notes below | Ingress listeners with bind, transport, feature, auth, network, and baseline ACL settings |
|
||||
@@ -193,18 +285,86 @@ CSV env vars use comma-separated values. Boolean env vars accept `1/0`, `true/fa
|
||||
| `:queue_interval` | `DB_QUEUE_INTERVAL_MS` | `5000` | Ecto queue interval in ms |
|
||||
| `:types` | `-` | `Parrhesia.PostgresTypes` | Internal config-file setting |
|
||||
|
||||
#### `Parrhesia.ReadRepo`
|
||||
|
||||
| Atom key | ENV | Default | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| `:url` | `DATABASE_URL` | required | Shares the primary DB URL with the write repo |
|
||||
| `:pool_size` | `DB_READ_POOL_SIZE` | `32` | Read-only query pool size |
|
||||
| `:queue_target` | `DB_READ_QUEUE_TARGET_MS` | `1000` | Read pool Ecto queue target in ms |
|
||||
| `:queue_interval` | `DB_READ_QUEUE_INTERVAL_MS` | `5000` | Read pool Ecto queue interval in ms |
|
||||
| `:types` | `-` | `Parrhesia.PostgresTypes` | Internal config-file setting |
|
||||
|
||||
#### `:listeners`
|
||||
|
||||
| Atom key | ENV | Default | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| `:public.bind.port` | `PORT` | `4413` | Default public listener port |
|
||||
| `:public.max_connections` | `PARRHESIA_PUBLIC_MAX_CONNECTIONS` | `20000` | Target total connection ceiling for the public listener |
|
||||
| `:public.proxy.trusted_cidrs` | `PARRHESIA_TRUSTED_PROXIES` | `[]` | Trusted reverse proxies for forwarded IP handling |
|
||||
| `:public.features.metrics.*` | `PARRHESIA_METRICS_*` | see below | Convenience runtime overrides for metrics on the public listener |
|
||||
| `:metrics.bind.port` | `PARRHESIA_METRICS_ENDPOINT_PORT` | `9568` | Optional dedicated metrics listener port |
|
||||
| `:metrics.max_connections` | `PARRHESIA_METRICS_ENDPOINT_MAX_CONNECTIONS` | `1024` | Target total connection ceiling for the dedicated metrics listener |
|
||||
| `:metrics.enabled` | `PARRHESIA_METRICS_ENDPOINT_ENABLED` | `false` | Enables the optional dedicated metrics listener |
|
||||
|
||||
Listener `max_connections` is a first-class config field. Parrhesia translates it to ThousandIsland's per-acceptor `num_connections` limit based on the active acceptor count. Raw `bandit_options[:thousand_island_options]` can still override that for advanced tuning.
|
||||
|
||||
Listener `transport.tls` supports `:disabled`, `:server`, `:mutual`, and `:proxy_terminated`. For TLS-enabled listeners, the main config-file fields are `certfile`, `keyfile`, optional `cacertfile`, optional `cipher_suite`, optional `client_pins`, and `proxy_headers` for proxy-terminated identity.
|
||||
|
||||
Every listener supports this config-file schema:
|
||||
|
||||
| Atom key | ENV | Default | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| `:id` | `-` | listener key or `:listener` | Listener identifier |
|
||||
| `:enabled` | public/metrics helpers only | `true` | Whether the listener is started |
|
||||
| `:bind.ip` | `-` | `0.0.0.0` (`public`) / `127.0.0.1` (`metrics`) | Bind address |
|
||||
| `:bind.port` | `PORT` / `PARRHESIA_METRICS_ENDPOINT_PORT` | `4413` / `9568` | Bind port |
|
||||
| `:max_connections` | `PARRHESIA_PUBLIC_MAX_CONNECTIONS` / `PARRHESIA_METRICS_ENDPOINT_MAX_CONNECTIONS` | `20000` / `1024` | Target total listener connection ceiling; accepts integer or `:infinity` in config files |
|
||||
| `:transport.scheme` | `-` | `:http` | Listener scheme |
|
||||
| `:transport.tls` | `-` | `%{mode: :disabled}` | TLS mode and TLS-specific options |
|
||||
| `:proxy.trusted_cidrs` | `PARRHESIA_TRUSTED_PROXIES` on `public` | `[]` | Trusted proxy CIDRs for forwarded identity / IP handling |
|
||||
| `:proxy.honor_x_forwarded_for` | `-` | `true` | Respect `X-Forwarded-For` from trusted proxies |
|
||||
| `:network.public` | `-` | `false` | Allow only public networks |
|
||||
| `:network.private_networks_only` | `-` | `false` | Allow only RFC1918 / local networks |
|
||||
| `:network.allow_cidrs` | `-` | `[]` | Explicit CIDR allowlist |
|
||||
| `:network.allow_all` | `-` | `true` | Allow all source IPs |
|
||||
| `:features.nostr.enabled` | `-` | `true` on `public`, `false` on metrics listener | Enables `/relay` |
|
||||
| `:features.admin.enabled` | `-` | `true` on `public`, `false` on metrics listener | Enables `/management` |
|
||||
| `:features.metrics.enabled` | `PARRHESIA_METRICS_ENABLED_ON_MAIN_ENDPOINT` on `public` | `true` on `public`, `true` on metrics listener | Enables `/metrics` |
|
||||
| `:features.metrics.auth_token` | `PARRHESIA_METRICS_AUTH_TOKEN` | `nil` | Optional bearer token for `/metrics` |
|
||||
| `:features.metrics.access.public` | `PARRHESIA_METRICS_PUBLIC` | `false` | Allow public-network access to `/metrics` |
|
||||
| `:features.metrics.access.private_networks_only` | `PARRHESIA_METRICS_PRIVATE_NETWORKS_ONLY` | `true` | Restrict `/metrics` to private networks |
|
||||
| `:features.metrics.access.allow_cidrs` | `PARRHESIA_METRICS_ALLOWED_CIDRS` | `[]` | Additional CIDR allowlist for `/metrics` |
|
||||
| `:features.metrics.access.allow_all` | `-` | `true` | Unconditional metrics access in config files |
|
||||
| `:auth.nip42_required` | `-` | `false` | Require NIP-42 for relay reads / writes |
|
||||
| `:auth.nip98_required_for_admin` | `PARRHESIA_POLICIES_MANAGEMENT_AUTH_REQUIRED` on `public` | `true` | Require NIP-98 for management API calls |
|
||||
| `:baseline_acl.read` | `-` | `[]` | Static read deny/allow rules |
|
||||
| `:baseline_acl.write` | `-` | `[]` | Static write deny/allow rules |
|
||||
| `:bandit_options` | `-` | `[]` | Advanced Bandit / ThousandIsland passthrough |
|
||||
|
||||
#### `:nip66`
|
||||
|
||||
| Atom key | ENV | Default | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| `:enabled` | `-` | `true` | Enables the built-in NIP-66 publisher worker |
|
||||
| `:publish_interval_seconds` | `-` | `900` | Republish cadence for `10166` and `30166` events |
|
||||
| `:publish_monitor_announcement?` | `-` | `true` | Publish a `10166` monitor announcement alongside discovery events |
|
||||
| `:timeout_ms` | `-` | `5000` | Probe timeout for websocket and NIP-11 checks |
|
||||
| `:checks` | `-` | `[:open, :read, :nip11]` | Checks advertised in `10166` and run against each target relay during probing |
|
||||
| `:targets` | `-` | `[]` | Optional explicit relay targets to probe; when empty, Parrhesia uses `:relay_url` for the `public` listener |
|
||||
|
||||
NIP-66 targets are probe sources, not publish destinations. Parrhesia connects to each target relay, collects the configured liveness / discovery data, and stores the resulting signed `10166` / `30166` events in its own local event store so clients can query them here.
|
||||
|
||||
#### `:nip43`
|
||||
|
||||
| Atom key | ENV | Default | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| `:enabled` | `-` | `true` | Enables the built-in NIP-43 relay access flow and advertises `43` in NIP-11 |
|
||||
| `:invite_ttl_seconds` | `-` | `900` | Expiration window for generated invite claim strings returned by `REQ` filters targeting kind `28935` |
|
||||
| `:request_max_age_seconds` | `-` | `300` | Maximum allowed age for inbound join (`28934`) and leave (`28936`) requests |
|
||||
|
||||
Parrhesia treats NIP-43 invite requests as synthetic relay output, not stored client input. A `REQ` for kind `28935` causes the relay to generate a fresh relay-signed invite event on the fly. Clients then submit that claim back in a protected kind `28934` join request. When a join or leave request is accepted, Parrhesia updates its local relay membership state and publishes the corresponding relay-signed `8000` / `8001` delta plus the latest `13534` membership snapshot locally.
|
||||
|
||||
#### `:limits`
|
||||
|
||||
| Atom key | ENV | Default |
|
||||
@@ -213,17 +373,27 @@ Listener `transport.tls` supports `:disabled`, `:server`, `:mutual`, and `:proxy
|
||||
| `:max_event_bytes` | `PARRHESIA_LIMITS_MAX_EVENT_BYTES` | `262144` |
|
||||
| `:max_filters_per_req` | `PARRHESIA_LIMITS_MAX_FILTERS_PER_REQ` | `16` |
|
||||
| `:max_filter_limit` | `PARRHESIA_LIMITS_MAX_FILTER_LIMIT` | `500` |
|
||||
| `:max_tags_per_event` | `PARRHESIA_LIMITS_MAX_TAGS_PER_EVENT` | `256` |
|
||||
| `:max_tag_values_per_filter` | `PARRHESIA_LIMITS_MAX_TAG_VALUES_PER_FILTER` | `128` |
|
||||
| `:ip_max_event_ingest_per_window` | `PARRHESIA_LIMITS_IP_MAX_EVENT_INGEST_PER_WINDOW` | `1000` |
|
||||
| `:ip_event_ingest_window_seconds` | `PARRHESIA_LIMITS_IP_EVENT_INGEST_WINDOW_SECONDS` | `1` |
|
||||
| `:relay_max_event_ingest_per_window` | `PARRHESIA_LIMITS_RELAY_MAX_EVENT_INGEST_PER_WINDOW` | `10000` |
|
||||
| `:relay_event_ingest_window_seconds` | `PARRHESIA_LIMITS_RELAY_EVENT_INGEST_WINDOW_SECONDS` | `1` |
|
||||
| `:max_subscriptions_per_connection` | `PARRHESIA_LIMITS_MAX_SUBSCRIPTIONS_PER_CONNECTION` | `32` |
|
||||
| `:max_event_future_skew_seconds` | `PARRHESIA_LIMITS_MAX_EVENT_FUTURE_SKEW_SECONDS` | `900` |
|
||||
| `:max_event_ingest_per_window` | `PARRHESIA_LIMITS_MAX_EVENT_INGEST_PER_WINDOW` | `120` |
|
||||
| `:event_ingest_window_seconds` | `PARRHESIA_LIMITS_EVENT_INGEST_WINDOW_SECONDS` | `1` |
|
||||
| `:auth_max_age_seconds` | `PARRHESIA_LIMITS_AUTH_MAX_AGE_SECONDS` | `600` |
|
||||
| `:websocket_ping_interval_seconds` | `PARRHESIA_LIMITS_WEBSOCKET_PING_INTERVAL_SECONDS` | `30` |
|
||||
| `:websocket_pong_timeout_seconds` | `PARRHESIA_LIMITS_WEBSOCKET_PONG_TIMEOUT_SECONDS` | `10` |
|
||||
| `:max_outbound_queue` | `PARRHESIA_LIMITS_MAX_OUTBOUND_QUEUE` | `256` |
|
||||
| `:outbound_drain_batch_size` | `PARRHESIA_LIMITS_OUTBOUND_DRAIN_BATCH_SIZE` | `64` |
|
||||
| `:outbound_overflow_strategy` | `PARRHESIA_LIMITS_OUTBOUND_OVERFLOW_STRATEGY` | `:close` |
|
||||
| `:max_negentropy_payload_bytes` | `PARRHESIA_LIMITS_MAX_NEGENTROPY_PAYLOAD_BYTES` | `4096` |
|
||||
| `:max_negentropy_sessions_per_connection` | `PARRHESIA_LIMITS_MAX_NEGENTROPY_SESSIONS_PER_CONNECTION` | `8` |
|
||||
| `:max_negentropy_total_sessions` | `PARRHESIA_LIMITS_MAX_NEGENTROPY_TOTAL_SESSIONS` | `10000` |
|
||||
| `:max_negentropy_items_per_session` | `PARRHESIA_LIMITS_MAX_NEGENTROPY_ITEMS_PER_SESSION` | `50000` |
|
||||
| `:negentropy_id_list_threshold` | `PARRHESIA_LIMITS_NEGENTROPY_ID_LIST_THRESHOLD` | `32` |
|
||||
| `:negentropy_session_idle_timeout_seconds` | `PARRHESIA_LIMITS_NEGENTROPY_SESSION_IDLE_TIMEOUT_SECONDS` | `60` |
|
||||
| `:negentropy_session_sweep_interval_seconds` | `PARRHESIA_LIMITS_NEGENTROPY_SESSION_SWEEP_INTERVAL_SECONDS` | `10` |
|
||||
|
||||
@@ -277,12 +447,14 @@ Listener `transport.tls` supports `:disabled`, `:server`, `:mutual`, and `:proxy
|
||||
|
||||
| Atom key | ENV | Default |
|
||||
| --- | --- | --- |
|
||||
| `:verify_event_signatures` | `PARRHESIA_FEATURES_VERIFY_EVENT_SIGNATURES` | `true` |
|
||||
| `:verify_event_signatures` | `-` | `true` |
|
||||
| `:nip_45_count` | `PARRHESIA_FEATURES_NIP_45_COUNT` | `true` |
|
||||
| `:nip_50_search` | `PARRHESIA_FEATURES_NIP_50_SEARCH` | `true` |
|
||||
| `:nip_77_negentropy` | `PARRHESIA_FEATURES_NIP_77_NEGENTROPY` | `true` |
|
||||
| `:marmot_push_notifications` | `PARRHESIA_FEATURES_MARMOT_PUSH_NOTIFICATIONS` | `false` |
|
||||
|
||||
`:verify_event_signatures` is config-file only. Production releases always verify event signatures.
|
||||
|
||||
#### Extra runtime config
|
||||
|
||||
| Atom key | ENV | Default | Notes |
|
||||
@@ -315,7 +487,7 @@ For systemd/process managers, run the release command with `start`.
|
||||
Build:
|
||||
|
||||
```bash
|
||||
nix-build
|
||||
nix build
|
||||
```
|
||||
|
||||
Run the built release from `./result/bin/parrhesia` (release command interface).
|
||||
@@ -399,31 +571,82 @@ Notes:
|
||||
|
||||
## Benchmark
|
||||
|
||||
The benchmark compares Parrhesia against [`strfry`](https://github.com/hoytech/strfry) and [`nostr-rs-relay`](https://sr.ht/~gheartsfield/nostr-rs-relay/) using [`nostr-bench`](https://github.com/rnostr/nostr-bench).
|
||||
The benchmark compares two Parrhesia profiles, one backed by PostgreSQL and one backed by the in-memory adapter, against [`strfry`](https://github.com/hoytech/strfry) and [`nostr-rs-relay`](https://sr.ht/~gheartsfield/nostr-rs-relay/) using [`nostr-bench`](https://github.com/rnostr/nostr-bench). The cloud benchmark target set also includes [`nostream`](https://github.com/Cameri/nostream) and [`Haven`](https://github.com/bitvora/haven). Benchmark runs also lift Parrhesia's relay-side limits by default so the benchmark client, not server guardrails, is the main bottleneck.
|
||||
|
||||
`just bench compare` is a sequential mixed-workload benchmark, not an isolated per-endpoint microbenchmark. Each relay instance runs `connect`, then `echo`, then `event`, then `req` against the same live process, so later phases measure against state and load created by earlier phases.
|
||||
|
||||
Run it with:
|
||||
|
||||
```bash
|
||||
mix bench
|
||||
just bench compare
|
||||
```
|
||||
|
||||
Current comparison results from [BENCHMARK.md](./BENCHMARK.md):
|
||||
### Cloud benchmark (Hetzner Cloud)
|
||||
|
||||
| metric | parrhesia | strfry | nostr-rs-relay | strfry/parrhesia | nostr-rs/parrhesia |
|
||||
| --- | ---: | ---: | ---: | ---: | ---: |
|
||||
| connect avg latency (ms) ↓ | 13.50 | 3.00 | 2.00 | **0.22x** | **0.15x** |
|
||||
| connect max latency (ms) ↓ | 22.50 | 5.50 | 3.00 | **0.24x** | **0.13x** |
|
||||
| echo throughput (TPS) ↑ | 80385.00 | 61673.00 | 164516.00 | 0.77x | **2.05x** |
|
||||
| echo throughput (MiB/s) ↑ | 44.00 | 34.45 | 90.10 | 0.78x | **2.05x** |
|
||||
| event throughput (TPS) ↑ | 2000.00 | 3404.50 | 788.00 | **1.70x** | 0.39x |
|
||||
| event throughput (MiB/s) ↑ | 1.30 | 2.20 | 0.50 | **1.69x** | 0.38x |
|
||||
| req throughput (TPS) ↑ | 3664.00 | 1808.50 | 877.50 | 0.49x | 0.24x |
|
||||
| req throughput (MiB/s) ↑ | 20.75 | 11.75 | 2.45 | 0.57x | 0.12x |
|
||||
For distributed runs (one server node + multiple client nodes), use:
|
||||
|
||||
```bash
|
||||
just bench cloud
|
||||
# or: ./scripts/run_bench_cloud.sh
|
||||
```
|
||||
|
||||
or invoke the orchestrator directly:
|
||||
|
||||
```bash
|
||||
node scripts/cloud_bench_orchestrate.mjs
|
||||
```
|
||||
|
||||
Prerequisites:
|
||||
|
||||
- [`hcloud`](https://github.com/hetznercloud/cli) CLI installed
|
||||
- Hetzner Cloud token exported as `HCLOUD_TOKEN`
|
||||
- local `docker`, `git`, `ssh`, and `scp` available
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
export HCLOUD_TOKEN=...
|
||||
just bench cloud-quick
|
||||
# or: ./scripts/run_bench_cloud.sh --quick
|
||||
```
|
||||
|
||||
Outputs:
|
||||
|
||||
- raw client logs per run: `bench/cloud_artifacts/<run_id>/...`
|
||||
- JSONL history entries (local + cloud): `bench/history.jsonl`
|
||||
|
||||
Useful history/render commands:
|
||||
|
||||
```bash
|
||||
# List available machines and runs in history
|
||||
just bench list
|
||||
|
||||
# Regenerate chart + README table for a machine
|
||||
just bench update <machine_id>
|
||||
|
||||
# Regenerate from all machines
|
||||
just bench update all
|
||||
```
|
||||
|
||||
Current comparison results:
|
||||
|
||||
| metric | parrhesia-pg | parrhesia-mem | strfry | nostr-rs-relay | mem/pg | strfry/pg | nostr-rs-relay/pg |
|
||||
| --- | ---: | ---: | ---: | ---: | ---: | ---: | ---: |
|
||||
| connect avg latency (ms) ↓ | 34.67 | 43.33 | 2.67 | 2.67 | 1.25x | **0.08x** | **0.08x** |
|
||||
| connect max latency (ms) ↓ | 61.67 | 74.67 | 4.67 | 4.00 | 1.21x | **0.08x** | **0.06x** |
|
||||
| echo throughput (TPS) ↑ | 72441.00 | 62704.67 | 61189.33 | 152654.33 | 0.87x | 0.84x | **2.11x** |
|
||||
| echo throughput (MiB/s) ↑ | 39.67 | 34.30 | 34.20 | 83.63 | 0.86x | 0.86x | **2.11x** |
|
||||
| event throughput (TPS) ↑ | 1897.33 | 1370.00 | 3426.67 | 772.67 | 0.72x | **1.81x** | 0.41x |
|
||||
| event throughput (MiB/s) ↑ | 1.23 | 0.87 | 2.20 | 0.50 | 0.70x | **1.78x** | 0.41x |
|
||||
| req throughput (TPS) ↑ | 13.33 | 47.00 | 1811.33 | 878.33 | **3.52x** | **135.85x** | **65.88x** |
|
||||
| req throughput (MiB/s) ↑ | 0.03 | 0.17 | 11.77 | 2.40 | **5.00x** | **353.00x** | **72.00x** |
|
||||
|
||||
Higher is better for `↑` metrics. Lower is better for `↓` metrics.
|
||||
|
||||
(Results from a Linux container on a 6-core Intel i5-8400T with NVMe drive, PostgreSQL 18)
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Development quality checks
|
||||
@@ -437,11 +660,13 @@ mix precommit
|
||||
Additional external CLI end-to-end checks with `nak`:
|
||||
|
||||
```bash
|
||||
mix test.nak_e2e
|
||||
just e2e nak
|
||||
```
|
||||
|
||||
For Marmot client end-to-end checks (TypeScript/Node suite using `marmot-ts`, included in `precommit`):
|
||||
|
||||
```bash
|
||||
mix test.marmot_e2e
|
||||
just e2e marmot
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
31
bench/chart.gnuplot
Normal file
31
bench/chart.gnuplot
Normal file
@@ -0,0 +1,31 @@
|
||||
# bench/chart.gnuplot — multi-panel SVG showing relay performance over git tags.
|
||||
#
|
||||
# Invoked by scripts/run_bench_update.sh with:
|
||||
# gnuplot -e "data_dir='...'" -e "output_file='...'" bench/chart.gnuplot
|
||||
#
|
||||
# The data_dir contains per-metric TSV files and a plot_commands.gnuplot
|
||||
# fragment generated by the data-prep step that defines the actual plot
|
||||
# directives (handling variable server columns).
|
||||
|
||||
set terminal svg enhanced size 1200,900 font "sans-serif,11" background "#f3f4f6"
|
||||
set output output_file
|
||||
|
||||
set style data linespoints
|
||||
set key outside right top
|
||||
set grid ytics
|
||||
set xtics rotate by -30
|
||||
set datafile separator "\t"
|
||||
|
||||
# parrhesia-pg: blue solid, parrhesia-memory: green solid
|
||||
# strfry: orange dashed, nostr-rs-relay: red dashed
|
||||
set linetype 1 lc rgb "#2563eb" lw 2 pt 7 ps 1.0
|
||||
set linetype 2 lc rgb "#16a34a" lw 2 pt 9 ps 1.0
|
||||
set linetype 3 lc rgb "#ea580c" lw 1.5 pt 5 ps 0.8 dt 2
|
||||
set linetype 4 lc rgb "#dc2626" lw 1.5 pt 4 ps 0.8 dt 2
|
||||
|
||||
set multiplot layout 2,2 title "Parrhesia Relay Benchmark History" font ",14"
|
||||
|
||||
# Load dynamically generated plot commands (handles variable column counts)
|
||||
load data_dir."/plot_commands.gnuplot"
|
||||
|
||||
unset multiplot
|
||||
953
bench/chart.svg
Normal file
953
bench/chart.svg
Normal file
@@ -0,0 +1,953 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="no"?>
|
||||
<svg
|
||||
width="1200" height="900"
|
||||
viewBox="0 0 1200 900"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
>
|
||||
|
||||
<title>Gnuplot</title>
|
||||
<desc>Produced by GNUPLOT 6.0 patchlevel 4 </desc>
|
||||
|
||||
<g id="gnuplot_canvas">
|
||||
|
||||
<rect x="0" y="0" width="1200" height="900" fill="#f3f4f6"/>
|
||||
<defs>
|
||||
|
||||
<circle id='gpDot' r='0.5' stroke-width='0.5' stroke='currentColor'/>
|
||||
<path id='gpPt0' stroke-width='0.242' stroke='currentColor' d='M-1,0 h2 M0,-1 v2'/>
|
||||
<path id='gpPt1' stroke-width='0.242' stroke='currentColor' d='M-1,-1 L1,1 M1,-1 L-1,1'/>
|
||||
<path id='gpPt2' stroke-width='0.242' stroke='currentColor' d='M-1,0 L1,0 M0,-1 L0,1 M-1,-1 L1,1 M-1,1 L1,-1'/>
|
||||
<rect id='gpPt3' stroke-width='0.242' stroke='currentColor' x='-1' y='-1' width='2' height='2'/>
|
||||
<rect id='gpPt4' stroke-width='0.242' stroke='currentColor' fill='currentColor' x='-1' y='-1' width='2' height='2'/>
|
||||
<circle id='gpPt5' stroke-width='0.242' stroke='currentColor' cx='0' cy='0' r='1'/>
|
||||
<use xlink:href='#gpPt5' id='gpPt6' fill='currentColor' stroke='none'/>
|
||||
<path id='gpPt7' stroke-width='0.242' stroke='currentColor' d='M0,-1.33 L-1.33,0.67 L1.33,0.67 z'/>
|
||||
<use xlink:href='#gpPt7' id='gpPt8' fill='currentColor' stroke='none'/>
|
||||
<use xlink:href='#gpPt7' id='gpPt9' stroke='currentColor' transform='rotate(180)'/>
|
||||
<use xlink:href='#gpPt9' id='gpPt10' fill='currentColor' stroke='none'/>
|
||||
<use xlink:href='#gpPt3' id='gpPt11' stroke='currentColor' transform='rotate(45)'/>
|
||||
<use xlink:href='#gpPt11' id='gpPt12' fill='currentColor' stroke='none'/>
|
||||
<path id='gpPt13' stroke-width='0.242' stroke='currentColor' d='M0,1.330 L1.265,0.411 L0.782,-1.067 L-0.782,-1.076 L-1.265,0.411 z'/>
|
||||
<use xlink:href='#gpPt13' id='gpPt14' fill='currentColor' stroke='none'/>
|
||||
<filter id='textbox' filterUnits='objectBoundingBox' x='0' y='0' height='1' width='1'>
|
||||
<feFlood flood-color='#F3F4F6' flood-opacity='1' result='bgnd'/>
|
||||
<feComposite in='SourceGraphic' in2='bgnd' operator='atop'/>
|
||||
</filter>
|
||||
<filter id='greybox' filterUnits='objectBoundingBox' x='0' y='0' height='1' width='1'>
|
||||
<feFlood flood-color='lightgrey' flood-opacity='1' result='grey'/>
|
||||
<feComposite in='SourceGraphic' in2='grey' operator='atop'/>
|
||||
</filter>
|
||||
</defs>
|
||||
<g fill="none" color="#F3F4F6" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(600.00,21.05)" stroke="none" fill="black" font-family="sans-serif" font-size="14.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >Parrhesia Relay Benchmark History</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,420.94 L399.49,420.94 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,420.94 L82.42,420.94 M399.49,420.94 L391.24,420.94 '/> <g transform="translate(66.48,424.52)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 500</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,370.88 L399.49,370.88 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,370.88 L82.42,370.88 M399.49,370.88 L391.24,370.88 '/> <g transform="translate(66.48,374.46)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 1000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,320.82 L399.49,320.82 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,320.82 L82.42,320.82 M399.49,320.82 L391.24,320.82 '/> <g transform="translate(66.48,324.40)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 1500</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,270.76 L399.49,270.76 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,270.76 L82.42,270.76 M399.49,270.76 L391.24,270.76 '/> <g transform="translate(66.48,274.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 2000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,220.69 L399.49,220.69 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,220.69 L82.42,220.69 M399.49,220.69 L391.24,220.69 '/> <g transform="translate(66.48,224.27)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 2500</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,170.63 L399.49,170.63 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,170.63 L82.42,170.63 M399.49,170.63 L391.24,170.63 '/> <g transform="translate(66.48,174.21)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 3000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,120.57 L399.49,120.57 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,120.57 L82.42,120.57 M399.49,120.57 L391.24,120.57 '/> <g transform="translate(66.48,124.15)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 3500</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M74.17,70.51 L399.49,70.51 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,70.51 L82.42,70.51 M399.49,70.51 L391.24,70.51 '/> <g transform="translate(66.48,74.09)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 4000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,420.94 L74.17,412.69 M74.17,70.51 L74.17,78.76 '/> <g transform="translate(72.38,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.2.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M155.50,420.94 L155.50,412.69 M155.50,70.51 L155.50,78.76 '/> <g transform="translate(153.71,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.3.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M236.83,420.94 L236.83,412.69 M236.83,70.51 L236.83,78.76 '/> <g transform="translate(235.04,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.4.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M318.16,420.94 L318.16,412.69 M318.16,70.51 L318.16,78.76 '/> <g transform="translate(316.37,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.5.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M399.49,420.94 L399.49,412.69 M399.49,70.51 L399.49,78.76 '/> <g transform="translate(397.70,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.6.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,70.51 L74.17,420.94 L399.49,420.94 L399.49,70.51 L74.17,70.51 Z '/></g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g id="gnuplot_plot_1a" ><title>parrhesia-pg</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="black" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,82.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-pg</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 37, 99, 235)' d='M545.60,78.76 L584.61,78.76 M74.17,310.54 L155.50,273.69 L236.83,276.90 L318.16,281.03 L399.49,306.07 '/> <use xlink:href='#gpPt6' transform='translate(74.17,310.54) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(155.50,273.69) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(236.83,276.90) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(318.16,281.03) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(399.49,306.07) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(565.10,78.76) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_2a" ><title>parrhesia-memory</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,98.84)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-memory</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 22, 163, 74)' d='M545.60,95.26 L584.61,95.26 M74.17,312.97 L155.50,275.49 L236.83,313.51 L318.16,333.83 L399.49,382.69 '/> <use xlink:href='#gpPt8' transform='translate(74.17,312.97) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(155.50,275.49) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(236.83,313.51) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(318.16,333.83) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(399.49,382.69) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(565.10,95.26) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_3a" ><title>strfry</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb( 22, 163, 74)" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,115.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >strfry</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(234, 88, 12)' stroke-dasharray='3.8,6.0' d='M545.60,111.76 L584.61,111.76 M74.17,122.84 L155.50,126.38 L236.83,132.52 L318.16,127.91 L399.49,115.73 '/> <use xlink:href='#gpPt4' transform='translate(74.17,122.84) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(155.50,126.38) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(236.83,132.52) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(318.16,127.91) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(399.49,115.73) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(565.10,111.76) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_4a" ><title>nostr-rs-relay</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,131.84)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >nostr-rs-relay</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(220, 38, 38)' stroke-dasharray='3.8,6.0' d='M545.60,128.26 L584.61,128.26 M74.17,394.71 L155.50,394.74 L236.83,394.11 L318.16,393.64 L399.49,392.20 '/> <use xlink:href='#gpPt3' transform='translate(74.17,394.71) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(155.50,394.74) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(236.83,394.11) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(318.16,393.64) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(399.49,392.20) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(565.10,128.26) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb(220, 38, 38)" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M74.17,70.51 L74.17,420.94 L399.49,420.94 L399.49,70.51 L74.17,70.51 Z '/> <g transform="translate(17.58,245.73) rotate(270.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >TPS</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(236.83,49.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >Event Throughput (TPS) — higher is better</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,420.94 L999.49,420.94 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,420.94 L682.42,420.94 M999.49,420.94 L991.24,420.94 '/> <g transform="translate(666.48,424.52)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,370.88 L999.49,370.88 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,370.88 L682.42,370.88 M999.49,370.88 L991.24,370.88 '/> <g transform="translate(666.48,374.46)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 1000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,320.82 L999.49,320.82 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,320.82 L682.42,320.82 M999.49,320.82 L991.24,320.82 '/> <g transform="translate(666.48,324.40)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 2000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,270.76 L999.49,270.76 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,270.76 L682.42,270.76 M999.49,270.76 L991.24,270.76 '/> <g transform="translate(666.48,274.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 3000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,220.69 L999.49,220.69 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,220.69 L682.42,220.69 M999.49,220.69 L991.24,220.69 '/> <g transform="translate(666.48,224.27)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 4000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,170.63 L999.49,170.63 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,170.63 L682.42,170.63 M999.49,170.63 L991.24,170.63 '/> <g transform="translate(666.48,174.21)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 5000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,120.57 L999.49,120.57 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,120.57 L682.42,120.57 M999.49,120.57 L991.24,120.57 '/> <g transform="translate(666.48,124.15)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 6000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M674.17,70.51 L999.49,70.51 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,70.51 L682.42,70.51 M999.49,70.51 L991.24,70.51 '/> <g transform="translate(666.48,74.09)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 7000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,420.94 L674.17,412.69 M674.17,70.51 L674.17,78.76 '/> <g transform="translate(672.38,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.2.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M755.50,420.94 L755.50,412.69 M755.50,70.51 L755.50,78.76 '/> <g transform="translate(753.71,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.3.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M836.83,420.94 L836.83,412.69 M836.83,70.51 L836.83,78.76 '/> <g transform="translate(835.04,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.4.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M918.16,420.94 L918.16,412.69 M918.16,70.51 L918.16,78.76 '/> <g transform="translate(916.37,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.5.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M999.49,420.94 L999.49,412.69 M999.49,70.51 L999.49,78.76 '/> <g transform="translate(997.70,431.73) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.6.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,70.51 L674.17,420.94 L999.49,420.94 L999.49,70.51 L674.17,70.51 Z '/></g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g id="gnuplot_plot_1b" ><title>parrhesia-pg</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="black" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,82.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-pg</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 37, 99, 235)' d='M1145.60,78.76 L1184.61,78.76 M674.17,299.89 L755.50,240.02 L836.83,189.67 L918.16,420.27 L999.49,241.89 '/> <use xlink:href='#gpPt6' transform='translate(674.17,299.89) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(755.50,240.02) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(836.83,189.67) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(918.16,420.27) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(999.49,241.89) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(1165.10,78.76) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_2b" ><title>parrhesia-memory</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,98.84)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-memory</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 22, 163, 74)' d='M1145.60,95.26 L1184.61,95.26 M674.17,299.22 L755.50,239.92 L836.83,182.25 L918.16,418.59 L999.49,76.12 '/> <use xlink:href='#gpPt8' transform='translate(674.17,299.22) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(755.50,239.92) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(836.83,182.25) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(918.16,418.59) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(999.49,76.12) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(1165.10,95.26) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_3b" ><title>strfry</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb( 22, 163, 74)" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,115.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >strfry</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(234, 88, 12)' stroke-dasharray='3.8,6.0' d='M1145.60,111.76 L1184.61,111.76 M674.17,330.63 L755.50,330.63 L836.83,329.81 L918.16,330.26 L999.49,330.43 '/> <use xlink:href='#gpPt4' transform='translate(674.17,330.63) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(755.50,330.63) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(836.83,329.81) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(918.16,330.26) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(999.49,330.43) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(1165.10,111.76) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_4b" ><title>nostr-rs-relay</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,131.84)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >nostr-rs-relay</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(220, 38, 38)' stroke-dasharray='3.8,6.0' d='M1145.60,128.26 L1184.61,128.26 M674.17,379.34 L755.50,378.57 L836.83,378.52 L918.16,376.97 L999.49,377.85 '/> <use xlink:href='#gpPt3' transform='translate(674.17,379.34) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(755.50,378.57) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(836.83,378.52) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(918.16,376.97) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(999.49,377.85) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(1165.10,128.26) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb(220, 38, 38)" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M674.17,70.51 L674.17,420.94 L999.49,420.94 L999.49,70.51 L674.17,70.51 Z '/> <g transform="translate(617.58,245.73) rotate(270.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >TPS</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(836.83,49.34)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >Req Throughput (TPS) — higher is better</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,860.44 L399.49,860.44 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,860.44 L97.80,860.44 M399.49,860.44 L391.24,860.44 '/> <g transform="translate(81.86,864.02)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 40000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,810.38 L399.49,810.38 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,810.38 L97.80,810.38 M399.49,810.38 L391.24,810.38 '/> <g transform="translate(81.86,813.96)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 60000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,760.31 L399.49,760.31 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,760.31 L97.80,760.31 M399.49,760.31 L391.24,760.31 '/> <g transform="translate(81.86,763.89)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 80000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,710.25 L399.49,710.25 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,710.25 L97.80,710.25 M399.49,710.25 L391.24,710.25 '/> <g transform="translate(81.86,713.83)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 100000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,660.19 L399.49,660.19 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,660.19 L97.80,660.19 M399.49,660.19 L391.24,660.19 '/> <g transform="translate(81.86,663.77)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 120000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,610.13 L399.49,610.13 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,610.13 L97.80,610.13 M399.49,610.13 L391.24,610.13 '/> <g transform="translate(81.86,613.71)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 140000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,560.06 L399.49,560.06 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,560.06 L97.80,560.06 M399.49,560.06 L391.24,560.06 '/> <g transform="translate(81.86,563.64)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 160000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M89.55,510.00 L399.49,510.00 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,510.00 L97.80,510.00 M399.49,510.00 L391.24,510.00 '/> <g transform="translate(81.86,513.58)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 180000</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,860.44 L89.55,852.19 M89.55,510.00 L89.55,518.25 '/> <g transform="translate(87.76,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.2.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M167.04,860.44 L167.04,852.19 M167.04,510.00 L167.04,518.25 '/> <g transform="translate(165.25,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.3.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M244.52,860.44 L244.52,852.19 M244.52,510.00 L244.52,518.25 '/> <g transform="translate(242.73,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.4.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M322.01,860.44 L322.01,852.19 M322.01,510.00 L322.01,518.25 '/> <g transform="translate(320.22,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.5.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M399.49,860.44 L399.49,852.19 M399.49,510.00 L399.49,518.25 '/> <g transform="translate(397.70,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.6.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,510.00 L89.55,860.44 L399.49,860.44 L399.49,510.00 L89.55,510.00 Z '/></g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g id="gnuplot_plot_1c" ><title>parrhesia-pg</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="black" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,521.83)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-pg</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 37, 99, 235)' d='M545.60,518.25 L584.61,518.25 M89.55,767.49 L167.04,783.59 L244.52,787.50 L322.01,779.24 L399.49,790.10 '/> <use xlink:href='#gpPt6' transform='translate(89.55,767.49) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(167.04,783.59) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(244.52,787.50) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(322.01,779.24) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(399.49,790.10) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(565.10,518.25) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_2c" ><title>parrhesia-memory</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,538.33)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-memory</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 22, 163, 74)' d='M545.60,534.75 L584.61,534.75 M89.55,799.82 L167.04,809.24 L244.52,803.58 L322.01,803.61 L399.49,820.44 '/> <use xlink:href='#gpPt8' transform='translate(89.55,799.82) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(167.04,809.24) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(244.52,803.58) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(322.01,803.61) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(399.49,820.44) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(565.10,534.75) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_3c" ><title>strfry</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb( 22, 163, 74)" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,554.83)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >strfry</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(234, 88, 12)' stroke-dasharray='3.8,6.0' d='M545.60,551.25 L584.61,551.25 M89.55,801.16 L167.04,802.55 L244.52,807.98 L322.01,807.40 L399.49,791.06 '/> <use xlink:href='#gpPt4' transform='translate(89.55,801.16) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(167.04,802.55) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(244.52,807.98) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(322.01,807.40) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(399.49,791.06) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(565.10,551.25) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_4c" ><title>nostr-rs-relay</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(537.91,571.33)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >nostr-rs-relay</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(220, 38, 38)' stroke-dasharray='3.8,6.0' d='M545.60,567.75 L584.61,567.75 M89.55,560.04 L167.04,547.56 L244.52,557.15 L322.01,578.45 L399.49,544.60 '/> <use xlink:href='#gpPt3' transform='translate(89.55,560.04) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(167.04,547.56) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(244.52,557.15) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(322.01,578.45) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(399.49,544.60) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(565.10,567.75) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb(220, 38, 38)" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M89.55,510.00 L89.55,860.44 L399.49,860.44 L399.49,510.00 L89.55,510.00 Z '/> <g transform="translate(17.58,685.22) rotate(270.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >TPS</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(244.52,488.83)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >Echo Throughput (TPS) — higher is better</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,860.44 L999.49,860.44 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,860.44 L667.04,860.44 M999.49,860.44 L991.24,860.44 '/> <g transform="translate(651.10,864.02)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,821.50 L999.49,821.50 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,821.50 L667.04,821.50 M999.49,821.50 L991.24,821.50 '/> <g transform="translate(651.10,825.08)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 5</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,782.56 L999.49,782.56 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,782.56 L667.04,782.56 M999.49,782.56 L991.24,782.56 '/> <g transform="translate(651.10,786.14)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 10</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,743.63 L999.49,743.63 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,743.63 L667.04,743.63 M999.49,743.63 L991.24,743.63 '/> <g transform="translate(651.10,747.21)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 15</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,704.69 L999.49,704.69 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,704.69 L667.04,704.69 M999.49,704.69 L991.24,704.69 '/> <g transform="translate(651.10,708.27)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 20</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,665.75 L999.49,665.75 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,665.75 L667.04,665.75 M999.49,665.75 L991.24,665.75 '/> <g transform="translate(651.10,669.33)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 25</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,626.81 L999.49,626.81 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,626.81 L667.04,626.81 M999.49,626.81 L991.24,626.81 '/> <g transform="translate(651.10,630.39)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 30</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,587.88 L999.49,587.88 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,587.88 L667.04,587.88 M999.49,587.88 L991.24,587.88 '/> <g transform="translate(651.10,591.46)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 35</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,548.94 L999.49,548.94 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,548.94 L667.04,548.94 M999.49,548.94 L991.24,548.94 '/> <g transform="translate(651.10,552.52)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 40</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="gray" stroke="currentColor" stroke-width="0.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='gray' stroke-dasharray='2,4' class="gridline" d='M658.79,510.00 L999.49,510.00 '/></g>
|
||||
<g fill="none" color="gray" stroke="gray" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,510.00 L667.04,510.00 M999.49,510.00 L991.24,510.00 '/> <g transform="translate(651.10,513.58)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" > 45</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,860.44 L658.79,852.19 M658.79,510.00 L658.79,518.25 '/> <g transform="translate(657.00,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.2.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M743.97,860.44 L743.97,852.19 M743.97,510.00 L743.97,518.25 '/> <g transform="translate(742.18,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.3.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M829.14,860.44 L829.14,852.19 M829.14,510.00 L829.14,518.25 '/> <g transform="translate(827.35,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.4.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M914.32,860.44 L914.32,852.19 M914.32,510.00 L914.32,518.25 '/> <g transform="translate(912.53,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.5.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M999.49,860.44 L999.49,852.19 M999.49,510.00 L999.49,518.25 '/> <g transform="translate(997.70,871.23) rotate(30.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="start">
|
||||
<text><tspan font-family="sans-serif" >v0.6.0</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,510.00 L658.79,860.44 L999.49,860.44 L999.49,510.00 L658.79,510.00 Z '/></g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g id="gnuplot_plot_1d" ><title>parrhesia-pg</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="black" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,521.83)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-pg</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 37, 99, 235)' d='M1145.60,518.25 L1184.61,518.25 M658.79,746.22 L743.97,759.20 L829.14,772.18 L914.32,590.47 L999.49,652.77 '/> <use xlink:href='#gpPt6' transform='translate(658.79,746.22) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(743.97,759.20) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(829.14,772.18) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(914.32,590.47) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(999.49,652.77) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
<use xlink:href='#gpPt6' transform='translate(1165.10,518.25) scale(4.12)' color='rgb( 37, 99, 235)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_2d" ><title>parrhesia-memory</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,538.33)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >parrhesia-memory</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb( 22, 163, 74)' d='M1145.60,534.75 L1184.61,534.75 M658.79,790.35 L743.97,759.20 L829.14,782.56 L914.32,522.98 L999.49,746.22 '/> <use xlink:href='#gpPt8' transform='translate(658.79,790.35) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(743.97,759.20) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(829.14,782.56) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(914.32,522.98) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(999.49,746.22) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
<use xlink:href='#gpPt8' transform='translate(1165.10,534.75) scale(4.12)' color='rgb( 22, 163, 74)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_3d" ><title>strfry</title>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb( 22, 163, 74)" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,554.83)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >strfry</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(234, 88, 12)' stroke-dasharray='3.8,6.0' d='M1145.60,551.25 L1184.61,551.25 M658.79,834.48 L743.97,831.89 L829.14,834.48 L914.32,839.67 L999.49,837.08 '/> <use xlink:href='#gpPt4' transform='translate(658.79,834.48) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(743.97,831.89) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(829.14,834.48) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(914.32,839.67) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(999.49,837.08) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
<use xlink:href='#gpPt4' transform='translate(1165.10,551.25) scale(3.30)' color='rgb(234, 88, 12)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g id="gnuplot_plot_4d" ><title>nostr-rs-relay</title>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(1137.91,571.33)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="end">
|
||||
<text><tspan font-family="sans-serif" >nostr-rs-relay</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.50" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='rgb(220, 38, 38)' stroke-dasharray='3.8,6.0' d='M1145.60,567.75 L1184.61,567.75 M658.79,839.67 L743.97,844.86 L829.14,839.67 L914.32,839.67 L999.49,844.86 '/> <use xlink:href='#gpPt3' transform='translate(658.79,839.67) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(743.97,844.86) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(829.14,839.67) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(914.32,839.67) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(999.49,844.86) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
<use xlink:href='#gpPt3' transform='translate(1165.10,567.75) scale(3.30)' color='rgb(220, 38, 38)'/>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="#F3F4F6" stroke="rgb(220, 38, 38)" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="2.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="black" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<path stroke='black' d='M658.79,510.00 L658.79,860.44 L999.49,860.44 L999.49,510.00 L658.79,510.00 Z '/> <g transform="translate(617.58,685.22) rotate(270.00)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >ms</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
<g transform="translate(829.14,488.83)" stroke="none" fill="black" font-family="sans-serif" font-size="11.00" text-anchor="middle">
|
||||
<text><tspan font-family="sans-serif" >Connect Avg Latency (ms) — lower is better</tspan></text>
|
||||
</g>
|
||||
</g>
|
||||
<g fill="none" color="black" stroke="currentColor" stroke-width="1.00" stroke-linecap="butt" stroke-linejoin="miter">
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
||||
|
After Width: | Height: | Size: 72 KiB |
5
bench/history.jsonl
Normal file
5
bench/history.jsonl
Normal file
@@ -0,0 +1,5 @@
|
||||
{"schema_version":2,"timestamp":"2026-03-18T21:35:03Z","machine_id":"agent","git_tag":"v0.6.0","git_commit":"7b337d9","runs":3,"versions":{"parrhesia":"0.6.0","strfry":"strfry 1.0.4 (nixpkgs)","nostr-rs-relay":"nostr-rs-relay 0.9.0","nostr-bench":"nostr-bench 0.4.0"},"servers":{"parrhesia-pg":{"connect_avg_ms":26.666666666666668,"connect_max_ms":45.333333333333336,"echo_tps":68100.33333333333,"echo_mibs":37.233333333333334,"event_tps":1647.3333333333333,"event_mibs":1.0666666666666667,"req_tps":3576.6666666666665,"req_mibs":18.833333333333332},"parrhesia-memory":{"connect_avg_ms":14.666666666666666,"connect_max_ms":24.333333333333332,"echo_tps":55978,"echo_mibs":30.633333333333336,"event_tps":882,"event_mibs":0.5666666666666668,"req_tps":6888,"req_mibs":36.06666666666666},"strfry":{"connect_avg_ms":3,"connect_max_ms":4.666666666666667,"echo_tps":67718.33333333333,"echo_mibs":37.86666666666667,"event_tps":3548.3333333333335,"event_mibs":2.3,"req_tps":1808,"req_mibs":11.699999999999998},"nostr-rs-relay":{"connect_avg_ms":2,"connect_max_ms":3.3333333333333335,"echo_tps":166178,"echo_mibs":91.03333333333335,"event_tps":787,"event_mibs":0.5,"req_tps":860.6666666666666,"req_mibs":2.4}},"run_id":"local-2026-03-18T21:35:03Z-agent-7b337d9","source":{"kind":"local","git_tag":"v0.6.0","git_commit":"7b337d9"},"infra":{"provider":"local"},"bench":{"runs":3,"targets":["parrhesia-pg","parrhesia-memory","strfry","nostr-rs-relay"]}}
|
||||
{"schema_version":2,"timestamp":"2026-03-18T22:14:37Z","machine_id":"agent","git_tag":"v0.2.0","git_commit":"b20dbf6","runs":3,"versions":{"parrhesia":"0.2.0","strfry":"strfry 1.0.4 (nixpkgs)","nostr-rs-relay":"nostr-rs-relay 0.9.0","nostr-bench":"nostr-bench 0.4.0"},"servers":{"parrhesia-pg":{"connect_avg_ms":14.666666666666666,"connect_max_ms":25.666666666666668,"echo_tps":77133,"echo_mibs":42.233333333333334,"event_tps":1602.6666666666667,"event_mibs":1.0666666666666667,"req_tps":2418,"req_mibs":12.5},"parrhesia-memory":{"connect_avg_ms":9,"connect_max_ms":16,"echo_tps":64218.333333333336,"echo_mibs":35.166666666666664,"event_tps":1578.3333333333333,"event_mibs":1,"req_tps":2431.3333333333335,"req_mibs":12.633333333333333},"strfry":{"connect_avg_ms":3.3333333333333335,"connect_max_ms":6,"echo_tps":63682.666666666664,"echo_mibs":35.6,"event_tps":3477.3333333333335,"event_mibs":2.2333333333333334,"req_tps":1804,"req_mibs":11.733333333333334},"nostr-rs-relay":{"connect_avg_ms":2.6666666666666665,"connect_max_ms":4.333333333333333,"echo_tps":160009,"echo_mibs":87.63333333333333,"event_tps":762,"event_mibs":0.4666666666666666,"req_tps":831,"req_mibs":2.2333333333333334}},"run_id":"local-2026-03-18T22:14:37Z-agent-b20dbf6","source":{"kind":"local","git_tag":"v0.2.0","git_commit":"b20dbf6"},"infra":{"provider":"local"},"bench":{"runs":3,"targets":["parrhesia-pg","parrhesia-memory","strfry","nostr-rs-relay"]}}
|
||||
{"schema_version":2,"timestamp":"2026-03-18T22:22:12Z","machine_id":"agent","git_tag":"v0.3.0","git_commit":"8c8d5a8","runs":3,"versions":{"parrhesia":"0.3.0","strfry":"strfry 1.0.4 (nixpkgs)","nostr-rs-relay":"nostr-rs-relay 0.9.0","nostr-bench":"nostr-bench 0.4.0"},"servers":{"parrhesia-pg":{"connect_avg_ms":13,"connect_max_ms":21.666666666666668,"echo_tps":70703.33333333333,"echo_mibs":38.7,"event_tps":1970.6666666666667,"event_mibs":1.3,"req_tps":3614,"req_mibs":20.966666666666665},"parrhesia-memory":{"connect_avg_ms":13,"connect_max_ms":22.333333333333332,"echo_tps":60452.333333333336,"echo_mibs":33.1,"event_tps":1952.6666666666667,"event_mibs":1.3,"req_tps":3616,"req_mibs":20.766666666666666},"strfry":{"connect_avg_ms":3.6666666666666665,"connect_max_ms":6,"echo_tps":63128.666666666664,"echo_mibs":35.300000000000004,"event_tps":3442,"event_mibs":2.2333333333333334,"req_tps":1804,"req_mibs":11.699999999999998},"nostr-rs-relay":{"connect_avg_ms":2,"connect_max_ms":3.3333333333333335,"echo_tps":164995.33333333334,"echo_mibs":90.36666666666667,"event_tps":761.6666666666666,"event_mibs":0.5,"req_tps":846.3333333333334,"req_mibs":2.333333333333333}},"run_id":"local-2026-03-18T22:22:12Z-agent-8c8d5a8","source":{"kind":"local","git_tag":"v0.3.0","git_commit":"8c8d5a8"},"infra":{"provider":"local"},"bench":{"runs":3,"targets":["parrhesia-pg","parrhesia-memory","strfry","nostr-rs-relay"]}}
|
||||
{"schema_version":2,"timestamp":"2026-03-18T22:30:08Z","machine_id":"agent","git_tag":"v0.4.0","git_commit":"b86b5db","runs":3,"versions":{"parrhesia":"0.4.0","strfry":"strfry 1.0.4 (nixpkgs)","nostr-rs-relay":"nostr-rs-relay 0.9.0","nostr-bench":"nostr-bench 0.4.0"},"servers":{"parrhesia-pg":{"connect_avg_ms":11.333333333333334,"connect_max_ms":20.666666666666668,"echo_tps":69139.33333333333,"echo_mibs":37.833333333333336,"event_tps":1938.6666666666667,"event_mibs":1.3,"req_tps":4619.666666666667,"req_mibs":26.266666666666666},"parrhesia-memory":{"connect_avg_ms":10,"connect_max_ms":17.333333333333332,"echo_tps":62715.333333333336,"echo_mibs":34.333333333333336,"event_tps":1573,"event_mibs":1.0333333333333334,"req_tps":4768,"req_mibs":23.733333333333334},"strfry":{"connect_avg_ms":3.3333333333333335,"connect_max_ms":6,"echo_tps":60956.666666666664,"echo_mibs":34.06666666666667,"event_tps":3380.6666666666665,"event_mibs":2.2,"req_tps":1820.3333333333333,"req_mibs":11.800000000000002},"nostr-rs-relay":{"connect_avg_ms":2.6666666666666665,"connect_max_ms":4.333333333333333,"echo_tps":161165.33333333334,"echo_mibs":88.26666666666665,"event_tps":768,"event_mibs":0.5,"req_tps":847.3333333333334,"req_mibs":2.3000000000000003}},"run_id":"local-2026-03-18T22:30:08Z-agent-b86b5db","source":{"kind":"local","git_tag":"v0.4.0","git_commit":"b86b5db"},"infra":{"provider":"local"},"bench":{"runs":3,"targets":["parrhesia-pg","parrhesia-memory","strfry","nostr-rs-relay"]}}
|
||||
{"schema_version":2,"timestamp":"2026-03-18T22:36:37Z","machine_id":"agent","git_tag":"v0.5.0","git_commit":"e557eba","runs":3,"versions":{"parrhesia":"0.5.0","strfry":"strfry 1.0.4 (nixpkgs)","nostr-rs-relay":"nostr-rs-relay 0.9.0","nostr-bench":"nostr-bench 0.4.0"},"servers":{"parrhesia-pg":{"connect_avg_ms":34.666666666666664,"connect_max_ms":61.666666666666664,"echo_tps":72441,"echo_mibs":39.666666666666664,"event_tps":1897.3333333333333,"event_mibs":1.2333333333333334,"req_tps":13.333333333333334,"req_mibs":0.03333333333333333},"parrhesia-memory":{"connect_avg_ms":43.333333333333336,"connect_max_ms":74.66666666666667,"echo_tps":62704.666666666664,"echo_mibs":34.300000000000004,"event_tps":1370,"event_mibs":0.8666666666666667,"req_tps":47,"req_mibs":0.16666666666666666},"strfry":{"connect_avg_ms":2.6666666666666665,"connect_max_ms":4.666666666666667,"echo_tps":61189.333333333336,"echo_mibs":34.2,"event_tps":3426.6666666666665,"event_mibs":2.2,"req_tps":1811.3333333333333,"req_mibs":11.766666666666666},"nostr-rs-relay":{"connect_avg_ms":2.6666666666666665,"connect_max_ms":4,"echo_tps":152654.33333333334,"echo_mibs":83.63333333333333,"event_tps":772.6666666666666,"event_mibs":0.5,"req_tps":878.3333333333334,"req_mibs":2.4}},"run_id":"local-2026-03-18T22:36:37Z-agent-e557eba","source":{"kind":"local","git_tag":"v0.5.0","git_commit":"e557eba"},"infra":{"provider":"local"},"bench":{"runs":3,"targets":["parrhesia-pg","parrhesia-memory","strfry","nostr-rs-relay"]}}
|
||||
@@ -1,28 +1,65 @@
|
||||
import Config
|
||||
|
||||
project_version =
|
||||
case Mix.Project.config()[:version] do
|
||||
version when is_binary(version) -> version
|
||||
version -> to_string(version)
|
||||
end
|
||||
|
||||
config :postgrex, :json_library, JSON
|
||||
|
||||
config :parrhesia,
|
||||
metadata: [
|
||||
name: "Parrhesia",
|
||||
version: project_version,
|
||||
hide_version?: true
|
||||
],
|
||||
database: [
|
||||
separate_read_pool?: config_env() != :test
|
||||
],
|
||||
moderation_cache_enabled: true,
|
||||
enable_partition_retention_worker: true,
|
||||
relay_url: "ws://localhost:4413/relay",
|
||||
nip43: [
|
||||
enabled: true,
|
||||
invite_ttl_seconds: 900,
|
||||
request_max_age_seconds: 300
|
||||
],
|
||||
nip66: [
|
||||
enabled: true,
|
||||
publish_interval_seconds: 900,
|
||||
publish_monitor_announcement?: true,
|
||||
timeout_ms: 5_000,
|
||||
checks: [:open, :read, :nip11],
|
||||
targets: []
|
||||
],
|
||||
identity: [
|
||||
path: nil,
|
||||
private_key: nil
|
||||
],
|
||||
sync: [
|
||||
path: nil,
|
||||
start_workers?: true
|
||||
start_workers?: true,
|
||||
relay_guard: false
|
||||
],
|
||||
limits: [
|
||||
max_frame_bytes: 1_048_576,
|
||||
max_event_bytes: 262_144,
|
||||
max_filters_per_req: 16,
|
||||
max_filter_limit: 500,
|
||||
max_tags_per_event: 256,
|
||||
max_tag_values_per_filter: 128,
|
||||
ip_max_event_ingest_per_window: 1_000,
|
||||
ip_event_ingest_window_seconds: 1,
|
||||
relay_max_event_ingest_per_window: 10_000,
|
||||
relay_event_ingest_window_seconds: 1,
|
||||
max_subscriptions_per_connection: 32,
|
||||
max_event_future_skew_seconds: 900,
|
||||
max_event_ingest_per_window: 120,
|
||||
event_ingest_window_seconds: 1,
|
||||
auth_max_age_seconds: 600,
|
||||
websocket_ping_interval_seconds: 30,
|
||||
websocket_pong_timeout_seconds: 10,
|
||||
max_outbound_queue: 256,
|
||||
outbound_drain_batch_size: 64,
|
||||
outbound_overflow_strategy: :close,
|
||||
@@ -61,6 +98,7 @@ config :parrhesia,
|
||||
public: %{
|
||||
enabled: true,
|
||||
bind: %{ip: {0, 0, 0, 0}, port: 4413},
|
||||
max_connections: 20_000,
|
||||
transport: %{scheme: :http, tls: %{mode: :disabled}},
|
||||
proxy: %{trusted_cidrs: [], honor_x_forwarded_for: true},
|
||||
network: %{allow_all: true},
|
||||
@@ -85,6 +123,7 @@ config :parrhesia,
|
||||
max_partitions_to_drop_per_run: 1
|
||||
],
|
||||
features: [
|
||||
verify_event_signatures_locked?: config_env() == :prod,
|
||||
verify_event_signatures: true,
|
||||
nip_45_count: true,
|
||||
nip_50_search: true,
|
||||
@@ -92,13 +131,16 @@ config :parrhesia,
|
||||
marmot_push_notifications: false
|
||||
],
|
||||
storage: [
|
||||
backend: :postgres,
|
||||
events: Parrhesia.Storage.Adapters.Postgres.Events,
|
||||
acl: Parrhesia.Storage.Adapters.Postgres.ACL,
|
||||
moderation: Parrhesia.Storage.Adapters.Postgres.Moderation,
|
||||
groups: Parrhesia.Storage.Adapters.Postgres.Groups,
|
||||
admin: Parrhesia.Storage.Adapters.Postgres.Admin
|
||||
]
|
||||
|
||||
config :parrhesia, Parrhesia.Repo, types: Parrhesia.PostgresTypes
|
||||
config :parrhesia, Parrhesia.ReadRepo, types: Parrhesia.PostgresTypes
|
||||
|
||||
config :parrhesia, ecto_repos: [Parrhesia.Repo]
|
||||
|
||||
|
||||
@@ -23,3 +23,13 @@ config :parrhesia,
|
||||
show_sensitive_data_on_connection_error: true,
|
||||
pool_size: 10
|
||||
] ++ repo_host_opts
|
||||
|
||||
config :parrhesia,
|
||||
Parrhesia.ReadRepo,
|
||||
[
|
||||
username: System.get_env("PGUSER") || System.get_env("USER") || "agent",
|
||||
password: System.get_env("PGPASSWORD"),
|
||||
database: System.get_env("PGDATABASE") || "parrhesia_dev",
|
||||
show_sensitive_data_on_connection_error: true,
|
||||
pool_size: 10
|
||||
] ++ repo_host_opts
|
||||
|
||||
@@ -5,4 +5,9 @@ config :parrhesia, Parrhesia.Repo,
|
||||
queue_target: 1_000,
|
||||
queue_interval: 5_000
|
||||
|
||||
config :parrhesia, Parrhesia.ReadRepo,
|
||||
pool_size: 32,
|
||||
queue_target: 1_000,
|
||||
queue_interval: 5_000
|
||||
|
||||
# Production runtime configuration lives in config/runtime.exs.
|
||||
|
||||
@@ -35,6 +35,20 @@ bool_env = fn name, default ->
|
||||
end
|
||||
end
|
||||
|
||||
storage_backend_env = fn name, default ->
|
||||
case System.get_env(name) do
|
||||
nil ->
|
||||
default
|
||||
|
||||
value ->
|
||||
case String.downcase(String.trim(value)) do
|
||||
"postgres" -> :postgres
|
||||
"memory" -> :memory
|
||||
_other -> raise "environment variable #{name} must be one of: postgres, memory"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
csv_env = fn name, default ->
|
||||
case System.get_env(name) do
|
||||
nil ->
|
||||
@@ -125,12 +139,12 @@ ipv4_env = fn name, default ->
|
||||
end
|
||||
|
||||
if config_env() == :prod do
|
||||
database_url =
|
||||
System.get_env("DATABASE_URL") ||
|
||||
raise "environment variable DATABASE_URL is missing. Example: ecto://USER:PASS@HOST/DATABASE"
|
||||
|
||||
repo_defaults = Application.get_env(:parrhesia, Parrhesia.Repo, [])
|
||||
read_repo_defaults = Application.get_env(:parrhesia, Parrhesia.ReadRepo, [])
|
||||
relay_url_default = Application.get_env(:parrhesia, :relay_url)
|
||||
metadata_defaults = Application.get_env(:parrhesia, :metadata, [])
|
||||
database_defaults = Application.get_env(:parrhesia, :database, [])
|
||||
storage_defaults = Application.get_env(:parrhesia, :storage, [])
|
||||
|
||||
moderation_cache_enabled_default =
|
||||
Application.get_env(:parrhesia, :moderation_cache_enabled, true)
|
||||
@@ -138,20 +152,55 @@ if config_env() == :prod do
|
||||
enable_expiration_worker_default =
|
||||
Application.get_env(:parrhesia, :enable_expiration_worker, true)
|
||||
|
||||
enable_partition_retention_worker_default =
|
||||
Application.get_env(:parrhesia, :enable_partition_retention_worker, true)
|
||||
|
||||
limits_defaults = Application.get_env(:parrhesia, :limits, [])
|
||||
policies_defaults = Application.get_env(:parrhesia, :policies, [])
|
||||
listeners_defaults = Application.get_env(:parrhesia, :listeners, %{})
|
||||
retention_defaults = Application.get_env(:parrhesia, :retention, [])
|
||||
features_defaults = Application.get_env(:parrhesia, :features, [])
|
||||
acl_defaults = Application.get_env(:parrhesia, :acl, [])
|
||||
sync_defaults = Application.get_env(:parrhesia, :sync, [])
|
||||
|
||||
default_pool_size = Keyword.get(repo_defaults, :pool_size, 32)
|
||||
default_queue_target = Keyword.get(repo_defaults, :queue_target, 1_000)
|
||||
default_queue_interval = Keyword.get(repo_defaults, :queue_interval, 5_000)
|
||||
default_read_pool_size = Keyword.get(read_repo_defaults, :pool_size, default_pool_size)
|
||||
default_read_queue_target = Keyword.get(read_repo_defaults, :queue_target, default_queue_target)
|
||||
|
||||
default_read_queue_interval =
|
||||
Keyword.get(read_repo_defaults, :queue_interval, default_queue_interval)
|
||||
|
||||
default_storage_backend =
|
||||
storage_defaults
|
||||
|> Keyword.get(:backend, :postgres)
|
||||
|> case do
|
||||
:postgres -> :postgres
|
||||
:memory -> :memory
|
||||
other -> raise "unsupported storage backend default: #{inspect(other)}"
|
||||
end
|
||||
|
||||
storage_backend = storage_backend_env.("PARRHESIA_STORAGE_BACKEND", default_storage_backend)
|
||||
postgres_backend? = storage_backend == :postgres
|
||||
|
||||
separate_read_pool? =
|
||||
postgres_backend? and Keyword.get(database_defaults, :separate_read_pool?, true)
|
||||
|
||||
database_url =
|
||||
if postgres_backend? do
|
||||
System.get_env("DATABASE_URL") ||
|
||||
raise "environment variable DATABASE_URL is missing. Example: ecto://USER:PASS@HOST/DATABASE"
|
||||
else
|
||||
nil
|
||||
end
|
||||
|
||||
pool_size = int_env.("POOL_SIZE", default_pool_size)
|
||||
queue_target = int_env.("DB_QUEUE_TARGET_MS", default_queue_target)
|
||||
queue_interval = int_env.("DB_QUEUE_INTERVAL_MS", default_queue_interval)
|
||||
read_pool_size = int_env.("DB_READ_POOL_SIZE", default_read_pool_size)
|
||||
read_queue_target = int_env.("DB_READ_QUEUE_TARGET_MS", default_read_queue_target)
|
||||
read_queue_interval = int_env.("DB_READ_QUEUE_INTERVAL_MS", default_read_queue_interval)
|
||||
|
||||
limits = [
|
||||
max_frame_bytes:
|
||||
@@ -174,6 +223,36 @@ if config_env() == :prod do
|
||||
"PARRHESIA_LIMITS_MAX_FILTER_LIMIT",
|
||||
Keyword.get(limits_defaults, :max_filter_limit, 500)
|
||||
),
|
||||
max_tags_per_event:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_MAX_TAGS_PER_EVENT",
|
||||
Keyword.get(limits_defaults, :max_tags_per_event, 256)
|
||||
),
|
||||
max_tag_values_per_filter:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_MAX_TAG_VALUES_PER_FILTER",
|
||||
Keyword.get(limits_defaults, :max_tag_values_per_filter, 128)
|
||||
),
|
||||
ip_max_event_ingest_per_window:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_IP_MAX_EVENT_INGEST_PER_WINDOW",
|
||||
Keyword.get(limits_defaults, :ip_max_event_ingest_per_window, 1_000)
|
||||
),
|
||||
ip_event_ingest_window_seconds:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_IP_EVENT_INGEST_WINDOW_SECONDS",
|
||||
Keyword.get(limits_defaults, :ip_event_ingest_window_seconds, 1)
|
||||
),
|
||||
relay_max_event_ingest_per_window:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_RELAY_MAX_EVENT_INGEST_PER_WINDOW",
|
||||
Keyword.get(limits_defaults, :relay_max_event_ingest_per_window, 10_000)
|
||||
),
|
||||
relay_event_ingest_window_seconds:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_RELAY_EVENT_INGEST_WINDOW_SECONDS",
|
||||
Keyword.get(limits_defaults, :relay_event_ingest_window_seconds, 1)
|
||||
),
|
||||
max_subscriptions_per_connection:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_MAX_SUBSCRIPTIONS_PER_CONNECTION",
|
||||
@@ -199,6 +278,16 @@ if config_env() == :prod do
|
||||
"PARRHESIA_LIMITS_AUTH_MAX_AGE_SECONDS",
|
||||
Keyword.get(limits_defaults, :auth_max_age_seconds, 600)
|
||||
),
|
||||
websocket_ping_interval_seconds:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_WEBSOCKET_PING_INTERVAL_SECONDS",
|
||||
Keyword.get(limits_defaults, :websocket_ping_interval_seconds, 30)
|
||||
),
|
||||
websocket_pong_timeout_seconds:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_WEBSOCKET_PONG_TIMEOUT_SECONDS",
|
||||
Keyword.get(limits_defaults, :websocket_pong_timeout_seconds, 10)
|
||||
),
|
||||
max_outbound_queue:
|
||||
int_env.(
|
||||
"PARRHESIA_LIMITS_MAX_OUTBOUND_QUEUE",
|
||||
@@ -388,6 +477,11 @@ if config_env() == :prod do
|
||||
ip: Map.get(public_bind_defaults, :ip, {0, 0, 0, 0}),
|
||||
port: int_env.("PORT", Map.get(public_bind_defaults, :port, 4413))
|
||||
},
|
||||
max_connections:
|
||||
infinity_or_int_env.(
|
||||
"PARRHESIA_PUBLIC_MAX_CONNECTIONS",
|
||||
Map.get(public_listener_defaults, :max_connections, 20_000)
|
||||
),
|
||||
transport: %{
|
||||
scheme: Map.get(public_transport_defaults, :scheme, :http),
|
||||
tls: Map.get(public_transport_defaults, :tls, %{mode: :disabled})
|
||||
@@ -471,6 +565,11 @@ if config_env() == :prod do
|
||||
Map.get(metrics_listener_bind_defaults, :port, 9568)
|
||||
)
|
||||
},
|
||||
max_connections:
|
||||
infinity_or_int_env.(
|
||||
"PARRHESIA_METRICS_ENDPOINT_MAX_CONNECTIONS",
|
||||
Map.get(metrics_listener_defaults, :max_connections, 1_024)
|
||||
),
|
||||
transport: %{
|
||||
scheme: Map.get(metrics_listener_transport_defaults, :scheme, :http),
|
||||
tls: Map.get(metrics_listener_transport_defaults, :tls, %{mode: :disabled})
|
||||
@@ -553,11 +652,14 @@ if config_env() == :prod do
|
||||
]
|
||||
|
||||
features = [
|
||||
verify_event_signatures_locked?:
|
||||
Keyword.get(features_defaults, :verify_event_signatures_locked?, false),
|
||||
verify_event_signatures:
|
||||
bool_env.(
|
||||
"PARRHESIA_FEATURES_VERIFY_EVENT_SIGNATURES",
|
||||
if Keyword.get(features_defaults, :verify_event_signatures_locked?, false) do
|
||||
true
|
||||
else
|
||||
Keyword.get(features_defaults, :verify_event_signatures, true)
|
||||
),
|
||||
end,
|
||||
nip_45_count:
|
||||
bool_env.(
|
||||
"PARRHESIA_FEATURES_NIP_45_COUNT",
|
||||
@@ -580,14 +682,57 @@ if config_env() == :prod do
|
||||
)
|
||||
]
|
||||
|
||||
config :parrhesia, Parrhesia.Repo,
|
||||
url: database_url,
|
||||
pool_size: pool_size,
|
||||
queue_target: queue_target,
|
||||
queue_interval: queue_interval
|
||||
storage =
|
||||
case storage_backend do
|
||||
:postgres ->
|
||||
[
|
||||
backend: :postgres,
|
||||
events: Parrhesia.Storage.Adapters.Postgres.Events,
|
||||
acl: Parrhesia.Storage.Adapters.Postgres.ACL,
|
||||
moderation: Parrhesia.Storage.Adapters.Postgres.Moderation,
|
||||
groups: Parrhesia.Storage.Adapters.Postgres.Groups,
|
||||
admin: Parrhesia.Storage.Adapters.Postgres.Admin
|
||||
]
|
||||
|
||||
:memory ->
|
||||
[
|
||||
backend: :memory,
|
||||
events: Parrhesia.Storage.Adapters.Memory.Events,
|
||||
acl: Parrhesia.Storage.Adapters.Memory.ACL,
|
||||
moderation: Parrhesia.Storage.Adapters.Memory.Moderation,
|
||||
groups: Parrhesia.Storage.Adapters.Memory.Groups,
|
||||
admin: Parrhesia.Storage.Adapters.Memory.Admin
|
||||
]
|
||||
end
|
||||
|
||||
if postgres_backend? do
|
||||
config :parrhesia, Parrhesia.Repo,
|
||||
url: database_url,
|
||||
pool_size: pool_size,
|
||||
queue_target: queue_target,
|
||||
queue_interval: queue_interval
|
||||
|
||||
config :parrhesia, Parrhesia.ReadRepo,
|
||||
url: database_url,
|
||||
pool_size: read_pool_size,
|
||||
queue_target: read_queue_target,
|
||||
queue_interval: read_queue_interval
|
||||
end
|
||||
|
||||
config :parrhesia,
|
||||
database: [
|
||||
separate_read_pool?: separate_read_pool?
|
||||
],
|
||||
relay_url: string_env.("PARRHESIA_RELAY_URL", relay_url_default),
|
||||
metadata: [
|
||||
name: Keyword.get(metadata_defaults, :name, "Parrhesia"),
|
||||
version: Keyword.get(metadata_defaults, :version, "0.0.0"),
|
||||
hide_version?:
|
||||
bool_env.(
|
||||
"PARRHESIA_METADATA_HIDE_VERSION",
|
||||
Keyword.get(metadata_defaults, :hide_version?, true)
|
||||
)
|
||||
],
|
||||
acl: [
|
||||
protected_filters:
|
||||
json_env.(
|
||||
@@ -604,18 +749,29 @@ if config_env() == :prod do
|
||||
start_workers?:
|
||||
bool_env.(
|
||||
"PARRHESIA_SYNC_START_WORKERS",
|
||||
Keyword.get(Application.get_env(:parrhesia, :sync, []), :start_workers?, true)
|
||||
Keyword.get(sync_defaults, :start_workers?, true)
|
||||
),
|
||||
relay_guard:
|
||||
bool_env.(
|
||||
"PARRHESIA_SYNC_RELAY_GUARD",
|
||||
Keyword.get(sync_defaults, :relay_guard, false)
|
||||
)
|
||||
],
|
||||
moderation_cache_enabled:
|
||||
bool_env.("PARRHESIA_MODERATION_CACHE_ENABLED", moderation_cache_enabled_default),
|
||||
enable_expiration_worker:
|
||||
bool_env.("PARRHESIA_ENABLE_EXPIRATION_WORKER", enable_expiration_worker_default),
|
||||
enable_partition_retention_worker:
|
||||
bool_env.(
|
||||
"PARRHESIA_ENABLE_PARTITION_RETENTION_WORKER",
|
||||
enable_partition_retention_worker_default
|
||||
),
|
||||
listeners: listeners,
|
||||
limits: limits,
|
||||
policies: policies,
|
||||
retention: retention,
|
||||
features: features
|
||||
features: features,
|
||||
storage: storage
|
||||
|
||||
case System.get_env("PARRHESIA_EXTRA_CONFIG") do
|
||||
nil -> :ok
|
||||
|
||||
@@ -27,6 +27,7 @@ config :parrhesia, :listeners,
|
||||
config :parrhesia,
|
||||
enable_expiration_worker: false,
|
||||
moderation_cache_enabled: false,
|
||||
nip66: [enabled: false],
|
||||
identity: [
|
||||
path: Path.join(System.tmp_dir!(), "parrhesia_test_identity.json"),
|
||||
private_key: nil
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
vips,
|
||||
}: let
|
||||
pname = "parrhesia";
|
||||
version = "0.5.0";
|
||||
version = "0.8.0";
|
||||
|
||||
beamPackages = beam.packages.erlang_28.extend (
|
||||
final: _prev: {
|
||||
|
||||
16
devenv.lock
16
devenv.lock
@@ -87,11 +87,27 @@
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"nostr-bench-src": {
|
||||
"flake": false,
|
||||
"locked": {
|
||||
"lastModified": 1774020724,
|
||||
"owner": "serpent213",
|
||||
"repo": "nostr-bench",
|
||||
"rev": "8561b84864ce1269b26304808c64219471999caf",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "serpent213",
|
||||
"repo": "nostr-bench",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"inputs": {
|
||||
"devenv": "devenv",
|
||||
"git-hooks": "git-hooks",
|
||||
"nixpkgs": "nixpkgs",
|
||||
"nostr-bench-src": "nostr-bench-src",
|
||||
"pre-commit-hooks": [
|
||||
"git-hooks"
|
||||
]
|
||||
|
||||
13
devenv.nix
13
devenv.nix
@@ -73,11 +73,14 @@ in {
|
||||
vips.overrideAttrs (oldAttrs: {
|
||||
buildInputs = oldAttrs.buildInputs ++ [mozjpeg];
|
||||
});
|
||||
nostr-bench = pkgs.callPackage ./nix/nostr-bench.nix {};
|
||||
nostr-bench = pkgs.callPackage ./nix/nostr-bench.nix {
|
||||
nostrBenchSrc = inputs.nostr-bench-src;
|
||||
};
|
||||
in
|
||||
with pkgs;
|
||||
[
|
||||
just
|
||||
# Mix NIFs
|
||||
gcc
|
||||
git
|
||||
gnumake
|
||||
@@ -85,6 +88,8 @@ in {
|
||||
automake
|
||||
libtool
|
||||
pkg-config
|
||||
# for tests
|
||||
openssl
|
||||
# Nix code formatter
|
||||
alejandra
|
||||
# i18n
|
||||
@@ -97,12 +102,18 @@ in {
|
||||
mermaid-cli
|
||||
# Nostr CLI client
|
||||
nak
|
||||
websocat
|
||||
# Nostr relay benchmark client
|
||||
nostr-bench
|
||||
# Nostr reference servers
|
||||
nostr-rs-relay
|
||||
# Benchmark graph
|
||||
gnuplot
|
||||
# Cloud benchmarks
|
||||
hcloud
|
||||
]
|
||||
++ lib.optionals pkgs.stdenv.hostPlatform.isx86_64 [
|
||||
# Nostr reference servers
|
||||
strfry
|
||||
];
|
||||
|
||||
|
||||
@@ -2,6 +2,9 @@
|
||||
inputs:
|
||||
nixpkgs:
|
||||
url: github:cachix/devenv-nixpkgs/rolling
|
||||
nostr-bench-src:
|
||||
url: github:serpent213/nostr-bench
|
||||
flake: false
|
||||
|
||||
# If you're using non-OSS software, you can set allowUnfree to true.
|
||||
# allowUnfree: true
|
||||
|
||||
20
docs/ARCH.md
20
docs/ARCH.md
@@ -82,16 +82,20 @@ Configured WS/HTTP Listeners (Bandit/Plug)
|
||||
|
||||
## 4) OTP supervision design
|
||||
|
||||
`Parrhesia.Application` children (top-level):
|
||||
`Parrhesia.Runtime` children (top-level):
|
||||
|
||||
1. `Parrhesia.Telemetry` – metric definitions/reporters
|
||||
2. `Parrhesia.Config` – runtime config cache (ETS-backed)
|
||||
3. `Parrhesia.Storage.Supervisor` – adapter processes (`Repo`, pools)
|
||||
4. `Parrhesia.Subscriptions.Supervisor` – subscription index + fanout workers
|
||||
5. `Parrhesia.Auth.Supervisor` – AUTH challenge/session tracking
|
||||
6. `Parrhesia.Policy.Supervisor` – rate limiters / ACL caches
|
||||
7. `Parrhesia.Web.Endpoint` – supervises configured WS + HTTP listeners
|
||||
8. `Parrhesia.Tasks.Supervisor` – background jobs (expiry purge, maintenance)
|
||||
2. `Parrhesia.ConnectionStats` – per-listener connection/subscription counters
|
||||
3. `Parrhesia.Config` – runtime config cache (ETS-backed)
|
||||
4. `Parrhesia.Web.EventIngestLimiter` – relay-wide event ingest rate limiter
|
||||
5. `Parrhesia.Web.IPEventIngestLimiter` – per-IP event ingest rate limiter
|
||||
6. `Parrhesia.Storage.Supervisor` – adapter processes (`Repo`, pools)
|
||||
7. `Parrhesia.Subscriptions.Supervisor` – subscription index + fanout workers
|
||||
8. `Parrhesia.Auth.Supervisor` – AUTH challenge/session tracking
|
||||
9. `Parrhesia.Sync.Supervisor` – outbound relay sync workers
|
||||
10. `Parrhesia.Policy.Supervisor` – rate limiters / ACL caches
|
||||
11. `Parrhesia.Web.Endpoint` – supervises configured WS + HTTP listeners
|
||||
12. `Parrhesia.Tasks.Supervisor` – background jobs (expiry purge, maintenance)
|
||||
|
||||
Failure model:
|
||||
|
||||
|
||||
344
docs/BETA_REVIEW.md
Normal file
344
docs/BETA_REVIEW.md
Normal file
@@ -0,0 +1,344 @@
|
||||
# Parrhesia Beta: Production-Readiness Gap Assessment
|
||||
|
||||
**Date:** 2026-03-20
|
||||
**Version:** 0.7.0
|
||||
**Scope:** Delta analysis from beta promotion — what stands between this codebase and confident public-facing production deployment.
|
||||
|
||||
---
|
||||
|
||||
## Production Readiness Scorecard
|
||||
|
||||
| # | Dimension | Rating | Summary |
|
||||
|---|----------------------------------|--------|----------------------------------------------|
|
||||
| 1 | Operational Resilience | 🟡 | Graceful shutdown partial; no DB circuit-breaking |
|
||||
| 2 | Multi-Node / Clustering | 🟡 | Best-effort only; acceptable for single-node prod |
|
||||
| 3 | Load & Capacity Characterisation | 🟡 | Benchmarks exist but no defined capacity model |
|
||||
| 4 | Deployment & Infrastructure | 🟡 | Strong Nix/Docker base; missing runbooks and migration strategy |
|
||||
| 5 | Security Hardening | 🟢 | Solid for production with reverse proxy |
|
||||
| 6 | Data Integrity & Consistency | 🟢 | Transaction-wrapped writes with dedup; minor multi-node edge cases |
|
||||
| 7 | Observability Completeness | 🟡 | Excellent metrics; no dashboards, alerts, or tracing |
|
||||
| 8 | Technical Debt (Prod Impact) | 🟡 | Manageable; connection.ex size is the main concern |
|
||||
|
||||
---
|
||||
|
||||
## 1. Operational Resilience — 🟡
|
||||
|
||||
### What's good
|
||||
|
||||
- **No `Process.sleep` on any hot path.** Zero occurrences in `lib/`. Clean async message passing throughout.
|
||||
- **WebSocket keepalive** implemented: 30s ping, 10s pong timeout, auto-close on timeout.
|
||||
- **Outbound queue backpressure** well-designed: bounded queue (256 default), configurable overflow strategy (`:close`/`:drop_oldest`/`:drop_newest`), pressure telemetry at 75% threshold.
|
||||
- **Connection isolation:** Each WebSocket is a separate process; one crash does not propagate.
|
||||
- **Graceful connection close on shutdown:** `handle_info({:EXIT, _, :shutdown}, ...)` drains outbound frames before closing with code 1012 ("service restart"). This is good.
|
||||
|
||||
### Gaps
|
||||
|
||||
**G1.1 — No DB circuit-breaking or backoff on PostgreSQL unavailability.**
|
||||
Ecto's connection pool (`db_connection`/`DBConnection`) will queue checkout requests up to `queue_target` (1000ms) / `queue_interval` (5000ms), then raise `DBConnection.ConnectionError`. These errors propagate as storage failures in the ingest path and return NOTICE errors to clients. However:
|
||||
- There is no circuit breaker to fast-reject requests when the DB is known-down, meaning every ingest/query attempt during an outage burns a pool checkout timeout slot.
|
||||
- On DB recovery, all queued checkouts may succeed simultaneously (thundering herd).
|
||||
- **Impact:** During a PostgreSQL failover (typically 10–30s), connection processes pile up waiting on the pool. Latency spikes for all connected clients. Memory pressure from queued processes.
|
||||
- **Mitigation:** Ecto's built-in queue management provides partial protection. For a relay with ≤1000 concurrent connections this is likely survivable without circuit-breaking. For higher connection counts, consider a fast-fail wrapper around storage calls when the pool reports consecutive failures.
|
||||
|
||||
**G1.2 — Metrics scrape on the hot path.**
|
||||
`/metrics` calls `TelemetryMetricsPrometheus.Core.scrape/1` synchronously within the HTTP request handler. This serialises metric aggregation and formatting. If the Prometheus reporter's internal state is large (many unique tag combinations), scraping can take 10–100ms. This runs on a Bandit acceptor process — it does not block WebSocket connections directly, but a slow scrape under high cardinality could make the health endpoint unresponsive if metrics and health share the same listener.
|
||||
- **Current mitigation:** Metrics can be isolated to a dedicated listener via `PARRHESIA_METRICS_ENDPOINT_*` config. If deployed this way, impact is isolated.
|
||||
- **Recommendation:** Document the dedicated metrics listener as required for production. Consider adding a scrape timeout guard.
|
||||
|
||||
**G1.3 — Supervisor shutdown timeout is OTP default (5s).**
|
||||
The `Parrhesia.Runtime` supervisor uses `:one_for_one` strategy with default child shutdown specs. Bandit listeners have their own shutdown behavior, but there is no explicit `shutdown: N` on the endpoint child spec. Under load with many connections, 5s may not be enough to drain all outbound queues.
|
||||
- **Recommendation:** Set explicit `shutdown: 15_000` on `Parrhesia.Web.Endpoint` child spec. Bandit supports graceful drain on listener stop.
|
||||
|
||||
---
|
||||
|
||||
## 2. Multi-Node / Clustering — 🟡
|
||||
|
||||
### Current state
|
||||
|
||||
Per `docs/CLUSTER.md`, clustering is **implemented but explicitly best-effort and untested**:
|
||||
|
||||
- `:pg`-based process groups for cross-node fanout.
|
||||
- No automatic cluster discovery (no libcluster).
|
||||
- ETS subscription index is node-local.
|
||||
- No durable inter-node transport; no replay on reconnect.
|
||||
- No explicit acknowledgement between nodes.
|
||||
|
||||
### Assessment for production
|
||||
|
||||
**For single-node production deployment: not a blocker.** The clustering code is unconditionally started (`MultiNode` joins `:pg` on init) but with a single node, `get_members/0` returns only self, and the `Enum.reject(&(&1 == self()))` filter means no remote sends occur. No performance overhead.
|
||||
|
||||
**For multi-node production: not ready.** Key issues:
|
||||
- **Subscription inconsistency on netsplit:** Events ingested on node A during a split are never delivered to subscribers on node B. No catch-up mechanism exists. Clients must reconnect and re-query to recover.
|
||||
- **Node departure drops subscriptions silently:** When a node leaves the cluster, subscribers on that node lose their connections (normal). Subscribers on other nodes are unaffected. But events that were in-flight from the departed node are lost.
|
||||
- **No cluster health observability:** No metrics for inter-node fanout lag, message drops, or membership changes.
|
||||
|
||||
**Recommendation for initial production:** Deploy single-node. Clustering is a Phase B concern per the documented roadmap.
|
||||
|
||||
---
|
||||
|
||||
## 3. Load & Capacity Characterisation — 🟡
|
||||
|
||||
### What exists
|
||||
|
||||
- `LoadSoakTest` asserts p95 fanout enqueue/drain < 25ms.
|
||||
- `bench/` directory with `nostr-bench` submodule for external load testing.
|
||||
- Cloud bench orchestration scripts (`scripts/cloud_bench_orchestrate.mjs`, `scripts/cloud_bench_server.sh`).
|
||||
|
||||
### Gaps
|
||||
|
||||
**G3.1 — No documented capacity model.**
|
||||
There is no documented answer to: "How many connections / events per second can one node handle before degradation?" The `LoadSoakTest` runs locally with synthetic data — useful for regression detection but not representative of production traffic patterns.
|
||||
|
||||
**G3.2 — Multi-filter query scaling is in-memory dedup.**
|
||||
`Postgres.Events.query/3` runs each filter as a separate SQL query, collects all results into memory, and deduplicates with `deduplicate_events/1` (Map.update accumulation). With many overlapping filters or high-cardinality results, this could produce significant memory pressure per-request.
|
||||
- At realistic scales (< 10 filters, < 1000 results per filter), this is fine.
|
||||
- At adversarial scales (32 subscriptions × large result sets), a single REQ could allocate substantial memory.
|
||||
- **Current mitigation:** `max_tag_values_per_filter` (128) and query `LIMIT` bounds exist. The risk is bounded but not eliminated.
|
||||
|
||||
**G3.3 — No query performance benchmarks against large datasets.**
|
||||
No evidence of testing against 100M+ events with monthly partitions. Partition pruning is implemented, but query plans may degrade if the partition list grows large (PostgreSQL planner overhead scales with partition count).
|
||||
|
||||
**Recommendation:** Before production, run `nostr-bench` at target load (e.g., 500 concurrent connections, 100 events/sec ingest, 1000 active subscriptions) and document the resulting latency profile. This becomes the baseline capacity model.
|
||||
|
||||
---
|
||||
|
||||
## 4. Deployment & Infrastructure Readiness — 🟡
|
||||
|
||||
### What's good
|
||||
|
||||
- **Docker image via Nix:** Non-root user (65534:65534), minimal base, cacerts bundled, SSL_CERT_FILE set. This is production-quality container hygiene.
|
||||
- **OTP release:** `mix release` with `Parrhesia.Release.migrate/0` for safe migration execution.
|
||||
- **CI pipeline:** Multi-matrix testing (OTP 27/28, Elixir 1.18/1.19), format/credo/unused deps checks, E2E tests.
|
||||
- **Environment-based configuration:** All critical settings overridable via `PARRHESIA_*` env vars in `runtime.exs`.
|
||||
- **Secrets:** No secrets committed. DB credentials via `DATABASE_URL`, identity key via env or file path.
|
||||
|
||||
### Gaps
|
||||
|
||||
**G4.1 — No zero-downtime migration strategy.**
|
||||
`Parrhesia.Release.migrate/0` runs `Ecto.Migrator.run/4` with `:up`. Under replicated deployments (rolling update with 2+ instances), there is no advisory lock or migration guard — two instances starting simultaneously could race on migrations. Ecto's default migrator uses `pg_advisory_lock` via `Ecto.Migration.Runner`, so this is actually safe for PostgreSQL. However:
|
||||
- **DDL migrations (CREATE INDEX CONCURRENTLY, ALTER TABLE) need careful handling.** The existing migrations use standard `CREATE TABLE` and `CREATE INDEX` which acquire ACCESS EXCLUSIVE locks. Running these against a live database will block reads and writes for the duration.
|
||||
- **Recommendation:** For production, migrations should be run as a separate step before deploying new code (the compose.yaml already has a `migrate` service — extend this pattern).
|
||||
|
||||
**G4.2 — No operational runbooks.**
|
||||
There are no documented procedures for:
|
||||
- Rolling restart / blue-green deploy
|
||||
- Partition pruning and retention tuning
|
||||
- Runtime pubkey banning (the NIP-86 management API exists but isn't documented for ops use)
|
||||
- DB failover response
|
||||
- Scaling (horizontal or vertical)
|
||||
|
||||
**G4.3 — No health check in Docker image.**
|
||||
The Nix-built Docker image has no `HEALTHCHECK` instruction. The `/health` and `/ready` endpoints exist but aren't wired into container orchestration.
|
||||
- **Recommendation:** Add `HEALTHCHECK CMD curl -f http://localhost:4413/ready || exit 1` to the Docker image definition, or document the readiness endpoint for Kubernetes probes.
|
||||
|
||||
**G4.4 — No disaster recovery plan.**
|
||||
No documented RTO/RPO. If the primary DB is lost, recovery depends entirely on external backup infrastructure. The relay has no built-in data export or snapshot capability.
|
||||
|
||||
---
|
||||
|
||||
## 5. Security Hardening — 🟢
|
||||
|
||||
### Assessment
|
||||
|
||||
The security posture is solid for production behind a reverse proxy:
|
||||
|
||||
- **TLS:** Full support for server, mutual, and proxy-terminated TLS modes. Cipher suite selection (strong/compatible). Certificate pin verification.
|
||||
- **Rate limiting:** Three layers — relay-wide (10k/s), per-IP (1k/s), per-connection (120/s). All configurable.
|
||||
- **Metrics endpoint:** Access-controlled via `metrics_allowed?/2` — supports private-network-only restriction and bearer token auth. Tested.
|
||||
- **NIP-42 auth:** Constant-time comparison via `Plug.Crypto.secure_compare/2` (addressed in beta).
|
||||
- **NIP-98:** Replay protection, event freshness check (< 60s), signature verification.
|
||||
- **Input validation:** Binary field length constraints at DB level (migration 7). Event size limits at WebSocket frame level.
|
||||
- **IP controls:** Trusted proxy CIDR configuration, X-Forwarded-For parsing, IP blocklist table.
|
||||
- **Audit logging:** `management_audit_logs` table tracks admin actions.
|
||||
- **No secrets in git.** Environment variable or file-path based secret injection.
|
||||
|
||||
### Minor considerations (not blocking)
|
||||
|
||||
- No integration with external threat intel feeds or IP reputation services. This is an infrastructure concern, not an application concern.
|
||||
- DDoS mitigation assumed to be at load balancer / CDN layer. Application-level rate limiting is defense-in-depth, not primary.
|
||||
- **Recommendation:** Document the expected deployment topology (Caddy/Nginx → Parrhesia) and which security controls are expected at each layer.
|
||||
|
||||
---
|
||||
|
||||
## 6. Data Integrity & Consistency — 🟢
|
||||
|
||||
### What's good
|
||||
|
||||
- **Duplicate event prevention:** Two-layer defence:
|
||||
1. `event_ids` table with unique PK on `id` — `INSERT ... ON CONFLICT DO NOTHING`.
|
||||
2. If `inserted == 0`, transaction rolls back with `:duplicate_event`.
|
||||
3. Separate unique index on `events.id` as belt-and-suspenders.
|
||||
- **Atomic writes:** `put_event/2` wraps `insert_event_id!`, `insert_event!`, `insert_tags!`, and `upsert_state_tables!` in a single `Repo.transaction/1`. Partial writes (event without tags) cannot occur.
|
||||
- **Replaceable/addressable event state:** Upsert logic in state tables with correct conflict resolution (higher `created_at` wins, then lower `id` as tiebreaker via `candidate_wins_state?/2`).
|
||||
|
||||
### Minor considerations
|
||||
|
||||
**G6.1 — Expiration worker concurrency on multi-node.**
|
||||
`ExpirationWorker` runs `Repo.delete_all/1` against all expired events. If two nodes run this worker against the same database, both execute the same DELETE query. PostgreSQL handles this safely (the second DELETE finds 0 rows), and the worker is idempotent. **Not a problem.**
|
||||
|
||||
**G6.2 — Partition pruning and sync.**
|
||||
`PartitionRetentionWorker.drop_partition/1` drops entire monthly partitions. If negentropy sync is in progress against events in that partition, the sync session's cached refs become stale. The session would fail or return incomplete results.
|
||||
- **Impact:** Low. Partition drops are infrequent (daily check, at most 1 per run). Negentropy sessions are short-lived (60s idle timeout).
|
||||
- **Recommendation:** No action needed for initial production. If operating as a sync source relay, consider pausing sync during partition drops.
|
||||
|
||||
---
|
||||
|
||||
## 7. Observability Completeness — 🟡
|
||||
|
||||
### What's good
|
||||
|
||||
Metrics coverage is comprehensive — 34+ distinct metrics covering:
|
||||
- Ingest: event count by outcome/reason, duration distribution
|
||||
- Query: request count, duration, result cardinality
|
||||
- Fanout: duration, candidates considered, events enqueued, batch size
|
||||
- Connection: outbound queue depth/pressure/overflow/drop, mailbox depth
|
||||
- Rate limiting: hit count by scope
|
||||
- DB: query count/total_time/queue_time/query_time/decode_time/idle_time by repo role
|
||||
- Maintenance: expiration purge count/duration, partition retention drops/duration
|
||||
- VM: memory (total/processes/system/atom/binary/ets)
|
||||
- Listener: active connections, active subscriptions
|
||||
|
||||
Readiness endpoint checks critical process liveness. Health endpoint for basic reachability.
|
||||
|
||||
### Gaps
|
||||
|
||||
**G7.1 — No dashboards or alerting rules.**
|
||||
The metrics exist but there are no Grafana dashboard JSON files, no Prometheus alerting rules, and no documented alert thresholds. An operator deploying this relay would need to build observability from scratch.
|
||||
- **Recommendation:** Ship a `deploy/grafana/` directory with a dashboard JSON and a `deploy/prometheus/alerts.yml` with rules for:
|
||||
- `parrhesia_db_query_queue_time_ms` p95 > 100ms (pool saturation)
|
||||
- `parrhesia_connection_outbound_queue_overflow_count` rate > 0 (clients being dropped)
|
||||
- `parrhesia_rate_limit_hits_count` rate sustained > threshold (potential abuse)
|
||||
- `parrhesia_vm_memory_total_bytes` > 80% of available
|
||||
- Listener connection count approaching `max_connections`
|
||||
|
||||
**G7.2 — No distributed tracing or request correlation IDs.**
|
||||
Events flow through validate → policy → persist → fanout without a correlation ID tying the stages together. Log-based debugging of "why didn't this event reach subscriber X" requires manual PID correlation across log lines.
|
||||
- **Impact:** Tolerable for initial production at moderate scale. Becomes painful at high event rates.
|
||||
|
||||
**G7.3 — No synthetic monitoring.**
|
||||
No built-in probe that ingests a canary event and verifies it arrives at a subscriber. End-to-end relay health depends on external monitoring.
|
||||
- **Recommendation:** This is best implemented as an external tool. Not blocking.
|
||||
|
||||
---
|
||||
|
||||
## 8. Technical Debt with Production Impact — 🟡
|
||||
|
||||
### G8.1 — `connection.ex` at 2,116 lines
|
||||
|
||||
This module is the per-connection state machine handling EVENT, REQ, CLOSE, AUTH, COUNT, NEG-*, keepalive, outbound queue management, rate limiting, and all associated telemetry. It is the single most critical file for production incident response.
|
||||
|
||||
**Production risk:** During a production incident involving connection behavior, an on-call engineer needs to quickly navigate this module. At 2,116 lines with interleaved concerns (protocol parsing, policy enforcement, queue management, telemetry emission), this slows incident response.
|
||||
|
||||
**Recommendation (M-sized effort):** Extract into focused modules:
|
||||
- `Connection.Ingest` — EVENT handling and policy application
|
||||
- `Connection.Subscription` — REQ/CLOSE management and initial query streaming
|
||||
- `Connection.OutboundQueue` — queue/drain/overflow logic
|
||||
- `Connection.Keepalive` — ping/pong state machine
|
||||
|
||||
The main `Connection` module would become an orchestrator delegating to these. This is a refactor-only change with no behavioral impact.
|
||||
|
||||
### G8.2 — Multi-filter in-memory dedup
|
||||
|
||||
`deduplicate_events/1` accumulates all query results into a Map before deduplication. With 32 subscriptions (the max) and generous limits, worst case is:
|
||||
- 32 filters × 5000 result limit = 160,000 events loaded into memory per REQ.
|
||||
|
||||
Each event struct is ~500 bytes minimum, so ~80MB per pathological request. This is bounded but could be weaponised by an attacker sending many concurrent REQs with overlapping filters.
|
||||
|
||||
**Current mitigation:** Per-connection subscription limit (32) and query result limits bound the damage. Per-IP rate limiting adds friction.
|
||||
|
||||
**Recommendation:** Not blocking for production. Monitor `parrhesia.query.results.count` distribution. If p99 > 10,000, investigate query patterns.
|
||||
|
||||
### G8.3 — Per-pubkey rate limiting absent
|
||||
|
||||
Rate limiting is currently per-IP and relay-wide. An attacker using a botnet (many IPs, one pubkey) bypasses IP-based limits. Per-pubkey rate limiting would catch this.
|
||||
|
||||
**Impact:** Medium for a public relay; low for an invite-only (NIP-43) relay.
|
||||
|
||||
**Recommendation (S-sized effort):** Add a per-pubkey event ingest limiter similar to `IPEventIngestLimiter`, keyed by `event.pubkey`. Apply after signature verification but before storage.
|
||||
|
||||
### G8.4 — Negentropy session memory ceiling
|
||||
|
||||
Negentropy session bounds:
|
||||
- Max 10,000 total sessions (`@default_max_total_sessions`)
|
||||
- Max 8 per connection (`@default_max_sessions_per_owner`)
|
||||
- Max 50,000 items per session (`@default_max_items_per_session`)
|
||||
- 60s idle timeout with 10s sweep interval
|
||||
|
||||
Worst case: 10,000 sessions × 50,000 items × ~40 bytes/ref = ~20GB. This is the theoretical maximum under adversarial session creation.
|
||||
|
||||
**Realistic ceiling:** The `open/6` path runs a DB query bounded by `max_items_per_session + 1`. At 50k items, this query itself provides backpressure (it takes time). An attacker would need 10,000 concurrent connections each opening 8 sessions, each returning 50k results. The relay-wide connection limit and rate limiting make this implausible in practice.
|
||||
|
||||
**Recommendation:** Reduce `@default_max_items_per_session` to 10,000 for production (reduces theoretical ceiling to ~4GB). This is a config change, not a code change.
|
||||
|
||||
---
|
||||
|
||||
## Critical Path to Production
|
||||
|
||||
Ordered by priority. Items above the line are required before production traffic; items below are strongly recommended.
|
||||
|
||||
| # | Work Item | Dimension | Effort |
|
||||
|---|-----------|-----------|--------|
|
||||
| 1 | Set explicit shutdown timeout on Endpoint child spec | Operational | S |
|
||||
| 2 | Document dedicated metrics listener as production requirement | Operational | S |
|
||||
| 3 | Add HEALTHCHECK to Docker image or document K8s probes | Deployment | S |
|
||||
| 4 | Run capacity benchmark at target load and document results | Load | M |
|
||||
| 5 | Ship Grafana dashboard + Prometheus alert rules | Observability | M |
|
||||
| 6 | Write operational runbook (deploy, rollback, ban, failover) | Deployment | M |
|
||||
| 7 | Document migration strategy (run before deploy, not during) | Deployment | S |
|
||||
| --- | --- | --- | --- |
|
||||
| 8 | Add per-pubkey rate limiting | Security | S |
|
||||
| 9 | Reduce default negentropy items-per-session to 10k | Security | S |
|
||||
| 10 | Extract connection.ex into sub-modules | Debt | M |
|
||||
| 11 | Add request correlation IDs to event lifecycle | Observability | M |
|
||||
| 12 | Add DB pool health fast-fail wrapper | Operational | M |
|
||||
|
||||
---
|
||||
|
||||
## Production Risk Register
|
||||
|
||||
| ID | Risk | Likelihood | Impact | Mitigation |
|
||||
|----|------|-----------|--------|------------|
|
||||
| R1 | PostgreSQL failover causes latency spike for all connections | Medium | High | G1.1: Ecto queue management provides partial protection. Add pool health telemetry alerting. Consider circuit breaker at high connection counts. |
|
||||
| R2 | Slow /metrics scrape blocks health checks | Low | Medium | G1.2: Deploy dedicated metrics listener (already supported). |
|
||||
| R3 | Ungraceful shutdown drops in-flight events | Low | Medium | G1.3: Set explicit shutdown timeout. Connection drain logic already exists. |
|
||||
| R4 | Multi-IP spam campaign bypasses rate limiting | Medium | Medium | G8.3: Add per-pubkey rate limiter. NIP-43 invite-only mode mitigates for private relays. |
|
||||
| R5 | Large REQ with many overlapping filters causes memory spike | Low | Medium | G8.2: Bounded by existing limits. Monitor query result cardinality. |
|
||||
| R6 | No alerting means silent degradation | Medium | High | G7.1: Ship dashboard and alert rules before production. |
|
||||
| R7 | DDL migration blocks reads during rolling deploy | Low | High | G4.1: Run migrations as separate pre-deploy step. |
|
||||
| R8 | Adversarial negentropy session creation exhausts memory | Low | High | G8.4: Reduce max items per session. Existing session limits provide protection. |
|
||||
| R9 | No runbooks slows incident response | Medium | Medium | G4.2: Write runbooks for common ops tasks. |
|
||||
| R10 | connection.ex complexity slows debugging | Medium | Low | G8.1: Extract sub-modules. Not urgent but improves maintainability. |
|
||||
|
||||
---
|
||||
|
||||
## Final Verdict
|
||||
|
||||
### 🟡 Ready for Limited Production
|
||||
|
||||
**Constraints for initial deployment:**
|
||||
|
||||
1. **Single-node only.** Multi-node clustering is best-effort and should not be relied upon for production traffic. Deploy one node with a properly sized PostgreSQL instance.
|
||||
|
||||
2. **Behind a reverse proxy.** Deploy behind Caddy, Nginx, or a cloud load balancer for TLS termination, DDoS mitigation, and connection limits. Document the expected topology.
|
||||
|
||||
3. **Moderate traffic cap.** Without a validated capacity model, start with conservative limits:
|
||||
- ≤ 2,000 concurrent WebSocket connections
|
||||
- ≤ 500 events/second ingest rate
|
||||
- Monitor `db.query.queue_time.ms` p95 and `connection.outbound_queue.overflow.count` as scaling signals.
|
||||
|
||||
4. **Observability must be deployed alongside.** The metrics exist but dashboards and alerts do not. Do not go live without at minimum:
|
||||
- Prometheus scraping the dedicated metrics listener
|
||||
- Alerts on DB queue time, outbound queue overflow, and VM memory
|
||||
- Log aggregation with ERROR-level alerts
|
||||
|
||||
5. **Migrations run pre-deploy.** Use the existing compose.yaml `migrate` service pattern. Never run migrations as part of application startup in a multi-replica deployment.
|
||||
|
||||
**What's strong:**
|
||||
- OTP supervision architecture is clean and fault-isolated
|
||||
- Data integrity layer is well-designed (transactional writes, dedup, constraint enforcement)
|
||||
- Security posture is production-appropriate
|
||||
- Telemetry coverage is comprehensive
|
||||
- Container image follows best practices
|
||||
- No blocking issues in the hot path (no sleeps, no synchronous calls, bounded queues)
|
||||
|
||||
**The codebase is architecturally sound for production.** The gaps are operational (runbooks, dashboards, capacity planning) rather than structural. A focused sprint addressing items 1–7 from the critical path would clear the way for a controlled production launch.
|
||||
140
docs/KHATRU.md
140
docs/KHATRU.md
@@ -1,140 +0,0 @@
|
||||
# Khatru-Inspired Runtime Improvements
|
||||
|
||||
This document collects refactoring and extension ideas learned from studying Khatru-style relay design.
|
||||
|
||||
It is intentionally **not** about the new public API surface or the sync ACL model. Those live in `docs/slop/LOCAL_API.md` and `docs/SYNC.md`.
|
||||
|
||||
The focus here is runtime shape, protocol behavior, and operator-visible relay features.
|
||||
|
||||
---
|
||||
|
||||
## 1. Why This Matters
|
||||
|
||||
Khatru appears mature mainly because it exposes clearer relay pipeline stages.
|
||||
|
||||
That gives three practical benefits:
|
||||
|
||||
- less policy drift between storage, websocket, and management code,
|
||||
- easier feature addition without hard-coding more branches into one connection module,
|
||||
- better composability for relay profiles with different trust and traffic models.
|
||||
|
||||
Parrhesia should borrow that clarity without copying Khatru's code-first hook model wholesale.
|
||||
|
||||
---
|
||||
|
||||
## 2. Proposed Runtime Refactors
|
||||
|
||||
### 2.1 Staged policy pipeline
|
||||
|
||||
Parrhesia should stop treating policy as one coarse `EventPolicy` module plus scattered special cases.
|
||||
|
||||
Recommended internal stages:
|
||||
|
||||
1. connection admission
|
||||
2. authentication challenge and validation
|
||||
3. publish/write authorization
|
||||
4. query/count authorization
|
||||
5. stream subscription authorization
|
||||
6. negentropy authorization
|
||||
7. response shaping
|
||||
8. broadcast/fanout suppression
|
||||
|
||||
This is an internal runtime refactor. It does not imply a new public API.
|
||||
|
||||
### 2.2 Richer internal request context
|
||||
|
||||
The runtime should carry a structured request context through all stages.
|
||||
|
||||
Useful fields:
|
||||
|
||||
- authenticated pubkeys
|
||||
- caller kind
|
||||
- remote IP
|
||||
- subscription id
|
||||
- peer id
|
||||
- negentropy session flag
|
||||
- internal-call flag
|
||||
|
||||
This reduces ad-hoc branching and makes audit/telemetry more coherent.
|
||||
|
||||
### 2.3 Separate policy from storage presence tables
|
||||
|
||||
Moderation state should remain data.
|
||||
|
||||
Runtime enforcement should be a first-class layer that consumes that data, not a side effect of whether a table exists.
|
||||
|
||||
This is especially important for:
|
||||
|
||||
- blocked IP enforcement,
|
||||
- pubkey allowlists,
|
||||
- future kind- or tag-scoped restrictions.
|
||||
|
||||
---
|
||||
|
||||
## 3. Protocol and Relay Features
|
||||
|
||||
### 3.1 Real COUNT sketches
|
||||
|
||||
Parrhesia currently returns a synthetic `hll` payload for NIP-45-style count responses.
|
||||
|
||||
If approximate count exchange matters, implement a real reusable HLL sketch path instead of hashing `filters + count`.
|
||||
|
||||
### 3.2 Relay identity in NIP-11
|
||||
|
||||
Once Parrhesia owns a stable server identity, NIP-11 should expose the relay pubkey instead of returning `nil`.
|
||||
|
||||
This is useful beyond sync:
|
||||
|
||||
- operator visibility,
|
||||
- relay fingerprinting,
|
||||
- future trust tooling.
|
||||
|
||||
### 3.3 Connection-level IP enforcement
|
||||
|
||||
Blocked IP support should be enforced on actual connection admission, not only stored in management tables.
|
||||
|
||||
This should happen early, before expensive protocol handling.
|
||||
|
||||
### 3.4 Better response shaping
|
||||
|
||||
Introduce a narrow internal response shaping layer for cases where returned events or counts need controlled rewriting or suppression.
|
||||
|
||||
Examples:
|
||||
|
||||
- hide fields for specific relay profiles,
|
||||
- suppress rebroadcast of locally-ingested remote sync traffic,
|
||||
- shape relay notices consistently.
|
||||
|
||||
This should stay narrow and deterministic. It should not become arbitrary app semantics.
|
||||
|
||||
---
|
||||
|
||||
## 4. Suggested Extension Points
|
||||
|
||||
These should be internal runtime seams, not necessarily public interfaces:
|
||||
|
||||
- `ConnectionPolicy`
|
||||
- `AuthPolicy`
|
||||
- `ReadPolicy`
|
||||
- `WritePolicy`
|
||||
- `NegentropyPolicy`
|
||||
- `ResponsePolicy`
|
||||
- `BroadcastPolicy`
|
||||
|
||||
They may initially be plain modules with well-defined callbacks or functions.
|
||||
|
||||
The point is not pluggability for its own sake. The point is to make policy stages explicit and testable.
|
||||
|
||||
---
|
||||
|
||||
## 5. Near-Term Priority
|
||||
|
||||
Recommended order:
|
||||
|
||||
1. enforce blocked IPs and any future connection-gating on the real connection path
|
||||
2. split the current websocket flow into explicit read/write/negentropy policy stages
|
||||
3. enrich runtime request context and telemetry metadata
|
||||
4. expose relay pubkey in NIP-11 once identity lands
|
||||
5. replace fake HLL payloads with a real approximate-count implementation if NIP-45 support matters operationally
|
||||
|
||||
This keeps the runtime improvements incremental and independent from the ongoing API and ACL implementation.
|
||||
174
docs/LOCAL_API.md
Normal file
174
docs/LOCAL_API.md
Normal file
@@ -0,0 +1,174 @@
|
||||
# Parrhesia Local API
|
||||
|
||||
Parrhesia can run as a normal standalone relay application, but it also exposes a stable
|
||||
in-process API for Elixir callers that want to embed the relay inside a larger OTP system.
|
||||
|
||||
This document describes that embedding surface. The runtime is now beta, so treat the API
|
||||
as usable with minor churn possible while it stabilizes.
|
||||
|
||||
## What embedding means today
|
||||
|
||||
Embedding currently means:
|
||||
|
||||
- the host app adds `:parrhesia` as a dependency and OTP application
|
||||
- the host app provides `config :parrhesia, ...` explicitly
|
||||
- the host app migrates the Parrhesia database schema
|
||||
- callers interact with the relay through `Parrhesia.API.*`
|
||||
- host-managed HTTP/WebSocket ingress is mounted through `Parrhesia.Plug`
|
||||
|
||||
Current operational assumptions:
|
||||
|
||||
- Parrhesia runs one runtime per BEAM node
|
||||
- core processes use global module names such as `Parrhesia.Config` and `Parrhesia.Web.Endpoint`
|
||||
- the config defaults in this repo's `config/*.exs` are not imported automatically by a host app
|
||||
|
||||
If you want multiple isolated relay instances inside one VM, Parrhesia does not support that
|
||||
cleanly yet.
|
||||
|
||||
## Minimal host setup
|
||||
|
||||
Add the dependency in your host app:
|
||||
|
||||
```elixir
|
||||
defp deps do
|
||||
[
|
||||
{:parrhesia, path: "../parrhesia"}
|
||||
]
|
||||
end
|
||||
```
|
||||
|
||||
Configure the runtime in your host app. At minimum you should carry over:
|
||||
|
||||
```elixir
|
||||
import Config
|
||||
|
||||
config :postgrex, :json_library, JSON
|
||||
|
||||
config :parrhesia,
|
||||
relay_url: "wss://relay.example.com/relay",
|
||||
listeners: %{},
|
||||
storage: [backend: :postgres]
|
||||
|
||||
config :parrhesia, Parrhesia.Repo,
|
||||
url: System.fetch_env!("DATABASE_URL"),
|
||||
pool_size: 10,
|
||||
types: Parrhesia.PostgresTypes
|
||||
|
||||
config :parrhesia, Parrhesia.ReadRepo,
|
||||
url: System.fetch_env!("DATABASE_URL"),
|
||||
pool_size: 10,
|
||||
types: Parrhesia.PostgresTypes
|
||||
|
||||
config :parrhesia, ecto_repos: [Parrhesia.Repo]
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- `listeners: %{}` is the official embedding pattern when your host app owns the HTTPS edge.
|
||||
- `listeners: %{}` disables Parrhesia-managed ingress (`/relay`, `/management`, `/metrics`, etc.).
|
||||
- Mount `Parrhesia.Plug` from the host app when you still want Parrhesia ingress behind that same
|
||||
HTTPS edge.
|
||||
- `Parrhesia.Web.*` modules are internal runtime wiring. Treat `Parrhesia.Plug` as the stable
|
||||
mount API.
|
||||
- If you prefer Parrhesia-managed ingress instead, copy the listener shape from the config
|
||||
reference in [README.md](../README.md).
|
||||
- Production runtime overrides still use the `PARRHESIA_*` environment variables described in
|
||||
[README.md](../README.md).
|
||||
|
||||
Migrate before serving traffic:
|
||||
|
||||
```elixir
|
||||
Parrhesia.Release.migrate()
|
||||
```
|
||||
|
||||
In development, `mix ecto.migrate -r Parrhesia.Repo` works too.
|
||||
|
||||
## Mounting `Parrhesia.Plug` from a host app
|
||||
|
||||
When `listeners: %{}` is set, you can still expose Parrhesia ingress by mounting `Parrhesia.Plug`
|
||||
in your host endpoint/router and passing an explicit listener config:
|
||||
|
||||
```elixir
|
||||
forward "/nostr", Parrhesia.Plug,
|
||||
listener: %{
|
||||
id: :public,
|
||||
transport: %{scheme: :https, tls: %{mode: :proxy_terminated}},
|
||||
proxy: %{trusted_cidrs: ["10.0.0.0/8"], honor_x_forwarded_for: true},
|
||||
features: %{
|
||||
nostr: %{enabled: true},
|
||||
admin: %{enabled: true},
|
||||
metrics: %{enabled: true, access: %{private_networks_only: true}}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Use the same listener schema documented in [README.md](../README.md).
|
||||
|
||||
## Starting the runtime
|
||||
|
||||
In the common case, letting OTP start the `:parrhesia` application is enough.
|
||||
|
||||
If you need to start the runtime explicitly under your own supervision tree, use
|
||||
`Parrhesia.Runtime`:
|
||||
|
||||
```elixir
|
||||
children = [
|
||||
{Parrhesia.Runtime, name: Parrhesia.Supervisor}
|
||||
]
|
||||
```
|
||||
|
||||
## Primary modules
|
||||
|
||||
The in-process surface is centered on these modules:
|
||||
|
||||
- `Parrhesia.API.Events` for publish, query, and count
|
||||
- `Parrhesia.API.Stream` for REQ-like local subscriptions
|
||||
- `Parrhesia.API.Auth` for event validation and NIP-98 auth parsing
|
||||
- `Parrhesia.API.Admin` for management operations
|
||||
- `Parrhesia.API.Identity` for relay-owned key management
|
||||
- `Parrhesia.API.ACL` for protected sync ACLs
|
||||
- `Parrhesia.API.Sync` for outbound relay sync management
|
||||
|
||||
Generated ExDoc groups these modules under `Embedded API`.
|
||||
|
||||
## Request context
|
||||
|
||||
Most calls take a `Parrhesia.API.RequestContext`. This carries authenticated pubkeys and
|
||||
caller metadata through policy checks.
|
||||
|
||||
```elixir
|
||||
%Parrhesia.API.RequestContext{
|
||||
caller: :local,
|
||||
authenticated_pubkeys: MapSet.new()
|
||||
}
|
||||
```
|
||||
|
||||
If your host app has already authenticated a user or peer, put that pubkey into
|
||||
`authenticated_pubkeys` before calling the API.
|
||||
|
||||
## Example
|
||||
|
||||
```elixir
|
||||
alias Parrhesia.API.Events
|
||||
alias Parrhesia.API.RequestContext
|
||||
alias Parrhesia.API.Stream
|
||||
|
||||
context = %RequestContext{caller: :local}
|
||||
|
||||
{:ok, publish_result} = Events.publish(event, context: context)
|
||||
{:ok, events} = Events.query([%{"kinds" => [1]}], context: context)
|
||||
{:ok, ref} = Stream.subscribe(self(), "local-sub", [%{"kinds" => [1]}], context: context)
|
||||
|
||||
receive do
|
||||
{:parrhesia, :event, ^ref, "local-sub", event} -> event
|
||||
{:parrhesia, :eose, ^ref, "local-sub"} -> :ok
|
||||
end
|
||||
|
||||
:ok = Stream.unsubscribe(ref)
|
||||
```
|
||||
|
||||
## Where to look next
|
||||
|
||||
- [README.md](../README.md) for setup and the full config reference
|
||||
- [docs/SYNC.md](./SYNC.md) for relay-to-relay sync semantics
|
||||
- module docs under `Parrhesia.API.*` for per-function behavior
|
||||
1
docs/nips
Submodule
1
docs/nips
Submodule
Submodule docs/nips added at 3492eb1aff
351
docs/slop/ALPHA_REVIEW.md
Normal file
351
docs/slop/ALPHA_REVIEW.md
Normal file
@@ -0,0 +1,351 @@
|
||||
# Parrhesia Alpha Code Review
|
||||
|
||||
**Reviewer:** Claude Opus 4.6 (automated review)
|
||||
**Date:** 2026-03-20
|
||||
**Version:** 0.6.0
|
||||
**Scope:** Full codebase review across 8 dimensions for alpha-to-beta promotion decision
|
||||
|
||||
---
|
||||
|
||||
## 1. Executive Summary
|
||||
|
||||
Parrhesia is a well-architected Nostr relay with mature OTP supervision design, comprehensive telemetry, and solid protocol implementation covering 15+ NIPs. The codebase demonstrates strong Elixir idioms — heavy ETS usage for hot paths, process monitoring for cleanup, and async-first patterns. The test suite (58 files, ~8K LOC) covers critical protocol paths including signature verification, malformed input rejection, and database integration.
|
||||
|
||||
**Most critical gaps:** No WebSocket-level ping/pong keepalives, no constant-time comparison for NIP-42 challenge validation, and the `effective_filter_limit` function can return `nil` when called outside the standard API path (though the default config sets `max_filter_limit: 500`). Property-based testing is severely underutilised despite `stream_data` being a dependency.
|
||||
|
||||
**Recommendation:** **Promote with conditions** — the codebase is production-quality for beta with two items to address first.
|
||||
|
||||
---
|
||||
|
||||
## 2. Dimension-by-Dimension Findings
|
||||
|
||||
### 2.1 Elixir Code Quality
|
||||
|
||||
**Rating: ✅ Good**
|
||||
|
||||
**Supervision tree:** Single-rooted `Parrhesia.Runtime` supervisor with `:one_for_one` strategy. 12 child supervisors/workers, each with appropriate isolation. Storage, subscriptions, auth, sync, policy, tasks, and web endpoint each have their own supervisor subtree. Restart strategies are correct — no `rest_for_one` or `one_for_all` where unnecessary.
|
||||
|
||||
**GenServer usage:** Idiomatic throughout. State-heavy GenServers (Subscriptions.Index, Auth.Challenges, Negentropy.Sessions) properly monitor owner processes and clean up via `:DOWN` handlers. Stateless dispatchers (Fanout.Dispatcher) use `cast` appropriately. No unnecessary `call` serialisation found.
|
||||
|
||||
**ETS usage:** 9+ ETS tables with appropriate access patterns:
|
||||
- Config cache: `:public`, `read_concurrency: true` — correct for hot-path reads
|
||||
- Rate limiters: `write_concurrency: true` — correct for high-throughput counters
|
||||
- Subscription indices: `:protected`, `read_concurrency: true` — correct (only Index GenServer writes)
|
||||
|
||||
**Error handling:** Consistent `{:ok, _}` / `{:error, _}` tuples throughout the API layer. No bare `throw` found. Connection handler wraps external calls in try/catch to prevent cascade failures. Rate limiter fallback returns `:ok` on service unavailability (availability over correctness — documented trade-off).
|
||||
|
||||
**Pattern matching:** Exhaustive in message handling. Protocol decoder has explicit clauses for each message type with a catch-all error clause. Event validator chains `with` clauses with explicit error atoms.
|
||||
|
||||
**Potential bottlenecks:**
|
||||
- `Subscriptions.Index` is a single GenServer handling all subscription mutations. Reads go through ETS (fast), but `upsert`/`remove` operations serialise through the GenServer. At very high subscription churn (thousands of REQ/CLOSE per second), this could become a bottleneck. Acceptable for beta.
|
||||
- `Negentropy.Sessions` holds all session state in process memory. Capped at 10K sessions with idle sweep — adequate.
|
||||
|
||||
**Module structure:** Clean separation of concerns. `web/` for transport, `protocol/` for parsing/validation, `api/` for business logic, `storage/` for persistence with adapter pattern, `policy/` for authorisation. 99% of modules have `@moduledoc` and `@spec` annotations.
|
||||
|
||||
**Findings:**
|
||||
- `connection.ex` is 1,925 lines — large but cohesive (per-connection state machine). Consider extracting queue management into a submodule in future.
|
||||
- `storage/adapters/postgres/events.ex` is the heaviest module — handles normalisation, queries, and tag indexing. Well-factored internally.
|
||||
|
||||
---
|
||||
|
||||
### 2.2 Nostr Protocol Correctness (NIPs Compliance)
|
||||
|
||||
**Rating: ✅ Good**
|
||||
|
||||
**NIPs implemented (advertised via NIP-11):**
|
||||
NIP-1, NIP-9, NIP-11, NIP-13, NIP-17, NIP-40, NIP-42, NIP-44, NIP-45, NIP-50, NIP-59, NIP-62, NIP-70, NIP-77, NIP-86, NIP-98. Conditional: NIP-43, NIP-66.
|
||||
|
||||
**NIP-01 (Core Protocol):**
|
||||
- Event structure: 7 required fields validated (`id`, `pubkey`, `created_at`, `kind`, `tags`, `content`, `sig`)
|
||||
- Event ID: SHA-256 over canonical JSON serialisation `[0, pubkey, created_at, kind, tags, content]` — verified in `validate_id_hash/1`
|
||||
- Signature: BIP-340 Schnorr via `lib_secp256k1` — `Secp256k1.schnorr_valid?(id_bin, sig_bin, pubkey_bin)`
|
||||
- Filters: `ids`, `authors`, `kinds`, `since`, `until`, `limit`, `search`, `#<letter>` tag filters — all implemented
|
||||
- Messages: EVENT, REQ, CLOSE, NOTICE, OK, EOSE, COUNT, AUTH — all implemented with correct response format
|
||||
- Subscription IDs: validated as non-empty strings, max 64 chars
|
||||
|
||||
**Event ID verification:** Correct. Computes SHA-256 over `JSON.encode!([0, pubkey_hex, created_at, kind, tags, content])` and compares against claimed `id`. Binary decoding verified.
|
||||
|
||||
**Signature verification:** Uses `lib_secp256k1` (wrapper around Bitcoin Core's libsecp256k1). Schnorr verification correct per BIP-340. Can be disabled via feature flag (appropriate for testing/development).
|
||||
|
||||
**Malformed event rejection:** Comprehensive. Invalid hex, wrong byte lengths, future timestamps (>15 min), non-integer kinds, non-string content, non-array tags — all produce specific error atoms returned via OK message with `false` status.
|
||||
|
||||
**Filter application:** Correct implementation. Each dimension (ids, authors, kinds, since, until, tags, search) is an independent predicate; all must match for a filter to match. Multiple filters are OR'd together (`matches_any?`).
|
||||
|
||||
**Spec deviations:**
|
||||
- Tag filter values capped at 128 per filter (configurable) — stricter than spec but reasonable
|
||||
- Max 16 filters per REQ (configurable) — reasonable relay policy
|
||||
- Max 256 tags per event — reasonable relay policy
|
||||
- Search is substring/FTS, not regex — spec doesn't mandate regex
|
||||
|
||||
---
|
||||
|
||||
### 2.3 WebSocket Handling
|
||||
|
||||
**Rating: ⚠️ Needs Work**
|
||||
|
||||
**Backpressure: ✅ Excellent.**
|
||||
Three-tier strategy with configurable overflow behaviour:
|
||||
1. `:close` (default) — closes connection on queue overflow with NOTICE
|
||||
2. `:drop_newest` — silently drops incoming events
|
||||
3. `:drop_oldest` — drops oldest queued event, enqueues new
|
||||
|
||||
Queue depth defaults: max 256, drain batch size 64. Pressure monitoring at 75% threshold emits telemetry. Batch draining prevents thundering herd.
|
||||
|
||||
**Connection cleanup: ✅ Solid.**
|
||||
`terminate/1` removes subscriptions from global index, unsubscribes from streams, clears auth challenges, decrements connection stats. Process monitors in Index/Challenges/Sessions provide backup cleanup on unexpected exits.
|
||||
|
||||
**Message size limits: ✅ Enforced.**
|
||||
- Frame size: 1MB default (`max_frame_bytes`), checked before JSON parsing
|
||||
- Event size: 256KB default (`max_event_bytes`), checked before DB write
|
||||
- Both configurable via environment variables
|
||||
|
||||
**Per-connection subscription limit: ✅ Enforced.**
|
||||
Default 32 subscriptions per connection. Checked before opening new REQ. Returns CLOSED with `rate-limited:` prefix.
|
||||
|
||||
**Ping/pong keepalives: ⚠️ Not implemented (optional).**
|
||||
No server-initiated WebSocket PING frames. RFC 6455 §5.5.2 makes PING optional ("MAY be sent"), and NIP-01 does not require keepalives. Bandit correctly responds to client-initiated PINGs per spec. However, server-side pings are a production best practice for detecting dead connections behind NAT/proxies — without them, the server relies on TCP-level detection which can take minutes.
|
||||
|
||||
**Per-connection event ingest rate limiting: ✅ Implemented.**
|
||||
Default 120 events/second per connection with sliding window. Per-IP limiting at 1,000 events/second. Relay-wide cap at 10,000 events/second.
|
||||
|
||||
---
|
||||
|
||||
### 2.4 PostgreSQL / Database Layer
|
||||
|
||||
**Rating: ✅ Good**
|
||||
|
||||
**Schema design:**
|
||||
- Events table range-partitioned by `created_at` (monthly partitions)
|
||||
- Normalised `event_tags` table with composite FK to events
|
||||
- JSONB `tags` column for efficient serialisation (denormalised copy of normalised tags)
|
||||
- Binary storage for pubkeys/IDs/sigs with CHECK constraints on byte lengths
|
||||
|
||||
**Indexes:** Comprehensive and appropriate:
|
||||
- `events(kind, created_at DESC)` — kind queries
|
||||
- `events(pubkey, created_at DESC)` — author queries
|
||||
- `events(created_at DESC)` — time-range queries
|
||||
- `events(id)` — direct lookup
|
||||
- `events(expires_at) WHERE expires_at IS NOT NULL` — expiration pruning
|
||||
- `event_tags(name, value, event_created_at DESC)` — tag filtering
|
||||
- GIN index on `to_tsvector('simple', content)` — full-text search
|
||||
- GIN trigram index on `content` — fuzzy search
|
||||
|
||||
**Tag queries:** Efficient. Uses `EXISTS (SELECT 1 FROM event_tags ...)` subqueries with parameterised values. Primary tag filter applied first, remaining filters chained. No N+1 — bulk tag insert via `Repo.insert_all`.
|
||||
|
||||
**Connection pools:** Write pool (32 default) and optional separate read pool (32 default). Queue target/interval configured at 1000ms/5000ms. Pool sizing configurable via environment variables.
|
||||
|
||||
**Bounded results:** `max_filter_limit` defaults to 500 in config. Applied at query level via `LIMIT` clause. Post-query `Enum.take` as safety net. The `effective_filter_limit/2` function can return `nil` if both filter and opts lack a limit — but the standard API path always passes `max_filter_limit` from config.
|
||||
|
||||
**Event expiration:** NIP-40 `expiration` tags extracted during normalisation. `ExpirationWorker` runs every 30 seconds, executing `DELETE FROM events WHERE expires_at IS NOT NULL AND expires_at <= now()`. Index on `expires_at` makes this efficient.
|
||||
|
||||
**Partition management:** `PartitionRetentionWorker` ensures partitions exist 2 months ahead, drops oldest partitions based on configurable retention window and max DB size. Limited to 1 drop per run to avoid I/O spikes. DDL operations use `CREATE TABLE IF NOT EXISTS` and validate identifiers against `^[a-zA-Z_][a-zA-Z0-9_]*$` to prevent SQL injection.
|
||||
|
||||
**Migrations:** Non-destructive. No `DROP COLUMN` or lock-heavy operations on existing tables. Additive indexes use `CREATE INDEX IF NOT EXISTS`. JSONB column added with data backfill in separate migration.
|
||||
|
||||
**Findings:**
|
||||
- Multi-filter queries use union + in-memory deduplication rather than SQL `UNION`. For queries with many filters returning large result sets, this could spike memory. Acceptable for beta given the 500-result default limit.
|
||||
- Replaceable/addressable state upserts use raw SQL CTEs — parameterised, no injection risk, but harder to maintain than Ecto queries.
|
||||
|
||||
---
|
||||
|
||||
### 2.5 Security
|
||||
|
||||
**Rating: ⚠️ Needs Work (one item)**
|
||||
|
||||
**Input validation: ✅ Thorough.**
|
||||
12-step validation pipeline for events. Hex decoding with explicit byte lengths. Tag structure validation. Content type checking. All before any DB write.
|
||||
|
||||
**Rate limiting: ✅ Well-designed.**
|
||||
Three tiers: per-connection (120/s), per-IP (1,000/s), relay-wide (10,000/s). ETS-backed with atomic counters. Configurable via environment variables. Telemetry on rate limit hits.
|
||||
|
||||
**SQL injection: ✅ No risks found.**
|
||||
All queries use Ecto parameterisation or `fragment` with positional placeholders. Raw SQL uses `$1, $2, ...` params. Partition identifier creation validates against regex before string interpolation.
|
||||
|
||||
**Amplification protection: ✅ Adequate.**
|
||||
- Giftwrap (kind 1059) queries blocked for unauthenticated users, restricted to recipients for authenticated users
|
||||
- `max_filter_limit: 500` bounds result sets
|
||||
- Frame/event size limits prevent memory exhaustion
|
||||
- Rate limiting prevents query flooding
|
||||
|
||||
**NIP-42 authentication: ⚠️ Minor issue.**
|
||||
Challenge generation uses `:crypto.strong_rand_bytes(16)` — correct. Challenge stored per-connection with process monitor cleanup — correct. However, challenge comparison uses standard Erlang binary equality (`==`), not constant-time comparison. While the 16-byte random challenge makes timing attacks impractical, using `Plug.Crypto.secure_compare/2` would be best practice.
|
||||
|
||||
**NIP-98 HTTP auth: ✅ Solid.**
|
||||
Base64-decoded event validated for kind (27235), freshness (±60s), method binding, URL binding, and signature. Replay cache prevents token reuse within TTL window.
|
||||
|
||||
**Moderation: ✅ Complete.**
|
||||
Banned pubkeys, allowed pubkeys, banned events, blocked IPs. ETS cache with lazy loading from PostgreSQL. ACL rules with principal/capability/match structure. Protected event enforcement (NIP-70).
|
||||
|
||||
---
|
||||
|
||||
### 2.6 Observability & Operability
|
||||
|
||||
**Rating: ✅ Good**
|
||||
|
||||
**Telemetry: ✅ Excellent.**
|
||||
25+ metrics covering ingest (count, duration, outcomes), queries (count, duration, result size), fanout (duration, batch size), connections (queue depth, pressure, overflow), rate limiting (hits by scope), process health (mailbox depth), database (queue time, query time, decode time), maintenance (expiration, partition retention), and VM memory.
|
||||
|
||||
**Prometheus endpoint: ✅ Implemented.**
|
||||
`/metrics` endpoint with access control. Histogram buckets configured for each metric type. Tagged metrics for cardinality management.
|
||||
|
||||
**Health check: ✅ Implemented.**
|
||||
`/ready` endpoint checks Subscriptions.Index, Auth.Challenges, Negentropy.Sessions (if enabled), and all PostgreSQL repos.
|
||||
|
||||
**Configuration: ✅ Fully externalised.**
|
||||
100+ config keys with environment variable overrides in `config/runtime.exs`. Helpers for `int_env`, `bool_env`, `csv_env`, `json_env`, `infinity_or_int_env`, `ipv4_env`. No hardcoded ports, DB URLs, or limits in application code.
|
||||
|
||||
**Documentation: ✅ Strong.**
|
||||
99% of modules have `@moduledoc`. Public APIs have `@spec` annotations. Error types defined as type unions. Architecture docs in `docs/` covering clustering, sync, and local API.
|
||||
|
||||
**Logging: ⚠️ Functional but basic.**
|
||||
Uses standard `Logger.error/warning` with `inspect()` formatting. No structured/JSON logging. Adequate for beta, but not ideal for log aggregation platforms.
|
||||
|
||||
---
|
||||
|
||||
### 2.7 Testing
|
||||
|
||||
**Rating: ✅ Good**
|
||||
|
||||
**Test suite:** 58 test files, ~8,000 lines of code.
|
||||
|
||||
**Unit tests:** Protocol validation, event validator (including signature verification), filter matching, auth challenges, NIP-98 replay cache, connection policy, event policy, config, negentropy engine/message/sessions.
|
||||
|
||||
**Integration tests:** 36 files using PostgreSQL sandbox. Event lifecycle (insert, query, update, delete), adapter contract tests, query plan regression tests, partition management, binary identifier constraints.
|
||||
|
||||
**Protocol edge cases tested:**
|
||||
- Invalid Schnorr signatures (when verification enabled)
|
||||
- Malformed JSON → `:invalid_json`
|
||||
- Invalid event structure → specific error atoms
|
||||
- Unknown filter keys → `:invalid_filter_key`
|
||||
- Tag filter value limits (128 max)
|
||||
- NIP-43 malformed relay access events, stale join requests
|
||||
- Marmot-specific validation (encoding tags, base64 content)
|
||||
- NIP-66 discovery event validation
|
||||
|
||||
**E2E tests:** WebSocket connection tests, TLS E2E, NAK CLI conformance, proxy IP extraction.
|
||||
|
||||
**Load test:** `LoadSoakTest` verifying p95 fanout latency under 25ms.
|
||||
|
||||
**Property-based tests: ⚠️ Minimal.**
|
||||
Single file (`FilterPropertyTest`) using `stream_data` for author filter membership. `stream_data` is a dependency but barely used. Significant opportunity to add property tests for event ID computation, filter boundary conditions, and tag parsing.
|
||||
|
||||
**Missing coverage:**
|
||||
- Cluster failover / multi-node crash recovery
|
||||
- Connection pool exhaustion under load
|
||||
- WebSocket frame fragmentation
|
||||
- Concurrent subscription mutation stress
|
||||
- Byzantine negentropy scenarios
|
||||
|
||||
---
|
||||
|
||||
### 2.8 Dependencies
|
||||
|
||||
**Rating: ✅ Good**
|
||||
|
||||
| Dependency | Version | Status |
|
||||
|---|---|---|
|
||||
| `bandit` | 1.10.3 | Current, actively maintained |
|
||||
| `plug` | 1.19.1 | Current, security-patched |
|
||||
| `ecto_sql` | 3.13.5 | Current |
|
||||
| `postgrex` | 0.22.0 | Current |
|
||||
| `lib_secp256k1` | 0.7.1 | Stable, wraps Bitcoin Core's libsecp256k1 |
|
||||
| `req` | 0.5.17 | Current |
|
||||
| `telemetry_metrics_prometheus` | 1.1.0 | Current |
|
||||
| `websockex` | 0.4.x | Test-only, stable |
|
||||
| `stream_data` | 1.3.0 | Current |
|
||||
| `credo` | 1.7.x | Dev-only, current |
|
||||
|
||||
**Cryptographic library assessment:** `lib_secp256k1` wraps libsecp256k1, the battle-tested C library from Bitcoin Core. Used only for Schnorr signature verification (BIP-340). Appropriate and trustworthy.
|
||||
|
||||
**No outdated or unmaintained dependencies.** No known CVEs in current dependency versions.
|
||||
|
||||
---
|
||||
|
||||
## 3. Top 5 Issues to Fix Before Beta
|
||||
|
||||
### 1. Add WebSocket Ping/Pong Keepalives
|
||||
**Severity:** High
|
||||
**Impact:** Long-lived subscriptions through proxies/NAT silently disconnect; server accumulates dead connections and leaked subscriptions until process monitor triggers (which requires the TCP connection to fully close).
|
||||
**Fix:** Implement periodic WebSocket PING frames (e.g., every 30s) in the connection handler. Close connections that don't respond within a timeout.
|
||||
**Files:** `lib/parrhesia/web/connection.ex`
|
||||
|
||||
### 2. Use Constant-Time Comparison for NIP-42 Challenges
|
||||
**Severity:** Medium (low practical risk due to 16-byte random challenge, but best practice)
|
||||
**Impact:** Theoretical timing side-channel on challenge validation.
|
||||
**Fix:** Replace `challenge == stored_challenge` with `Plug.Crypto.secure_compare(challenge, stored_challenge)` in `Auth.Challenges`.
|
||||
**Files:** `lib/parrhesia/auth/challenges.ex`
|
||||
|
||||
### 3. Expand Property-Based Testing
|
||||
**Severity:** Medium
|
||||
**Impact:** Undiscovered edge cases in event validation, filter matching, and tag parsing. `stream_data` is already a dependency but only used in one test file.
|
||||
**Fix:** Add property tests for: event ID computation with random payloads, filter boundary conditions (since/until edge cases), tag parsing with adversarial input, subscription index correctness under random insert/delete sequences.
|
||||
**Files:** `test/parrhesia/protocol/`
|
||||
|
||||
### 4. Add Structured Logging
|
||||
**Severity:** Low-Medium
|
||||
**Impact:** Log aggregation (ELK, Datadog, Grafana Loki) requires structured output. Current plaintext logs are adequate for development but make production debugging harder at scale.
|
||||
**Fix:** Add JSON log formatter (e.g., `LoggerJSON` or custom formatter). Include connection ID, subscription ID, and event kind as structured fields.
|
||||
**Files:** `config/config.exs`, new formatter module
|
||||
|
||||
### 5. Add Server-Initiated WebSocket PING Frames
|
||||
**Severity:** Low (not spec-required)
|
||||
**Impact:** RFC 6455 §5.5.2 makes PING optional, and NIP-01 does not require keepalives. However, without server-initiated pings, dead connections behind NAT/proxies are only detected via TCP-level timeouts (which can take minutes), during which subscriptions and state remain allocated.
|
||||
**Fix:** Consider periodic PING frames (e.g., every 30s) in the connection handler to proactively detect dead connections.
|
||||
**Files:** `lib/parrhesia/web/connection.ex`
|
||||
|
||||
---
|
||||
|
||||
## 4. Nice-to-Haves for Beta
|
||||
|
||||
1. **Extract queue management** from `connection.ex` (1,925 lines) into a dedicated `Parrhesia.Web.OutboundQueue` module for maintainability.
|
||||
|
||||
2. **Add request correlation IDs** to WebSocket connections for log tracing across the event lifecycle (ingest → validation → storage → fanout).
|
||||
|
||||
3. **SQL UNION for multi-filter queries** instead of in-memory deduplication. Would reduce memory spikes for queries with many filters, though the 500-result limit mitigates this.
|
||||
|
||||
4. **Slow query telemetry** — flag database queries exceeding a configurable threshold (e.g., 100ms) via dedicated telemetry event.
|
||||
|
||||
5. **Connection idle timeout** — close WebSocket connections with no activity for a configurable period (e.g., 30 minutes), independent of ping/pong.
|
||||
|
||||
6. **Per-pubkey rate limiting** — current rate limiting is per-connection and per-IP. A determined attacker could use multiple IPs. Per-pubkey limiting would add a layer but requires NIP-42 auth.
|
||||
|
||||
7. **OpenTelemetry integration** — for distributed tracing across multi-relay deployments.
|
||||
|
||||
8. **Negentropy session memory bounds** — while capped at 10K sessions, large filter sets within sessions could still consume significant memory. Consider per-session size limits.
|
||||
|
||||
---
|
||||
|
||||
## 5. Promotion Recommendation
|
||||
|
||||
### ⚠️ Promote with Conditions
|
||||
|
||||
**The codebase meets beta promotion criteria with one condition:**
|
||||
|
||||
**Condition: Use constant-time comparison for NIP-42 challenge validation.**
|
||||
While the practical risk is low (16-byte random challenge), this is a security best practice that takes one line to fix (`Plug.Crypto.secure_compare/2`).
|
||||
|
||||
**Criteria assessment:**
|
||||
|
||||
| Criterion | Status |
|
||||
|---|---|
|
||||
| NIP-01 correctly and fully implemented | ✅ Yes |
|
||||
| Event signature and ID verification cryptographically correct | ✅ Yes (lib_secp256k1 / BIP-340) |
|
||||
| No ❌ blocking in Security | ✅ No blockers (one minor item) |
|
||||
| No ❌ blocking in WebSocket handling | ✅ No blockers (ping/pong optional per RFC 6455) |
|
||||
| System does not crash or leak resources under normal load | ✅ Process monitors, queue management, rate limiting |
|
||||
| Working test suite covering critical protocol path | ✅ 58 files, 8K LOC, protocol edge cases covered |
|
||||
| Basic operability (config externalised, logs meaningful) | ✅ 100+ config keys, telemetry, Prometheus, health check |
|
||||
|
||||
**What's strong:**
|
||||
- OTP design is production-grade
|
||||
- Protocol implementation is comprehensive and spec-compliant
|
||||
- Security posture is solid (rate limiting, input validation, ACLs, moderation)
|
||||
- Telemetry coverage is excellent
|
||||
- Test suite covers critical paths
|
||||
- Dependencies are current and trustworthy
|
||||
|
||||
**What needs attention post-beta:**
|
||||
- Expand property-based testing
|
||||
- Add structured logging for production observability
|
||||
- Consider per-pubkey rate limiting
|
||||
- Connection handler module size (1,925 lines)
|
||||
File diff suppressed because it is too large
Load Diff
10
flake.nix
10
flake.nix
@@ -2,6 +2,8 @@
|
||||
description = "Parrhesia Nostr relay";
|
||||
|
||||
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||
# Can be reenabled once patched nostr-bench is up on GitHub
|
||||
# inputs.self.submodules = true;
|
||||
|
||||
outputs = {nixpkgs, ...}: let
|
||||
systems = [
|
||||
@@ -18,12 +20,18 @@
|
||||
packages = forAllSystems (
|
||||
system: let
|
||||
pkgs = import nixpkgs {inherit system;};
|
||||
pkgsLinux = import nixpkgs {system = "x86_64-linux";};
|
||||
lib = pkgs.lib;
|
||||
parrhesia = pkgs.callPackage ./default.nix {};
|
||||
nostrBench = pkgs.callPackage ./nix/nostr-bench.nix {};
|
||||
in
|
||||
{
|
||||
default = parrhesia;
|
||||
inherit parrhesia;
|
||||
inherit parrhesia nostrBench;
|
||||
|
||||
# Uses x86_64-linux pkgs so it can cross-build via a remote
|
||||
# builder even when the host is aarch64-darwin.
|
||||
nostrBenchStaticX86_64Musl = pkgsLinux.callPackage ./nix/nostr-bench.nix {staticX86_64Musl = true;};
|
||||
}
|
||||
// lib.optionalAttrs pkgs.stdenv.hostPlatform.isLinux {
|
||||
dockerImage = pkgs.dockerTools.buildLayeredImage {
|
||||
|
||||
79
justfile
Normal file
79
justfile
Normal file
@@ -0,0 +1,79 @@
|
||||
set shell := ["bash", "-euo", "pipefail", "-c"]
|
||||
|
||||
repo_root := justfile_directory()
|
||||
|
||||
# Show curated command help (same as `just help`).
|
||||
default:
|
||||
@just help
|
||||
|
||||
# Show top-level or topic-specific help.
|
||||
help topic="":
|
||||
@cd "{{repo_root}}" && ./scripts/just_help.sh "{{topic}}"
|
||||
|
||||
# Raw e2e harness commands.
|
||||
e2e subcommand *args:
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
cd "{{repo_root}}"
|
||||
subcommand="{{subcommand}}"
|
||||
|
||||
if [[ -z "$subcommand" || "$subcommand" == "help" ]]; then
|
||||
just help e2e
|
||||
elif [[ "$subcommand" == "nak" ]]; then
|
||||
./scripts/run_nak_e2e.sh {{args}}
|
||||
elif [[ "$subcommand" == "marmot" ]]; then
|
||||
./scripts/run_marmot_e2e.sh {{args}}
|
||||
elif [[ "$subcommand" == "node-sync" ]]; then
|
||||
./scripts/run_node_sync_e2e.sh {{args}}
|
||||
elif [[ "$subcommand" == "node-sync-docker" ]]; then
|
||||
./scripts/run_node_sync_docker_e2e.sh {{args}}
|
||||
elif [[ "$subcommand" == "suite" ]]; then
|
||||
if [[ -z "{{args}}" ]]; then
|
||||
echo "usage: just e2e suite <suite-name> <command> [args...]" >&2
|
||||
exit 1
|
||||
fi
|
||||
./scripts/run_e2e_suite.sh {{args}}
|
||||
else
|
||||
echo "Unknown e2e subcommand: $subcommand" >&2
|
||||
just help e2e
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Benchmark flows (local/cloud/history + direct relay targets).
|
||||
bench subcommand *args:
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
cd "{{repo_root}}"
|
||||
subcommand="{{subcommand}}"
|
||||
|
||||
if [[ -z "$subcommand" || "$subcommand" == "help" ]]; then
|
||||
just help bench
|
||||
elif [[ "$subcommand" == "compare" ]]; then
|
||||
./scripts/run_bench_compare.sh {{args}}
|
||||
elif [[ "$subcommand" == "collect" ]]; then
|
||||
./scripts/run_bench_collect.sh {{args}}
|
||||
elif [[ "$subcommand" == "update" ]]; then
|
||||
./scripts/run_bench_update.sh {{args}}
|
||||
elif [[ "$subcommand" == "list" ]]; then
|
||||
./scripts/run_bench_update.sh --list {{args}}
|
||||
elif [[ "$subcommand" == "at" ]]; then
|
||||
if [[ -z "{{args}}" ]]; then
|
||||
echo "usage: just bench at <git-ref>" >&2
|
||||
exit 1
|
||||
fi
|
||||
./scripts/run_bench_at_ref.sh {{args}}
|
||||
elif [[ "$subcommand" == "cloud" ]]; then
|
||||
./scripts/run_bench_cloud.sh {{args}}
|
||||
elif [[ "$subcommand" == "cloud-quick" ]]; then
|
||||
./scripts/run_bench_cloud.sh --quick {{args}}
|
||||
elif [[ "$subcommand" == "relay" ]]; then
|
||||
./scripts/run_nostr_bench.sh {{args}}
|
||||
elif [[ "$subcommand" == "relay-strfry" ]]; then
|
||||
./scripts/run_nostr_bench_strfry.sh {{args}}
|
||||
elif [[ "$subcommand" == "relay-nostr-rs" ]]; then
|
||||
./scripts/run_nostr_bench_nostr_rs_relay.sh {{args}}
|
||||
else
|
||||
echo "Unknown bench subcommand: $subcommand" >&2
|
||||
just help bench
|
||||
exit 1
|
||||
fi
|
||||
@@ -1,17 +1,29 @@
|
||||
defmodule Parrhesia do
|
||||
@moduledoc """
|
||||
Documentation for `Parrhesia`.
|
||||
Parrhesia is a Nostr relay runtime that can run standalone or as an embedded OTP service.
|
||||
|
||||
For embedded use, the main developer-facing surface is `Parrhesia.API.*`.
|
||||
For host-managed HTTP/WebSocket ingress mounting, use `Parrhesia.Plug`.
|
||||
Start with:
|
||||
|
||||
- `Parrhesia.API.Events`
|
||||
- `Parrhesia.API.Stream`
|
||||
- `Parrhesia.API.Admin`
|
||||
- `Parrhesia.API.Identity`
|
||||
- `Parrhesia.API.ACL`
|
||||
- `Parrhesia.API.Sync`
|
||||
- `Parrhesia.Plug`
|
||||
|
||||
The host application is responsible for:
|
||||
|
||||
- setting `config :parrhesia, ...`
|
||||
- migrating the configured Parrhesia repos
|
||||
- deciding whether to expose listeners or use only the in-process API
|
||||
|
||||
See `README.md` and `docs/LOCAL_API.md` for the embedding model and configuration guide.
|
||||
"""
|
||||
|
||||
@doc """
|
||||
Hello world.
|
||||
|
||||
## Examples
|
||||
|
||||
iex> Parrhesia.hello()
|
||||
:world
|
||||
|
||||
"""
|
||||
@doc false
|
||||
def hello do
|
||||
:world
|
||||
end
|
||||
|
||||
@@ -1,12 +1,37 @@
|
||||
defmodule Parrhesia.API.ACL do
|
||||
@moduledoc """
|
||||
Public ACL API and rule matching for protected sync traffic.
|
||||
|
||||
ACL checks are only applied when the requested subject overlaps with
|
||||
`config :parrhesia, :acl, protected_filters: [...]`.
|
||||
|
||||
The intended flow is:
|
||||
|
||||
1. mark a subset of sync traffic as protected with `protected_filters`
|
||||
2. persist pubkey-based grants with `grant/2`
|
||||
3. call `check/3` during sync reads and writes
|
||||
|
||||
Unprotected subjects always return `:ok`.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.RequestContext
|
||||
alias Parrhesia.Protocol.Filter
|
||||
alias Parrhesia.Storage
|
||||
|
||||
@doc """
|
||||
Persists an ACL rule.
|
||||
|
||||
A typical rule looks like:
|
||||
|
||||
```elixir
|
||||
%{
|
||||
principal_type: :pubkey,
|
||||
principal: "...64 hex chars...",
|
||||
capability: :sync_read,
|
||||
match: %{"kinds" => [5000], "#r" => ["tribes.accounts.user"]}
|
||||
}
|
||||
```
|
||||
"""
|
||||
@spec grant(map(), keyword()) :: :ok | {:error, term()}
|
||||
def grant(rule, _opts \\ []) do
|
||||
with {:ok, _stored_rule} <- Storage.acl().put_rule(%{}, normalize_rule(rule)) do
|
||||
@@ -14,16 +39,39 @@ defmodule Parrhesia.API.ACL do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Deletes ACL rules matching the given selector.
|
||||
|
||||
The selector is passed through to the configured storage adapter, which typically accepts an
|
||||
id-based selector such as `%{id: rule_id}`.
|
||||
"""
|
||||
@spec revoke(map(), keyword()) :: :ok | {:error, term()}
|
||||
def revoke(rule, _opts \\ []) do
|
||||
Storage.acl().delete_rule(%{}, normalize_delete_selector(rule))
|
||||
end
|
||||
|
||||
@doc """
|
||||
Lists persisted ACL rules.
|
||||
|
||||
Supported filters are:
|
||||
|
||||
- `:principal_type`
|
||||
- `:principal`
|
||||
- `:capability`
|
||||
"""
|
||||
@spec list(keyword()) :: {:ok, [map()]} | {:error, term()}
|
||||
def list(opts \\ []) do
|
||||
Storage.acl().list_rules(%{}, normalize_list_opts(opts))
|
||||
end
|
||||
|
||||
@doc """
|
||||
Authorizes a protected sync read or write subject for the given request context.
|
||||
|
||||
Supported capabilities are `:sync_read` and `:sync_write`.
|
||||
|
||||
`opts[:context]` defaults to an empty `Parrhesia.API.RequestContext`, which means protected
|
||||
subjects will fail with `{:error, :auth_required}` until authenticated pubkeys are present.
|
||||
"""
|
||||
@spec check(atom(), map(), keyword()) :: :ok | {:error, term()}
|
||||
def check(capability, subject, opts \\ [])
|
||||
|
||||
@@ -44,6 +92,9 @@ defmodule Parrhesia.API.ACL do
|
||||
|
||||
def check(_capability, _subject, _opts), do: {:error, :invalid_acl_capability}
|
||||
|
||||
@doc """
|
||||
Returns `true` when a filter overlaps the configured protected read surface.
|
||||
"""
|
||||
@spec protected_read?(map()) :: boolean()
|
||||
def protected_read?(filter) when is_map(filter) do
|
||||
case protected_filters() do
|
||||
@@ -57,6 +108,9 @@ defmodule Parrhesia.API.ACL do
|
||||
|
||||
def protected_read?(_filter), do: false
|
||||
|
||||
@doc """
|
||||
Returns `true` when an event matches the configured protected write surface.
|
||||
"""
|
||||
@spec protected_write?(map()) :: boolean()
|
||||
def protected_write?(event) when is_map(event) do
|
||||
case protected_filters() do
|
||||
|
||||
@@ -1,6 +1,14 @@
|
||||
defmodule Parrhesia.API.Admin do
|
||||
@moduledoc """
|
||||
Public management API facade.
|
||||
|
||||
This module exposes the DX-friendly control plane for administrative tasks. It wraps
|
||||
storage-backed management methods and a set of built-in helpers for ACL, identity, sync,
|
||||
and listener management.
|
||||
|
||||
`execute/3` accepts the same method names used by NIP-86 style management endpoints, while
|
||||
the dedicated functions (`stats/1`, `health/1`, `list_audit_logs/1`) are easier to call
|
||||
from Elixir code.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.ACL
|
||||
@@ -26,6 +34,22 @@ defmodule Parrhesia.API.Admin do
|
||||
sync_sync_now
|
||||
)
|
||||
|
||||
@doc """
|
||||
Executes a management method by name.
|
||||
|
||||
Built-in methods include:
|
||||
|
||||
- `supportedmethods`
|
||||
- `stats`
|
||||
- `health`
|
||||
- `list_audit_logs`
|
||||
- `acl_grant`, `acl_revoke`, `acl_list`
|
||||
- `identity_get`, `identity_ensure`, `identity_import`, `identity_rotate`
|
||||
- `listener_reload`
|
||||
- `sync_*`
|
||||
|
||||
Unknown methods are delegated to the configured `Parrhesia.Storage.Admin` implementation.
|
||||
"""
|
||||
@spec execute(String.t() | atom(), map(), keyword()) :: {:ok, map()} | {:error, term()}
|
||||
def execute(method, params, opts \\ [])
|
||||
|
||||
@@ -41,6 +65,9 @@ defmodule Parrhesia.API.Admin do
|
||||
def execute(method, _params, _opts),
|
||||
do: {:error, {:unsupported_method, normalize_method_name(method)}}
|
||||
|
||||
@doc """
|
||||
Returns aggregate relay stats plus nested sync stats.
|
||||
"""
|
||||
@spec stats(keyword()) :: {:ok, map()} | {:error, term()}
|
||||
def stats(opts \\ []) do
|
||||
with {:ok, relay_stats} <- relay_stats(),
|
||||
@@ -49,6 +76,12 @@ defmodule Parrhesia.API.Admin do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Returns the overall management health payload.
|
||||
|
||||
The top-level `"status"` is currently derived from sync health, while relay-specific health
|
||||
details remain delegated to storage-backed management methods.
|
||||
"""
|
||||
@spec health(keyword()) :: {:ok, map()} | {:error, term()}
|
||||
def health(opts \\ []) do
|
||||
with {:ok, sync_health} <- Sync.sync_health(opts) do
|
||||
@@ -60,6 +93,12 @@ defmodule Parrhesia.API.Admin do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Lists persisted audit log entries from the configured admin storage backend.
|
||||
|
||||
Supported options are storage-adapter specific. The built-in admin execution path forwards
|
||||
`:limit`, `:method`, and `:actor_pubkey`.
|
||||
"""
|
||||
@spec list_audit_logs(keyword()) :: {:ok, [map()]} | {:error, term()}
|
||||
def list_audit_logs(opts \\ []) do
|
||||
Storage.admin().list_audit_logs(%{}, opts)
|
||||
|
||||
@@ -1,6 +1,15 @@
|
||||
defmodule Parrhesia.API.Auth do
|
||||
@moduledoc """
|
||||
Shared auth and event validation helpers.
|
||||
Public helpers for event validation and NIP-98 HTTP authentication.
|
||||
|
||||
This module is intended for callers that need a programmatic API surface:
|
||||
|
||||
- `validate_event/1` returns validator reason atoms.
|
||||
- `compute_event_id/1` computes the canonical Nostr event id.
|
||||
- `validate_nip98/3` and `validate_nip98/4` turn an `Authorization` header into a
|
||||
shared auth context that can be reused by the rest of the API surface.
|
||||
|
||||
For transport-facing validation messages, see `Parrhesia.Protocol.validate_event/1`.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.Auth.Context
|
||||
@@ -8,18 +17,46 @@ defmodule Parrhesia.API.Auth do
|
||||
alias Parrhesia.Auth.Nip98
|
||||
alias Parrhesia.Protocol.EventValidator
|
||||
|
||||
@doc """
|
||||
Validates a Nostr event and returns validator-friendly error atoms.
|
||||
|
||||
This is the low-level validation entrypoint used by the API surface. Unlike
|
||||
`Parrhesia.Protocol.validate_event/1`, it preserves the raw validator reason so callers
|
||||
can branch on it directly.
|
||||
"""
|
||||
@spec validate_event(map()) :: :ok | {:error, term()}
|
||||
def validate_event(event), do: EventValidator.validate(event)
|
||||
|
||||
@doc """
|
||||
Computes the canonical Nostr event id for an event payload.
|
||||
|
||||
The event does not need to be persisted first. This is useful when building or signing
|
||||
events locally.
|
||||
"""
|
||||
@spec compute_event_id(map()) :: String.t()
|
||||
def compute_event_id(event), do: EventValidator.compute_id(event)
|
||||
|
||||
@doc """
|
||||
Validates a NIP-98 `Authorization` header using default options.
|
||||
"""
|
||||
@spec validate_nip98(String.t() | nil, String.t(), String.t()) ::
|
||||
{:ok, Context.t()} | {:error, term()}
|
||||
def validate_nip98(authorization, method, url) do
|
||||
validate_nip98(authorization, method, url, [])
|
||||
end
|
||||
|
||||
@doc """
|
||||
Validates a NIP-98 `Authorization` header and returns a shared auth context.
|
||||
|
||||
The returned `Parrhesia.API.Auth.Context` includes:
|
||||
|
||||
- the decoded auth event
|
||||
- the authenticated pubkey
|
||||
- a `Parrhesia.API.RequestContext` with `caller: :http`
|
||||
|
||||
Supported options are forwarded to `Parrhesia.Auth.Nip98.validate_authorization_header/4`,
|
||||
including `:max_age_seconds` and `:replay_cache`.
|
||||
"""
|
||||
@spec validate_nip98(String.t() | nil, String.t(), String.t(), keyword()) ::
|
||||
{:ok, Context.t()} | {:error, term()}
|
||||
def validate_nip98(authorization, method, url, opts)
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
defmodule Parrhesia.API.Auth.Context do
|
||||
@moduledoc """
|
||||
Authenticated request details returned by shared auth helpers.
|
||||
|
||||
This is the higher-level result returned by `Parrhesia.API.Auth.validate_nip98/3` and
|
||||
`validate_nip98/4`. The nested `request_context` is ready to be passed into the rest of the
|
||||
public API surface.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.RequestContext
|
||||
|
||||
@@ -1,17 +1,28 @@
|
||||
defmodule Parrhesia.API.Events do
|
||||
@moduledoc """
|
||||
Canonical event publish, query, and count API.
|
||||
|
||||
This is the main in-process API for working with Nostr events. It applies the same core
|
||||
validation and policy checks used by the relay edge, but without going through a socket or
|
||||
HTTP transport.
|
||||
|
||||
All public functions expect `opts[:context]` to contain a `Parrhesia.API.RequestContext`.
|
||||
That context drives authorization, caller attribution, and downstream policy behavior.
|
||||
|
||||
`publish/2` intentionally returns `{:ok, %PublishResult{accepted: false}}` for policy and
|
||||
storage rejections so callers can mirror relay `OK` semantics without treating a rejected
|
||||
event as a process error.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.Events.PublishResult
|
||||
alias Parrhesia.API.RequestContext
|
||||
alias Parrhesia.Fanout.Dispatcher
|
||||
alias Parrhesia.Fanout.MultiNode
|
||||
alias Parrhesia.Groups.Flow
|
||||
alias Parrhesia.NIP43
|
||||
alias Parrhesia.Policy.EventPolicy
|
||||
alias Parrhesia.Protocol
|
||||
alias Parrhesia.Protocol.Filter
|
||||
alias Parrhesia.Storage
|
||||
alias Parrhesia.Subscriptions.Index
|
||||
alias Parrhesia.Telemetry
|
||||
|
||||
@default_max_event_bytes 262_144
|
||||
@@ -29,27 +40,54 @@ defmodule Parrhesia.API.Events do
|
||||
449
|
||||
])
|
||||
|
||||
@doc """
|
||||
Validates, authorizes, persists, and fans out an event.
|
||||
|
||||
Required options:
|
||||
|
||||
- `:context` - a `Parrhesia.API.RequestContext`
|
||||
|
||||
Supported options:
|
||||
|
||||
- `:max_event_bytes` - overrides the configured max encoded event size
|
||||
- `:path`, `:private_key`, `:configured_private_key` - forwarded to the NIP-43 helper flow
|
||||
|
||||
Return semantics:
|
||||
|
||||
- `{:ok, %PublishResult{accepted: true}}` for accepted events
|
||||
- `{:ok, %PublishResult{accepted: false}}` for rejected or duplicate events
|
||||
- `{:error, :invalid_context}` only when the call itself is malformed
|
||||
"""
|
||||
@spec publish(map(), keyword()) :: {:ok, PublishResult.t()} | {:error, term()}
|
||||
def publish(event, opts \\ [])
|
||||
|
||||
def publish(event, opts) when is_map(event) and is_list(opts) do
|
||||
started_at = System.monotonic_time()
|
||||
event_id = Map.get(event, "id", "")
|
||||
telemetry_metadata = telemetry_metadata_for_event(event)
|
||||
|
||||
with {:ok, context} <- fetch_context(opts),
|
||||
:ok <- validate_event_payload_size(event, max_event_bytes(opts)),
|
||||
:ok <- Protocol.validate_event(event),
|
||||
:ok <- EventPolicy.authorize_write(event, context.authenticated_pubkeys, context),
|
||||
:ok <- maybe_process_group_event(event),
|
||||
{:ok, publish_state} <- NIP43.prepare_publish(event, nip43_opts(opts, context)),
|
||||
{:ok, _stored, message} <- persist_event(event) do
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :ingest, :stop],
|
||||
%{duration: System.monotonic_time() - started_at},
|
||||
telemetry_metadata_for_event(event)
|
||||
telemetry_metadata
|
||||
)
|
||||
|
||||
fanout_event(event)
|
||||
maybe_publish_multi_node(event)
|
||||
emit_ingest_result(telemetry_metadata, :accepted, :accepted)
|
||||
|
||||
message =
|
||||
case NIP43.finalize_publish(event, publish_state, nip43_opts(opts, context)) do
|
||||
{:ok, override} when is_binary(override) -> override
|
||||
:ok -> message
|
||||
end
|
||||
|
||||
Dispatcher.dispatch(event)
|
||||
maybe_publish_multi_node(event, context)
|
||||
|
||||
{:ok,
|
||||
%PublishResult{
|
||||
@@ -60,9 +98,12 @@ defmodule Parrhesia.API.Events do
|
||||
}}
|
||||
else
|
||||
{:error, :invalid_context} = error ->
|
||||
emit_ingest_result(telemetry_metadata, :rejected, :invalid_context)
|
||||
error
|
||||
|
||||
{:error, reason} ->
|
||||
emit_ingest_result(telemetry_metadata, :rejected, reason)
|
||||
|
||||
{:ok,
|
||||
%PublishResult{
|
||||
event_id: event_id,
|
||||
@@ -75,47 +116,96 @@ defmodule Parrhesia.API.Events do
|
||||
|
||||
def publish(_event, _opts), do: {:error, :invalid_event}
|
||||
|
||||
@doc """
|
||||
Queries stored events plus any dynamic NIP-43 events visible to the caller.
|
||||
|
||||
Required options:
|
||||
|
||||
- `:context` - a `Parrhesia.API.RequestContext`
|
||||
|
||||
Supported options:
|
||||
|
||||
- `:max_filter_limit` - overrides the configured per-filter limit
|
||||
- `:validate_filters?` - skips filter validation when `false`
|
||||
- `:authorize_read?` - skips read policy checks when `false`
|
||||
|
||||
The skip flags are primarily for internal composition, such as `Parrhesia.API.Stream`.
|
||||
External callers should normally leave them enabled.
|
||||
"""
|
||||
@spec query([map()], keyword()) :: {:ok, [map()]} | {:error, term()}
|
||||
def query(filters, opts \\ [])
|
||||
|
||||
def query(filters, opts) when is_list(filters) and is_list(opts) do
|
||||
started_at = System.monotonic_time()
|
||||
telemetry_metadata = telemetry_metadata_for_filters(filters, :query)
|
||||
|
||||
with {:ok, context} <- fetch_context(opts),
|
||||
:ok <- maybe_validate_filters(filters, opts),
|
||||
:ok <- maybe_authorize_read(filters, context, opts),
|
||||
{:ok, events} <- Storage.events().query(%{}, filters, storage_query_opts(context, opts)) do
|
||||
events = NIP43.dynamic_events(filters, nip43_opts(opts, context)) ++ events
|
||||
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :query, :stop],
|
||||
%{duration: System.monotonic_time() - started_at},
|
||||
telemetry_metadata_for_filters(filters)
|
||||
%{duration: System.monotonic_time() - started_at, result_count: length(events)},
|
||||
telemetry_metadata
|
||||
)
|
||||
|
||||
emit_query_result(telemetry_metadata, :ok)
|
||||
|
||||
{:ok, events}
|
||||
else
|
||||
{:error, reason} = error ->
|
||||
emit_query_result(telemetry_metadata, :error, reason)
|
||||
error
|
||||
end
|
||||
end
|
||||
|
||||
def query(_filters, _opts), do: {:error, :invalid_filters}
|
||||
|
||||
@doc """
|
||||
Counts events matching the given filters.
|
||||
|
||||
Required options:
|
||||
|
||||
- `:context` - a `Parrhesia.API.RequestContext`
|
||||
|
||||
Supported options:
|
||||
|
||||
- `:validate_filters?` - skips filter validation when `false`
|
||||
- `:authorize_read?` - skips read policy checks when `false`
|
||||
- `:options` - when set to a map, returns a NIP-45-style payload instead of a bare integer
|
||||
|
||||
When `opts[:options]` is a map, the result shape is `%{"count" => count, "approximate" => false}`.
|
||||
If `opts[:options]["hll"]` is `true` and the feature is enabled, an `"hll"` field is included.
|
||||
"""
|
||||
@spec count([map()], keyword()) :: {:ok, non_neg_integer() | map()} | {:error, term()}
|
||||
def count(filters, opts \\ [])
|
||||
|
||||
def count(filters, opts) when is_list(filters) and is_list(opts) do
|
||||
started_at = System.monotonic_time()
|
||||
telemetry_metadata = telemetry_metadata_for_filters(filters, :count)
|
||||
|
||||
with {:ok, context} <- fetch_context(opts),
|
||||
:ok <- maybe_validate_filters(filters, opts),
|
||||
:ok <- maybe_authorize_read(filters, context, opts),
|
||||
{:ok, count} <-
|
||||
Storage.events().count(%{}, filters, requester_pubkeys: requester_pubkeys(context)),
|
||||
count <- count + NIP43.dynamic_count(filters, nip43_opts(opts, context)),
|
||||
{:ok, result} <- maybe_build_count_result(filters, count, Keyword.get(opts, :options)) do
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :query, :stop],
|
||||
%{duration: System.monotonic_time() - started_at},
|
||||
telemetry_metadata_for_filters(filters)
|
||||
%{duration: System.monotonic_time() - started_at, result_count: count},
|
||||
telemetry_metadata
|
||||
)
|
||||
|
||||
emit_query_result(telemetry_metadata, :ok)
|
||||
|
||||
{:ok, result}
|
||||
else
|
||||
{:error, reason} = error ->
|
||||
emit_query_result(telemetry_metadata, :error, reason)
|
||||
error
|
||||
end
|
||||
end
|
||||
|
||||
@@ -184,14 +274,6 @@ defmodule Parrhesia.API.Events do
|
||||
|> Base.encode64()
|
||||
end
|
||||
|
||||
defp maybe_process_group_event(event) do
|
||||
if Flow.group_related_kind?(Map.get(event, "kind")) do
|
||||
Flow.handle_event(event)
|
||||
else
|
||||
:ok
|
||||
end
|
||||
end
|
||||
|
||||
defp persist_event(event) do
|
||||
kind = Map.get(event, "kind")
|
||||
|
||||
@@ -230,33 +312,25 @@ defmodule Parrhesia.API.Events do
|
||||
end
|
||||
end
|
||||
|
||||
defp fanout_event(event) do
|
||||
case Index.candidate_subscription_keys(event) do
|
||||
candidates when is_list(candidates) ->
|
||||
Enum.each(candidates, fn {owner_pid, subscription_id} ->
|
||||
send(owner_pid, {:fanout_event, subscription_id, event})
|
||||
end)
|
||||
defp maybe_publish_multi_node(event, %RequestContext{} = context) do
|
||||
relay_guard? = Parrhesia.Config.get([:sync, :relay_guard], false)
|
||||
|
||||
_other ->
|
||||
:ok
|
||||
if relay_guard? and context.caller == :sync do
|
||||
:ok
|
||||
else
|
||||
MultiNode.publish(event)
|
||||
:ok
|
||||
end
|
||||
catch
|
||||
:exit, _reason -> :ok
|
||||
end
|
||||
|
||||
defp maybe_publish_multi_node(event) do
|
||||
MultiNode.publish(event)
|
||||
:ok
|
||||
catch
|
||||
:exit, _reason -> :ok
|
||||
end
|
||||
|
||||
defp telemetry_metadata_for_event(event) do
|
||||
%{traffic_class: traffic_class_for_event(event)}
|
||||
end
|
||||
|
||||
defp telemetry_metadata_for_filters(filters) do
|
||||
%{traffic_class: traffic_class_for_filters(filters)}
|
||||
defp telemetry_metadata_for_filters(filters, operation) do
|
||||
%{traffic_class: traffic_class_for_filters(filters), operation: operation}
|
||||
end
|
||||
|
||||
defp traffic_class_for_filters(filters) do
|
||||
@@ -289,6 +363,30 @@ defmodule Parrhesia.API.Events do
|
||||
|
||||
defp traffic_class_for_event(_event), do: :generic
|
||||
|
||||
defp emit_ingest_result(metadata, outcome, reason) do
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :ingest, :result],
|
||||
%{count: 1},
|
||||
Map.merge(metadata, %{outcome: outcome, reason: normalize_reason(reason)})
|
||||
)
|
||||
end
|
||||
|
||||
defp emit_query_result(metadata, outcome, reason \\ nil) do
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :query, :result],
|
||||
%{count: 1},
|
||||
Map.merge(
|
||||
metadata,
|
||||
%{outcome: outcome, reason: normalize_reason(reason || outcome)}
|
||||
)
|
||||
)
|
||||
end
|
||||
|
||||
defp normalize_reason(reason) when is_atom(reason), do: reason
|
||||
defp normalize_reason(reason) when is_binary(reason), do: reason
|
||||
defp normalize_reason(nil), do: :none
|
||||
defp normalize_reason(_reason), do: :unknown
|
||||
|
||||
defp fetch_context(opts) do
|
||||
case Keyword.get(opts, :context) do
|
||||
%RequestContext{} = context -> {:ok, context}
|
||||
@@ -296,6 +394,11 @@ defmodule Parrhesia.API.Events do
|
||||
end
|
||||
end
|
||||
|
||||
defp nip43_opts(opts, %RequestContext{} = context) do
|
||||
[context: context, relay_url: Application.get_env(:parrhesia, :relay_url)]
|
||||
|> Kernel.++(Keyword.take(opts, [:path, :private_key, :configured_private_key]))
|
||||
end
|
||||
|
||||
defp error_message_for_publish_failure(:duplicate_event),
|
||||
do: "duplicate: event already stored"
|
||||
|
||||
|
||||
@@ -1,6 +1,14 @@
|
||||
defmodule Parrhesia.API.Events.PublishResult do
|
||||
@moduledoc """
|
||||
Result shape for event publish attempts.
|
||||
|
||||
This mirrors relay `OK` semantics:
|
||||
|
||||
- `accepted: true` means the event was accepted
|
||||
- `accepted: false` means the event was rejected or identified as a duplicate
|
||||
|
||||
The surrounding call still returns `{:ok, result}` in both cases so callers can surface the
|
||||
rejection message without treating it as a transport or process failure.
|
||||
"""
|
||||
|
||||
defstruct [:event_id, :accepted, :message, :reason]
|
||||
|
||||
@@ -1,15 +1,40 @@
|
||||
defmodule Parrhesia.API.Identity do
|
||||
@moduledoc """
|
||||
Server-auth identity management.
|
||||
|
||||
Parrhesia uses a single server identity for flows that need the relay to sign events or
|
||||
prove control of a pubkey.
|
||||
|
||||
Identity resolution follows this order:
|
||||
|
||||
1. `opts[:private_key]` or `opts[:configured_private_key]`
|
||||
2. `Application.get_env(:parrhesia, :identity)`
|
||||
3. the persisted file on disk
|
||||
|
||||
Supported options across this module:
|
||||
|
||||
- `:path` - overrides the identity file path
|
||||
- `:private_key` / `:configured_private_key` - uses an explicit hex secret key
|
||||
|
||||
A configured private key is treated as read-only input and therefore cannot be rotated.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.Auth
|
||||
|
||||
@typedoc """
|
||||
Public identity metadata returned to callers.
|
||||
"""
|
||||
@type identity_metadata :: %{
|
||||
pubkey: String.t(),
|
||||
source: :configured | :persisted | :generated | :imported
|
||||
}
|
||||
|
||||
@doc """
|
||||
Returns the current server identity metadata.
|
||||
|
||||
This does not generate a new identity. If no configured or persisted identity exists, it
|
||||
returns `{:error, :identity_not_found}`.
|
||||
"""
|
||||
@spec get(keyword()) :: {:ok, identity_metadata()} | {:error, term()}
|
||||
def get(opts \\ []) do
|
||||
with {:ok, identity} <- fetch_existing_identity(opts) do
|
||||
@@ -17,6 +42,9 @@ defmodule Parrhesia.API.Identity do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Returns the current identity, generating and persisting one when necessary.
|
||||
"""
|
||||
@spec ensure(keyword()) :: {:ok, identity_metadata()} | {:error, term()}
|
||||
def ensure(opts \\ []) do
|
||||
with {:ok, identity} <- ensure_identity(opts) do
|
||||
@@ -24,6 +52,12 @@ defmodule Parrhesia.API.Identity do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Imports an explicit secret key and persists it as the server identity.
|
||||
|
||||
The input map must contain `:secret_key` or `"secret_key"` as a 64-character lowercase or
|
||||
uppercase hex string.
|
||||
"""
|
||||
@spec import(map(), keyword()) :: {:ok, identity_metadata()} | {:error, term()}
|
||||
def import(identity, opts \\ [])
|
||||
|
||||
@@ -37,6 +71,12 @@ defmodule Parrhesia.API.Identity do
|
||||
|
||||
def import(_identity, _opts), do: {:error, :invalid_identity}
|
||||
|
||||
@doc """
|
||||
Generates and persists a fresh server identity.
|
||||
|
||||
Rotation is rejected with `{:error, :configured_identity_cannot_rotate}` when the active
|
||||
identity comes from configuration rather than the persisted file.
|
||||
"""
|
||||
@spec rotate(keyword()) :: {:ok, identity_metadata()} | {:error, term()}
|
||||
def rotate(opts \\ []) do
|
||||
with :ok <- ensure_rotation_allowed(opts),
|
||||
@@ -46,6 +86,18 @@ defmodule Parrhesia.API.Identity do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Signs an event with the current server identity.
|
||||
|
||||
The incoming event must already include the fields required to compute a Nostr id:
|
||||
|
||||
- `"created_at"`
|
||||
- `"kind"`
|
||||
- `"tags"`
|
||||
- `"content"`
|
||||
|
||||
On success the returned event includes `"pubkey"`, `"id"`, and `"sig"`.
|
||||
"""
|
||||
@spec sign_event(map(), keyword()) :: {:ok, map()} | {:error, term()}
|
||||
def sign_event(event, opts \\ [])
|
||||
|
||||
@@ -59,6 +111,9 @@ defmodule Parrhesia.API.Identity do
|
||||
|
||||
def sign_event(_event, _opts), do: {:error, :invalid_event}
|
||||
|
||||
@doc """
|
||||
Returns the default filesystem path for the persisted server identity.
|
||||
"""
|
||||
def default_path do
|
||||
Path.join([default_data_dir(), "server_identity.json"])
|
||||
end
|
||||
|
||||
@@ -1,6 +1,15 @@
|
||||
defmodule Parrhesia.API.RequestContext do
|
||||
@moduledoc """
|
||||
Shared request context used across API and policy surfaces.
|
||||
|
||||
This struct carries caller identity and transport metadata through authorization and storage
|
||||
boundaries.
|
||||
|
||||
The most important field for external callers is `authenticated_pubkeys`. For example:
|
||||
|
||||
- `Parrhesia.API.Events` uses it for read and write policy checks
|
||||
- `Parrhesia.API.Stream` uses it for subscription authorization
|
||||
- `Parrhesia.API.ACL` uses it when evaluating protected sync traffic
|
||||
"""
|
||||
|
||||
defstruct authenticated_pubkeys: MapSet.new(),
|
||||
@@ -23,6 +32,11 @@ defmodule Parrhesia.API.RequestContext do
|
||||
metadata: map()
|
||||
}
|
||||
|
||||
@doc """
|
||||
Merges arbitrary metadata into the context.
|
||||
|
||||
Existing keys are overwritten by the incoming map.
|
||||
"""
|
||||
@spec put_metadata(t(), map()) :: t()
|
||||
def put_metadata(%__MODULE__{} = context, metadata) when is_map(metadata) do
|
||||
%__MODULE__{context | metadata: Map.merge(context.metadata, metadata)}
|
||||
|
||||
@@ -1,6 +1,15 @@
|
||||
defmodule Parrhesia.API.Stream do
|
||||
@moduledoc """
|
||||
In-process subscription API with relay-equivalent catch-up and live fanout semantics.
|
||||
|
||||
Subscriptions are process-local bridges. After subscribing, the caller receives messages in
|
||||
the same order a relay client would expect:
|
||||
|
||||
- `{:parrhesia, :event, ref, subscription_id, event}` for catch-up and live events
|
||||
- `{:parrhesia, :eose, ref, subscription_id}` after the initial replay finishes
|
||||
|
||||
This API requires a `Parrhesia.API.RequestContext` so read policies are applied exactly as
|
||||
they would be for a transport-backed subscriber.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.Events
|
||||
@@ -9,6 +18,16 @@ defmodule Parrhesia.API.Stream do
|
||||
alias Parrhesia.Policy.EventPolicy
|
||||
alias Parrhesia.Protocol.Filter
|
||||
|
||||
@doc """
|
||||
Starts an in-process subscription for a subscriber pid.
|
||||
|
||||
`opts[:context]` must be a `Parrhesia.API.RequestContext`.
|
||||
|
||||
On success the returned reference is both:
|
||||
|
||||
- the subscription handle used by `unsubscribe/1`
|
||||
- the value embedded in emitted subscriber messages
|
||||
"""
|
||||
@spec subscribe(pid(), String.t(), [map()], keyword()) :: {:ok, reference()} | {:error, term()}
|
||||
def subscribe(subscriber, subscription_id, filters, opts \\ [])
|
||||
|
||||
@@ -42,6 +61,11 @@ defmodule Parrhesia.API.Stream do
|
||||
def subscribe(_subscriber, _subscription_id, _filters, _opts),
|
||||
do: {:error, :invalid_subscription}
|
||||
|
||||
@doc """
|
||||
Stops a subscription previously created with `subscribe/4`.
|
||||
|
||||
This function is idempotent. Unknown or already-stopped references return `:ok`.
|
||||
"""
|
||||
@spec unsubscribe(reference()) :: :ok
|
||||
def unsubscribe(ref) when is_reference(ref) do
|
||||
case Registry.lookup(Parrhesia.API.Stream.Registry, ref) do
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
defmodule Parrhesia.API.Stream.Subscription do
|
||||
@moduledoc false
|
||||
|
||||
use GenServer
|
||||
use GenServer, restart: :temporary
|
||||
|
||||
alias Parrhesia.Protocol.Filter
|
||||
alias Parrhesia.Subscriptions.Index
|
||||
alias Parrhesia.Telemetry
|
||||
|
||||
defstruct [
|
||||
:ref,
|
||||
@@ -57,6 +58,7 @@ defmodule Parrhesia.API.Stream.Subscription do
|
||||
buffered_events: []
|
||||
}
|
||||
|
||||
Telemetry.emit_process_mailbox_depth(:subscription)
|
||||
{:ok, state}
|
||||
else
|
||||
{:error, reason} -> {:stop, reason}
|
||||
@@ -72,20 +74,27 @@ defmodule Parrhesia.API.Stream.Subscription do
|
||||
end)
|
||||
|
||||
{:reply, :ok, %__MODULE__{state | ready?: true, buffered_events: []}}
|
||||
|> emit_mailbox_depth()
|
||||
end
|
||||
|
||||
@impl true
|
||||
def handle_info({:fanout_event, subscription_id, event}, %__MODULE__{} = state)
|
||||
when is_binary(subscription_id) and is_map(event) do
|
||||
handle_fanout_event(state, subscription_id, event)
|
||||
state
|
||||
|> handle_fanout_event(subscription_id, event)
|
||||
|> emit_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_info({:DOWN, monitor_ref, :process, subscriber, _reason}, %__MODULE__{} = state)
|
||||
when monitor_ref == state.subscriber_monitor_ref and subscriber == state.subscriber do
|
||||
{:stop, :normal, state}
|
||||
|> emit_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_info(_message, %__MODULE__{} = state), do: {:noreply, state}
|
||||
def handle_info(_message, %__MODULE__{} = state) do
|
||||
{:noreply, state}
|
||||
|> emit_mailbox_depth()
|
||||
end
|
||||
|
||||
@impl true
|
||||
def terminate(reason, %__MODULE__{} = state) do
|
||||
@@ -175,4 +184,9 @@ defmodule Parrhesia.API.Stream.Subscription do
|
||||
{:noreply, %__MODULE__{state | buffered_events: buffered_events}}
|
||||
end
|
||||
end
|
||||
|
||||
defp emit_mailbox_depth(result) do
|
||||
Telemetry.emit_process_mailbox_depth(:subscription)
|
||||
result
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,12 +1,45 @@
|
||||
defmodule Parrhesia.API.Sync do
|
||||
@moduledoc """
|
||||
Sync server control-plane API.
|
||||
|
||||
This module manages outbound relay sync definitions and exposes runtime status for each
|
||||
configured sync worker.
|
||||
|
||||
The main entrypoint is `put_server/2`. Accepted server maps are normalized into a stable
|
||||
internal shape and persisted by the sync manager. The expected input shape is:
|
||||
|
||||
```elixir
|
||||
%{
|
||||
"id" => "tribes-primary",
|
||||
"url" => "wss://relay-a.example/relay",
|
||||
"enabled?" => true,
|
||||
"auth_pubkey" => "...64 hex chars...",
|
||||
"filters" => [%{"kinds" => [5000]}],
|
||||
"mode" => "req_stream",
|
||||
"overlap_window_seconds" => 300,
|
||||
"auth" => %{"type" => "nip42"},
|
||||
"tls" => %{
|
||||
"mode" => "required",
|
||||
"hostname" => "relay-a.example",
|
||||
"pins" => [%{"type" => "spki_sha256", "value" => "..."}]
|
||||
},
|
||||
"metadata" => %{}
|
||||
}
|
||||
```
|
||||
|
||||
Most functions accept `:manager` or `:name` in `opts` to target a non-default manager.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.Sync.Manager
|
||||
|
||||
@typedoc """
|
||||
Normalized sync server configuration returned by the sync manager.
|
||||
"""
|
||||
@type server :: map()
|
||||
|
||||
@doc """
|
||||
Creates or replaces a sync server definition.
|
||||
"""
|
||||
@spec put_server(map(), keyword()) :: {:ok, server()} | {:error, term()}
|
||||
def put_server(server, opts \\ [])
|
||||
|
||||
@@ -16,6 +49,9 @@ defmodule Parrhesia.API.Sync do
|
||||
|
||||
def put_server(_server, _opts), do: {:error, :invalid_server}
|
||||
|
||||
@doc """
|
||||
Removes a stored sync server definition and stops its worker if it is running.
|
||||
"""
|
||||
@spec remove_server(String.t(), keyword()) :: :ok | {:error, term()}
|
||||
def remove_server(server_id, opts \\ [])
|
||||
|
||||
@@ -25,6 +61,11 @@ defmodule Parrhesia.API.Sync do
|
||||
|
||||
def remove_server(_server_id, _opts), do: {:error, :invalid_server_id}
|
||||
|
||||
@doc """
|
||||
Fetches a single normalized sync server definition.
|
||||
|
||||
Returns `:error` when the server id is unknown.
|
||||
"""
|
||||
@spec get_server(String.t(), keyword()) :: {:ok, server()} | :error | {:error, term()}
|
||||
def get_server(server_id, opts \\ [])
|
||||
|
||||
@@ -34,11 +75,17 @@ defmodule Parrhesia.API.Sync do
|
||||
|
||||
def get_server(_server_id, _opts), do: {:error, :invalid_server_id}
|
||||
|
||||
@doc """
|
||||
Lists all configured sync servers, including their runtime state.
|
||||
"""
|
||||
@spec list_servers(keyword()) :: {:ok, [server()]} | {:error, term()}
|
||||
def list_servers(opts \\ []) when is_list(opts) do
|
||||
Manager.list_servers(manager_name(opts))
|
||||
end
|
||||
|
||||
@doc """
|
||||
Marks a sync server as running and reconciles its worker state.
|
||||
"""
|
||||
@spec start_server(String.t(), keyword()) :: :ok | {:error, term()}
|
||||
def start_server(server_id, opts \\ [])
|
||||
|
||||
@@ -48,6 +95,9 @@ defmodule Parrhesia.API.Sync do
|
||||
|
||||
def start_server(_server_id, _opts), do: {:error, :invalid_server_id}
|
||||
|
||||
@doc """
|
||||
Stops a sync server and records a disconnect timestamp in runtime state.
|
||||
"""
|
||||
@spec stop_server(String.t(), keyword()) :: :ok | {:error, term()}
|
||||
def stop_server(server_id, opts \\ [])
|
||||
|
||||
@@ -57,6 +107,9 @@ defmodule Parrhesia.API.Sync do
|
||||
|
||||
def stop_server(_server_id, _opts), do: {:error, :invalid_server_id}
|
||||
|
||||
@doc """
|
||||
Triggers an immediate sync run for a server.
|
||||
"""
|
||||
@spec sync_now(String.t(), keyword()) :: :ok | {:error, term()}
|
||||
def sync_now(server_id, opts \\ [])
|
||||
|
||||
@@ -66,6 +119,11 @@ defmodule Parrhesia.API.Sync do
|
||||
|
||||
def sync_now(_server_id, _opts), do: {:error, :invalid_server_id}
|
||||
|
||||
@doc """
|
||||
Returns runtime counters and timestamps for a single sync server.
|
||||
|
||||
Returns `:error` when the server id is unknown.
|
||||
"""
|
||||
@spec server_stats(String.t(), keyword()) :: {:ok, map()} | :error | {:error, term()}
|
||||
def server_stats(server_id, opts \\ [])
|
||||
|
||||
@@ -75,16 +133,25 @@ defmodule Parrhesia.API.Sync do
|
||||
|
||||
def server_stats(_server_id, _opts), do: {:error, :invalid_server_id}
|
||||
|
||||
@doc """
|
||||
Returns aggregate counters across all configured sync servers.
|
||||
"""
|
||||
@spec sync_stats(keyword()) :: {:ok, map()} | {:error, term()}
|
||||
def sync_stats(opts \\ []) when is_list(opts) do
|
||||
Manager.sync_stats(manager_name(opts))
|
||||
end
|
||||
|
||||
@doc """
|
||||
Returns a health summary for the sync subsystem.
|
||||
"""
|
||||
@spec sync_health(keyword()) :: {:ok, map()} | {:error, term()}
|
||||
def sync_health(opts \\ []) when is_list(opts) do
|
||||
Manager.sync_health(manager_name(opts))
|
||||
end
|
||||
|
||||
@doc """
|
||||
Returns the default filesystem path for persisted sync server state.
|
||||
"""
|
||||
def default_path do
|
||||
Path.join([default_data_dir(), "sync_servers.json"])
|
||||
end
|
||||
|
||||
@@ -74,6 +74,7 @@ defmodule Parrhesia.API.Sync.Manager do
|
||||
{:ok, normalized_server} ->
|
||||
updated_state =
|
||||
state
|
||||
|> stop_worker_if_running(normalized_server.id)
|
||||
|> put_server_state(normalized_server)
|
||||
|> persist_and_reconcile!(normalized_server.id)
|
||||
|
||||
@@ -248,9 +249,7 @@ defmodule Parrhesia.API.Sync.Manager do
|
||||
state
|
||||
|
||||
desired_running?(state, server_id) ->
|
||||
state
|
||||
|> stop_worker_if_running(server_id)
|
||||
|> maybe_start_worker(server_id)
|
||||
maybe_start_worker(state, server_id)
|
||||
|
||||
true ->
|
||||
stop_worker_if_running(state, server_id)
|
||||
|
||||
@@ -5,19 +5,6 @@ defmodule Parrhesia.Application do
|
||||
|
||||
@impl true
|
||||
def start(_type, _args) do
|
||||
children = [
|
||||
Parrhesia.Telemetry,
|
||||
Parrhesia.Config,
|
||||
Parrhesia.Storage.Supervisor,
|
||||
Parrhesia.Subscriptions.Supervisor,
|
||||
Parrhesia.Auth.Supervisor,
|
||||
Parrhesia.Sync.Supervisor,
|
||||
Parrhesia.Policy.Supervisor,
|
||||
Parrhesia.Web.Endpoint,
|
||||
Parrhesia.Tasks.Supervisor
|
||||
]
|
||||
|
||||
opts = [strategy: :one_for_one, name: Parrhesia.Supervisor]
|
||||
Supervisor.start_link(children, opts)
|
||||
Parrhesia.Runtime.start_link(name: Parrhesia.Supervisor)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -67,7 +67,16 @@ defmodule Parrhesia.Auth.Challenges do
|
||||
end
|
||||
|
||||
def handle_call({:valid?, owner_pid, challenge}, _from, state) do
|
||||
{:reply, Map.get(state.entries, owner_pid) == challenge, state}
|
||||
valid? =
|
||||
case Map.get(state.entries, owner_pid) do
|
||||
stored_challenge when is_binary(stored_challenge) ->
|
||||
Plug.Crypto.secure_compare(stored_challenge, challenge)
|
||||
|
||||
_other ->
|
||||
false
|
||||
end
|
||||
|
||||
{:reply, valid?, state}
|
||||
end
|
||||
|
||||
def handle_call({:clear, owner_pid}, _from, state) do
|
||||
|
||||
@@ -3,6 +3,7 @@ defmodule Parrhesia.Auth.Nip98 do
|
||||
Minimal NIP-98 HTTP auth validation.
|
||||
"""
|
||||
|
||||
alias Parrhesia.Auth.Nip98ReplayCache
|
||||
alias Parrhesia.Protocol.EventValidator
|
||||
|
||||
@max_age_seconds 60
|
||||
@@ -23,7 +24,8 @@ defmodule Parrhesia.Auth.Nip98 do
|
||||
with {:ok, event_json} <- decode_base64(encoded_event),
|
||||
{:ok, event} <- JSON.decode(event_json),
|
||||
:ok <- validate_event_shape(event, opts),
|
||||
:ok <- validate_http_binding(event, method, url) do
|
||||
:ok <- validate_http_binding(event, method, url),
|
||||
:ok <- consume_replay_token(event, opts) do
|
||||
{:ok, event}
|
||||
else
|
||||
{:error, reason} -> {:error, reason}
|
||||
@@ -95,4 +97,14 @@ defmodule Parrhesia.Auth.Nip98 do
|
||||
true -> :ok
|
||||
end
|
||||
end
|
||||
|
||||
defp consume_replay_token(%{"id" => event_id, "created_at" => created_at}, opts)
|
||||
when is_binary(event_id) and is_integer(created_at) do
|
||||
case Keyword.get(opts, :replay_cache, Nip98ReplayCache) do
|
||||
nil -> :ok
|
||||
replay_cache -> Nip98ReplayCache.consume(replay_cache, event_id, created_at, opts)
|
||||
end
|
||||
end
|
||||
|
||||
defp consume_replay_token(_event, _opts), do: {:error, :invalid_event}
|
||||
end
|
||||
|
||||
56
lib/parrhesia/auth/nip98_replay_cache.ex
Normal file
56
lib/parrhesia/auth/nip98_replay_cache.ex
Normal file
@@ -0,0 +1,56 @@
|
||||
defmodule Parrhesia.Auth.Nip98ReplayCache do
|
||||
@moduledoc """
|
||||
Tracks recently accepted NIP-98 auth event ids to prevent replay.
|
||||
"""
|
||||
|
||||
use GenServer
|
||||
|
||||
@default_max_age_seconds 60
|
||||
|
||||
@spec start_link(keyword()) :: GenServer.on_start()
|
||||
def start_link(opts \\ []) do
|
||||
case Keyword.get(opts, :name, __MODULE__) do
|
||||
nil -> GenServer.start_link(__MODULE__, opts)
|
||||
name -> GenServer.start_link(__MODULE__, opts, name: name)
|
||||
end
|
||||
end
|
||||
|
||||
@spec consume(GenServer.server(), String.t(), integer(), keyword()) ::
|
||||
:ok | {:error, :replayed_auth_event}
|
||||
def consume(server \\ __MODULE__, event_id, created_at, opts \\ [])
|
||||
when is_binary(event_id) and is_integer(created_at) and is_list(opts) do
|
||||
GenServer.call(server, {:consume, event_id, created_at, opts})
|
||||
end
|
||||
|
||||
@impl true
|
||||
def init(_opts) do
|
||||
{:ok, %{entries: %{}}}
|
||||
end
|
||||
|
||||
@impl true
|
||||
def handle_call({:consume, event_id, created_at, opts}, _from, state) do
|
||||
now_ms = System.monotonic_time(:millisecond)
|
||||
entries = prune_expired(state.entries, now_ms)
|
||||
|
||||
case Map.has_key?(entries, event_id) do
|
||||
true ->
|
||||
{:reply, {:error, :replayed_auth_event}, %{state | entries: entries}}
|
||||
|
||||
false ->
|
||||
expires_at_ms = replay_expiration_ms(now_ms, created_at, opts)
|
||||
next_entries = Map.put(entries, event_id, expires_at_ms)
|
||||
{:reply, :ok, %{state | entries: next_entries}}
|
||||
end
|
||||
end
|
||||
|
||||
defp prune_expired(entries, now_ms) do
|
||||
Map.reject(entries, fn {_event_id, expires_at_ms} -> expires_at_ms <= now_ms end)
|
||||
end
|
||||
|
||||
defp replay_expiration_ms(now_ms, created_at, opts) do
|
||||
max_age_seconds = Keyword.get(opts, :max_age_seconds, max_age_seconds())
|
||||
max(now_ms, created_at * 1000) + max_age_seconds * 1000
|
||||
end
|
||||
|
||||
defp max_age_seconds, do: @default_max_age_seconds
|
||||
end
|
||||
@@ -13,6 +13,7 @@ defmodule Parrhesia.Auth.Supervisor do
|
||||
def init(_init_arg) do
|
||||
children = [
|
||||
{Parrhesia.Auth.Challenges, name: Parrhesia.Auth.Challenges},
|
||||
{Parrhesia.Auth.Nip98ReplayCache, name: Parrhesia.Auth.Nip98ReplayCache},
|
||||
{Parrhesia.API.Identity.Manager, []}
|
||||
]
|
||||
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
defmodule Parrhesia.Config do
|
||||
@moduledoc """
|
||||
Runtime configuration cache backed by ETS.
|
||||
|
||||
The application environment is copied into ETS at startup so hot-path reads do not need to
|
||||
traverse the application environment repeatedly.
|
||||
"""
|
||||
|
||||
use GenServer
|
||||
@@ -8,6 +11,9 @@ defmodule Parrhesia.Config do
|
||||
@table __MODULE__
|
||||
@root_key :config
|
||||
|
||||
@doc """
|
||||
Starts the config cache server.
|
||||
"""
|
||||
def start_link(init_arg \\ []) do
|
||||
GenServer.start_link(__MODULE__, init_arg, name: __MODULE__)
|
||||
end
|
||||
@@ -26,6 +32,9 @@ defmodule Parrhesia.Config do
|
||||
{:ok, %{}}
|
||||
end
|
||||
|
||||
@doc """
|
||||
Returns the cached top-level Parrhesia application config.
|
||||
"""
|
||||
@spec all() :: map() | keyword()
|
||||
def all do
|
||||
case :ets.lookup(@table, @root_key) do
|
||||
@@ -34,6 +43,11 @@ defmodule Parrhesia.Config do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Reads a nested config value by path.
|
||||
|
||||
The path may traverse maps or keyword lists. Missing paths return `default`.
|
||||
"""
|
||||
@spec get([atom()], term()) :: term()
|
||||
def get(path, default \\ nil) when is_list(path) do
|
||||
case fetch(path) do
|
||||
|
||||
89
lib/parrhesia/connection_stats.ex
Normal file
89
lib/parrhesia/connection_stats.ex
Normal file
@@ -0,0 +1,89 @@
|
||||
defmodule Parrhesia.ConnectionStats do
|
||||
@moduledoc """
|
||||
Per-listener connection and subscription counters.
|
||||
|
||||
Tracks active connection and subscription counts per listener and emits
|
||||
`[:parrhesia, :listener, :population]` telemetry events on each change.
|
||||
"""
|
||||
|
||||
use GenServer
|
||||
|
||||
alias Parrhesia.Telemetry
|
||||
|
||||
defstruct connections: %{}, subscriptions: %{}
|
||||
|
||||
@type state :: %__MODULE__{
|
||||
connections: %{(atom() | String.t()) => non_neg_integer()},
|
||||
subscriptions: %{(atom() | String.t()) => non_neg_integer()}
|
||||
}
|
||||
|
||||
@spec start_link(keyword()) :: GenServer.on_start()
|
||||
def start_link(opts \\ []) do
|
||||
name = Keyword.get(opts, :name, __MODULE__)
|
||||
GenServer.start_link(__MODULE__, %__MODULE__{}, name: name)
|
||||
end
|
||||
|
||||
@spec connection_open(atom() | String.t()) :: :ok
|
||||
def connection_open(listener_id), do: cast({:connection_open, listener_id})
|
||||
|
||||
@spec connection_close(atom() | String.t()) :: :ok
|
||||
def connection_close(listener_id), do: cast({:connection_close, listener_id})
|
||||
|
||||
@spec subscriptions_change(atom() | String.t(), integer()) :: :ok
|
||||
def subscriptions_change(listener_id, delta) when is_integer(delta) do
|
||||
cast({:subscriptions_change, listener_id, delta})
|
||||
end
|
||||
|
||||
@impl true
|
||||
def init(%__MODULE__{} = state), do: {:ok, state}
|
||||
|
||||
@impl true
|
||||
def handle_cast({:connection_open, listener_id}, %__MODULE__{} = state) do
|
||||
listener_id = normalize_listener_id(listener_id)
|
||||
next_state = %{state | connections: increment(state.connections, listener_id, 1)}
|
||||
emit_population(listener_id, next_state)
|
||||
{:noreply, next_state}
|
||||
end
|
||||
|
||||
def handle_cast({:connection_close, listener_id}, %__MODULE__{} = state) do
|
||||
listener_id = normalize_listener_id(listener_id)
|
||||
next_state = %{state | connections: increment(state.connections, listener_id, -1)}
|
||||
emit_population(listener_id, next_state)
|
||||
{:noreply, next_state}
|
||||
end
|
||||
|
||||
def handle_cast({:subscriptions_change, listener_id, delta}, %__MODULE__{} = state) do
|
||||
listener_id = normalize_listener_id(listener_id)
|
||||
next_state = %{state | subscriptions: increment(state.subscriptions, listener_id, delta)}
|
||||
emit_population(listener_id, next_state)
|
||||
{:noreply, next_state}
|
||||
end
|
||||
|
||||
defp cast(message) do
|
||||
GenServer.cast(__MODULE__, message)
|
||||
:ok
|
||||
catch
|
||||
:exit, {:noproc, _details} -> :ok
|
||||
:exit, {:normal, _details} -> :ok
|
||||
end
|
||||
|
||||
defp increment(counts, key, delta) do
|
||||
current = Map.get(counts, key, 0)
|
||||
Map.put(counts, key, max(current + delta, 0))
|
||||
end
|
||||
|
||||
defp emit_population(listener_id, %__MODULE__{} = state) do
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :listener, :population],
|
||||
%{
|
||||
connections: Map.get(state.connections, listener_id, 0),
|
||||
subscriptions: Map.get(state.subscriptions, listener_id, 0)
|
||||
},
|
||||
%{listener_id: listener_id}
|
||||
)
|
||||
end
|
||||
|
||||
defp normalize_listener_id(listener_id) when is_atom(listener_id), do: listener_id
|
||||
defp normalize_listener_id(listener_id) when is_binary(listener_id), do: listener_id
|
||||
defp normalize_listener_id(_listener_id), do: :unknown
|
||||
end
|
||||
46
lib/parrhesia/fanout/dispatcher.ex
Normal file
46
lib/parrhesia/fanout/dispatcher.ex
Normal file
@@ -0,0 +1,46 @@
|
||||
defmodule Parrhesia.Fanout.Dispatcher do
|
||||
@moduledoc """
|
||||
Asynchronous local fanout dispatcher.
|
||||
"""
|
||||
|
||||
use GenServer
|
||||
|
||||
alias Parrhesia.Subscriptions.Index
|
||||
|
||||
@spec start_link(keyword()) :: GenServer.on_start()
|
||||
def start_link(opts \\ []) do
|
||||
name = Keyword.get(opts, :name, __MODULE__)
|
||||
GenServer.start_link(__MODULE__, :ok, name: name)
|
||||
end
|
||||
|
||||
@spec dispatch(map()) :: :ok
|
||||
def dispatch(event), do: dispatch(__MODULE__, event)
|
||||
|
||||
@spec dispatch(GenServer.server(), map()) :: :ok
|
||||
def dispatch(server, event) when is_map(event) do
|
||||
GenServer.cast(server, {:dispatch, event})
|
||||
end
|
||||
|
||||
@impl true
|
||||
def init(:ok), do: {:ok, %{}}
|
||||
|
||||
@impl true
|
||||
def handle_cast({:dispatch, event}, state) do
|
||||
dispatch_to_candidates(event)
|
||||
{:noreply, state}
|
||||
end
|
||||
|
||||
defp dispatch_to_candidates(event) do
|
||||
case Index.candidate_subscription_keys(event) do
|
||||
candidates when is_list(candidates) ->
|
||||
Enum.each(candidates, fn {owner_pid, subscription_id} ->
|
||||
send(owner_pid, {:fanout_event, subscription_id, event})
|
||||
end)
|
||||
|
||||
_other ->
|
||||
:ok
|
||||
end
|
||||
catch
|
||||
:exit, _reason -> :ok
|
||||
end
|
||||
end
|
||||
@@ -5,7 +5,7 @@ defmodule Parrhesia.Fanout.MultiNode do
|
||||
|
||||
use GenServer
|
||||
|
||||
alias Parrhesia.Subscriptions.Index
|
||||
alias Parrhesia.Fanout.Dispatcher
|
||||
|
||||
@group __MODULE__
|
||||
|
||||
@@ -44,11 +44,7 @@ defmodule Parrhesia.Fanout.MultiNode do
|
||||
|
||||
@impl true
|
||||
def handle_info({:remote_fanout_event, event}, state) do
|
||||
Index.candidate_subscription_keys(event)
|
||||
|> Enum.each(fn {owner_pid, subscription_id} ->
|
||||
send(owner_pid, {:fanout_event, subscription_id, event})
|
||||
end)
|
||||
|
||||
Dispatcher.dispatch(event)
|
||||
{:noreply, state}
|
||||
end
|
||||
|
||||
|
||||
@@ -1,52 +1,62 @@
|
||||
defmodule Parrhesia.Groups.Flow do
|
||||
@moduledoc """
|
||||
Minimal group and membership flow handling for NIP-29/NIP-43 related kinds.
|
||||
Relay access membership projection backed by the shared group storage adapter.
|
||||
"""
|
||||
|
||||
alias Parrhesia.Storage
|
||||
|
||||
@membership_request_kind 8_000
|
||||
@membership_approval_kind 8_001
|
||||
@relay_metadata_kind 28_934
|
||||
@relay_admins_kind 28_935
|
||||
@relay_rules_kind 28_936
|
||||
@membership_event_kind 13_534
|
||||
@relay_access_group_id "__relay_access__"
|
||||
@add_user_kind 8_000
|
||||
@remove_user_kind 8_001
|
||||
@join_request_kind 28_934
|
||||
@invite_request_kind 28_935
|
||||
@leave_request_kind 28_936
|
||||
@membership_list_kind 13_534
|
||||
|
||||
@spec handle_event(map()) :: :ok | {:error, term()}
|
||||
def handle_event(event) when is_map(event) do
|
||||
case Map.get(event, "kind") do
|
||||
@membership_request_kind -> upsert_membership(event, "requested")
|
||||
@membership_approval_kind -> upsert_membership(event, "member")
|
||||
@membership_event_kind -> upsert_membership(event, "member")
|
||||
@relay_metadata_kind -> :ok
|
||||
@relay_admins_kind -> :ok
|
||||
@relay_rules_kind -> :ok
|
||||
@join_request_kind -> put_member(event, membership_pubkey_from_event(event))
|
||||
@leave_request_kind -> delete_member(event, membership_pubkey_from_event(event))
|
||||
@add_user_kind -> put_member(event, tagged_pubkey(event, "p"))
|
||||
@remove_user_kind -> delete_member(event, tagged_pubkey(event, "p"))
|
||||
@membership_list_kind -> replace_membership_snapshot(event)
|
||||
@invite_request_kind -> :ok
|
||||
_other -> :ok
|
||||
end
|
||||
end
|
||||
|
||||
@spec group_related_kind?(non_neg_integer()) :: boolean()
|
||||
def group_related_kind?(kind)
|
||||
@spec relay_access_kind?(non_neg_integer()) :: boolean()
|
||||
def relay_access_kind?(kind)
|
||||
when kind in [
|
||||
@membership_request_kind,
|
||||
@membership_approval_kind,
|
||||
@relay_metadata_kind,
|
||||
@relay_admins_kind,
|
||||
@relay_rules_kind,
|
||||
@membership_event_kind
|
||||
@add_user_kind,
|
||||
@remove_user_kind,
|
||||
@join_request_kind,
|
||||
@invite_request_kind,
|
||||
@leave_request_kind,
|
||||
@membership_list_kind
|
||||
],
|
||||
do: true
|
||||
|
||||
def group_related_kind?(_kind), do: false
|
||||
def relay_access_kind?(_kind), do: false
|
||||
|
||||
defp upsert_membership(event, role) do
|
||||
with {:ok, group_id} <- group_id_from_event(event),
|
||||
{:ok, pubkey} <- pubkey_from_event(event) do
|
||||
@spec get_membership(binary()) :: {:ok, map() | nil} | {:error, term()}
|
||||
def get_membership(pubkey) when is_binary(pubkey) do
|
||||
Storage.groups().get_membership(%{}, @relay_access_group_id, pubkey)
|
||||
end
|
||||
|
||||
@spec list_memberships() :: {:ok, [map()]} | {:error, term()}
|
||||
def list_memberships do
|
||||
Storage.groups().list_memberships(%{}, @relay_access_group_id)
|
||||
end
|
||||
|
||||
defp put_member(event, {:ok, pubkey}) do
|
||||
with {:ok, metadata} <- membership_metadata(event) do
|
||||
Storage.groups().put_membership(%{}, %{
|
||||
group_id: group_id,
|
||||
group_id: @relay_access_group_id,
|
||||
pubkey: pubkey,
|
||||
role: role,
|
||||
metadata: %{"source_kind" => Map.get(event, "kind")}
|
||||
role: "member",
|
||||
metadata: metadata
|
||||
})
|
||||
|> case do
|
||||
{:ok, _membership} -> :ok
|
||||
@@ -55,21 +65,85 @@ defmodule Parrhesia.Groups.Flow do
|
||||
end
|
||||
end
|
||||
|
||||
defp group_id_from_event(event) do
|
||||
group_id =
|
||||
event
|
||||
|> Map.get("tags", [])
|
||||
|> Enum.find_value(fn
|
||||
["h", value | _rest] when is_binary(value) and value != "" -> value
|
||||
_tag -> nil
|
||||
end)
|
||||
defp put_member(_event, {:error, reason}), do: {:error, reason}
|
||||
|
||||
case group_id do
|
||||
nil -> {:error, :missing_group_id}
|
||||
value -> {:ok, value}
|
||||
defp delete_member(_event, {:ok, pubkey}) do
|
||||
Storage.groups().delete_membership(%{}, @relay_access_group_id, pubkey)
|
||||
end
|
||||
|
||||
defp delete_member(_event, {:error, reason}), do: {:error, reason}
|
||||
|
||||
defp replace_membership_snapshot(event) do
|
||||
with {:ok, tagged_members} <- tagged_pubkeys(event, "member"),
|
||||
{:ok, existing_memberships} <- list_memberships() do
|
||||
incoming_pubkeys = MapSet.new(tagged_members)
|
||||
existing_pubkeys = MapSet.new(Enum.map(existing_memberships, & &1.pubkey))
|
||||
|
||||
remove_members =
|
||||
existing_pubkeys
|
||||
|> MapSet.difference(incoming_pubkeys)
|
||||
|> MapSet.to_list()
|
||||
|
||||
add_members =
|
||||
incoming_pubkeys
|
||||
|> MapSet.to_list()
|
||||
|
||||
:ok = remove_memberships(remove_members)
|
||||
add_memberships(event, add_members)
|
||||
else
|
||||
{:error, reason} -> {:error, reason}
|
||||
end
|
||||
end
|
||||
|
||||
defp pubkey_from_event(%{"pubkey" => pubkey}) when is_binary(pubkey), do: {:ok, pubkey}
|
||||
defp pubkey_from_event(_event), do: {:error, :missing_pubkey}
|
||||
defp membership_pubkey_from_event(%{"pubkey" => pubkey}) when is_binary(pubkey),
|
||||
do: {:ok, pubkey}
|
||||
|
||||
defp membership_pubkey_from_event(_event), do: {:error, :missing_pubkey}
|
||||
|
||||
defp tagged_pubkey(event, tag_name) do
|
||||
event
|
||||
|> tagged_pubkeys(tag_name)
|
||||
|> case do
|
||||
{:ok, [pubkey]} -> {:ok, pubkey}
|
||||
{:ok, []} -> {:error, :missing_pubkey}
|
||||
{:ok, _pubkeys} -> {:error, :invalid_pubkey}
|
||||
end
|
||||
end
|
||||
|
||||
defp tagged_pubkeys(event, tag_name) do
|
||||
pubkeys =
|
||||
event
|
||||
|> Map.get("tags", [])
|
||||
|> Enum.flat_map(fn
|
||||
[^tag_name, pubkey | _rest] when is_binary(pubkey) and pubkey != "" -> [pubkey]
|
||||
_tag -> []
|
||||
end)
|
||||
|
||||
{:ok, Enum.uniq(pubkeys)}
|
||||
end
|
||||
|
||||
defp membership_metadata(event) do
|
||||
{:ok,
|
||||
%{
|
||||
"source_kind" => Map.get(event, "kind"),
|
||||
"source_event_id" => Map.get(event, "id")
|
||||
}}
|
||||
end
|
||||
|
||||
defp remove_memberships(pubkeys) when is_list(pubkeys) do
|
||||
Enum.each(pubkeys, fn pubkey ->
|
||||
:ok = Storage.groups().delete_membership(%{}, @relay_access_group_id, pubkey)
|
||||
end)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
defp add_memberships(event, pubkeys) when is_list(pubkeys) do
|
||||
Enum.reduce_while(pubkeys, :ok, fn pubkey, :ok ->
|
||||
case put_member(event, {:ok, pubkey}) do
|
||||
:ok -> {:cont, :ok}
|
||||
{:error, _reason} = error -> {:halt, error}
|
||||
end
|
||||
end)
|
||||
end
|
||||
end
|
||||
|
||||
48
lib/parrhesia/http.ex
Normal file
48
lib/parrhesia/http.ex
Normal file
@@ -0,0 +1,48 @@
|
||||
defmodule Parrhesia.HTTP do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.Metadata
|
||||
|
||||
@default_headers [{"user-agent", Metadata.user_agent()}]
|
||||
|
||||
@spec default_headers() :: [{String.t(), String.t()}]
|
||||
def default_headers, do: @default_headers
|
||||
|
||||
@spec get(Keyword.t()) :: {:ok, Req.Response.t()} | {:error, Exception.t()}
|
||||
def get(options) when is_list(options) do
|
||||
Req.get(put_default_headers(options))
|
||||
end
|
||||
|
||||
@spec post(Keyword.t()) :: {:ok, Req.Response.t()} | {:error, Exception.t()}
|
||||
def post(options) when is_list(options) do
|
||||
Req.post(put_default_headers(options))
|
||||
end
|
||||
|
||||
@spec put_default_headers(Keyword.t()) :: Keyword.t()
|
||||
def put_default_headers(options) when is_list(options) do
|
||||
Keyword.update(options, :headers, @default_headers, &merge_headers(&1, @default_headers))
|
||||
end
|
||||
|
||||
defp merge_headers(headers, defaults) do
|
||||
existing_names =
|
||||
headers
|
||||
|> List.wrap()
|
||||
|> Enum.reduce(MapSet.new(), fn
|
||||
{name, _value}, acc -> MapSet.put(acc, normalize_header_name(name))
|
||||
_other, acc -> acc
|
||||
end)
|
||||
|
||||
headers ++
|
||||
Enum.reject(defaults, fn {name, _value} ->
|
||||
MapSet.member?(existing_names, normalize_header_name(name))
|
||||
end)
|
||||
end
|
||||
|
||||
defp normalize_header_name(name) when is_atom(name) do
|
||||
name
|
||||
|> Atom.to_string()
|
||||
|> String.downcase()
|
||||
end
|
||||
|
||||
defp normalize_header_name(name) when is_binary(name), do: String.downcase(name)
|
||||
end
|
||||
29
lib/parrhesia/metadata.ex
Normal file
29
lib/parrhesia/metadata.ex
Normal file
@@ -0,0 +1,29 @@
|
||||
defmodule Parrhesia.Metadata do
|
||||
@moduledoc false
|
||||
|
||||
@metadata Application.compile_env(:parrhesia, :metadata, [])
|
||||
@name Keyword.get(@metadata, :name, "Parrhesia")
|
||||
@version Keyword.get(@metadata, :version, "0.0.0")
|
||||
@hide_version? Keyword.get(@metadata, :hide_version?, true)
|
||||
|
||||
@spec name() :: String.t()
|
||||
def name, do: @name
|
||||
|
||||
@spec version() :: String.t()
|
||||
def version, do: @version
|
||||
|
||||
@spec hide_version?() :: boolean()
|
||||
def hide_version?, do: @hide_version?
|
||||
|
||||
@spec name_and_version() :: String.t()
|
||||
def name_and_version, do: "#{@name}/#{@version}"
|
||||
|
||||
@spec user_agent() :: String.t()
|
||||
def user_agent do
|
||||
if hide_version?() do
|
||||
name()
|
||||
else
|
||||
name_and_version()
|
||||
end
|
||||
end
|
||||
end
|
||||
389
lib/parrhesia/nip43.ex
Normal file
389
lib/parrhesia/nip43.ex
Normal file
@@ -0,0 +1,389 @@
|
||||
defmodule Parrhesia.NIP43 do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.API.Events
|
||||
alias Parrhesia.API.Identity
|
||||
alias Parrhesia.API.RequestContext
|
||||
alias Parrhesia.Groups.Flow
|
||||
alias Parrhesia.Protocol
|
||||
alias Parrhesia.Protocol.Filter
|
||||
|
||||
@join_request_kind 28_934
|
||||
@invite_request_kind 28_935
|
||||
@leave_request_kind 28_936
|
||||
@add_user_kind 8_000
|
||||
@remove_user_kind 8_001
|
||||
@membership_list_kind 13_534
|
||||
@claim_token_kind 31_943
|
||||
@default_invite_ttl_seconds 900
|
||||
|
||||
@type publish_state ::
|
||||
:ok
|
||||
| %{action: :join, duplicate?: boolean(), message: String.t()}
|
||||
| %{action: :leave, duplicate?: boolean(), message: String.t()}
|
||||
|
||||
@spec enabled?(keyword()) :: boolean()
|
||||
def enabled?(opts \\ []) do
|
||||
config(opts)
|
||||
|> Keyword.get(:enabled, true)
|
||||
|> Kernel.==(true)
|
||||
end
|
||||
|
||||
@spec prepare_publish(map(), keyword()) :: {:ok, publish_state()} | {:error, term()}
|
||||
def prepare_publish(event, opts \\ []) when is_map(event) and is_list(opts) do
|
||||
if enabled?(opts) do
|
||||
prepare_enabled_publish(event, opts)
|
||||
else
|
||||
prepare_disabled_publish(event)
|
||||
end
|
||||
end
|
||||
|
||||
@spec finalize_publish(map(), publish_state(), keyword()) :: :ok | {:ok, String.t()}
|
||||
def finalize_publish(event, publish_state, opts \\ [])
|
||||
|
||||
def finalize_publish(event, :ok, _opts) when is_map(event) do
|
||||
case Map.get(event, "kind") do
|
||||
kind when kind in [@add_user_kind, @remove_user_kind, @membership_list_kind] ->
|
||||
Flow.handle_event(event)
|
||||
|
||||
_other ->
|
||||
:ok
|
||||
end
|
||||
end
|
||||
|
||||
def finalize_publish(event, %{action: :join, duplicate?: true, message: message}, _opts)
|
||||
when is_map(event) do
|
||||
{:ok, message}
|
||||
end
|
||||
|
||||
def finalize_publish(event, %{action: :join, duplicate?: false, message: message}, opts)
|
||||
when is_map(event) do
|
||||
opts = Keyword.put_new(opts, :now, Map.get(event, "created_at"))
|
||||
:ok = Flow.handle_event(event)
|
||||
publish_membership_events(Map.get(event, "pubkey"), :add, opts)
|
||||
{:ok, message}
|
||||
end
|
||||
|
||||
def finalize_publish(event, %{action: :leave, duplicate?: true, message: message}, _opts)
|
||||
when is_map(event) do
|
||||
{:ok, message}
|
||||
end
|
||||
|
||||
def finalize_publish(event, %{action: :leave, duplicate?: false, message: message}, opts)
|
||||
when is_map(event) do
|
||||
opts = Keyword.put_new(opts, :now, Map.get(event, "created_at"))
|
||||
:ok = Flow.handle_event(event)
|
||||
publish_membership_events(Map.get(event, "pubkey"), :remove, opts)
|
||||
{:ok, message}
|
||||
end
|
||||
|
||||
@spec dynamic_events([map()], keyword()) :: [map()]
|
||||
def dynamic_events(filters, opts \\ []) when is_list(filters) and is_list(opts) do
|
||||
if enabled?(opts) and requests_invite?(filters) do
|
||||
filters
|
||||
|> build_invite_event(opts)
|
||||
|> maybe_wrap_event()
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
@spec dynamic_count([map()], keyword()) :: non_neg_integer()
|
||||
def dynamic_count(filters, opts \\ []) do
|
||||
filters
|
||||
|> dynamic_events(opts)
|
||||
|> length()
|
||||
end
|
||||
|
||||
defp prepare_enabled_publish(%{"kind" => @join_request_kind, "pubkey" => pubkey} = event, opts)
|
||||
when is_binary(pubkey) do
|
||||
with {:ok, _claim} <- validate_claim_from_event(event),
|
||||
{:ok, membership} <- Flow.get_membership(pubkey) do
|
||||
if membership_active?(membership) do
|
||||
{:ok,
|
||||
%{
|
||||
action: :join,
|
||||
duplicate?: true,
|
||||
message: "duplicate: you are already a member of this relay."
|
||||
}}
|
||||
else
|
||||
{:ok,
|
||||
%{
|
||||
action: :join,
|
||||
duplicate?: false,
|
||||
message: "info: welcome to #{relay_url(opts)}!"
|
||||
}}
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defp prepare_enabled_publish(%{"kind" => @leave_request_kind, "pubkey" => pubkey}, _opts)
|
||||
when is_binary(pubkey) do
|
||||
with {:ok, membership} <- Flow.get_membership(pubkey) do
|
||||
if membership_active?(membership) do
|
||||
{:ok, %{action: :leave, duplicate?: false, message: "info: membership revoked."}}
|
||||
else
|
||||
{:ok,
|
||||
%{
|
||||
action: :leave,
|
||||
duplicate?: true,
|
||||
message: "duplicate: you are not a member of this relay."
|
||||
}}
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defp prepare_enabled_publish(%{"kind" => @invite_request_kind}, _opts) do
|
||||
{:error, "restricted: kind 28935 invite claims are generated via REQ"}
|
||||
end
|
||||
|
||||
defp prepare_enabled_publish(%{"kind" => kind, "pubkey" => pubkey}, _opts)
|
||||
when kind in [@add_user_kind, @remove_user_kind, @membership_list_kind] and
|
||||
is_binary(pubkey) do
|
||||
case relay_pubkey() do
|
||||
{:ok, ^pubkey} -> {:ok, :ok}
|
||||
{:ok, _other} -> {:error, "restricted: relay access metadata must be relay-signed"}
|
||||
{:error, _reason} -> {:error, "error: relay identity unavailable"}
|
||||
end
|
||||
end
|
||||
|
||||
defp prepare_enabled_publish(_event, _opts), do: {:ok, :ok}
|
||||
|
||||
defp prepare_disabled_publish(%{"kind" => kind})
|
||||
when kind in [
|
||||
@join_request_kind,
|
||||
@invite_request_kind,
|
||||
@leave_request_kind,
|
||||
@add_user_kind,
|
||||
@remove_user_kind,
|
||||
@membership_list_kind
|
||||
] do
|
||||
{:error, "blocked: NIP-43 relay access requests are disabled"}
|
||||
end
|
||||
|
||||
defp prepare_disabled_publish(_event), do: {:ok, :ok}
|
||||
|
||||
defp build_invite_event(filters, opts) do
|
||||
now = Keyword.get(opts, :now, System.system_time(:second))
|
||||
identity_opts = identity_opts(opts)
|
||||
|
||||
with {:ok, claim} <- issue_claim(now, opts),
|
||||
{:ok, signed_event} <-
|
||||
%{
|
||||
"created_at" => now,
|
||||
"kind" => @invite_request_kind,
|
||||
"tags" => [["-"], ["claim", claim]],
|
||||
"content" => ""
|
||||
}
|
||||
|> Identity.sign_event(identity_opts),
|
||||
true <- Filter.matches_any?(signed_event, filters) do
|
||||
{:ok, signed_event}
|
||||
else
|
||||
_other -> :error
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_wrap_event({:ok, event}), do: [event]
|
||||
defp maybe_wrap_event(_other), do: []
|
||||
|
||||
defp requests_invite?(filters) do
|
||||
Enum.any?(filters, fn filter ->
|
||||
case Map.get(filter, "kinds") do
|
||||
kinds when is_list(kinds) -> @invite_request_kind in kinds
|
||||
_other -> false
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
defp issue_claim(now, opts) do
|
||||
ttl_seconds =
|
||||
config(opts)
|
||||
|> Keyword.get(:invite_ttl_seconds, @default_invite_ttl_seconds)
|
||||
|> normalize_positive_integer(@default_invite_ttl_seconds)
|
||||
|
||||
identity_opts = identity_opts(opts)
|
||||
|
||||
token_event = %{
|
||||
"created_at" => now,
|
||||
"kind" => @claim_token_kind,
|
||||
"tags" => [["exp", Integer.to_string(now + ttl_seconds)]],
|
||||
"content" => Base.encode16(:crypto.strong_rand_bytes(16), case: :lower)
|
||||
}
|
||||
|
||||
with {:ok, signed_token} <- Identity.sign_event(token_event, identity_opts) do
|
||||
signed_token
|
||||
|> JSON.encode!()
|
||||
|> Base.url_encode64(padding: false)
|
||||
|> then(&{:ok, &1})
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_claim_from_event(event) do
|
||||
claim =
|
||||
event
|
||||
|> Map.get("tags", [])
|
||||
|> Enum.find_value(fn
|
||||
["claim", value | _rest] when is_binary(value) and value != "" -> value
|
||||
_tag -> nil
|
||||
end)
|
||||
|
||||
case claim do
|
||||
nil -> {:error, "restricted: that is an invalid invite code."}
|
||||
value -> validate_claim(value)
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_claim(claim) when is_binary(claim) do
|
||||
with {:ok, payload} <- Base.url_decode64(claim, padding: false),
|
||||
{:ok, decoded} <- JSON.decode(payload),
|
||||
:ok <- Protocol.validate_event(decoded),
|
||||
:ok <- validate_claim_token(decoded) do
|
||||
{:ok, decoded}
|
||||
else
|
||||
{:error, :expired_claim} ->
|
||||
{:error, "restricted: that invite code is expired."}
|
||||
|
||||
_other ->
|
||||
{:error, "restricted: that is an invalid invite code."}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_claim(_claim), do: {:error, "restricted: that is an invalid invite code."}
|
||||
|
||||
defp validate_claim_token(%{
|
||||
"kind" => @claim_token_kind,
|
||||
"pubkey" => pubkey,
|
||||
"tags" => tags
|
||||
}) do
|
||||
with {:ok, relay_pubkey} <- relay_pubkey(),
|
||||
true <- pubkey == relay_pubkey,
|
||||
{:ok, expires_at} <- fetch_expiration(tags),
|
||||
true <- expires_at >= System.system_time(:second) do
|
||||
:ok
|
||||
else
|
||||
false -> {:error, :invalid_claim}
|
||||
{:error, _reason} -> {:error, :invalid_claim}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_claim_token(_event), do: {:error, :invalid_claim}
|
||||
|
||||
defp fetch_expiration(tags) when is_list(tags) do
|
||||
case Enum.find(tags, &match?(["exp", _value | _rest], &1)) do
|
||||
["exp", value | _rest] ->
|
||||
parse_expiration(value)
|
||||
|
||||
_other ->
|
||||
{:error, :invalid_claim}
|
||||
end
|
||||
end
|
||||
|
||||
defp parse_expiration(value) when is_binary(value) do
|
||||
case Integer.parse(value) do
|
||||
{expires_at, ""} when expires_at > 0 -> validate_expiration(expires_at)
|
||||
_other -> {:error, :invalid_claim}
|
||||
end
|
||||
end
|
||||
|
||||
defp parse_expiration(_value), do: {:error, :invalid_claim}
|
||||
|
||||
defp validate_expiration(expires_at) when is_integer(expires_at) do
|
||||
if expires_at >= System.system_time(:second) do
|
||||
{:ok, expires_at}
|
||||
else
|
||||
{:error, :expired_claim}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_expiration(_expires_at), do: {:error, :expired_claim}
|
||||
|
||||
defp publish_membership_events(member_pubkey, action, opts) when is_binary(member_pubkey) do
|
||||
now = Keyword.get(opts, :now, System.system_time(:second))
|
||||
identity_opts = identity_opts(opts)
|
||||
context = Keyword.get(opts, :context, %RequestContext{})
|
||||
|
||||
action
|
||||
|> build_membership_delta_event(member_pubkey, now)
|
||||
|> sign_and_publish(context, identity_opts)
|
||||
|
||||
current_membership_snapshot(now)
|
||||
|> sign_and_publish(context, identity_opts)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
defp build_membership_delta_event(:add, member_pubkey, now) do
|
||||
%{
|
||||
"created_at" => now,
|
||||
"kind" => @add_user_kind,
|
||||
"tags" => [["-"], ["p", member_pubkey]],
|
||||
"content" => ""
|
||||
}
|
||||
end
|
||||
|
||||
defp build_membership_delta_event(:remove, member_pubkey, now) do
|
||||
%{
|
||||
"created_at" => now,
|
||||
"kind" => @remove_user_kind,
|
||||
"tags" => [["-"], ["p", member_pubkey]],
|
||||
"content" => ""
|
||||
}
|
||||
end
|
||||
|
||||
defp current_membership_snapshot(now) do
|
||||
tags =
|
||||
case Flow.list_memberships() do
|
||||
{:ok, memberships} ->
|
||||
[["-"] | Enum.map(memberships, &["member", &1.pubkey])]
|
||||
|
||||
{:error, _reason} ->
|
||||
[["-"]]
|
||||
end
|
||||
|
||||
%{
|
||||
"created_at" => now,
|
||||
"kind" => @membership_list_kind,
|
||||
"tags" => tags,
|
||||
"content" => ""
|
||||
}
|
||||
end
|
||||
|
||||
defp sign_and_publish(unsigned_event, context, identity_opts) do
|
||||
with {:ok, signed_event} <- Identity.sign_event(unsigned_event, identity_opts),
|
||||
{:ok, %{accepted: true}} <- Events.publish(signed_event, context: context) do
|
||||
:ok
|
||||
else
|
||||
_other -> :ok
|
||||
end
|
||||
end
|
||||
|
||||
defp membership_active?(nil), do: false
|
||||
defp membership_active?(%{role: "member"}), do: true
|
||||
defp membership_active?(_membership), do: false
|
||||
|
||||
defp relay_pubkey do
|
||||
case Identity.get() do
|
||||
{:ok, %{pubkey: pubkey}} when is_binary(pubkey) -> {:ok, pubkey}
|
||||
{:error, reason} -> {:error, reason}
|
||||
end
|
||||
end
|
||||
|
||||
defp relay_url(opts) do
|
||||
Keyword.get(opts, :relay_url, Application.get_env(:parrhesia, :relay_url))
|
||||
end
|
||||
|
||||
defp identity_opts(opts) do
|
||||
opts
|
||||
|> Keyword.take([:path, :private_key, :configured_private_key])
|
||||
end
|
||||
|
||||
defp config(opts) do
|
||||
case Keyword.get(opts, :config) do
|
||||
config when is_list(config) -> config
|
||||
_other -> Application.get_env(:parrhesia, :nip43, [])
|
||||
end
|
||||
end
|
||||
|
||||
defp normalize_positive_integer(value, _default) when is_integer(value) and value > 0, do: value
|
||||
defp normalize_positive_integer(_value, default), do: default
|
||||
end
|
||||
400
lib/parrhesia/nip66.ex
Normal file
400
lib/parrhesia/nip66.ex
Normal file
@@ -0,0 +1,400 @@
|
||||
defmodule Parrhesia.NIP66 do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.API.Events
|
||||
alias Parrhesia.API.Identity
|
||||
alias Parrhesia.API.RequestContext
|
||||
alias Parrhesia.NIP66.Probe
|
||||
alias Parrhesia.Web.Listener
|
||||
alias Parrhesia.Web.RelayInfo
|
||||
|
||||
@default_publish_interval_seconds 900
|
||||
@default_timeout_ms 5_000
|
||||
@default_checks [:open, :read, :nip11]
|
||||
@allowed_requirement_keys MapSet.new(~w[auth writes pow payment])
|
||||
|
||||
@spec enabled?(keyword()) :: boolean()
|
||||
def enabled?(opts \\ []) do
|
||||
config = config(opts)
|
||||
config_enabled?(config) and active_targets(config, listeners(opts)) != []
|
||||
end
|
||||
|
||||
@spec publish_snapshot(keyword()) :: {:ok, [map()]}
|
||||
def publish_snapshot(opts \\ []) when is_list(opts) do
|
||||
config = config(opts)
|
||||
targets = active_targets(config, listeners(opts))
|
||||
|
||||
if config_enabled?(config) and targets != [] do
|
||||
probe_fun = Keyword.get(opts, :probe_fun, &Probe.probe/3)
|
||||
context = Keyword.get(opts, :context, %RequestContext{})
|
||||
now = Keyword.get(opts, :now, System.system_time(:second))
|
||||
identity_opts = identity_opts(opts)
|
||||
|
||||
events =
|
||||
maybe_publish_monitor_announcement(config, now, context, identity_opts)
|
||||
|> Kernel.++(
|
||||
publish_discovery_events(targets, config, probe_fun, now, context, identity_opts)
|
||||
)
|
||||
|
||||
{:ok, events}
|
||||
else
|
||||
{:ok, []}
|
||||
end
|
||||
end
|
||||
|
||||
@spec publish_interval_ms(keyword()) :: pos_integer()
|
||||
def publish_interval_ms(opts \\ []) when is_list(opts) do
|
||||
config = config(opts)
|
||||
|
||||
config
|
||||
|> Keyword.get(:publish_interval_seconds, @default_publish_interval_seconds)
|
||||
|> normalize_positive_integer(@default_publish_interval_seconds)
|
||||
|> Kernel.*(1_000)
|
||||
end
|
||||
|
||||
defp maybe_publish_monitor_announcement(config, now, context, identity_opts) do
|
||||
if Keyword.get(config, :publish_monitor_announcement?, true) do
|
||||
config
|
||||
|> build_monitor_announcement(now)
|
||||
|> sign_and_publish(context, identity_opts)
|
||||
|> maybe_wrap_event()
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
defp publish_discovery_events(targets, config, probe_fun, now, context, identity_opts) do
|
||||
probe_opts = [
|
||||
timeout_ms:
|
||||
config
|
||||
|> Keyword.get(:timeout_ms, @default_timeout_ms)
|
||||
|> normalize_positive_integer(@default_timeout_ms),
|
||||
checks: normalize_checks(Keyword.get(config, :checks, @default_checks))
|
||||
]
|
||||
|
||||
Enum.flat_map(targets, fn target ->
|
||||
probe_result =
|
||||
case probe_fun.(target, probe_opts, identity_opts) do
|
||||
{:ok, result} when is_map(result) -> result
|
||||
_other -> %{checks: [], metrics: %{}, relay_info: nil, relay_info_body: nil}
|
||||
end
|
||||
|
||||
target
|
||||
|> build_discovery_event(now, probe_result, identity_opts)
|
||||
|> sign_and_publish(context, identity_opts)
|
||||
|> maybe_wrap_event()
|
||||
end)
|
||||
end
|
||||
|
||||
defp sign_and_publish(event, context, identity_opts) do
|
||||
with {:ok, signed_event} <- Identity.sign_event(event, identity_opts),
|
||||
{:ok, %{accepted: true}} <- Events.publish(signed_event, context: context) do
|
||||
{:ok, signed_event}
|
||||
else
|
||||
_other -> :error
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_wrap_event({:ok, event}), do: [event]
|
||||
defp maybe_wrap_event(_other), do: []
|
||||
|
||||
defp build_monitor_announcement(config, now) do
|
||||
checks = normalize_checks(Keyword.get(config, :checks, @default_checks))
|
||||
timeout_ms = Keyword.get(config, :timeout_ms, @default_timeout_ms)
|
||||
frequency = Keyword.get(config, :publish_interval_seconds, @default_publish_interval_seconds)
|
||||
|
||||
tags =
|
||||
[
|
||||
[
|
||||
"frequency",
|
||||
Integer.to_string(
|
||||
normalize_positive_integer(frequency, @default_publish_interval_seconds)
|
||||
)
|
||||
]
|
||||
] ++
|
||||
Enum.map(checks, fn check ->
|
||||
["timeout", Atom.to_string(check), Integer.to_string(timeout_ms)]
|
||||
end) ++
|
||||
Enum.map(checks, fn check -> ["c", Atom.to_string(check)] end) ++
|
||||
maybe_geohash_tag(config)
|
||||
|
||||
%{
|
||||
"created_at" => now,
|
||||
"kind" => 10_166,
|
||||
"tags" => tags,
|
||||
"content" => ""
|
||||
}
|
||||
end
|
||||
|
||||
defp build_discovery_event(target, now, probe_result, identity_opts) do
|
||||
relay_info = probe_result[:relay_info] || local_relay_info(target.listener, identity_opts)
|
||||
content = probe_result[:relay_info_body] || JSON.encode!(relay_info)
|
||||
|
||||
tags =
|
||||
[["d", target.relay_url]]
|
||||
|> append_network_tag(target)
|
||||
|> append_relay_type_tag(target)
|
||||
|> append_geohash_tag(target)
|
||||
|> append_topic_tags(target)
|
||||
|> Kernel.++(nip_tags(relay_info))
|
||||
|> Kernel.++(requirement_tags(relay_info))
|
||||
|> Kernel.++(rtt_tags(probe_result[:metrics] || %{}))
|
||||
|
||||
%{
|
||||
"created_at" => now,
|
||||
"kind" => 30_166,
|
||||
"tags" => tags,
|
||||
"content" => content
|
||||
}
|
||||
end
|
||||
|
||||
defp nip_tags(relay_info) do
|
||||
relay_info
|
||||
|> Map.get("supported_nips", [])
|
||||
|> Enum.map(&["N", Integer.to_string(&1)])
|
||||
end
|
||||
|
||||
defp requirement_tags(relay_info) do
|
||||
limitation = Map.get(relay_info, "limitation", %{})
|
||||
|
||||
[
|
||||
requirement_value("auth", Map.get(limitation, "auth_required", false)),
|
||||
requirement_value("writes", Map.get(limitation, "restricted_writes", false)),
|
||||
requirement_value("pow", Map.get(limitation, "min_pow_difficulty", 0) > 0),
|
||||
requirement_value("payment", Map.get(limitation, "payment_required", false))
|
||||
]
|
||||
|> Enum.filter(&MapSet.member?(@allowed_requirement_keys, String.trim_leading(&1, "!")))
|
||||
|> Enum.map(&["R", &1])
|
||||
end
|
||||
|
||||
defp requirement_value(name, true), do: name
|
||||
defp requirement_value(name, false), do: "!" <> name
|
||||
|
||||
defp rtt_tags(metrics) when is_map(metrics) do
|
||||
[]
|
||||
|> maybe_put_metric_tag("rtt-open", Map.get(metrics, :rtt_open_ms))
|
||||
|> maybe_put_metric_tag("rtt-read", Map.get(metrics, :rtt_read_ms))
|
||||
|> maybe_put_metric_tag("rtt-write", Map.get(metrics, :rtt_write_ms))
|
||||
end
|
||||
|
||||
defp append_network_tag(tags, target) do
|
||||
case target.network do
|
||||
nil -> tags
|
||||
value -> tags ++ [["n", value]]
|
||||
end
|
||||
end
|
||||
|
||||
defp append_relay_type_tag(tags, target) do
|
||||
case target.relay_type do
|
||||
nil -> tags
|
||||
value -> tags ++ [["T", value]]
|
||||
end
|
||||
end
|
||||
|
||||
defp append_geohash_tag(tags, target) do
|
||||
case target.geohash do
|
||||
nil -> tags
|
||||
value -> tags ++ [["g", value]]
|
||||
end
|
||||
end
|
||||
|
||||
defp append_topic_tags(tags, target) do
|
||||
tags ++ Enum.map(target.topics, &["t", &1])
|
||||
end
|
||||
|
||||
defp maybe_put_metric_tag(tags, _name, nil), do: tags
|
||||
|
||||
defp maybe_put_metric_tag(tags, name, value) when is_integer(value) and value >= 0 do
|
||||
tags ++ [[name, Integer.to_string(value)]]
|
||||
end
|
||||
|
||||
defp maybe_put_metric_tag(tags, _name, _value), do: tags
|
||||
|
||||
defp local_relay_info(listener, identity_opts) do
|
||||
relay_info = RelayInfo.document(listener)
|
||||
|
||||
case Identity.get(identity_opts) do
|
||||
{:ok, %{pubkey: pubkey}} ->
|
||||
relay_info
|
||||
|> Map.put("pubkey", pubkey)
|
||||
|> Map.put("self", pubkey)
|
||||
|
||||
{:error, _reason} ->
|
||||
relay_info
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_geohash_tag(config) do
|
||||
case fetch_value(config, :geohash) do
|
||||
value when is_binary(value) and value != "" -> [["g", value]]
|
||||
_other -> []
|
||||
end
|
||||
end
|
||||
|
||||
defp active_targets(config, listeners) do
|
||||
listeners_by_id = Map.new(listeners, &{&1.id, &1})
|
||||
|
||||
raw_targets =
|
||||
case Keyword.get(config, :targets, []) do
|
||||
[] -> [default_target()]
|
||||
targets when is_list(targets) -> targets
|
||||
_other -> []
|
||||
end
|
||||
|
||||
Enum.flat_map(raw_targets, fn raw_target ->
|
||||
case normalize_target(raw_target, listeners_by_id) do
|
||||
{:ok, target} -> [target]
|
||||
:error -> []
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
defp normalize_target(target, listeners_by_id) when is_map(target) or is_list(target) do
|
||||
listener_id = fetch_value(target, :listener) || :public
|
||||
relay_url = fetch_value(target, :relay_url) || Application.get_env(:parrhesia, :relay_url)
|
||||
|
||||
with %{} = listener <- Map.get(listeners_by_id, normalize_listener_id(listener_id)),
|
||||
true <- listener.enabled and Listener.feature_enabled?(listener, :nostr),
|
||||
{:ok, normalized_relay_url} <- normalize_relay_url(relay_url) do
|
||||
{:ok,
|
||||
%{
|
||||
listener: listener,
|
||||
relay_url: normalized_relay_url,
|
||||
network: normalize_network(fetch_value(target, :network), normalized_relay_url),
|
||||
relay_type: normalize_optional_string(fetch_value(target, :relay_type)),
|
||||
geohash: normalize_optional_string(fetch_value(target, :geohash)),
|
||||
topics: normalize_string_list(fetch_value(target, :topics))
|
||||
}}
|
||||
else
|
||||
_other -> :error
|
||||
end
|
||||
end
|
||||
|
||||
defp normalize_target(_target, _listeners_by_id), do: :error
|
||||
|
||||
defp normalize_relay_url(relay_url) when is_binary(relay_url) and relay_url != "" do
|
||||
case URI.parse(relay_url) do
|
||||
%URI{scheme: scheme, host: host} = uri
|
||||
when scheme in ["ws", "wss"] and is_binary(host) and host != "" ->
|
||||
normalized_uri = %URI{
|
||||
uri
|
||||
| scheme: String.downcase(scheme),
|
||||
host: String.downcase(host),
|
||||
path: normalize_path(uri.path),
|
||||
query: nil,
|
||||
fragment: nil,
|
||||
port: normalize_port(uri.port, scheme)
|
||||
}
|
||||
|
||||
{:ok, URI.to_string(normalized_uri)}
|
||||
|
||||
_other ->
|
||||
:error
|
||||
end
|
||||
end
|
||||
|
||||
defp normalize_relay_url(_relay_url), do: :error
|
||||
|
||||
defp normalize_path(nil), do: "/"
|
||||
defp normalize_path(""), do: "/"
|
||||
defp normalize_path(path), do: path
|
||||
|
||||
defp normalize_port(80, "ws"), do: nil
|
||||
defp normalize_port(443, "wss"), do: nil
|
||||
defp normalize_port(port, _scheme), do: port
|
||||
|
||||
defp normalize_network(value, _relay_url)
|
||||
when is_binary(value) and value in ["clearnet", "tor", "i2p", "loki"],
|
||||
do: value
|
||||
|
||||
defp normalize_network(_value, relay_url) do
|
||||
relay_url
|
||||
|> URI.parse()
|
||||
|> Map.get(:host)
|
||||
|> infer_network()
|
||||
end
|
||||
|
||||
defp infer_network(host) when is_binary(host) do
|
||||
cond do
|
||||
String.ends_with?(host, ".onion") -> "tor"
|
||||
String.ends_with?(host, ".i2p") -> "i2p"
|
||||
true -> "clearnet"
|
||||
end
|
||||
end
|
||||
|
||||
defp infer_network(_host), do: "clearnet"
|
||||
|
||||
defp normalize_checks(checks) when is_list(checks) do
|
||||
checks
|
||||
|> Enum.map(&normalize_check/1)
|
||||
|> Enum.reject(&is_nil/1)
|
||||
|> Enum.uniq()
|
||||
end
|
||||
|
||||
defp normalize_checks(_checks), do: @default_checks
|
||||
|
||||
defp normalize_check(:open), do: :open
|
||||
defp normalize_check("open"), do: :open
|
||||
defp normalize_check(:read), do: :read
|
||||
defp normalize_check("read"), do: :read
|
||||
defp normalize_check(:nip11), do: :nip11
|
||||
defp normalize_check("nip11"), do: :nip11
|
||||
defp normalize_check(_check), do: nil
|
||||
|
||||
defp listeners(opts) do
|
||||
case Keyword.get(opts, :listeners) do
|
||||
listeners when is_list(listeners) -> listeners
|
||||
_other -> Listener.all()
|
||||
end
|
||||
end
|
||||
|
||||
defp identity_opts(opts) do
|
||||
opts
|
||||
|> Keyword.take([:path, :private_key, :configured_private_key])
|
||||
end
|
||||
|
||||
defp config(opts) do
|
||||
case Keyword.get(opts, :config) do
|
||||
config when is_list(config) -> config
|
||||
_other -> Application.get_env(:parrhesia, :nip66, [])
|
||||
end
|
||||
end
|
||||
|
||||
defp config_enabled?(config), do: Keyword.get(config, :enabled, true)
|
||||
|
||||
defp default_target do
|
||||
%{listener: :public, relay_url: Application.get_env(:parrhesia, :relay_url)}
|
||||
end
|
||||
|
||||
defp normalize_listener_id(value) when is_atom(value), do: value
|
||||
|
||||
defp normalize_listener_id(value) when is_binary(value) do
|
||||
String.to_existing_atom(value)
|
||||
rescue
|
||||
ArgumentError -> :public
|
||||
end
|
||||
|
||||
defp normalize_listener_id(_value), do: :public
|
||||
|
||||
defp normalize_positive_integer(value, _default) when is_integer(value) and value > 0, do: value
|
||||
defp normalize_positive_integer(_value, default), do: default
|
||||
|
||||
defp normalize_optional_string(value) when is_binary(value) and value != "", do: value
|
||||
defp normalize_optional_string(_value), do: nil
|
||||
|
||||
defp normalize_string_list(values) when is_list(values) do
|
||||
Enum.filter(values, &(is_binary(&1) and &1 != ""))
|
||||
end
|
||||
|
||||
defp normalize_string_list(_values), do: []
|
||||
|
||||
defp fetch_value(map, key) when is_map(map) do
|
||||
Map.get(map, key) || Map.get(map, Atom.to_string(key))
|
||||
end
|
||||
|
||||
defp fetch_value(list, key) when is_list(list) do
|
||||
if Keyword.keyword?(list), do: Keyword.get(list, key), else: nil
|
||||
end
|
||||
|
||||
defp fetch_value(_container, _key), do: nil
|
||||
end
|
||||
218
lib/parrhesia/nip66/probe.ex
Normal file
218
lib/parrhesia/nip66/probe.ex
Normal file
@@ -0,0 +1,218 @@
|
||||
defmodule Parrhesia.NIP66.Probe do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.HTTP
|
||||
alias Parrhesia.Sync.Transport.WebSockexClient
|
||||
|
||||
@type result :: %{
|
||||
checks: [atom()],
|
||||
metrics: map(),
|
||||
relay_info: map() | nil,
|
||||
relay_info_body: String.t() | nil
|
||||
}
|
||||
|
||||
@spec probe(map(), keyword(), keyword()) :: {:ok, result()}
|
||||
def probe(target, opts \\ [], publish_opts \\ [])
|
||||
|
||||
def probe(target, opts, _publish_opts) when is_map(target) and is_list(opts) do
|
||||
timeout_ms = Keyword.get(opts, :timeout_ms, 5_000)
|
||||
checks = normalize_checks(Keyword.get(opts, :checks, [:open, :read, :nip11]))
|
||||
|
||||
initial = %{checks: [], metrics: %{}, relay_info: nil, relay_info_body: nil}
|
||||
|
||||
result =
|
||||
Enum.reduce(checks, initial, fn check, acc ->
|
||||
merge_probe_result(acc, check_result(check, target, timeout_ms))
|
||||
end)
|
||||
|
||||
{:ok, result}
|
||||
end
|
||||
|
||||
def probe(_target, _opts, _publish_opts),
|
||||
do: {:ok, %{checks: [], metrics: %{}, relay_info: nil, relay_info_body: nil}}
|
||||
|
||||
defp merge_probe_result(acc, %{check: check, metric_key: metric_key, metric_value: metric_value}) do
|
||||
acc
|
||||
|> Map.update!(:checks, &[check | &1])
|
||||
|> Map.update!(:metrics, &Map.put(&1, metric_key, metric_value))
|
||||
end
|
||||
|
||||
defp merge_probe_result(acc, %{
|
||||
check: check,
|
||||
relay_info: relay_info,
|
||||
relay_info_body: relay_info_body
|
||||
}) do
|
||||
acc
|
||||
|> Map.update!(:checks, &[check | &1])
|
||||
|> Map.put(:relay_info, relay_info)
|
||||
|> Map.put(:relay_info_body, relay_info_body)
|
||||
end
|
||||
|
||||
defp merge_probe_result(acc, :skip), do: acc
|
||||
defp merge_probe_result(acc, {:error, _reason}), do: acc
|
||||
|
||||
defp check_result(:open, target, timeout_ms) do
|
||||
case measure_websocket_connect(Map.fetch!(target, :relay_url), timeout_ms) do
|
||||
{:ok, metric_value} ->
|
||||
%{check: :open, metric_key: :rtt_open_ms, metric_value: metric_value}
|
||||
|
||||
{:error, reason} ->
|
||||
{:error, reason}
|
||||
end
|
||||
end
|
||||
|
||||
defp check_result(:read, %{listener: listener} = target, timeout_ms) do
|
||||
if listener.auth.nip42_required do
|
||||
:skip
|
||||
else
|
||||
case measure_websocket_read(Map.fetch!(target, :relay_url), timeout_ms) do
|
||||
{:ok, metric_value} ->
|
||||
%{check: :read, metric_key: :rtt_read_ms, metric_value: metric_value}
|
||||
|
||||
{:error, reason} ->
|
||||
{:error, reason}
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defp check_result(:nip11, target, timeout_ms) do
|
||||
case fetch_nip11(Map.fetch!(target, :relay_url), timeout_ms) do
|
||||
{:ok, relay_info, relay_info_body, _metric_value} ->
|
||||
%{check: :nip11, relay_info: relay_info, relay_info_body: relay_info_body}
|
||||
|
||||
{:error, reason} ->
|
||||
{:error, reason}
|
||||
end
|
||||
end
|
||||
|
||||
defp check_result(_check, _target, _timeout_ms), do: :skip
|
||||
|
||||
defp measure_websocket_connect(relay_url, timeout_ms) do
|
||||
with {:ok, websocket} <- connect(relay_url, timeout_ms),
|
||||
{:ok, metric_value} <- await_connected(websocket, timeout_ms) do
|
||||
:ok = WebSockexClient.close(websocket)
|
||||
{:ok, metric_value}
|
||||
end
|
||||
end
|
||||
|
||||
defp measure_websocket_read(relay_url, timeout_ms) do
|
||||
with {:ok, websocket} <- connect(relay_url, timeout_ms),
|
||||
{:ok, started_at} <- await_connected_started_at(websocket, timeout_ms),
|
||||
:ok <- WebSockexClient.send_json(websocket, ["COUNT", "nip66-probe", %{"kinds" => [1]}]),
|
||||
{:ok, metric_value} <- await_count_response(websocket, timeout_ms, started_at) do
|
||||
:ok = WebSockexClient.close(websocket)
|
||||
{:ok, metric_value}
|
||||
end
|
||||
end
|
||||
|
||||
defp connect(relay_url, timeout_ms) do
|
||||
server = %{url: relay_url, tls: tls_config(relay_url)}
|
||||
|
||||
WebSockexClient.connect(self(), server, websocket_opts: [timeout: timeout_ms, protocols: nil])
|
||||
end
|
||||
|
||||
defp await_connected(websocket, timeout_ms) do
|
||||
with {:ok, started_at} <- await_connected_started_at(websocket, timeout_ms) do
|
||||
{:ok, monotonic_duration_ms(started_at)}
|
||||
end
|
||||
end
|
||||
|
||||
defp await_connected_started_at(websocket, timeout_ms) do
|
||||
started_at = System.monotonic_time()
|
||||
|
||||
receive do
|
||||
{:sync_transport, ^websocket, :connected, _metadata} -> {:ok, started_at}
|
||||
{:sync_transport, ^websocket, :disconnected, reason} -> {:error, reason}
|
||||
after
|
||||
timeout_ms -> {:error, :timeout}
|
||||
end
|
||||
end
|
||||
|
||||
defp await_count_response(websocket, timeout_ms, started_at) do
|
||||
receive do
|
||||
{:sync_transport, ^websocket, :frame, ["COUNT", "nip66-probe", _payload]} ->
|
||||
{:ok, monotonic_duration_ms(started_at)}
|
||||
|
||||
{:sync_transport, ^websocket, :frame, ["CLOSED", "nip66-probe", _message]} ->
|
||||
{:error, :closed}
|
||||
|
||||
{:sync_transport, ^websocket, :disconnected, reason} ->
|
||||
{:error, reason}
|
||||
after
|
||||
timeout_ms -> {:error, :timeout}
|
||||
end
|
||||
end
|
||||
|
||||
defp fetch_nip11(relay_url, timeout_ms) do
|
||||
started_at = System.monotonic_time()
|
||||
|
||||
case HTTP.get(
|
||||
url: relay_info_url(relay_url),
|
||||
headers: [{"accept", "application/nostr+json"}],
|
||||
decode_body: false,
|
||||
connect_options: [timeout: timeout_ms],
|
||||
receive_timeout: timeout_ms
|
||||
) do
|
||||
{:ok, %Req.Response{status: 200, body: body}} when is_binary(body) ->
|
||||
case JSON.decode(body) do
|
||||
{:ok, relay_info} when is_map(relay_info) ->
|
||||
{:ok, relay_info, body, monotonic_duration_ms(started_at)}
|
||||
|
||||
{:error, reason} ->
|
||||
{:error, reason}
|
||||
|
||||
_other ->
|
||||
{:error, :invalid_relay_info}
|
||||
end
|
||||
|
||||
{:ok, %Req.Response{status: status}} ->
|
||||
{:error, {:relay_info_request_failed, status}}
|
||||
|
||||
{:error, reason} ->
|
||||
{:error, reason}
|
||||
end
|
||||
end
|
||||
|
||||
defp relay_info_url(relay_url) do
|
||||
relay_url
|
||||
|> URI.parse()
|
||||
|> Map.update!(:scheme, fn
|
||||
"wss" -> "https"
|
||||
"ws" -> "http"
|
||||
end)
|
||||
|> URI.to_string()
|
||||
end
|
||||
|
||||
defp tls_config(relay_url) do
|
||||
case URI.parse(relay_url) do
|
||||
%URI{scheme: "wss", host: host} when is_binary(host) and host != "" ->
|
||||
%{mode: :required, hostname: host, pins: []}
|
||||
|
||||
_other ->
|
||||
%{mode: :disabled}
|
||||
end
|
||||
end
|
||||
|
||||
defp normalize_checks(checks) when is_list(checks) do
|
||||
checks
|
||||
|> Enum.map(&normalize_check/1)
|
||||
|> Enum.reject(&is_nil/1)
|
||||
|> Enum.uniq()
|
||||
end
|
||||
|
||||
defp normalize_checks(_checks), do: []
|
||||
|
||||
defp normalize_check(:open), do: :open
|
||||
defp normalize_check("open"), do: :open
|
||||
defp normalize_check(:read), do: :read
|
||||
defp normalize_check("read"), do: :read
|
||||
defp normalize_check(:nip11), do: :nip11
|
||||
defp normalize_check("nip11"), do: :nip11
|
||||
defp normalize_check(_check), do: nil
|
||||
|
||||
defp monotonic_duration_ms(started_at) do
|
||||
System.monotonic_time()
|
||||
|> Kernel.-(started_at)
|
||||
|> System.convert_time_unit(:native, :millisecond)
|
||||
end
|
||||
end
|
||||
113
lib/parrhesia/plug.ex
Normal file
113
lib/parrhesia/plug.ex
Normal file
@@ -0,0 +1,113 @@
|
||||
defmodule Parrhesia.Plug do
|
||||
@moduledoc """
|
||||
Official Plug interface for mounting Parrhesia HTTP/WebSocket ingress in a host app.
|
||||
|
||||
This plug serves the same route surface as the built-in listener endpoint:
|
||||
|
||||
- `GET /health`
|
||||
- `GET /ready`
|
||||
- `GET /relay` (NIP-11 + websocket transport)
|
||||
- `POST /management`
|
||||
- `GET /metrics`
|
||||
|
||||
## Options
|
||||
|
||||
* `:listener` - listener configuration used to authorize and serve requests.
|
||||
Supported values:
|
||||
* an atom listener id from `config :parrhesia, :listeners` (for example `:public`)
|
||||
* a listener config map/keyword list (same schema as `:listeners` entries)
|
||||
|
||||
When a host app owns the HTTPS edge, a common pattern is:
|
||||
|
||||
config :parrhesia, :listeners, %{}
|
||||
|
||||
and mount `Parrhesia.Plug` with an explicit `:listener` map.
|
||||
"""
|
||||
|
||||
@behaviour Plug
|
||||
|
||||
alias Parrhesia.Web.Listener
|
||||
alias Parrhesia.Web.Router
|
||||
|
||||
@type listener_option :: atom() | map() | keyword()
|
||||
@type option :: {:listener, listener_option()}
|
||||
|
||||
@spec init([option()]) :: keyword()
|
||||
@impl Plug
|
||||
def init(opts) do
|
||||
opts = Keyword.validate!(opts, listener: :public)
|
||||
listener = opts |> Keyword.fetch!(:listener) |> resolve_listener!()
|
||||
[listener: listener]
|
||||
end
|
||||
|
||||
@spec call(Plug.Conn.t(), keyword()) :: Plug.Conn.t()
|
||||
@impl Plug
|
||||
def call(conn, opts) do
|
||||
conn
|
||||
|> Listener.put_conn(opts)
|
||||
|> Router.call([])
|
||||
end
|
||||
|
||||
defp resolve_listener!(listener_id) when is_atom(listener_id) do
|
||||
listeners = Application.get_env(:parrhesia, :listeners, %{})
|
||||
|
||||
case lookup_listener_by_id(listeners, listener_id) do
|
||||
nil ->
|
||||
raise ArgumentError,
|
||||
"listener #{inspect(listener_id)} not found in config :parrhesia, :listeners; " <>
|
||||
"configure it there or pass :listener as a map"
|
||||
|
||||
listener ->
|
||||
Listener.from_opts(listener: listener)
|
||||
end
|
||||
end
|
||||
|
||||
defp resolve_listener!(listener) when is_map(listener) do
|
||||
Listener.from_opts(listener: listener)
|
||||
end
|
||||
|
||||
defp resolve_listener!(listener) when is_list(listener) do
|
||||
if Keyword.keyword?(listener) do
|
||||
Listener.from_opts(listener: Map.new(listener))
|
||||
else
|
||||
raise ArgumentError,
|
||||
":listener keyword list must be a valid keyword configuration"
|
||||
end
|
||||
end
|
||||
|
||||
defp resolve_listener!(other) do
|
||||
raise ArgumentError,
|
||||
":listener must be an atom id, map, or keyword list, got: #{inspect(other)}"
|
||||
end
|
||||
|
||||
defp lookup_listener_by_id(listeners, listener_id) when is_map(listeners) do
|
||||
case Map.fetch(listeners, listener_id) do
|
||||
{:ok, listener} when is_map(listener) ->
|
||||
Map.put_new(listener, :id, listener_id)
|
||||
|
||||
{:ok, listener} when is_list(listener) ->
|
||||
listener |> Map.new() |> Map.put_new(:id, listener_id)
|
||||
|
||||
_other ->
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
defp lookup_listener_by_id(listeners, listener_id) when is_list(listeners) do
|
||||
case Enum.find(listeners, fn
|
||||
{id, _listener} -> id == listener_id
|
||||
_other -> false
|
||||
end) do
|
||||
{^listener_id, listener} when is_map(listener) ->
|
||||
Map.put_new(listener, :id, listener_id)
|
||||
|
||||
{^listener_id, listener} when is_list(listener) ->
|
||||
listener |> Map.new() |> Map.put_new(:id, listener_id)
|
||||
|
||||
_other ->
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
defp lookup_listener_by_id(_listeners, _listener_id), do: nil
|
||||
end
|
||||
@@ -686,19 +686,29 @@ defmodule Parrhesia.Policy.EventPolicy do
|
||||
_tag -> false
|
||||
end)
|
||||
|
||||
if protected? do
|
||||
pubkey = Map.get(event, "pubkey")
|
||||
cond do
|
||||
not protected? ->
|
||||
:ok
|
||||
|
||||
cond do
|
||||
MapSet.size(authenticated_pubkeys) == 0 -> {:error, :protected_event_requires_auth}
|
||||
MapSet.member?(authenticated_pubkeys, pubkey) -> :ok
|
||||
true -> {:error, :protected_event_pubkey_mismatch}
|
||||
end
|
||||
else
|
||||
:ok
|
||||
nip43_relay_access_kind?(Map.get(event, "kind")) ->
|
||||
:ok
|
||||
|
||||
true ->
|
||||
pubkey = Map.get(event, "pubkey")
|
||||
|
||||
cond do
|
||||
MapSet.size(authenticated_pubkeys) == 0 -> {:error, :protected_event_requires_auth}
|
||||
MapSet.member?(authenticated_pubkeys, pubkey) -> :ok
|
||||
true -> {:error, :protected_event_pubkey_mismatch}
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
defp nip43_relay_access_kind?(kind) when kind in [8_000, 8_001, 13_534, 28_934, 28_935, 28_936],
|
||||
do: true
|
||||
|
||||
defp nip43_relay_access_kind?(_kind), do: false
|
||||
|
||||
defp config_bool([scope, key], default) do
|
||||
case Application.get_env(:parrhesia, scope, []) |> Keyword.get(key, default) do
|
||||
true -> true
|
||||
|
||||
73
lib/parrhesia/postgres_repos.ex
Normal file
73
lib/parrhesia/postgres_repos.ex
Normal file
@@ -0,0 +1,73 @@
|
||||
defmodule Parrhesia.PostgresRepos do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.Config
|
||||
alias Parrhesia.ReadRepo
|
||||
alias Parrhesia.Repo
|
||||
|
||||
@spec write() :: module()
|
||||
def write, do: Repo
|
||||
|
||||
@spec read() :: module()
|
||||
def read do
|
||||
if separate_read_pool_enabled?() and is_pid(Process.whereis(ReadRepo)) do
|
||||
ReadRepo
|
||||
else
|
||||
Repo
|
||||
end
|
||||
end
|
||||
|
||||
@spec started_repos() :: [module()]
|
||||
def started_repos do
|
||||
cond do
|
||||
not postgres_enabled?() ->
|
||||
[]
|
||||
|
||||
separate_read_pool_enabled?() ->
|
||||
[Repo, ReadRepo]
|
||||
|
||||
true ->
|
||||
[Repo]
|
||||
end
|
||||
end
|
||||
|
||||
@spec postgres_enabled?() :: boolean()
|
||||
def postgres_enabled? do
|
||||
case Process.whereis(Config) do
|
||||
pid when is_pid(pid) ->
|
||||
Config.get([:storage, :backend], storage_backend_default()) == :postgres
|
||||
|
||||
nil ->
|
||||
storage_backend_default() == :postgres
|
||||
end
|
||||
end
|
||||
|
||||
@spec separate_read_pool_enabled?() :: boolean()
|
||||
def separate_read_pool_enabled? do
|
||||
case {postgres_enabled?(), Process.whereis(Config)} do
|
||||
{false, _pid} ->
|
||||
false
|
||||
|
||||
{true, pid} when is_pid(pid) ->
|
||||
Config.get(
|
||||
[:database, :separate_read_pool?],
|
||||
application_default(:separate_read_pool?, false)
|
||||
)
|
||||
|
||||
{true, nil} ->
|
||||
application_default(:separate_read_pool?, false)
|
||||
end
|
||||
end
|
||||
|
||||
defp application_default(key, default) do
|
||||
:parrhesia
|
||||
|> Application.get_env(:database, [])
|
||||
|> Keyword.get(key, default)
|
||||
end
|
||||
|
||||
defp storage_backend_default do
|
||||
:parrhesia
|
||||
|> Application.get_env(:storage, [])
|
||||
|> Keyword.get(:backend, :postgres)
|
||||
end
|
||||
end
|
||||
@@ -1 +1,4 @@
|
||||
Postgrex.Types.define(Parrhesia.PostgresTypes, [], json: JSON)
|
||||
Postgrex.Types.define(Parrhesia.PostgresTypes, [],
|
||||
json: JSON,
|
||||
moduledoc: "Custom Postgrex type definitions used by `Parrhesia.Repo` and `Parrhesia.ReadRepo`."
|
||||
)
|
||||
|
||||
@@ -1,6 +1,15 @@
|
||||
defmodule Parrhesia.Protocol do
|
||||
@moduledoc """
|
||||
Nostr protocol message decode/encode helpers.
|
||||
|
||||
This module is transport-oriented: it turns websocket payloads into structured tuples and
|
||||
back again.
|
||||
|
||||
For programmatic API calls inside the application, prefer the `Parrhesia.API.*` modules.
|
||||
In particular:
|
||||
|
||||
- `validate_event/1` returns user-facing error strings
|
||||
- `Parrhesia.API.Auth.validate_event/1` returns machine-friendly validator atoms
|
||||
"""
|
||||
|
||||
alias Parrhesia.Protocol.EventValidator
|
||||
@@ -41,6 +50,9 @@ defmodule Parrhesia.Protocol do
|
||||
|
||||
@count_options_keys MapSet.new(["hll", "approximate"])
|
||||
|
||||
@doc """
|
||||
Decodes a client websocket payload into a structured protocol tuple.
|
||||
"""
|
||||
@spec decode_client(binary()) :: {:ok, client_message()} | {:error, decode_error()}
|
||||
def decode_client(payload) when is_binary(payload) do
|
||||
with {:ok, decoded} <- decode_json(payload) do
|
||||
@@ -48,6 +60,9 @@ defmodule Parrhesia.Protocol do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Validates an event and returns relay-facing error strings.
|
||||
"""
|
||||
@spec validate_event(event()) :: :ok | {:error, String.t()}
|
||||
def validate_event(event) do
|
||||
case EventValidator.validate(event) do
|
||||
@@ -56,6 +71,9 @@ defmodule Parrhesia.Protocol do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Encodes a relay message tuple into the JSON frame sent to clients.
|
||||
"""
|
||||
@spec encode_relay(relay_message()) :: binary()
|
||||
def encode_relay(message) do
|
||||
message
|
||||
@@ -63,6 +81,9 @@ defmodule Parrhesia.Protocol do
|
||||
|> JSON.encode!()
|
||||
end
|
||||
|
||||
@doc """
|
||||
Converts a decode error into the relay notice string that should be sent to a client.
|
||||
"""
|
||||
@spec decode_error_notice(decode_error()) :: String.t()
|
||||
def decode_error_notice(reason) do
|
||||
case reason do
|
||||
|
||||
@@ -6,6 +6,14 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
@required_fields ~w[id pubkey created_at kind tags content sig]
|
||||
@max_kind 65_535
|
||||
@default_max_event_future_skew_seconds 900
|
||||
@default_max_tags_per_event 256
|
||||
@default_nip43_request_max_age_seconds 300
|
||||
@verify_event_signatures_locked Application.compile_env(
|
||||
:parrhesia,
|
||||
[:features, :verify_event_signatures_locked?],
|
||||
false
|
||||
)
|
||||
|
||||
@supported_mls_ciphersuites MapSet.new(~w[0x0001 0x0002 0x0003 0x0004 0x0005 0x0006 0x0007])
|
||||
@required_mls_extensions MapSet.new(["0xf2ee", "0x000a"])
|
||||
@supported_keypackage_ref_sizes [32, 48, 64]
|
||||
@@ -17,6 +25,7 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
| :invalid_created_at
|
||||
| :created_at_too_far_in_future
|
||||
| :invalid_kind
|
||||
| :too_many_tags
|
||||
| :invalid_tags
|
||||
| :invalid_content
|
||||
| :invalid_sig
|
||||
@@ -44,6 +53,22 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
| :missing_marmot_group_tag
|
||||
| :invalid_marmot_group_tag
|
||||
| :invalid_marmot_group_content
|
||||
| :missing_nip66_d_tag
|
||||
| :invalid_nip66_d_tag
|
||||
| :invalid_nip66_discovery_tag
|
||||
| :missing_nip66_frequency_tag
|
||||
| :invalid_nip66_frequency_tag
|
||||
| :invalid_nip66_timeout_tag
|
||||
| :invalid_nip66_check_tag
|
||||
| :missing_nip43_protected_tag
|
||||
| :missing_nip43_claim_tag
|
||||
| :invalid_nip43_claim_tag
|
||||
| :missing_nip43_member_tag
|
||||
| :invalid_nip43_member_tag
|
||||
| :missing_nip43_pubkey_tag
|
||||
| :invalid_nip43_pubkey_tag
|
||||
| :stale_nip43_join_request
|
||||
| :stale_nip43_leave_request
|
||||
|
||||
@spec validate(map()) :: :ok | {:error, error_reason()}
|
||||
def validate(event) when is_map(event) do
|
||||
@@ -87,6 +112,7 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
created_at_too_far_in_future:
|
||||
"invalid: event creation date is too far off from the current time",
|
||||
invalid_kind: "invalid: kind must be an integer between 0 and 65535",
|
||||
too_many_tags: "invalid: event tags exceed configured limit",
|
||||
invalid_tags: "invalid: tags must be an array of non-empty string arrays",
|
||||
invalid_content: "invalid: content must be a string",
|
||||
invalid_sig: "invalid: sig must be 64-byte lowercase hex",
|
||||
@@ -127,7 +153,35 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
missing_marmot_group_tag: "invalid: kind 445 must include at least one h tag with a group id",
|
||||
invalid_marmot_group_tag:
|
||||
"invalid: kind 445 h tags must contain 32-byte lowercase hex group ids",
|
||||
invalid_marmot_group_content: "invalid: kind 445 content must be non-empty base64"
|
||||
invalid_marmot_group_content: "invalid: kind 445 content must be non-empty base64",
|
||||
missing_nip66_d_tag:
|
||||
"invalid: kind 30166 must include a single [\"d\", <normalized ws/wss url or relay pubkey>] tag",
|
||||
invalid_nip66_d_tag:
|
||||
"invalid: kind 30166 must include a single [\"d\", <normalized ws/wss url or relay pubkey>] tag",
|
||||
invalid_nip66_discovery_tag: "invalid: kind 30166 includes malformed NIP-66 discovery tags",
|
||||
missing_nip66_frequency_tag:
|
||||
"invalid: kind 10166 must include a single [\"frequency\", <seconds>] tag",
|
||||
invalid_nip66_frequency_tag:
|
||||
"invalid: kind 10166 must include a single [\"frequency\", <seconds>] tag",
|
||||
invalid_nip66_timeout_tag:
|
||||
"invalid: kind 10166 timeout tags must be [\"timeout\", <check>, <ms>]",
|
||||
invalid_nip66_check_tag: "invalid: kind 10166 c tags must contain lowercase check names",
|
||||
missing_nip43_protected_tag:
|
||||
"invalid: NIP-43 events must include a NIP-70 protected [\"-\"] tag",
|
||||
missing_nip43_claim_tag:
|
||||
"invalid: kinds 28934 and 28935 must include a single [\"claim\", <invite code>] tag",
|
||||
invalid_nip43_claim_tag:
|
||||
"invalid: kinds 28934 and 28935 must include a single [\"claim\", <invite code>] tag",
|
||||
missing_nip43_member_tag:
|
||||
"invalid: kind 13534 must include at least one [\"member\", <hex pubkey>] tag",
|
||||
invalid_nip43_member_tag:
|
||||
"invalid: kind 13534 member tags must contain lowercase hex pubkeys",
|
||||
missing_nip43_pubkey_tag:
|
||||
"invalid: kinds 8000 and 8001 must include a single [\"p\", <hex pubkey>] tag",
|
||||
invalid_nip43_pubkey_tag:
|
||||
"invalid: kinds 8000 and 8001 must include a single [\"p\", <hex pubkey>] tag",
|
||||
stale_nip43_join_request: "invalid: kind 28934 created_at must be recent",
|
||||
stale_nip43_leave_request: "invalid: kind 28936 created_at must be recent"
|
||||
}
|
||||
|
||||
@spec error_message(error_reason()) :: String.t()
|
||||
@@ -169,16 +223,25 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
defp validate_kind(kind) when is_integer(kind) and kind >= 0 and kind <= @max_kind, do: :ok
|
||||
defp validate_kind(_kind), do: {:error, :invalid_kind}
|
||||
|
||||
defp validate_tags(tags) when is_list(tags) do
|
||||
if Enum.all?(tags, &valid_tag?/1) do
|
||||
:ok
|
||||
else
|
||||
{:error, :invalid_tags}
|
||||
end
|
||||
end
|
||||
defp validate_tags(tags) when is_list(tags), do: validate_tags(tags, max_tags_per_event(), 0)
|
||||
|
||||
defp validate_tags(_tags), do: {:error, :invalid_tags}
|
||||
|
||||
defp validate_tags([], _max_tags, _count), do: :ok
|
||||
|
||||
defp validate_tags([tag | rest], max_tags, count) do
|
||||
cond do
|
||||
count + 1 > max_tags ->
|
||||
{:error, :too_many_tags}
|
||||
|
||||
valid_tag?(tag) ->
|
||||
validate_tags(rest, max_tags, count + 1)
|
||||
|
||||
true ->
|
||||
{:error, :invalid_tags}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_content(content) when is_binary(content), do: :ok
|
||||
defp validate_content(_content), do: {:error, :invalid_content}
|
||||
|
||||
@@ -197,7 +260,7 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
end
|
||||
|
||||
defp validate_signature(event) do
|
||||
if verify_event_signatures?() do
|
||||
if @verify_event_signatures_locked or verify_event_signatures?() do
|
||||
verify_signature(event)
|
||||
else
|
||||
:ok
|
||||
@@ -240,6 +303,27 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
defp validate_kind_specific(%{"kind" => 1059} = event),
|
||||
do: validate_giftwrap_event(event)
|
||||
|
||||
defp validate_kind_specific(%{"kind" => 30_166} = event),
|
||||
do: validate_nip66_discovery_event(event)
|
||||
|
||||
defp validate_kind_specific(%{"kind" => 10_166} = event),
|
||||
do: validate_nip66_monitor_announcement(event)
|
||||
|
||||
defp validate_kind_specific(%{"kind" => 13_534} = event),
|
||||
do: validate_nip43_membership_list(event)
|
||||
|
||||
defp validate_kind_specific(%{"kind" => kind} = event) when kind in [8_000, 8_001],
|
||||
do: validate_nip43_membership_delta(event)
|
||||
|
||||
defp validate_kind_specific(%{"kind" => 28_934} = event),
|
||||
do: validate_nip43_join_request(event)
|
||||
|
||||
defp validate_kind_specific(%{"kind" => 28_935} = event),
|
||||
do: validate_nip43_invite_response(event)
|
||||
|
||||
defp validate_kind_specific(%{"kind" => 28_936} = event),
|
||||
do: validate_nip43_leave_request(event)
|
||||
|
||||
defp validate_kind_specific(_event), do: :ok
|
||||
|
||||
defp validate_marmot_keypackage_event(event) do
|
||||
@@ -313,6 +397,184 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip66_discovery_event(event) do
|
||||
tags = Map.get(event, "tags", [])
|
||||
|
||||
with :ok <- validate_nip66_d_tag(tags),
|
||||
:ok <-
|
||||
validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"n",
|
||||
:invalid_nip66_discovery_tag,
|
||||
&(&1 in ["clearnet", "tor", "i2p", "loki"])
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"T",
|
||||
:invalid_nip66_discovery_tag,
|
||||
&valid_pascal_case?/1
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"g",
|
||||
:invalid_nip66_discovery_tag,
|
||||
&non_empty_string?/1
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_repeated_tag(
|
||||
tags,
|
||||
"N",
|
||||
&positive_integer_string?/1,
|
||||
:invalid_nip66_discovery_tag
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_repeated_tag(
|
||||
tags,
|
||||
"R",
|
||||
&valid_nip66_requirement_value?/1,
|
||||
:invalid_nip66_discovery_tag
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_repeated_tag(
|
||||
tags,
|
||||
"k",
|
||||
&valid_nip66_kind_value?/1,
|
||||
:invalid_nip66_discovery_tag
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_repeated_tag(
|
||||
tags,
|
||||
"t",
|
||||
&non_empty_string?/1,
|
||||
:invalid_nip66_discovery_tag
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"rtt-open",
|
||||
:invalid_nip66_discovery_tag,
|
||||
&positive_integer_string?/1
|
||||
),
|
||||
:ok <-
|
||||
validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"rtt-read",
|
||||
:invalid_nip66_discovery_tag,
|
||||
&positive_integer_string?/1
|
||||
) do
|
||||
validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"rtt-write",
|
||||
:invalid_nip66_discovery_tag,
|
||||
&positive_integer_string?/1
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip66_monitor_announcement(event) do
|
||||
tags = Map.get(event, "tags", [])
|
||||
|
||||
with :ok <-
|
||||
validate_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"frequency",
|
||||
:missing_nip66_frequency_tag,
|
||||
:invalid_nip66_frequency_tag,
|
||||
&positive_integer_string?/1
|
||||
),
|
||||
:ok <- validate_optional_repeated_timeout_tags(tags),
|
||||
:ok <-
|
||||
validate_optional_repeated_tag(
|
||||
tags,
|
||||
"c",
|
||||
&valid_nip66_check_name?/1,
|
||||
:invalid_nip66_check_tag
|
||||
) do
|
||||
validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"g",
|
||||
:invalid_nip66_discovery_tag,
|
||||
&non_empty_string?/1
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip43_membership_list(event) do
|
||||
tags = Map.get(event, "tags", [])
|
||||
|
||||
case validate_protected_tag(tags) do
|
||||
:ok -> validate_optional_repeated_pubkey_tag(tags, "member", :invalid_nip43_member_tag)
|
||||
{:error, _reason} = error -> error
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip43_membership_delta(event) do
|
||||
tags = Map.get(event, "tags", [])
|
||||
|
||||
case validate_protected_tag(tags) do
|
||||
:ok ->
|
||||
validate_single_pubkey_tag(
|
||||
tags,
|
||||
"p",
|
||||
:missing_nip43_pubkey_tag,
|
||||
:invalid_nip43_pubkey_tag
|
||||
)
|
||||
|
||||
{:error, _reason} = error ->
|
||||
error
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip43_join_request(event) do
|
||||
tags = Map.get(event, "tags", [])
|
||||
|
||||
case validate_protected_tag(tags) do
|
||||
:ok ->
|
||||
with :ok <-
|
||||
validate_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"claim",
|
||||
:missing_nip43_claim_tag,
|
||||
:invalid_nip43_claim_tag,
|
||||
&non_empty_string?/1
|
||||
) do
|
||||
validate_recent_created_at(event, :stale_nip43_join_request)
|
||||
end
|
||||
|
||||
{:error, _reason} = error ->
|
||||
error
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip43_invite_response(event) do
|
||||
tags = Map.get(event, "tags", [])
|
||||
|
||||
case validate_protected_tag(tags) do
|
||||
:ok ->
|
||||
validate_single_string_tag_with_predicate(
|
||||
tags,
|
||||
"claim",
|
||||
:missing_nip43_claim_tag,
|
||||
:invalid_nip43_claim_tag,
|
||||
&non_empty_string?/1
|
||||
)
|
||||
|
||||
{:error, _reason} = error ->
|
||||
error
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip43_leave_request(event) do
|
||||
tags = Map.get(event, "tags", [])
|
||||
|
||||
case validate_protected_tag(tags) do
|
||||
:ok -> validate_recent_created_at(event, :stale_nip43_leave_request)
|
||||
{:error, _reason} = error -> error
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_non_empty_base64_content(event),
|
||||
do: validate_non_empty_base64_content(event, :invalid_marmot_keypackage_content)
|
||||
|
||||
@@ -394,6 +656,25 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_optional_single_string_tag_with_predicate(
|
||||
tags,
|
||||
tag_name,
|
||||
invalid_error,
|
||||
predicate
|
||||
)
|
||||
when is_function(predicate, 1) do
|
||||
case Enum.filter(tags, &match_tag_name?(&1, tag_name)) do
|
||||
[] ->
|
||||
:ok
|
||||
|
||||
[[^tag_name, value]] ->
|
||||
if predicate.(value), do: :ok, else: {:error, invalid_error}
|
||||
|
||||
_other ->
|
||||
{:error, invalid_error}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_mls_extensions_tag(tags) do
|
||||
with {:ok, ["mls_extensions" | extensions]} <-
|
||||
fetch_single_tag(tags, "mls_extensions", :missing_marmot_extensions_tag),
|
||||
@@ -432,6 +713,89 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_nip66_d_tag(tags) do
|
||||
with {:ok, ["d", value]} <- fetch_single_tag(tags, "d", :missing_nip66_d_tag),
|
||||
true <- valid_websocket_url?(value) or lowercase_hex?(value, 32) do
|
||||
:ok
|
||||
else
|
||||
{:ok, _invalid_tag_shape} -> {:error, :invalid_nip66_d_tag}
|
||||
false -> {:error, :invalid_nip66_d_tag}
|
||||
{:error, _reason} = error -> error
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_optional_repeated_timeout_tags(tags) do
|
||||
timeout_tags = Enum.filter(tags, &match_tag_name?(&1, "timeout"))
|
||||
|
||||
if Enum.all?(timeout_tags, &valid_nip66_timeout_tag?/1) do
|
||||
:ok
|
||||
else
|
||||
{:error, :invalid_nip66_timeout_tag}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_optional_repeated_tag(tags, tag_name, predicate, invalid_error)
|
||||
when is_function(predicate, 1) do
|
||||
tags
|
||||
|> Enum.filter(&match_tag_name?(&1, tag_name))
|
||||
|> Enum.reduce_while(:ok, fn
|
||||
[^tag_name, value], :ok ->
|
||||
if predicate.(value), do: {:cont, :ok}, else: {:halt, {:error, invalid_error}}
|
||||
|
||||
_other, :ok ->
|
||||
{:halt, {:error, invalid_error}}
|
||||
end)
|
||||
end
|
||||
|
||||
defp validate_protected_tag(tags) do
|
||||
if Enum.any?(tags, &match?(["-"], &1)) do
|
||||
:ok
|
||||
else
|
||||
{:error, :missing_nip43_protected_tag}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_single_pubkey_tag(tags, tag_name, missing_error, invalid_error) do
|
||||
case fetch_single_tag(tags, tag_name, missing_error) do
|
||||
{:ok, [^tag_name, value]} ->
|
||||
if lowercase_hex?(value, 32) do
|
||||
:ok
|
||||
else
|
||||
{:error, invalid_error}
|
||||
end
|
||||
|
||||
{:ok, _invalid_tag_shape} ->
|
||||
{:error, invalid_error}
|
||||
|
||||
{:error, _reason} = error ->
|
||||
error
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_optional_repeated_pubkey_tag(tags, tag_name, invalid_error) do
|
||||
matching_tags = Enum.filter(tags, &match_tag_name?(&1, tag_name))
|
||||
|
||||
if Enum.all?(matching_tags, fn
|
||||
[^tag_name, pubkey | _rest] -> lowercase_hex?(pubkey, 32)
|
||||
_other -> false
|
||||
end) do
|
||||
:ok
|
||||
else
|
||||
{:error, invalid_error}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_recent_created_at(%{"created_at" => created_at}, error_reason)
|
||||
when is_integer(created_at) do
|
||||
if created_at >= System.system_time(:second) - nip43_request_max_age_seconds() do
|
||||
:ok
|
||||
else
|
||||
{:error, error_reason}
|
||||
end
|
||||
end
|
||||
|
||||
defp validate_recent_created_at(_event, error_reason), do: {:error, error_reason}
|
||||
|
||||
defp fetch_single_tag(tags, tag_name, missing_error) do
|
||||
case Enum.filter(tags, &match_tag_name?(&1, tag_name)) do
|
||||
[tag] -> {:ok, tag}
|
||||
@@ -488,6 +852,49 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
|
||||
defp valid_websocket_url?(_url), do: false
|
||||
|
||||
defp valid_nip66_timeout_tag?(["timeout", milliseconds]),
|
||||
do: positive_integer_string?(milliseconds)
|
||||
|
||||
defp valid_nip66_timeout_tag?(["timeout", check, milliseconds]) do
|
||||
valid_nip66_check_name?(check) and positive_integer_string?(milliseconds)
|
||||
end
|
||||
|
||||
defp valid_nip66_timeout_tag?(_tag), do: false
|
||||
|
||||
defp valid_nip66_requirement_value?(value) when is_binary(value) do
|
||||
normalized = String.trim_leading(value, "!")
|
||||
normalized in ["auth", "writes", "pow", "payment"]
|
||||
end
|
||||
|
||||
defp valid_nip66_requirement_value?(_value), do: false
|
||||
|
||||
defp valid_nip66_kind_value?(<<"!", rest::binary>>), do: positive_integer_string?(rest)
|
||||
defp valid_nip66_kind_value?(value), do: positive_integer_string?(value)
|
||||
|
||||
defp valid_nip66_check_name?(value) when is_binary(value) do
|
||||
String.match?(value, ~r/^[a-z0-9-]+$/)
|
||||
end
|
||||
|
||||
defp valid_nip66_check_name?(_value), do: false
|
||||
|
||||
defp valid_pascal_case?(value) when is_binary(value) do
|
||||
String.match?(value, ~r/^[A-Z][A-Za-z0-9]*$/)
|
||||
end
|
||||
|
||||
defp valid_pascal_case?(_value), do: false
|
||||
|
||||
defp positive_integer_string?(value) when is_binary(value) do
|
||||
case Integer.parse(value) do
|
||||
{integer, ""} when integer >= 0 -> true
|
||||
_other -> false
|
||||
end
|
||||
end
|
||||
|
||||
defp positive_integer_string?(_value), do: false
|
||||
|
||||
defp non_empty_string?(value) when is_binary(value), do: value != ""
|
||||
defp non_empty_string?(_value), do: false
|
||||
|
||||
defp valid_keypackage_ref?(value) when is_binary(value) do
|
||||
Enum.any?(@supported_keypackage_ref_sizes, &lowercase_hex?(value, &1))
|
||||
end
|
||||
@@ -510,4 +917,17 @@ defmodule Parrhesia.Protocol.EventValidator do
|
||||
|> Application.get_env(:limits, [])
|
||||
|> Keyword.get(:max_event_future_skew_seconds, @default_max_event_future_skew_seconds)
|
||||
end
|
||||
|
||||
defp max_tags_per_event do
|
||||
case Application.get_env(:parrhesia, :limits, []) |> Keyword.get(:max_tags_per_event) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> @default_max_tags_per_event
|
||||
end
|
||||
end
|
||||
|
||||
defp nip43_request_max_age_seconds do
|
||||
:parrhesia
|
||||
|> Application.get_env(:nip43, [])
|
||||
|> Keyword.get(:request_max_age_seconds, @default_nip43_request_max_age_seconds)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -5,6 +5,7 @@ defmodule Parrhesia.Protocol.Filter do
|
||||
|
||||
@max_kind 65_535
|
||||
@default_max_filters_per_req 16
|
||||
@default_max_tag_values_per_filter 128
|
||||
|
||||
@type validation_error ::
|
||||
:invalid_filters
|
||||
@@ -19,6 +20,7 @@ defmodule Parrhesia.Protocol.Filter do
|
||||
| :invalid_until
|
||||
| :invalid_limit
|
||||
| :invalid_search
|
||||
| :too_many_tag_values
|
||||
| :invalid_tag_filter
|
||||
|
||||
@allowed_keys MapSet.new(["ids", "authors", "kinds", "since", "until", "limit", "search"])
|
||||
@@ -36,6 +38,7 @@ defmodule Parrhesia.Protocol.Filter do
|
||||
invalid_until: "invalid: until must be a non-negative integer",
|
||||
invalid_limit: "invalid: limit must be a positive integer",
|
||||
invalid_search: "invalid: search must be a non-empty string",
|
||||
too_many_tag_values: "invalid: tag filters exceed configured value limit",
|
||||
invalid_tag_filter:
|
||||
"invalid: tag filters must use #<single-letter> with non-empty string arrays"
|
||||
}
|
||||
@@ -178,19 +181,33 @@ defmodule Parrhesia.Protocol.Filter do
|
||||
filter
|
||||
|> Enum.filter(fn {key, _value} -> valid_tag_filter_key?(key) end)
|
||||
|> Enum.reduce_while(:ok, fn {_key, values}, :ok ->
|
||||
if valid_tag_filter_values?(values) do
|
||||
{:cont, :ok}
|
||||
else
|
||||
{:halt, {:error, :invalid_tag_filter}}
|
||||
case validate_tag_filter_values(values) do
|
||||
:ok -> {:cont, :ok}
|
||||
{:error, reason} -> {:halt, {:error, reason}}
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
defp valid_tag_filter_values?(values) when is_list(values) do
|
||||
values != [] and Enum.all?(values, &is_binary/1)
|
||||
end
|
||||
defp validate_tag_filter_values(values) when is_list(values),
|
||||
do: validate_tag_filter_values(values, max_tag_values_per_filter(), 0)
|
||||
|
||||
defp valid_tag_filter_values?(_values), do: false
|
||||
defp validate_tag_filter_values(_values), do: {:error, :invalid_tag_filter}
|
||||
|
||||
defp validate_tag_filter_values([], _max_values, 0), do: {:error, :invalid_tag_filter}
|
||||
defp validate_tag_filter_values([], _max_values, _count), do: :ok
|
||||
|
||||
defp validate_tag_filter_values([value | rest], max_values, count) do
|
||||
cond do
|
||||
count + 1 > max_values ->
|
||||
{:error, :too_many_tag_values}
|
||||
|
||||
is_binary(value) ->
|
||||
validate_tag_filter_values(rest, max_values, count + 1)
|
||||
|
||||
true ->
|
||||
{:error, :invalid_tag_filter}
|
||||
end
|
||||
end
|
||||
|
||||
defp filter_predicates(event, filter) do
|
||||
[
|
||||
@@ -278,4 +295,12 @@ defmodule Parrhesia.Protocol.Filter do
|
||||
|> Application.get_env(:limits, [])
|
||||
|> Keyword.get(:max_filters_per_req, @default_max_filters_per_req)
|
||||
end
|
||||
|
||||
defp max_tag_values_per_filter do
|
||||
case Application.get_env(:parrhesia, :limits, [])
|
||||
|> Keyword.get(:max_tag_values_per_filter) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> @default_max_tag_values_per_filter
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
9
lib/parrhesia/read_repo.ex
Normal file
9
lib/parrhesia/read_repo.ex
Normal file
@@ -0,0 +1,9 @@
|
||||
defmodule Parrhesia.ReadRepo do
|
||||
@moduledoc """
|
||||
PostgreSQL repository dedicated to read-heavy workloads when a separate read pool is enabled.
|
||||
"""
|
||||
|
||||
use Ecto.Repo,
|
||||
otp_app: :parrhesia,
|
||||
adapter: Ecto.Adapters.Postgres
|
||||
end
|
||||
@@ -1,10 +1,18 @@
|
||||
defmodule Parrhesia.Release do
|
||||
@moduledoc """
|
||||
Helpers for running Ecto tasks from a production release.
|
||||
|
||||
Intended for use from a release `eval` command where Mix is not available:
|
||||
|
||||
bin/parrhesia eval "Parrhesia.Release.migrate()"
|
||||
bin/parrhesia eval "Parrhesia.Release.rollback(Parrhesia.Repo, 20260101000000)"
|
||||
"""
|
||||
|
||||
@app :parrhesia
|
||||
|
||||
@doc """
|
||||
Runs all pending Ecto migrations for every configured repo.
|
||||
"""
|
||||
def migrate do
|
||||
load_app()
|
||||
|
||||
@@ -16,6 +24,9 @@ defmodule Parrhesia.Release do
|
||||
end
|
||||
end
|
||||
|
||||
@doc """
|
||||
Rolls back the given `repo` to the specified migration `version`.
|
||||
"""
|
||||
def rollback(repo, version) when is_atom(repo) and is_integer(version) do
|
||||
load_app()
|
||||
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
defmodule Parrhesia.Repo do
|
||||
@moduledoc """
|
||||
PostgreSQL repository for storage adapter persistence.
|
||||
PostgreSQL repository for write traffic and storage adapter persistence.
|
||||
|
||||
Separated from `Parrhesia.ReadRepo` so that ingest writes and read-heavy
|
||||
queries use independent connection pools.
|
||||
"""
|
||||
|
||||
use Ecto.Repo,
|
||||
|
||||
52
lib/parrhesia/runtime.ex
Normal file
52
lib/parrhesia/runtime.ex
Normal file
@@ -0,0 +1,52 @@
|
||||
defmodule Parrhesia.Runtime do
|
||||
@moduledoc """
|
||||
Top-level Parrhesia supervisor.
|
||||
|
||||
In normal standalone use, the `:parrhesia` application starts this supervisor automatically.
|
||||
Host applications can also embed it directly under their own supervision tree:
|
||||
|
||||
children = [
|
||||
{Parrhesia.Runtime, name: Parrhesia.Supervisor}
|
||||
]
|
||||
|
||||
Parrhesia currently assumes a single runtime per BEAM node and uses globally registered
|
||||
process names for core services.
|
||||
"""
|
||||
|
||||
use Supervisor
|
||||
|
||||
@doc """
|
||||
Starts the Parrhesia runtime supervisor.
|
||||
|
||||
Accepts a `:name` option (defaults to `Parrhesia.Supervisor`).
|
||||
"""
|
||||
def start_link(opts \\ []) do
|
||||
name = Keyword.get(opts, :name, Parrhesia.Supervisor)
|
||||
Supervisor.start_link(__MODULE__, opts, name: name)
|
||||
end
|
||||
|
||||
@impl true
|
||||
def init(_opts) do
|
||||
Supervisor.init(children(), strategy: :one_for_one)
|
||||
end
|
||||
|
||||
@doc """
|
||||
Returns the list of child specifications started by the runtime supervisor.
|
||||
"""
|
||||
def children do
|
||||
[
|
||||
Parrhesia.Telemetry,
|
||||
Parrhesia.ConnectionStats,
|
||||
Parrhesia.Config,
|
||||
Parrhesia.Web.EventIngestLimiter,
|
||||
Parrhesia.Web.IPEventIngestLimiter,
|
||||
Parrhesia.Storage.Supervisor,
|
||||
Parrhesia.Subscriptions.Supervisor,
|
||||
Parrhesia.Auth.Supervisor,
|
||||
Parrhesia.Sync.Supervisor,
|
||||
Parrhesia.Policy.Supervisor,
|
||||
Parrhesia.Web.Endpoint,
|
||||
Parrhesia.Tasks.Supervisor
|
||||
]
|
||||
end
|
||||
end
|
||||
@@ -4,6 +4,9 @@ defmodule Parrhesia.Storage do
|
||||
|
||||
Domain/runtime code should resolve behavior modules through this module instead of
|
||||
depending on concrete adapter implementations directly.
|
||||
|
||||
Each accessor validates that the configured module is loaded and declares the expected
|
||||
behaviour before returning it.
|
||||
"""
|
||||
|
||||
@default_modules [
|
||||
@@ -14,18 +17,33 @@ defmodule Parrhesia.Storage do
|
||||
admin: Parrhesia.Storage.Adapters.Postgres.Admin
|
||||
]
|
||||
|
||||
@doc """
|
||||
Returns the configured events storage module.
|
||||
"""
|
||||
@spec events() :: module()
|
||||
def events, do: fetch_module!(:events, Parrhesia.Storage.Events)
|
||||
|
||||
@doc """
|
||||
Returns the configured moderation storage module.
|
||||
"""
|
||||
@spec moderation() :: module()
|
||||
def moderation, do: fetch_module!(:moderation, Parrhesia.Storage.Moderation)
|
||||
|
||||
@doc """
|
||||
Returns the configured ACL storage module.
|
||||
"""
|
||||
@spec acl() :: module()
|
||||
def acl, do: fetch_module!(:acl, Parrhesia.Storage.ACL)
|
||||
|
||||
@doc """
|
||||
Returns the configured groups storage module.
|
||||
"""
|
||||
@spec groups() :: module()
|
||||
def groups, do: fetch_module!(:groups, Parrhesia.Storage.Groups)
|
||||
|
||||
@doc """
|
||||
Returns the configured admin storage module.
|
||||
"""
|
||||
@spec admin() :: module()
|
||||
def admin, do: fetch_module!(:admin, Parrhesia.Storage.Admin)
|
||||
|
||||
|
||||
@@ -6,6 +6,9 @@ defmodule Parrhesia.Storage.Adapters.Memory.Admin do
|
||||
alias Parrhesia.Storage.Adapters.Memory.Store
|
||||
|
||||
@behaviour Parrhesia.Storage.Admin
|
||||
@default_limit 100
|
||||
@max_limit 1_000
|
||||
@max_audit_logs 1_000
|
||||
|
||||
@impl true
|
||||
def execute(_context, method, _params) do
|
||||
@@ -17,18 +20,59 @@ defmodule Parrhesia.Storage.Adapters.Memory.Admin do
|
||||
|
||||
@impl true
|
||||
def append_audit_log(_context, audit_entry) when is_map(audit_entry) do
|
||||
Store.update(fn state -> update_in(state.audit_logs, &[audit_entry | &1]) end)
|
||||
Store.update(fn state ->
|
||||
update_in(state.audit_logs, fn logs ->
|
||||
[audit_entry | logs] |> Enum.take(@max_audit_logs)
|
||||
end)
|
||||
end)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
def append_audit_log(_context, _audit_entry), do: {:error, :invalid_audit_entry}
|
||||
|
||||
@impl true
|
||||
def list_audit_logs(_context, _opts) do
|
||||
{:ok, Store.get(fn state -> Enum.reverse(state.audit_logs) end)}
|
||||
def list_audit_logs(_context, opts) when is_list(opts) do
|
||||
limit = normalize_limit(Keyword.get(opts, :limit, @default_limit))
|
||||
method = normalize_method_filter(Keyword.get(opts, :method))
|
||||
actor_pubkey = Keyword.get(opts, :actor_pubkey)
|
||||
|
||||
logs =
|
||||
Store.get(fn state ->
|
||||
state.audit_logs
|
||||
|> Enum.filter(&matches_filters?(&1, method, actor_pubkey))
|
||||
|> Enum.take(limit)
|
||||
end)
|
||||
|
||||
{:ok, logs}
|
||||
end
|
||||
|
||||
def list_audit_logs(_context, _opts), do: {:error, :invalid_opts}
|
||||
|
||||
defp normalize_method(method) when is_binary(method), do: method
|
||||
defp normalize_method(method) when is_atom(method), do: Atom.to_string(method)
|
||||
defp normalize_method(method), do: inspect(method)
|
||||
|
||||
defp normalize_limit(limit) when is_integer(limit) and limit > 0, do: min(limit, @max_limit)
|
||||
defp normalize_limit(_limit), do: @default_limit
|
||||
|
||||
defp normalize_method_filter(nil), do: nil
|
||||
defp normalize_method_filter(method), do: normalize_method(method)
|
||||
|
||||
defp matches_method?(_entry, nil), do: true
|
||||
|
||||
defp matches_method?(entry, method) do
|
||||
normalize_method(Map.get(entry, :method) || Map.get(entry, "method")) == method
|
||||
end
|
||||
|
||||
defp matches_actor_pubkey?(_entry, nil), do: true
|
||||
|
||||
defp matches_actor_pubkey?(entry, actor_pubkey) do
|
||||
Map.get(entry, :actor_pubkey) == actor_pubkey or
|
||||
Map.get(entry, "actor_pubkey") == actor_pubkey
|
||||
end
|
||||
|
||||
defp matches_filters?(entry, method, actor_pubkey) do
|
||||
matches_method?(entry, method) and matches_actor_pubkey?(entry, actor_pubkey)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -12,71 +12,75 @@ defmodule Parrhesia.Storage.Adapters.Memory.Events do
|
||||
def put_event(_context, event) do
|
||||
event_id = Map.fetch!(event, "id")
|
||||
|
||||
result =
|
||||
Store.get_and_update(fn state ->
|
||||
if Map.has_key?(state.events, event_id) do
|
||||
{{:error, :duplicate_event}, state}
|
||||
else
|
||||
next_state = put_in(state.events[event_id], event)
|
||||
{{:ok, event}, next_state}
|
||||
end
|
||||
end)
|
||||
|
||||
result
|
||||
case Store.put_event(event_id, event) do
|
||||
:ok -> {:ok, event}
|
||||
{:error, :duplicate_event} -> {:error, :duplicate_event}
|
||||
end
|
||||
end
|
||||
|
||||
@impl true
|
||||
def get_event(_context, event_id) do
|
||||
deleted? = Store.get(fn state -> MapSet.member?(state.deleted, event_id) end)
|
||||
|
||||
if deleted? do
|
||||
{:ok, nil}
|
||||
else
|
||||
{:ok, Store.get(fn state -> Map.get(state.events, event_id) end)}
|
||||
case Store.get_event(event_id) do
|
||||
{:ok, _event, true} -> {:ok, nil}
|
||||
{:ok, event, false} -> {:ok, event}
|
||||
:error -> {:ok, nil}
|
||||
end
|
||||
end
|
||||
|
||||
@impl true
|
||||
def query(_context, filters, opts) do
|
||||
with :ok <- Filter.validate_filters(filters) do
|
||||
state = Store.get(& &1)
|
||||
requester_pubkeys = Keyword.get(opts, :requester_pubkeys, [])
|
||||
|
||||
events =
|
||||
state.events
|
||||
|> Map.values()
|
||||
|> Enum.filter(fn event ->
|
||||
not MapSet.member?(state.deleted, event["id"]) and
|
||||
Filter.matches_any?(event, filters) and
|
||||
giftwrap_visible_to_requester?(event, requester_pubkeys)
|
||||
end)
|
||||
filters
|
||||
|> Enum.flat_map(&matching_events_for_filter(&1, requester_pubkeys, opts))
|
||||
|> deduplicate_events()
|
||||
|> sort_events()
|
||||
|> maybe_apply_query_limit(opts)
|
||||
|
||||
{:ok, events}
|
||||
end
|
||||
end
|
||||
|
||||
@impl true
|
||||
def query_event_refs(context, filters, opts) do
|
||||
with {:ok, events} <- query(context, filters, opts) do
|
||||
def query_event_refs(_context, filters, opts) do
|
||||
with :ok <- Filter.validate_filters(filters) do
|
||||
requester_pubkeys = Keyword.get(opts, :requester_pubkeys, [])
|
||||
query_opts = Keyword.put(opts, :apply_filter_limits?, false)
|
||||
|
||||
{_, refs} =
|
||||
reduce_unique_matching_events(
|
||||
filters,
|
||||
requester_pubkeys,
|
||||
query_opts,
|
||||
{MapSet.new(), []},
|
||||
&append_unique_event_ref/2
|
||||
)
|
||||
|
||||
refs =
|
||||
events
|
||||
|> Enum.map(fn event ->
|
||||
%{
|
||||
created_at: Map.fetch!(event, "created_at"),
|
||||
id: Base.decode16!(Map.fetch!(event, "id"), case: :mixed)
|
||||
}
|
||||
end)
|
||||
|> Enum.sort(&(compare_event_refs(&1, &2) != :gt))
|
||||
|> maybe_limit_event_refs(opts)
|
||||
refs |> Enum.sort(&(compare_event_refs(&1, &2) != :gt)) |> maybe_limit_event_refs(opts)
|
||||
|
||||
{:ok, refs}
|
||||
end
|
||||
end
|
||||
|
||||
@impl true
|
||||
def count(context, filters, opts) do
|
||||
with {:ok, events} <- query(context, filters, opts) do
|
||||
{:ok, length(events)}
|
||||
def count(_context, filters, opts) do
|
||||
with :ok <- Filter.validate_filters(filters) do
|
||||
requester_pubkeys = Keyword.get(opts, :requester_pubkeys, [])
|
||||
query_opts = Keyword.put(opts, :apply_filter_limits?, false)
|
||||
|
||||
{_seen_ids, count} =
|
||||
reduce_unique_matching_events(
|
||||
filters,
|
||||
requester_pubkeys,
|
||||
query_opts,
|
||||
{MapSet.new(), 0},
|
||||
&count_unique_event/2
|
||||
)
|
||||
|
||||
{:ok, count}
|
||||
end
|
||||
end
|
||||
|
||||
@@ -107,22 +111,14 @@ defmodule Parrhesia.Storage.Adapters.Memory.Events do
|
||||
end)
|
||||
|
||||
coordinate_delete_ids =
|
||||
Store.get(fn state ->
|
||||
state.events
|
||||
|> Map.values()
|
||||
|> Enum.filter(fn candidate ->
|
||||
matches_delete_coordinate?(candidate, delete_coordinates, deleter_pubkey)
|
||||
end)
|
||||
|> Enum.map(& &1["id"])
|
||||
end)
|
||||
delete_coordinates
|
||||
|> coordinate_delete_candidates(deleter_pubkey)
|
||||
|> Enum.filter(&matches_delete_coordinate?(&1, delete_coordinates, deleter_pubkey))
|
||||
|> Enum.map(& &1["id"])
|
||||
|
||||
all_delete_ids = Enum.uniq(delete_event_ids ++ coordinate_delete_ids)
|
||||
|
||||
Store.update(fn state ->
|
||||
Enum.reduce(all_delete_ids, state, fn event_id, acc ->
|
||||
update_in(acc.deleted, &MapSet.put(&1, event_id))
|
||||
end)
|
||||
end)
|
||||
Enum.each(all_delete_ids, &Store.mark_deleted/1)
|
||||
|
||||
{:ok, length(all_delete_ids)}
|
||||
end
|
||||
@@ -132,18 +128,11 @@ defmodule Parrhesia.Storage.Adapters.Memory.Events do
|
||||
pubkey = Map.get(event, "pubkey")
|
||||
|
||||
deleted_ids =
|
||||
Store.get(fn state ->
|
||||
state.events
|
||||
|> Map.values()
|
||||
|> Enum.filter(fn candidate -> candidate["pubkey"] == pubkey end)
|
||||
|> Enum.map(& &1["id"])
|
||||
end)
|
||||
pubkey
|
||||
|> vanish_candidates(Map.get(event, "created_at"))
|
||||
|> Enum.map(& &1["id"])
|
||||
|
||||
Store.update(fn state ->
|
||||
Enum.reduce(deleted_ids, state, fn event_id, acc ->
|
||||
update_in(acc.deleted, &MapSet.put(&1, event_id))
|
||||
end)
|
||||
end)
|
||||
Enum.each(deleted_ids, &Store.mark_deleted/1)
|
||||
|
||||
{:ok, length(deleted_ids)}
|
||||
end
|
||||
@@ -224,4 +213,311 @@ defmodule Parrhesia.Storage.Adapters.Memory.Events do
|
||||
_other -> refs
|
||||
end
|
||||
end
|
||||
|
||||
defp matching_events_for_filter(filter, requester_pubkeys, opts) do
|
||||
cond do
|
||||
Map.has_key?(filter, "ids") ->
|
||||
direct_id_lookup_events(filter, requester_pubkeys, opts)
|
||||
|
||||
indexed_candidate_spec(filter) != nil ->
|
||||
indexed_tag_lookup_events(filter, requester_pubkeys, opts)
|
||||
|
||||
true ->
|
||||
scan_filter_matches(filter, requester_pubkeys, opts)
|
||||
end
|
||||
end
|
||||
|
||||
defp direct_id_lookup_events(filter, requester_pubkeys, opts) do
|
||||
filter
|
||||
|> Map.get("ids", [])
|
||||
|> Enum.reduce([], fn event_id, acc ->
|
||||
maybe_prepend_direct_lookup_match(acc, event_id, filter, requester_pubkeys)
|
||||
end)
|
||||
|> deduplicate_events()
|
||||
|> sort_events()
|
||||
|> maybe_take_filter_limit(filter, opts)
|
||||
end
|
||||
|
||||
defp scan_filter_matches(filter, requester_pubkeys, opts) do
|
||||
limit =
|
||||
if Keyword.get(opts, :apply_filter_limits?, true) do
|
||||
effective_filter_limit(filter, opts)
|
||||
else
|
||||
nil
|
||||
end
|
||||
|
||||
{matches, _count} =
|
||||
Store.reduce_events_newest(
|
||||
{[], 0},
|
||||
&reduce_scan_match(&1, &2, filter, requester_pubkeys, limit)
|
||||
)
|
||||
|
||||
matches
|
||||
|> Enum.reverse()
|
||||
|> sort_events()
|
||||
end
|
||||
|
||||
defp indexed_tag_lookup_events(filter, requester_pubkeys, opts) do
|
||||
filter
|
||||
|> indexed_candidate_events()
|
||||
|> Enum.filter(&filter_match_visible?(&1, filter, requester_pubkeys))
|
||||
|> maybe_take_filter_limit(filter, opts)
|
||||
end
|
||||
|
||||
defp indexed_tag_filter(filter) do
|
||||
filter
|
||||
|> Enum.filter(fn
|
||||
{"#" <> _tag_name, values} when is_list(values) -> values != []
|
||||
_entry -> false
|
||||
end)
|
||||
|> Enum.sort_by(fn {key, _values} -> key end)
|
||||
|> List.first()
|
||||
|> case do
|
||||
{"#" <> tag_name, values} -> {tag_name, values}
|
||||
nil -> nil
|
||||
end
|
||||
end
|
||||
|
||||
defp indexed_candidate_spec(filter) do
|
||||
authors = Map.get(filter, "authors")
|
||||
kinds = Map.get(filter, "kinds")
|
||||
tag_filter = indexed_tag_filter(filter)
|
||||
|
||||
cond do
|
||||
is_tuple(tag_filter) ->
|
||||
{tag_name, tag_values} = tag_filter
|
||||
{:tag, tag_name, effective_indexed_tag_values(filter, tag_values)}
|
||||
|
||||
is_list(authors) and is_list(kinds) ->
|
||||
{:pubkey_kind, authors, kinds}
|
||||
|
||||
is_list(authors) ->
|
||||
{:pubkey, authors}
|
||||
|
||||
is_list(kinds) ->
|
||||
{:kind, kinds}
|
||||
|
||||
true ->
|
||||
nil
|
||||
end
|
||||
end
|
||||
|
||||
defp indexed_candidate_events(filter) do
|
||||
case indexed_candidate_spec(filter) do
|
||||
{:tag, tag_name, tag_values} ->
|
||||
Store.tagged_events(tag_name, tag_values)
|
||||
|
||||
{:pubkey_kind, authors, kinds} ->
|
||||
Store.events_by_pubkeys_and_kinds(authors, kinds)
|
||||
|
||||
{:pubkey, authors} ->
|
||||
Store.events_by_pubkeys(authors)
|
||||
|
||||
{:kind, kinds} ->
|
||||
Store.events_by_kinds(kinds)
|
||||
|
||||
nil ->
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
defp effective_indexed_tag_values(filter, tag_values) do
|
||||
case Map.get(filter, "limit") do
|
||||
limit when is_integer(limit) and limit == 1 ->
|
||||
Enum.take(tag_values, 1)
|
||||
|
||||
_other ->
|
||||
tag_values
|
||||
end
|
||||
end
|
||||
|
||||
defp filter_match_visible?(event, filter, requester_pubkeys) do
|
||||
Filter.matches_filter?(event, filter) and
|
||||
giftwrap_visible_to_requester?(event, requester_pubkeys)
|
||||
end
|
||||
|
||||
defp maybe_prepend_direct_lookup_match(acc, event_id, filter, requester_pubkeys) do
|
||||
case Store.get_event(event_id) do
|
||||
{:ok, event, false} ->
|
||||
if filter_match_visible?(event, filter, requester_pubkeys) do
|
||||
[event | acc]
|
||||
else
|
||||
acc
|
||||
end
|
||||
|
||||
_other ->
|
||||
acc
|
||||
end
|
||||
end
|
||||
|
||||
defp reduce_scan_match(event, {acc, count}, filter, requester_pubkeys, limit) do
|
||||
if filter_match_visible?(event, filter, requester_pubkeys) do
|
||||
maybe_halt_scan([event | acc], count + 1, limit)
|
||||
else
|
||||
{acc, count}
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_halt_scan(acc, count, limit) when is_integer(limit) and count >= limit do
|
||||
{:halt, {acc, count}}
|
||||
end
|
||||
|
||||
defp maybe_halt_scan(acc, count, _limit), do: {acc, count}
|
||||
|
||||
defp reduce_unique_matching_events(filters, requester_pubkeys, opts, acc, reducer) do
|
||||
Enum.reduce(filters, acc, fn filter, current_acc ->
|
||||
reduce_matching_events_for_filter(filter, requester_pubkeys, opts, current_acc, reducer)
|
||||
end)
|
||||
end
|
||||
|
||||
defp reduce_matching_events_for_filter(filter, requester_pubkeys, _opts, acc, reducer) do
|
||||
cond do
|
||||
Map.has_key?(filter, "ids") ->
|
||||
filter
|
||||
|> Map.get("ids", [])
|
||||
|> Enum.reduce(acc, &reduce_event_id_match(&1, filter, requester_pubkeys, &2, reducer))
|
||||
|
||||
indexed_candidate_spec(filter) != nil ->
|
||||
filter
|
||||
|> indexed_candidate_events()
|
||||
|> Enum.reduce(
|
||||
acc,
|
||||
&maybe_reduce_visible_event(&1, filter, requester_pubkeys, &2, reducer)
|
||||
)
|
||||
|
||||
true ->
|
||||
Store.reduce_events_newest(
|
||||
acc,
|
||||
&maybe_reduce_visible_event(&1, filter, requester_pubkeys, &2, reducer)
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
defp coordinate_delete_candidates(delete_coordinates, deleter_pubkey) do
|
||||
delete_coordinates
|
||||
|> Enum.flat_map(fn coordinate ->
|
||||
cond do
|
||||
coordinate.pubkey != deleter_pubkey ->
|
||||
[]
|
||||
|
||||
addressable_kind?(coordinate.kind) ->
|
||||
Store.events_by_addresses([{coordinate.kind, deleter_pubkey, coordinate.d_tag}])
|
||||
|
||||
replaceable_kind?(coordinate.kind) ->
|
||||
Store.events_by_pubkeys_and_kinds([deleter_pubkey], [coordinate.kind])
|
||||
|
||||
true ->
|
||||
[]
|
||||
end
|
||||
end)
|
||||
|> deduplicate_events()
|
||||
end
|
||||
|
||||
defp vanish_candidates(pubkey, created_at) do
|
||||
own_events =
|
||||
Store.events_by_pubkeys([pubkey])
|
||||
|> Enum.filter(&(&1["created_at"] <= created_at))
|
||||
|
||||
giftwrap_events =
|
||||
Store.tagged_events("p", [pubkey])
|
||||
|> Enum.filter(&(&1["kind"] == 1059 and &1["created_at"] <= created_at))
|
||||
|
||||
deduplicate_events(own_events ++ giftwrap_events)
|
||||
end
|
||||
|
||||
defp event_ref(event) do
|
||||
%{
|
||||
created_at: Map.fetch!(event, "created_at"),
|
||||
id: Base.decode16!(Map.fetch!(event, "id"), case: :mixed)
|
||||
}
|
||||
end
|
||||
|
||||
defp append_unique_event_ref(event, {seen_ids, acc}) do
|
||||
reduce_unique_event(event, {seen_ids, acc}, fn _event_id, next_seen_ids ->
|
||||
{next_seen_ids, [event_ref(event) | acc]}
|
||||
end)
|
||||
end
|
||||
|
||||
defp count_unique_event(event, {seen_ids, acc}) do
|
||||
reduce_unique_event(event, {seen_ids, acc}, fn _event_id, next_seen_ids ->
|
||||
{next_seen_ids, acc + 1}
|
||||
end)
|
||||
end
|
||||
|
||||
defp reduce_unique_event(event, {seen_ids, acc}, fun) do
|
||||
event_id = Map.fetch!(event, "id")
|
||||
|
||||
if MapSet.member?(seen_ids, event_id) do
|
||||
{seen_ids, acc}
|
||||
else
|
||||
fun.(event_id, MapSet.put(seen_ids, event_id))
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_reduce_visible_event(event, filter, requester_pubkeys, acc, reducer) do
|
||||
if filter_match_visible?(event, filter, requester_pubkeys) do
|
||||
reducer.(event, acc)
|
||||
else
|
||||
acc
|
||||
end
|
||||
end
|
||||
|
||||
defp reduce_event_id_match(event_id, filter, requester_pubkeys, acc, reducer) do
|
||||
case Store.get_event(event_id) do
|
||||
{:ok, event, false} ->
|
||||
maybe_reduce_visible_event(event, filter, requester_pubkeys, acc, reducer)
|
||||
|
||||
_other ->
|
||||
acc
|
||||
end
|
||||
end
|
||||
|
||||
defp deduplicate_events(events) do
|
||||
events
|
||||
|> Enum.reduce(%{}, fn event, acc -> Map.put(acc, event["id"], event) end)
|
||||
|> Map.values()
|
||||
end
|
||||
|
||||
defp sort_events(events) do
|
||||
Enum.sort(events, &chronological_sorter/2)
|
||||
end
|
||||
|
||||
defp chronological_sorter(left, right) do
|
||||
cond do
|
||||
left["created_at"] > right["created_at"] -> true
|
||||
left["created_at"] < right["created_at"] -> false
|
||||
true -> left["id"] < right["id"]
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_apply_query_limit(events, opts) do
|
||||
case Keyword.get(opts, :limit) do
|
||||
limit when is_integer(limit) and limit > 0 -> Enum.take(events, limit)
|
||||
_other -> events
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_take_filter_limit(events, filter, opts) do
|
||||
case effective_filter_limit(filter, opts) do
|
||||
limit when is_integer(limit) and limit > 0 -> Enum.take(events, limit)
|
||||
_other -> events
|
||||
end
|
||||
end
|
||||
|
||||
defp effective_filter_limit(filter, opts) do
|
||||
max_filter_limit = Keyword.get(opts, :max_filter_limit)
|
||||
|
||||
case Map.get(filter, "limit") do
|
||||
limit
|
||||
when is_integer(limit) and limit > 0 and is_integer(max_filter_limit) and
|
||||
max_filter_limit > 0 ->
|
||||
min(limit, max_filter_limit)
|
||||
|
||||
limit when is_integer(limit) and limit > 0 ->
|
||||
limit
|
||||
|
||||
_other ->
|
||||
nil
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -4,10 +4,15 @@ defmodule Parrhesia.Storage.Adapters.Memory.Store do
|
||||
use Agent
|
||||
|
||||
@name __MODULE__
|
||||
@events_table :parrhesia_memory_events
|
||||
@events_by_time_table :parrhesia_memory_events_by_time
|
||||
@events_by_tag_table :parrhesia_memory_events_by_tag
|
||||
@events_by_pubkey_table :parrhesia_memory_events_by_pubkey
|
||||
@events_by_kind_table :parrhesia_memory_events_by_kind
|
||||
@events_by_pubkey_kind_table :parrhesia_memory_events_by_pubkey_kind
|
||||
@events_by_address_table :parrhesia_memory_events_by_address
|
||||
|
||||
@initial_state %{
|
||||
events: %{},
|
||||
deleted: MapSet.new(),
|
||||
bans: %{pubkeys: MapSet.new(), events: MapSet.new(), ips: MapSet.new()},
|
||||
allowed_pubkeys: MapSet.new(),
|
||||
acl_rules: [],
|
||||
@@ -17,34 +22,412 @@ defmodule Parrhesia.Storage.Adapters.Memory.Store do
|
||||
audit_logs: []
|
||||
}
|
||||
|
||||
def start_link(opts \\ []) do
|
||||
name = Keyword.get(opts, :name, @name)
|
||||
Agent.start_link(&init_state/0, name: name)
|
||||
end
|
||||
|
||||
def ensure_started do
|
||||
if Process.whereis(@name) do
|
||||
case Process.whereis(@name) do
|
||||
pid when is_pid(pid) -> :ok
|
||||
nil -> start_store()
|
||||
end
|
||||
end
|
||||
|
||||
def put_event(event_id, event) when is_binary(event_id) and is_map(event) do
|
||||
:ok = ensure_started()
|
||||
|
||||
if :ets.insert_new(@events_table, {event_id, event, false}) do
|
||||
true = :ets.insert(@events_by_time_table, {{sort_key(event), event_id}, event_id})
|
||||
index_event_tags(event_id, event)
|
||||
index_event_secondary_keys(event_id, event)
|
||||
:ok
|
||||
else
|
||||
start_store()
|
||||
{:error, :duplicate_event}
|
||||
end
|
||||
end
|
||||
|
||||
defp start_store do
|
||||
case Agent.start_link(fn -> @initial_state end, name: @name) do
|
||||
{:ok, _pid} -> :ok
|
||||
{:error, {:already_started, _pid}} -> :ok
|
||||
{:error, reason} -> {:error, reason}
|
||||
def get_event(event_id) when is_binary(event_id) do
|
||||
:ok = ensure_started()
|
||||
|
||||
case :ets.lookup(@events_table, event_id) do
|
||||
[{^event_id, event, deleted?}] -> {:ok, event, deleted?}
|
||||
[] -> :error
|
||||
end
|
||||
end
|
||||
|
||||
def mark_deleted(event_id) when is_binary(event_id) do
|
||||
:ok = ensure_started()
|
||||
|
||||
case lookup_event(event_id) do
|
||||
{:ok, event, false} ->
|
||||
true = :ets.insert(@events_table, {event_id, event, true})
|
||||
true = :ets.delete(@events_by_time_table, {sort_key(event), event_id})
|
||||
unindex_event_tags(event_id, event)
|
||||
unindex_event_secondary_keys(event_id, event)
|
||||
:ok
|
||||
|
||||
{:ok, _event, true} ->
|
||||
:ok
|
||||
|
||||
:error ->
|
||||
:ok
|
||||
end
|
||||
end
|
||||
|
||||
def reduce_events(acc, fun) when is_function(fun, 2) do
|
||||
:ok = ensure_started()
|
||||
|
||||
:ets.foldl(
|
||||
fn {_event_id, event, deleted?}, current_acc ->
|
||||
if deleted? do
|
||||
current_acc
|
||||
else
|
||||
fun.(event, current_acc)
|
||||
end
|
||||
end,
|
||||
acc,
|
||||
@events_table
|
||||
)
|
||||
end
|
||||
|
||||
def reduce_events_newest(acc, fun) when is_function(fun, 2) do
|
||||
:ok = ensure_started()
|
||||
reduce_events_newest_from(:ets.first(@events_by_time_table), acc, fun)
|
||||
end
|
||||
|
||||
def tagged_events(tag_name, tag_values) when is_binary(tag_name) and is_list(tag_values) do
|
||||
:ok = ensure_started()
|
||||
|
||||
tag_values
|
||||
|> Enum.flat_map(&indexed_events_for_value(@events_by_tag_table, {tag_name, &1}))
|
||||
|> sort_and_deduplicate_events()
|
||||
end
|
||||
|
||||
def events_by_pubkeys(pubkeys) when is_list(pubkeys) do
|
||||
:ok = ensure_started()
|
||||
|
||||
pubkeys
|
||||
|> Enum.flat_map(&indexed_events_for_value(@events_by_pubkey_table, &1))
|
||||
|> sort_and_deduplicate_events()
|
||||
end
|
||||
|
||||
def events_by_kinds(kinds) when is_list(kinds) do
|
||||
:ok = ensure_started()
|
||||
|
||||
kinds
|
||||
|> Enum.flat_map(&indexed_events_for_value(@events_by_kind_table, &1))
|
||||
|> sort_and_deduplicate_events()
|
||||
end
|
||||
|
||||
def events_by_pubkeys_and_kinds(pubkeys, kinds) when is_list(pubkeys) and is_list(kinds) do
|
||||
:ok = ensure_started()
|
||||
|
||||
pubkeys
|
||||
|> Enum.flat_map(fn pubkey ->
|
||||
kinds
|
||||
|> Enum.flat_map(&indexed_events_for_value(@events_by_pubkey_kind_table, {pubkey, &1}))
|
||||
end)
|
||||
|> sort_and_deduplicate_events()
|
||||
end
|
||||
|
||||
def events_by_addresses(addresses) when is_list(addresses) do
|
||||
:ok = ensure_started()
|
||||
|
||||
addresses
|
||||
|> Enum.flat_map(&indexed_events_for_value(@events_by_address_table, &1))
|
||||
|> sort_and_deduplicate_events()
|
||||
end
|
||||
|
||||
defp reduce_events_newest_from(:"$end_of_table", acc, _fun), do: acc
|
||||
|
||||
defp reduce_events_newest_from(key, acc, fun) do
|
||||
next_key = :ets.next(@events_by_time_table, key)
|
||||
acc = reduce_indexed_event(key, acc, fun)
|
||||
|
||||
case acc do
|
||||
{:halt, final_acc} -> final_acc
|
||||
next_acc -> reduce_events_newest_from(next_key, next_acc, fun)
|
||||
end
|
||||
end
|
||||
|
||||
defp reduce_indexed_event(key, acc, fun) do
|
||||
case :ets.lookup(@events_by_time_table, key) do
|
||||
[{^key, event_id}] -> apply_reduce_fun(event_id, acc, fun)
|
||||
[] -> acc
|
||||
end
|
||||
end
|
||||
|
||||
defp apply_reduce_fun(event_id, acc, fun) do
|
||||
case lookup_event(event_id) do
|
||||
{:ok, event, false} -> normalize_reduce_result(fun.(event, acc))
|
||||
_other -> acc
|
||||
end
|
||||
end
|
||||
|
||||
defp normalize_reduce_result({:halt, next_acc}), do: {:halt, next_acc}
|
||||
defp normalize_reduce_result(next_acc), do: next_acc
|
||||
|
||||
def get(fun) do
|
||||
:ok = ensure_started()
|
||||
Agent.get(@name, fun)
|
||||
with_store(fn pid -> Agent.get(pid, fun) end)
|
||||
end
|
||||
|
||||
def update(fun) do
|
||||
:ok = ensure_started()
|
||||
Agent.update(@name, fun)
|
||||
with_store(fn pid -> Agent.update(pid, fun) end)
|
||||
end
|
||||
|
||||
def get_and_update(fun) do
|
||||
:ok = ensure_started()
|
||||
Agent.get_and_update(@name, fun)
|
||||
with_store(fn pid -> Agent.get_and_update(pid, fun) end)
|
||||
end
|
||||
|
||||
defp start_store do
|
||||
case start_link() do
|
||||
{:ok, _pid} ->
|
||||
:ok
|
||||
|
||||
{:error, {:already_started, pid}} ->
|
||||
if Process.alive?(pid) do
|
||||
:ok
|
||||
else
|
||||
wait_for_store_exit(pid)
|
||||
end
|
||||
|
||||
{:error, reason} ->
|
||||
{:error, reason}
|
||||
end
|
||||
end
|
||||
|
||||
defp with_store(fun, attempts \\ 2)
|
||||
|
||||
defp with_store(fun, attempts) when attempts > 0 do
|
||||
:ok = ensure_started()
|
||||
|
||||
case Process.whereis(@name) do
|
||||
pid when is_pid(pid) ->
|
||||
try do
|
||||
fun.(pid)
|
||||
catch
|
||||
:exit, reason ->
|
||||
if noproc_exit?(reason) and attempts > 1 do
|
||||
with_store(fun, attempts - 1)
|
||||
else
|
||||
exit(reason)
|
||||
end
|
||||
end
|
||||
|
||||
nil ->
|
||||
with_store(fun, attempts - 1)
|
||||
end
|
||||
end
|
||||
|
||||
defp with_store(_fun, 0), do: exit(:noproc)
|
||||
|
||||
defp wait_for_store_exit(pid) do
|
||||
ref = Process.monitor(pid)
|
||||
|
||||
receive do
|
||||
{:DOWN, ^ref, :process, ^pid, _reason} -> start_store()
|
||||
after
|
||||
100 -> start_store()
|
||||
end
|
||||
end
|
||||
|
||||
defp noproc_exit?({:noproc, _details}), do: true
|
||||
defp noproc_exit?(_reason), do: false
|
||||
|
||||
defp init_state do
|
||||
ensure_tables_started()
|
||||
|
||||
@initial_state
|
||||
end
|
||||
|
||||
defp ensure_tables_started do
|
||||
ensure_table(@events_table, [
|
||||
:named_table,
|
||||
:public,
|
||||
:set,
|
||||
read_concurrency: true,
|
||||
write_concurrency: true
|
||||
])
|
||||
|
||||
ensure_table(@events_by_time_table, [
|
||||
:named_table,
|
||||
:public,
|
||||
:ordered_set,
|
||||
read_concurrency: true,
|
||||
write_concurrency: true
|
||||
])
|
||||
|
||||
ensure_table(@events_by_tag_table, [
|
||||
:named_table,
|
||||
:public,
|
||||
:bag,
|
||||
read_concurrency: true,
|
||||
write_concurrency: true
|
||||
])
|
||||
|
||||
ensure_table(@events_by_pubkey_table, [
|
||||
:named_table,
|
||||
:public,
|
||||
:bag,
|
||||
read_concurrency: true,
|
||||
write_concurrency: true
|
||||
])
|
||||
|
||||
ensure_table(@events_by_kind_table, [
|
||||
:named_table,
|
||||
:public,
|
||||
:bag,
|
||||
read_concurrency: true,
|
||||
write_concurrency: true
|
||||
])
|
||||
|
||||
ensure_table(@events_by_pubkey_kind_table, [
|
||||
:named_table,
|
||||
:public,
|
||||
:bag,
|
||||
read_concurrency: true,
|
||||
write_concurrency: true
|
||||
])
|
||||
|
||||
ensure_table(@events_by_address_table, [
|
||||
:named_table,
|
||||
:public,
|
||||
:bag,
|
||||
read_concurrency: true,
|
||||
write_concurrency: true
|
||||
])
|
||||
end
|
||||
|
||||
defp ensure_table(name, options) do
|
||||
case :ets.whereis(name) do
|
||||
:undefined -> :ets.new(name, options)
|
||||
_table -> :ok
|
||||
end
|
||||
end
|
||||
|
||||
defp lookup_event(event_id) do
|
||||
case :ets.lookup(@events_table, event_id) do
|
||||
[{^event_id, event, deleted?}] -> {:ok, event, deleted?}
|
||||
[] -> :error
|
||||
end
|
||||
end
|
||||
|
||||
defp index_event_tags(event_id, event) do
|
||||
event
|
||||
|> event_tag_index_entries(event_id)
|
||||
|> Enum.each(fn entry ->
|
||||
true = :ets.insert(@events_by_tag_table, entry)
|
||||
end)
|
||||
end
|
||||
|
||||
defp index_event_secondary_keys(event_id, event) do
|
||||
event
|
||||
|> secondary_index_entries(event_id)
|
||||
|> Enum.each(fn {table, entry} ->
|
||||
true = :ets.insert(table, entry)
|
||||
end)
|
||||
end
|
||||
|
||||
defp unindex_event_tags(event_id, event) do
|
||||
event
|
||||
|> event_tag_index_entries(event_id)
|
||||
|> Enum.each(&:ets.delete_object(@events_by_tag_table, &1))
|
||||
end
|
||||
|
||||
defp unindex_event_secondary_keys(event_id, event) do
|
||||
event
|
||||
|> secondary_index_entries(event_id)
|
||||
|> Enum.each(fn {table, entry} ->
|
||||
:ets.delete_object(table, entry)
|
||||
end)
|
||||
end
|
||||
|
||||
defp event_tag_index_entries(event, event_id) do
|
||||
created_sort_key = sort_key(event)
|
||||
|
||||
event
|
||||
|> Map.get("tags", [])
|
||||
|> Enum.flat_map(fn
|
||||
[tag_name, tag_value | _rest] when is_binary(tag_name) and is_binary(tag_value) ->
|
||||
[{{tag_name, tag_value}, created_sort_key, event_id}]
|
||||
|
||||
_tag ->
|
||||
[]
|
||||
end)
|
||||
end
|
||||
|
||||
defp secondary_index_entries(event, event_id) do
|
||||
created_sort_key = sort_key(event)
|
||||
pubkey = Map.get(event, "pubkey")
|
||||
kind = Map.get(event, "kind")
|
||||
|
||||
[]
|
||||
|> maybe_put_secondary_entry(@events_by_pubkey_table, pubkey, created_sort_key, event_id)
|
||||
|> maybe_put_secondary_entry(@events_by_kind_table, kind, created_sort_key, event_id)
|
||||
|> maybe_put_pubkey_kind_entry(pubkey, kind, created_sort_key, event_id)
|
||||
|> maybe_put_address_entry(event, pubkey, kind, event_id)
|
||||
end
|
||||
|
||||
defp maybe_put_secondary_entry(entries, _table, key, _created_sort_key, _event_id)
|
||||
when is_nil(key),
|
||||
do: entries
|
||||
|
||||
defp maybe_put_secondary_entry(entries, table, key, created_sort_key, event_id) do
|
||||
[{table, {key, created_sort_key, event_id}} | entries]
|
||||
end
|
||||
|
||||
defp maybe_put_pubkey_kind_entry(entries, pubkey, kind, created_sort_key, event_id)
|
||||
when is_binary(pubkey) and is_integer(kind) do
|
||||
[{@events_by_pubkey_kind_table, {{pubkey, kind}, created_sort_key, event_id}} | entries]
|
||||
end
|
||||
|
||||
defp maybe_put_pubkey_kind_entry(entries, _pubkey, _kind, _created_sort_key, _event_id),
|
||||
do: entries
|
||||
|
||||
defp maybe_put_address_entry(entries, event, pubkey, kind, event_id)
|
||||
when is_binary(pubkey) and is_integer(kind) and kind >= 30_000 and kind < 40_000 do
|
||||
d_tag =
|
||||
event
|
||||
|> Map.get("tags", [])
|
||||
|> Enum.find_value("", fn
|
||||
["d", value | _rest] -> value
|
||||
_tag -> nil
|
||||
end)
|
||||
|
||||
[{@events_by_address_table, {{kind, pubkey, d_tag}, sort_key(event), event_id}} | entries]
|
||||
end
|
||||
|
||||
defp maybe_put_address_entry(entries, _event, _pubkey, _kind, _event_id), do: entries
|
||||
|
||||
defp indexed_events_for_value(_table, value)
|
||||
when not is_binary(value) and not is_integer(value) and not is_tuple(value),
|
||||
do: []
|
||||
|
||||
defp indexed_events_for_value(table, value) do
|
||||
table
|
||||
|> :ets.lookup(value)
|
||||
|> Enum.reduce([], fn {^value, _created_sort_key, event_id}, acc ->
|
||||
case lookup_event(event_id) do
|
||||
{:ok, event, false} -> [event | acc]
|
||||
_other -> acc
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
defp sort_and_deduplicate_events(events) do
|
||||
events
|
||||
|> Enum.uniq_by(& &1["id"])
|
||||
|> Enum.sort(&chronological_sorter/2)
|
||||
end
|
||||
|
||||
defp chronological_sorter(left, right) do
|
||||
cond do
|
||||
left["created_at"] > right["created_at"] -> true
|
||||
left["created_at"] < right["created_at"] -> false
|
||||
true -> left["id"] < right["id"]
|
||||
end
|
||||
end
|
||||
|
||||
defp sort_key(event), do: -Map.get(event, "created_at", 0)
|
||||
end
|
||||
|
||||
@@ -5,6 +5,7 @@ defmodule Parrhesia.Storage.Adapters.Postgres.ACL do
|
||||
|
||||
import Ecto.Query
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
alias Parrhesia.Repo
|
||||
|
||||
@behaviour Parrhesia.Storage.ACL
|
||||
@@ -74,7 +75,8 @@ defmodule Parrhesia.Storage.Adapters.Postgres.ACL do
|
||||
|> maybe_filter_principal(Keyword.get(opts, :principal))
|
||||
|> maybe_filter_capability(Keyword.get(opts, :capability))
|
||||
|
||||
{:ok, Enum.map(Repo.all(query), &normalize_persisted_rule/1)}
|
||||
repo = read_repo()
|
||||
{:ok, Enum.map(repo.all(query), &normalize_persisted_rule/1)}
|
||||
end
|
||||
|
||||
def list_rules(_context, _opts), do: {:error, :invalid_opts}
|
||||
@@ -133,12 +135,16 @@ defmodule Parrhesia.Storage.Adapters.Postgres.ACL do
|
||||
}
|
||||
)
|
||||
|
||||
case Repo.one(query) do
|
||||
repo = read_repo()
|
||||
|
||||
case repo.one(query) do
|
||||
nil -> nil
|
||||
stored_rule -> normalize_persisted_rule(stored_rule)
|
||||
end
|
||||
end
|
||||
|
||||
defp read_repo, do: PostgresRepos.read()
|
||||
|
||||
defp insert_rule(normalized_rule) do
|
||||
now = DateTime.utc_now() |> DateTime.truncate(:microsecond)
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Admin do
|
||||
|
||||
import Ecto.Query
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
alias Parrhesia.Repo
|
||||
|
||||
@behaviour Parrhesia.Storage.Admin
|
||||
@@ -73,8 +74,8 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Admin do
|
||||
|> maybe_filter_actor_pubkey(Keyword.get(opts, :actor_pubkey))
|
||||
|
||||
logs =
|
||||
query
|
||||
|> Repo.all()
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.all(query) end)
|
||||
|> Enum.map(&to_audit_log_map/1)
|
||||
|
||||
{:ok, logs}
|
||||
@@ -83,11 +84,12 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Admin do
|
||||
def list_audit_logs(_context, _opts), do: {:error, :invalid_opts}
|
||||
|
||||
defp relay_stats do
|
||||
events_count = Repo.aggregate("events", :count, :id)
|
||||
banned_pubkeys = Repo.aggregate("banned_pubkeys", :count, :pubkey)
|
||||
allowed_pubkeys = Repo.aggregate("allowed_pubkeys", :count, :pubkey)
|
||||
blocked_ips = Repo.aggregate("blocked_ips", :count, :ip)
|
||||
acl_rules = Repo.aggregate("acl_rules", :count, :id)
|
||||
repo = read_repo()
|
||||
events_count = repo.aggregate("events", :count, :id)
|
||||
banned_pubkeys = repo.aggregate("banned_pubkeys", :count, :pubkey)
|
||||
allowed_pubkeys = repo.aggregate("allowed_pubkeys", :count, :pubkey)
|
||||
blocked_ips = repo.aggregate("blocked_ips", :count, :ip)
|
||||
acl_rules = repo.aggregate("acl_rules", :count, :id)
|
||||
|
||||
%{
|
||||
"events" => events_count,
|
||||
@@ -234,6 +236,8 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Admin do
|
||||
|
||||
defp normalize_pubkey(_value), do: {:error, :invalid_actor_pubkey}
|
||||
|
||||
defp read_repo, do: PostgresRepos.read()
|
||||
|
||||
defp invalid_key_reason(:params), do: :invalid_params
|
||||
defp invalid_key_reason(:result), do: :invalid_result
|
||||
|
||||
|
||||
@@ -5,10 +5,16 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
|
||||
import Ecto.Query
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
alias Parrhesia.Protocol.Filter
|
||||
alias Parrhesia.Repo
|
||||
|
||||
@behaviour Parrhesia.Storage.Events
|
||||
@trigram_fallback_max_single_term_length 4
|
||||
@trigram_fallback_pattern ~r/[^\p{L}\p{N}\s"]/u
|
||||
@fts_match_fragment "to_tsvector('simple', ?) @@ websearch_to_tsquery('simple', ?)"
|
||||
@fts_rank_fragment "ts_rank_cd(to_tsvector('simple', ?), websearch_to_tsquery('simple', ?))"
|
||||
@trigram_rank_fragment "word_similarity(lower(?), lower(?))"
|
||||
|
||||
@type normalized_event :: %{
|
||||
id: binary(),
|
||||
@@ -62,7 +68,9 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
}
|
||||
)
|
||||
|
||||
case Repo.one(event_query) do
|
||||
repo = read_repo()
|
||||
|
||||
case repo.one(event_query) do
|
||||
nil ->
|
||||
{:ok, nil}
|
||||
|
||||
@@ -76,16 +84,17 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
def query(_context, filters, opts) when is_list(opts) do
|
||||
with :ok <- Filter.validate_filters(filters) do
|
||||
now = Keyword.get(opts, :now, System.system_time(:second))
|
||||
repo = read_repo()
|
||||
|
||||
persisted_events =
|
||||
filters
|
||||
|> Enum.flat_map(fn filter ->
|
||||
filter
|
||||
|> event_query_for_filter(now, opts)
|
||||
|> Repo.all()
|
||||
|> repo.all()
|
||||
end)
|
||||
|> deduplicate_events()
|
||||
|> sort_persisted_events()
|
||||
|> sort_persisted_events(filters)
|
||||
|> maybe_apply_query_limit(opts)
|
||||
|
||||
{:ok, Enum.map(persisted_events, &to_nostr_event/1)}
|
||||
@@ -360,30 +369,7 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
|
||||
defp maybe_upsert_replaceable_state(normalized_event, now, deleted_at) do
|
||||
if replaceable_kind?(normalized_event.kind) do
|
||||
lookup_query =
|
||||
from(state in "replaceable_event_state",
|
||||
where:
|
||||
state.pubkey == ^normalized_event.pubkey and state.kind == ^normalized_event.kind,
|
||||
select: %{event_created_at: state.event_created_at, event_id: state.event_id}
|
||||
)
|
||||
|
||||
update_query =
|
||||
from(state in "replaceable_event_state",
|
||||
where:
|
||||
state.pubkey == ^normalized_event.pubkey and
|
||||
state.kind == ^normalized_event.kind
|
||||
)
|
||||
|
||||
upsert_state_table(
|
||||
"replaceable_event_state",
|
||||
lookup_query,
|
||||
update_query,
|
||||
replaceable_state_row(normalized_event, now),
|
||||
normalized_event,
|
||||
now,
|
||||
deleted_at,
|
||||
:replaceable_state_update_failed
|
||||
)
|
||||
upsert_replaceable_state_table(normalized_event, now, deleted_at)
|
||||
else
|
||||
:ok
|
||||
end
|
||||
@@ -391,159 +377,94 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
|
||||
defp maybe_upsert_addressable_state(normalized_event, now, deleted_at) do
|
||||
if addressable_kind?(normalized_event.kind) do
|
||||
lookup_query =
|
||||
from(state in "addressable_event_state",
|
||||
where:
|
||||
state.pubkey == ^normalized_event.pubkey and
|
||||
state.kind == ^normalized_event.kind and
|
||||
state.d_tag == ^normalized_event.d_tag,
|
||||
select: %{event_created_at: state.event_created_at, event_id: state.event_id}
|
||||
)
|
||||
|
||||
update_query =
|
||||
from(state in "addressable_event_state",
|
||||
where:
|
||||
state.pubkey == ^normalized_event.pubkey and
|
||||
state.kind == ^normalized_event.kind and
|
||||
state.d_tag == ^normalized_event.d_tag
|
||||
)
|
||||
|
||||
upsert_state_table(
|
||||
"addressable_event_state",
|
||||
lookup_query,
|
||||
update_query,
|
||||
addressable_state_row(normalized_event, now),
|
||||
normalized_event,
|
||||
now,
|
||||
deleted_at,
|
||||
:addressable_state_update_failed
|
||||
)
|
||||
upsert_addressable_state_table(normalized_event, now, deleted_at)
|
||||
else
|
||||
:ok
|
||||
end
|
||||
end
|
||||
|
||||
defp upsert_state_table(
|
||||
table_name,
|
||||
lookup_query,
|
||||
update_query,
|
||||
insert_row,
|
||||
normalized_event,
|
||||
now,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
) do
|
||||
case Repo.one(lookup_query) do
|
||||
nil ->
|
||||
insert_state_or_resolve_race(
|
||||
table_name,
|
||||
lookup_query,
|
||||
update_query,
|
||||
insert_row,
|
||||
normalized_event,
|
||||
now,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
)
|
||||
defp upsert_replaceable_state_table(normalized_event, now, deleted_at) do
|
||||
params = [
|
||||
normalized_event.pubkey,
|
||||
normalized_event.kind,
|
||||
normalized_event.created_at,
|
||||
normalized_event.id,
|
||||
now,
|
||||
now
|
||||
]
|
||||
|
||||
current_state ->
|
||||
maybe_update_state(
|
||||
update_query,
|
||||
normalized_event,
|
||||
current_state,
|
||||
now,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
)
|
||||
case Repo.query(replaceable_state_upsert_sql(), params) do
|
||||
{:ok, %{rows: [row]}} ->
|
||||
finalize_state_upsert(row, normalized_event, deleted_at, :replaceable_state_update_failed)
|
||||
|
||||
{:ok, _result} ->
|
||||
Repo.rollback(:replaceable_state_update_failed)
|
||||
|
||||
{:error, _reason} ->
|
||||
Repo.rollback(:replaceable_state_update_failed)
|
||||
end
|
||||
end
|
||||
|
||||
defp insert_state_or_resolve_race(
|
||||
table_name,
|
||||
lookup_query,
|
||||
update_query,
|
||||
insert_row,
|
||||
defp upsert_addressable_state_table(normalized_event, now, deleted_at) do
|
||||
params = [
|
||||
normalized_event.pubkey,
|
||||
normalized_event.kind,
|
||||
normalized_event.d_tag,
|
||||
normalized_event.created_at,
|
||||
normalized_event.id,
|
||||
now,
|
||||
now
|
||||
]
|
||||
|
||||
case Repo.query(addressable_state_upsert_sql(), params) do
|
||||
{:ok, %{rows: [row]}} ->
|
||||
finalize_state_upsert(row, normalized_event, deleted_at, :addressable_state_update_failed)
|
||||
|
||||
{:ok, _result} ->
|
||||
Repo.rollback(:addressable_state_update_failed)
|
||||
|
||||
{:error, _reason} ->
|
||||
Repo.rollback(:addressable_state_update_failed)
|
||||
end
|
||||
end
|
||||
|
||||
defp finalize_state_upsert(
|
||||
[retired_event_created_at, retired_event_id, winner_event_created_at, winner_event_id],
|
||||
normalized_event,
|
||||
now,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
) do
|
||||
case Repo.insert_all(table_name, [insert_row], on_conflict: :nothing) do
|
||||
{1, _result} ->
|
||||
:ok
|
||||
|
||||
{0, _result} ->
|
||||
resolve_state_race(
|
||||
lookup_query,
|
||||
update_query,
|
||||
normalized_event,
|
||||
now,
|
||||
case {winner_event_created_at, winner_event_id} do
|
||||
{created_at, event_id}
|
||||
when created_at == normalized_event.created_at and event_id == normalized_event.id ->
|
||||
maybe_retire_previous_state_event(
|
||||
retired_event_created_at,
|
||||
retired_event_id,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
)
|
||||
|
||||
{_inserted, _result} ->
|
||||
Repo.rollback(failure_reason)
|
||||
end
|
||||
end
|
||||
|
||||
defp resolve_state_race(
|
||||
lookup_query,
|
||||
update_query,
|
||||
normalized_event,
|
||||
now,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
) do
|
||||
case Repo.one(lookup_query) do
|
||||
nil ->
|
||||
Repo.rollback(failure_reason)
|
||||
|
||||
current_state ->
|
||||
maybe_update_state(
|
||||
update_query,
|
||||
normalized_event,
|
||||
current_state,
|
||||
now,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_update_state(
|
||||
update_query,
|
||||
normalized_event,
|
||||
current_state,
|
||||
now,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
) do
|
||||
if candidate_wins_state?(normalized_event, current_state) do
|
||||
{updated, _result} =
|
||||
Repo.update_all(update_query,
|
||||
set: [
|
||||
event_created_at: normalized_event.created_at,
|
||||
event_id: normalized_event.id,
|
||||
updated_at: now
|
||||
]
|
||||
)
|
||||
|
||||
if updated == 1 do
|
||||
{_created_at, _event_id} ->
|
||||
retire_event!(
|
||||
current_state.event_created_at,
|
||||
current_state.event_id,
|
||||
normalized_event.created_at,
|
||||
normalized_event.id,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
)
|
||||
else
|
||||
Repo.rollback(failure_reason)
|
||||
end
|
||||
else
|
||||
retire_event!(normalized_event.created_at, normalized_event.id, deleted_at, failure_reason)
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_retire_previous_state_event(nil, nil, _deleted_at, _failure_reason), do: :ok
|
||||
|
||||
defp maybe_retire_previous_state_event(
|
||||
retired_event_created_at,
|
||||
retired_event_id,
|
||||
deleted_at,
|
||||
failure_reason
|
||||
) do
|
||||
retire_event!(retired_event_created_at, retired_event_id, deleted_at, failure_reason)
|
||||
end
|
||||
|
||||
defp retire_event!(event_created_at, event_id, deleted_at, failure_reason) do
|
||||
{updated, _result} =
|
||||
Repo.update_all(
|
||||
@@ -567,27 +488,147 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
|
||||
defp addressable_kind?(kind), do: kind >= 30_000 and kind < 40_000
|
||||
|
||||
defp replaceable_state_row(normalized_event, now) do
|
||||
%{
|
||||
pubkey: normalized_event.pubkey,
|
||||
kind: normalized_event.kind,
|
||||
event_created_at: normalized_event.created_at,
|
||||
event_id: normalized_event.id,
|
||||
inserted_at: now,
|
||||
updated_at: now
|
||||
}
|
||||
defp replaceable_state_upsert_sql do
|
||||
"""
|
||||
WITH inserted AS (
|
||||
INSERT INTO replaceable_event_state (
|
||||
pubkey,
|
||||
kind,
|
||||
event_created_at,
|
||||
event_id,
|
||||
inserted_at,
|
||||
updated_at
|
||||
)
|
||||
VALUES ($1, $2, $3, $4, $5, $6)
|
||||
ON CONFLICT (pubkey, kind) DO NOTHING
|
||||
RETURNING
|
||||
NULL::bigint AS retired_event_created_at,
|
||||
NULL::bytea AS retired_event_id,
|
||||
event_created_at AS winner_event_created_at,
|
||||
event_id AS winner_event_id
|
||||
),
|
||||
updated AS (
|
||||
UPDATE replaceable_event_state AS state
|
||||
SET
|
||||
event_created_at = $3,
|
||||
event_id = $4,
|
||||
updated_at = $6
|
||||
FROM (
|
||||
SELECT current.event_created_at, current.event_id
|
||||
FROM replaceable_event_state AS current
|
||||
WHERE current.pubkey = $1 AND current.kind = $2
|
||||
FOR UPDATE
|
||||
) AS previous
|
||||
WHERE
|
||||
NOT EXISTS (SELECT 1 FROM inserted)
|
||||
AND state.pubkey = $1
|
||||
AND state.kind = $2
|
||||
AND (
|
||||
state.event_created_at < $3
|
||||
OR (state.event_created_at = $3 AND state.event_id > $4)
|
||||
)
|
||||
RETURNING
|
||||
previous.event_created_at AS retired_event_created_at,
|
||||
previous.event_id AS retired_event_id,
|
||||
state.event_created_at AS winner_event_created_at,
|
||||
state.event_id AS winner_event_id
|
||||
),
|
||||
current AS (
|
||||
SELECT
|
||||
NULL::bigint AS retired_event_created_at,
|
||||
NULL::bytea AS retired_event_id,
|
||||
state.event_created_at AS winner_event_created_at,
|
||||
state.event_id AS winner_event_id
|
||||
FROM replaceable_event_state AS state
|
||||
WHERE
|
||||
NOT EXISTS (SELECT 1 FROM inserted)
|
||||
AND NOT EXISTS (SELECT 1 FROM updated)
|
||||
AND state.pubkey = $1
|
||||
AND state.kind = $2
|
||||
)
|
||||
SELECT *
|
||||
FROM inserted
|
||||
UNION ALL
|
||||
SELECT *
|
||||
FROM updated
|
||||
UNION ALL
|
||||
SELECT *
|
||||
FROM current
|
||||
LIMIT 1
|
||||
"""
|
||||
end
|
||||
|
||||
defp addressable_state_row(normalized_event, now) do
|
||||
%{
|
||||
pubkey: normalized_event.pubkey,
|
||||
kind: normalized_event.kind,
|
||||
d_tag: normalized_event.d_tag,
|
||||
event_created_at: normalized_event.created_at,
|
||||
event_id: normalized_event.id,
|
||||
inserted_at: now,
|
||||
updated_at: now
|
||||
}
|
||||
defp addressable_state_upsert_sql do
|
||||
"""
|
||||
WITH inserted AS (
|
||||
INSERT INTO addressable_event_state (
|
||||
pubkey,
|
||||
kind,
|
||||
d_tag,
|
||||
event_created_at,
|
||||
event_id,
|
||||
inserted_at,
|
||||
updated_at
|
||||
)
|
||||
VALUES ($1, $2, $3, $4, $5, $6, $7)
|
||||
ON CONFLICT (pubkey, kind, d_tag) DO NOTHING
|
||||
RETURNING
|
||||
NULL::bigint AS retired_event_created_at,
|
||||
NULL::bytea AS retired_event_id,
|
||||
event_created_at AS winner_event_created_at,
|
||||
event_id AS winner_event_id
|
||||
),
|
||||
updated AS (
|
||||
UPDATE addressable_event_state AS state
|
||||
SET
|
||||
event_created_at = $4,
|
||||
event_id = $5,
|
||||
updated_at = $7
|
||||
FROM (
|
||||
SELECT current.event_created_at, current.event_id
|
||||
FROM addressable_event_state AS current
|
||||
WHERE current.pubkey = $1 AND current.kind = $2 AND current.d_tag = $3
|
||||
FOR UPDATE
|
||||
) AS previous
|
||||
WHERE
|
||||
NOT EXISTS (SELECT 1 FROM inserted)
|
||||
AND state.pubkey = $1
|
||||
AND state.kind = $2
|
||||
AND state.d_tag = $3
|
||||
AND (
|
||||
state.event_created_at < $4
|
||||
OR (state.event_created_at = $4 AND state.event_id > $5)
|
||||
)
|
||||
RETURNING
|
||||
previous.event_created_at AS retired_event_created_at,
|
||||
previous.event_id AS retired_event_id,
|
||||
state.event_created_at AS winner_event_created_at,
|
||||
state.event_id AS winner_event_id
|
||||
),
|
||||
current AS (
|
||||
SELECT
|
||||
NULL::bigint AS retired_event_created_at,
|
||||
NULL::bytea AS retired_event_id,
|
||||
state.event_created_at AS winner_event_created_at,
|
||||
state.event_id AS winner_event_id
|
||||
FROM addressable_event_state AS state
|
||||
WHERE
|
||||
NOT EXISTS (SELECT 1 FROM inserted)
|
||||
AND NOT EXISTS (SELECT 1 FROM updated)
|
||||
AND state.pubkey = $1
|
||||
AND state.kind = $2
|
||||
AND state.d_tag = $3
|
||||
)
|
||||
SELECT *
|
||||
FROM inserted
|
||||
UNION ALL
|
||||
SELECT *
|
||||
FROM updated
|
||||
UNION ALL
|
||||
SELECT *
|
||||
FROM current
|
||||
LIMIT 1
|
||||
"""
|
||||
end
|
||||
|
||||
defp event_row(normalized_event, now) do
|
||||
@@ -607,11 +648,12 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
end
|
||||
|
||||
defp event_query_for_filter(filter, now, opts) do
|
||||
search_plan = search_plan(Map.get(filter, "search"))
|
||||
{base_query, remaining_tag_filters} = event_source_query(filter, now)
|
||||
|
||||
base_query
|
||||
|> apply_common_event_filters(filter, remaining_tag_filters, opts)
|
||||
|> order_by([event: event], desc: event.created_at, asc: event.id)
|
||||
|> apply_common_event_filters(filter, remaining_tag_filters, opts, search_plan)
|
||||
|> maybe_order_by_search_rank(search_plan)
|
||||
|> select([event: event], %{
|
||||
id: event.id,
|
||||
pubkey: event.pubkey,
|
||||
@@ -621,14 +663,16 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
content: event.content,
|
||||
sig: event.sig
|
||||
})
|
||||
|> maybe_select_search_score(search_plan)
|
||||
|> maybe_limit_query(effective_filter_limit(filter, opts))
|
||||
end
|
||||
|
||||
defp event_id_query_for_filter(filter, now, opts) do
|
||||
search_plan = search_plan(Map.get(filter, "search"))
|
||||
{base_query, remaining_tag_filters} = event_source_query(filter, now)
|
||||
|
||||
base_query
|
||||
|> apply_common_event_filters(filter, remaining_tag_filters, opts)
|
||||
|> apply_common_event_filters(filter, remaining_tag_filters, opts, search_plan)
|
||||
|> select([event: event], event.id)
|
||||
end
|
||||
|
||||
@@ -647,10 +691,11 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
end
|
||||
|
||||
defp event_ref_query_for_filter(filter, now, opts) do
|
||||
search_plan = search_plan(Map.get(filter, "search"))
|
||||
{base_query, remaining_tag_filters} = event_source_query(filter, now)
|
||||
|
||||
base_query
|
||||
|> apply_common_event_filters(filter, remaining_tag_filters, opts)
|
||||
|> apply_common_event_filters(filter, remaining_tag_filters, opts, search_plan)
|
||||
|> order_by([event: event], asc: event.created_at, asc: event.id)
|
||||
|> select([event: event], %{
|
||||
created_at: event.created_at,
|
||||
@@ -674,45 +719,57 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
end
|
||||
|
||||
defp fetch_event_refs([filter], now, opts) do
|
||||
filter
|
||||
|> event_ref_query_for_filter(now, opts)
|
||||
|> maybe_limit_query(Keyword.get(opts, :limit))
|
||||
|> Repo.all()
|
||||
query =
|
||||
filter
|
||||
|> event_ref_query_for_filter(now, opts)
|
||||
|> maybe_limit_query(Keyword.get(opts, :limit))
|
||||
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.all(query) end)
|
||||
end
|
||||
|
||||
defp fetch_event_refs(filters, now, opts) do
|
||||
filters
|
||||
|> event_ref_union_query_for_filters(now, opts)
|
||||
|> subquery()
|
||||
|> then(fn union_query ->
|
||||
from(ref in union_query,
|
||||
group_by: [ref.created_at, ref.id],
|
||||
order_by: [asc: ref.created_at, asc: ref.id],
|
||||
select: %{created_at: ref.created_at, id: ref.id}
|
||||
)
|
||||
end)
|
||||
|> maybe_limit_query(Keyword.get(opts, :limit))
|
||||
|> Repo.all()
|
||||
query =
|
||||
filters
|
||||
|> event_ref_union_query_for_filters(now, opts)
|
||||
|> subquery()
|
||||
|> then(fn union_query ->
|
||||
from(ref in union_query,
|
||||
group_by: [ref.created_at, ref.id],
|
||||
order_by: [asc: ref.created_at, asc: ref.id],
|
||||
select: %{created_at: ref.created_at, id: ref.id}
|
||||
)
|
||||
end)
|
||||
|> maybe_limit_query(Keyword.get(opts, :limit))
|
||||
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.all(query) end)
|
||||
end
|
||||
|
||||
defp count_events([filter], now, opts) do
|
||||
filter
|
||||
|> event_id_query_for_filter(now, opts)
|
||||
|> subquery()
|
||||
|> then(fn query ->
|
||||
from(event in query, select: count())
|
||||
end)
|
||||
|> Repo.one()
|
||||
query =
|
||||
filter
|
||||
|> event_id_query_for_filter(now, opts)
|
||||
|> subquery()
|
||||
|> then(fn query ->
|
||||
from(event in query, select: count())
|
||||
end)
|
||||
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.one(query) end)
|
||||
end
|
||||
|
||||
defp count_events(filters, now, opts) do
|
||||
filters
|
||||
|> event_id_distinct_union_query_for_filters(now, opts)
|
||||
|> subquery()
|
||||
|> then(fn union_query ->
|
||||
from(event in union_query, select: count())
|
||||
end)
|
||||
|> Repo.one()
|
||||
query =
|
||||
filters
|
||||
|> event_id_distinct_union_query_for_filters(now, opts)
|
||||
|> subquery()
|
||||
|> then(fn union_query ->
|
||||
from(event in union_query, select: count())
|
||||
end)
|
||||
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.one(query) end)
|
||||
end
|
||||
|
||||
defp event_source_query(filter, now) do
|
||||
@@ -744,14 +801,14 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
end
|
||||
end
|
||||
|
||||
defp apply_common_event_filters(query, filter, remaining_tag_filters, opts) do
|
||||
defp apply_common_event_filters(query, filter, remaining_tag_filters, opts, search_plan) do
|
||||
query
|
||||
|> maybe_filter_ids(Map.get(filter, "ids"))
|
||||
|> maybe_filter_authors(Map.get(filter, "authors"))
|
||||
|> maybe_filter_kinds(Map.get(filter, "kinds"))
|
||||
|> maybe_filter_since(Map.get(filter, "since"))
|
||||
|> maybe_filter_until(Map.get(filter, "until"))
|
||||
|> maybe_filter_search(Map.get(filter, "search"))
|
||||
|> maybe_filter_search(search_plan)
|
||||
|> filter_by_tag_filters(remaining_tag_filters)
|
||||
|> maybe_restrict_giftwrap_access(filter, opts)
|
||||
end
|
||||
@@ -792,13 +849,19 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
|
||||
defp maybe_filter_search(query, nil), do: query
|
||||
|
||||
defp maybe_filter_search(query, search) when is_binary(search) and search != "" do
|
||||
defp maybe_filter_search(query, %{mode: :fts, query: search}) do
|
||||
where(
|
||||
query,
|
||||
[event: event],
|
||||
fragment(@fts_match_fragment, event.content, ^search)
|
||||
)
|
||||
end
|
||||
|
||||
defp maybe_filter_search(query, %{mode: :trigram, query: search}) do
|
||||
escaped_search = escape_like_pattern(search)
|
||||
where(query, [event: event], ilike(event.content, ^"%#{escaped_search}%"))
|
||||
end
|
||||
|
||||
defp maybe_filter_search(query, _search), do: query
|
||||
|
||||
defp escape_like_pattern(search) do
|
||||
search
|
||||
|> String.replace("\\", "\\\\")
|
||||
@@ -886,20 +949,90 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
defp maybe_limit_query(query, nil), do: query
|
||||
defp maybe_limit_query(query, limit), do: limit(query, ^limit)
|
||||
|
||||
defp maybe_order_by_search_rank(query, nil) do
|
||||
order_by(query, [event: event], desc: event.created_at, asc: event.id)
|
||||
end
|
||||
|
||||
defp maybe_order_by_search_rank(query, %{mode: :fts, query: search}) do
|
||||
order_by(
|
||||
query,
|
||||
[event: event],
|
||||
desc: fragment(@fts_rank_fragment, event.content, ^search),
|
||||
desc: event.created_at,
|
||||
asc: event.id
|
||||
)
|
||||
end
|
||||
|
||||
defp maybe_order_by_search_rank(query, %{mode: :trigram, query: search}) do
|
||||
order_by(
|
||||
query,
|
||||
[event: event],
|
||||
desc: fragment(@trigram_rank_fragment, ^search, event.content),
|
||||
desc: event.created_at,
|
||||
asc: event.id
|
||||
)
|
||||
end
|
||||
|
||||
defp maybe_select_search_score(query, nil), do: query
|
||||
|
||||
defp maybe_select_search_score(query, %{mode: :fts, query: search}) do
|
||||
select_merge(
|
||||
query,
|
||||
[event: event],
|
||||
%{search_score: fragment(@fts_rank_fragment, event.content, ^search)}
|
||||
)
|
||||
end
|
||||
|
||||
defp maybe_select_search_score(query, %{mode: :trigram, query: search}) do
|
||||
select_merge(
|
||||
query,
|
||||
[event: event],
|
||||
%{search_score: fragment(@trigram_rank_fragment, ^search, event.content)}
|
||||
)
|
||||
end
|
||||
|
||||
defp search_plan(nil), do: nil
|
||||
|
||||
defp search_plan(search) when is_binary(search) do
|
||||
normalized_search = String.trim(search)
|
||||
|
||||
cond do
|
||||
normalized_search == "" ->
|
||||
nil
|
||||
|
||||
trigram_fallback_search?(normalized_search) ->
|
||||
%{mode: :trigram, query: normalized_search}
|
||||
|
||||
true ->
|
||||
%{mode: :fts, query: normalized_search}
|
||||
end
|
||||
end
|
||||
|
||||
defp trigram_fallback_search?(search) do
|
||||
String.match?(search, @trigram_fallback_pattern) or short_single_term_search?(search)
|
||||
end
|
||||
|
||||
defp short_single_term_search?(search) do
|
||||
case String.split(search, ~r/\s+/, trim: true) do
|
||||
[term] -> String.length(term) <= @trigram_fallback_max_single_term_length
|
||||
_other -> false
|
||||
end
|
||||
end
|
||||
|
||||
defp deduplicate_events(events) do
|
||||
events
|
||||
|> Enum.reduce(%{}, fn event, acc -> Map.put_new(acc, event.id, event) end)
|
||||
|> Enum.reduce(%{}, fn event, acc ->
|
||||
Map.update(acc, event.id, event, fn existing -> preferred_event(existing, event) end)
|
||||
end)
|
||||
|> Map.values()
|
||||
end
|
||||
|
||||
defp sort_persisted_events(events) do
|
||||
Enum.sort(events, fn left, right ->
|
||||
cond do
|
||||
left.created_at > right.created_at -> true
|
||||
left.created_at < right.created_at -> false
|
||||
true -> left.id < right.id
|
||||
end
|
||||
end)
|
||||
defp sort_persisted_events(events, filters) do
|
||||
if Enum.any?(filters, &search_filter?/1) do
|
||||
Enum.sort(events, &search_result_sorter/2)
|
||||
else
|
||||
Enum.sort(events, &chronological_sorter/2)
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_apply_query_limit(events, opts) do
|
||||
@@ -921,6 +1054,50 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
}
|
||||
end
|
||||
|
||||
defp preferred_event(existing, candidate) do
|
||||
if search_result_sorter(candidate, existing) do
|
||||
candidate
|
||||
else
|
||||
existing
|
||||
end
|
||||
end
|
||||
|
||||
defp search_filter?(filter) do
|
||||
filter
|
||||
|> Map.get("search")
|
||||
|> search_plan()
|
||||
|> Kernel.!=(nil)
|
||||
end
|
||||
|
||||
defp search_result_sorter(left, right) do
|
||||
left_score = search_score(left)
|
||||
right_score = search_score(right)
|
||||
|
||||
cond do
|
||||
left_score > right_score -> true
|
||||
left_score < right_score -> false
|
||||
true -> chronological_sorter(left, right)
|
||||
end
|
||||
end
|
||||
|
||||
defp chronological_sorter(left, right) do
|
||||
cond do
|
||||
left.created_at > right.created_at -> true
|
||||
left.created_at < right.created_at -> false
|
||||
true -> left.id < right.id
|
||||
end
|
||||
end
|
||||
|
||||
defp search_score(event) do
|
||||
event
|
||||
|> Map.get(:search_score, 0.0)
|
||||
|> case do
|
||||
score when is_float(score) -> score
|
||||
score when is_integer(score) -> score / 1
|
||||
_other -> 0.0
|
||||
end
|
||||
end
|
||||
|
||||
defp normalize_persisted_tags(tags) when is_list(tags), do: tags
|
||||
defp normalize_persisted_tags(_tags), do: []
|
||||
|
||||
@@ -1066,4 +1243,6 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Events do
|
||||
end
|
||||
|
||||
defp maybe_apply_mls_group_retention(expires_at, _kind, _created_at), do: expires_at
|
||||
|
||||
defp read_repo, do: PostgresRepos.read()
|
||||
end
|
||||
|
||||
@@ -5,6 +5,7 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Groups do
|
||||
|
||||
import Ecto.Query
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
alias Parrhesia.Repo
|
||||
|
||||
@behaviour Parrhesia.Storage.Groups
|
||||
@@ -46,7 +47,9 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Groups do
|
||||
limit: 1
|
||||
)
|
||||
|
||||
case Repo.one(query) do
|
||||
repo = read_repo()
|
||||
|
||||
case repo.one(query) do
|
||||
nil ->
|
||||
{:ok, nil}
|
||||
|
||||
@@ -94,8 +97,8 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Groups do
|
||||
)
|
||||
|
||||
memberships =
|
||||
query
|
||||
|> Repo.all()
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.all(query) end)
|
||||
|> Enum.map(fn membership ->
|
||||
to_membership_map(
|
||||
membership.group_id,
|
||||
@@ -163,8 +166,8 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Groups do
|
||||
)
|
||||
|
||||
roles =
|
||||
query
|
||||
|> Repo.all()
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.all(query) end)
|
||||
|> Enum.map(fn role ->
|
||||
to_role_map(role.group_id, role.pubkey, role.role, role.metadata)
|
||||
end)
|
||||
@@ -242,6 +245,7 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Groups do
|
||||
|
||||
defp unwrap_transaction_result({:ok, result}), do: {:ok, result}
|
||||
defp unwrap_transaction_result({:error, reason}), do: {:error, reason}
|
||||
defp read_repo, do: PostgresRepos.read()
|
||||
|
||||
defp fetch_required_string(map, key) do
|
||||
map
|
||||
|
||||
@@ -5,6 +5,7 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Moderation do
|
||||
|
||||
import Ecto.Query
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
alias Parrhesia.Repo
|
||||
|
||||
@behaviour Parrhesia.Storage.Moderation
|
||||
@@ -212,7 +213,8 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Moderation do
|
||||
select: field(record, ^field)
|
||||
)
|
||||
|
||||
Repo.all(query)
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.all(query) end)
|
||||
end
|
||||
|
||||
defp cache_put(scope, value) do
|
||||
@@ -266,7 +268,9 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Moderation do
|
||||
limit: 1
|
||||
)
|
||||
|
||||
Repo.one(query) == 1
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.one(query) end)
|
||||
|> Kernel.==(1)
|
||||
end
|
||||
|
||||
defp scope_populated_db?(table, field) do
|
||||
@@ -276,7 +280,10 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Moderation do
|
||||
limit: 1
|
||||
)
|
||||
|
||||
not is_nil(Repo.one(query))
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.one(query) end)
|
||||
|> is_nil()
|
||||
|> Kernel.not()
|
||||
end
|
||||
|
||||
defp normalize_hex_or_binary(value, expected_bytes, _reason)
|
||||
@@ -315,4 +322,6 @@ defmodule Parrhesia.Storage.Adapters.Postgres.Moderation do
|
||||
|
||||
defp to_inet({_, _, _, _, _, _, _, _} = ip_tuple),
|
||||
do: %Postgrex.INET{address: ip_tuple, netmask: 128}
|
||||
|
||||
defp read_repo, do: PostgresRepos.read()
|
||||
end
|
||||
|
||||
@@ -5,6 +5,7 @@ defmodule Parrhesia.Storage.Partitions do
|
||||
|
||||
import Ecto.Query
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
alias Parrhesia.Repo
|
||||
|
||||
@identifier_pattern ~r/^[a-zA-Z_][a-zA-Z0-9_]*$/
|
||||
@@ -35,7 +36,8 @@ defmodule Parrhesia.Storage.Partitions do
|
||||
order_by: [asc: table.tablename]
|
||||
)
|
||||
|
||||
Repo.all(query)
|
||||
read_repo()
|
||||
|> then(fn repo -> repo.all(query) end)
|
||||
end
|
||||
|
||||
@doc """
|
||||
@@ -88,7 +90,9 @@ defmodule Parrhesia.Storage.Partitions do
|
||||
"""
|
||||
@spec database_size_bytes() :: {:ok, non_neg_integer()} | {:error, term()}
|
||||
def database_size_bytes do
|
||||
case Repo.query("SELECT pg_database_size(current_database())") do
|
||||
repo = read_repo()
|
||||
|
||||
case repo.query("SELECT pg_database_size(current_database())") do
|
||||
{:ok, %{rows: [[size]]}} when is_integer(size) and size >= 0 -> {:ok, size}
|
||||
{:ok, _result} -> {:error, :unexpected_result}
|
||||
{:error, reason} -> {:error, reason}
|
||||
@@ -219,7 +223,9 @@ defmodule Parrhesia.Storage.Partitions do
|
||||
LIMIT 1
|
||||
"""
|
||||
|
||||
case Repo.query(query, [partition_name, parent_table_name]) do
|
||||
repo = read_repo()
|
||||
|
||||
case repo.query(query, [partition_name, parent_table_name]) do
|
||||
{:ok, %{rows: [[1]]}} -> true
|
||||
{:ok, %{rows: []}} -> false
|
||||
{:ok, _result} -> false
|
||||
@@ -278,6 +284,8 @@ defmodule Parrhesia.Storage.Partitions do
|
||||
|> DateTime.to_unix()
|
||||
end
|
||||
|
||||
defp read_repo, do: PostgresRepos.read()
|
||||
|
||||
defp month_start(%Date{} = date), do: Date.new!(date.year, date.month, 1)
|
||||
|
||||
defp shift_month(%Date{} = date, month_delta) when is_integer(month_delta) do
|
||||
|
||||
@@ -5,18 +5,36 @@ defmodule Parrhesia.Storage.Supervisor do
|
||||
|
||||
use Supervisor
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
|
||||
def start_link(init_arg \\ []) do
|
||||
Supervisor.start_link(__MODULE__, init_arg, name: __MODULE__)
|
||||
end
|
||||
|
||||
@impl true
|
||||
def init(_init_arg) do
|
||||
children = [
|
||||
{Parrhesia.Storage.Adapters.Postgres.ModerationCache,
|
||||
name: Parrhesia.Storage.Adapters.Postgres.ModerationCache},
|
||||
Parrhesia.Repo
|
||||
]
|
||||
children =
|
||||
memory_store_children() ++ moderation_cache_children() ++ PostgresRepos.started_repos()
|
||||
|
||||
Supervisor.init(children, strategy: :one_for_one)
|
||||
end
|
||||
|
||||
defp memory_store_children do
|
||||
case Application.get_env(:parrhesia, :storage, [])[:backend] do
|
||||
:memory -> [Parrhesia.Storage.Adapters.Memory.Store]
|
||||
_other -> []
|
||||
end
|
||||
end
|
||||
|
||||
defp moderation_cache_children do
|
||||
if PostgresRepos.postgres_enabled?() and
|
||||
Application.get_env(:parrhesia, :moderation_cache_enabled, true) do
|
||||
[
|
||||
{Parrhesia.Storage.Adapters.Postgres.ModerationCache,
|
||||
name: Parrhesia.Storage.Adapters.Postgres.ModerationCache}
|
||||
]
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -14,6 +14,7 @@ defmodule Parrhesia.Subscriptions.Supervisor do
|
||||
children =
|
||||
[
|
||||
{Parrhesia.Subscriptions.Index, name: Parrhesia.Subscriptions.Index},
|
||||
{Parrhesia.Fanout.Dispatcher, name: Parrhesia.Fanout.Dispatcher},
|
||||
{Registry, keys: :unique, name: Parrhesia.API.Stream.Registry},
|
||||
{DynamicSupervisor, strategy: :one_for_one, name: Parrhesia.API.Stream.Supervisor}
|
||||
] ++
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
defmodule Parrhesia.Sync.RelayInfoClient do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.HTTP
|
||||
alias Parrhesia.Sync.TLS
|
||||
|
||||
@spec verify_remote_identity(map(), keyword()) :: :ok | {:error, term()}
|
||||
@@ -18,11 +19,12 @@ defmodule Parrhesia.Sync.RelayInfoClient do
|
||||
end
|
||||
|
||||
defp default_request(url, opts) do
|
||||
case Req.get(
|
||||
case HTTP.get(
|
||||
url: url,
|
||||
headers: [{"accept", "application/nostr+json"}],
|
||||
decode_body: false,
|
||||
connect_options: opts
|
||||
connect_options: Keyword.merge([timeout: 5_000], opts),
|
||||
receive_timeout: 5_000
|
||||
) do
|
||||
{:ok, response} -> {:ok, response}
|
||||
{:error, reason} -> {:error, reason}
|
||||
|
||||
@@ -30,10 +30,19 @@ defmodule Parrhesia.Tasks.ExpirationWorker do
|
||||
def handle_info(:tick, state) do
|
||||
started_at = System.monotonic_time()
|
||||
|
||||
_result = Storage.events().purge_expired([])
|
||||
purged_events =
|
||||
case Storage.events().purge_expired([]) do
|
||||
{:ok, count} when is_integer(count) and count >= 0 -> count
|
||||
_other -> 0
|
||||
end
|
||||
|
||||
duration = System.monotonic_time() - started_at
|
||||
Telemetry.emit([:parrhesia, :maintenance, :purge_expired, :stop], %{duration: duration}, %{})
|
||||
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :maintenance, :purge_expired, :stop],
|
||||
%{duration: duration, purged_events: purged_events},
|
||||
%{}
|
||||
)
|
||||
|
||||
schedule_tick(state.interval_ms)
|
||||
{:noreply, state}
|
||||
|
||||
40
lib/parrhesia/tasks/nip66_publisher.ex
Normal file
40
lib/parrhesia/tasks/nip66_publisher.ex
Normal file
@@ -0,0 +1,40 @@
|
||||
defmodule Parrhesia.Tasks.Nip66Publisher do
|
||||
@moduledoc """
|
||||
Periodic worker that publishes NIP-66 monitor and discovery events.
|
||||
"""
|
||||
|
||||
use GenServer
|
||||
|
||||
alias Parrhesia.NIP66
|
||||
|
||||
@spec start_link(keyword()) :: GenServer.on_start()
|
||||
def start_link(opts \\ []) do
|
||||
name = Keyword.get(opts, :name, __MODULE__)
|
||||
GenServer.start_link(__MODULE__, opts, name: name)
|
||||
end
|
||||
|
||||
@impl true
|
||||
def init(opts) do
|
||||
state = %{
|
||||
interval_ms: Keyword.get(opts, :interval_ms, NIP66.publish_interval_ms()),
|
||||
publish_opts: Keyword.drop(opts, [:name, :interval_ms, :nip66_module]),
|
||||
nip66_module: Keyword.get(opts, :nip66_module, NIP66)
|
||||
}
|
||||
|
||||
schedule_tick(0)
|
||||
{:ok, state}
|
||||
end
|
||||
|
||||
@impl true
|
||||
def handle_info(:tick, state) do
|
||||
_result = state.nip66_module.publish_snapshot(state.publish_opts)
|
||||
schedule_tick(state.interval_ms)
|
||||
{:noreply, state}
|
||||
end
|
||||
|
||||
def handle_info(_message, state), do: {:noreply, state}
|
||||
|
||||
defp schedule_tick(interval_ms) do
|
||||
Process.send_after(self(), :tick, interval_ms)
|
||||
end
|
||||
end
|
||||
@@ -11,7 +11,7 @@ defmodule Parrhesia.Tasks.Supervisor do
|
||||
|
||||
@impl true
|
||||
def init(_init_arg) do
|
||||
children = expiration_children() ++ partition_retention_children()
|
||||
children = expiration_children() ++ partition_retention_children() ++ nip66_children()
|
||||
|
||||
Supervisor.init(children, strategy: :one_for_one)
|
||||
end
|
||||
@@ -25,8 +25,20 @@ defmodule Parrhesia.Tasks.Supervisor do
|
||||
end
|
||||
|
||||
defp partition_retention_children do
|
||||
[
|
||||
{Parrhesia.Tasks.PartitionRetentionWorker, name: Parrhesia.Tasks.PartitionRetentionWorker}
|
||||
]
|
||||
if Application.get_env(:parrhesia, :enable_partition_retention_worker, true) do
|
||||
[
|
||||
{Parrhesia.Tasks.PartitionRetentionWorker, name: Parrhesia.Tasks.PartitionRetentionWorker}
|
||||
]
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
defp nip66_children do
|
||||
if Parrhesia.NIP66.enabled?() do
|
||||
[{Parrhesia.Tasks.Nip66Publisher, name: Parrhesia.Tasks.Nip66Publisher}]
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,12 +1,17 @@
|
||||
defmodule Parrhesia.Telemetry do
|
||||
@moduledoc """
|
||||
Supervision entrypoint and helpers for relay telemetry.
|
||||
|
||||
Starts the Prometheus reporter and telemetry poller as supervised children.
|
||||
All relay metrics are namespaced under `parrhesia.*` and exposed through the
|
||||
`/metrics` endpoint in Prometheus exposition format.
|
||||
"""
|
||||
|
||||
use Supervisor
|
||||
|
||||
import Telemetry.Metrics
|
||||
|
||||
@repo_query_handler_id "parrhesia-repo-query-handler"
|
||||
@prometheus_reporter __MODULE__.Prometheus
|
||||
|
||||
@spec start_link(keyword()) :: Supervisor.on_start()
|
||||
@@ -16,6 +21,8 @@ defmodule Parrhesia.Telemetry do
|
||||
|
||||
@impl true
|
||||
def init(_init_arg) do
|
||||
:ok = attach_repo_query_handlers()
|
||||
|
||||
children = [
|
||||
{TelemetryMetricsPrometheus.Core, name: @prometheus_reporter, metrics: metrics()},
|
||||
{:telemetry_poller, measurements: periodic_measurements(), period: 10_000}
|
||||
@@ -30,6 +37,12 @@ defmodule Parrhesia.Telemetry do
|
||||
@spec metrics() :: [Telemetry.Metrics.t()]
|
||||
def metrics do
|
||||
[
|
||||
counter("parrhesia.ingest.events.count",
|
||||
event_name: [:parrhesia, :ingest, :result],
|
||||
measurement: :count,
|
||||
tags: [:traffic_class, :outcome, :reason],
|
||||
tag_values: &ingest_result_tag_values/1
|
||||
),
|
||||
distribution("parrhesia.ingest.duration.ms",
|
||||
event_name: [:parrhesia, :ingest, :stop],
|
||||
measurement: :duration,
|
||||
@@ -38,14 +51,27 @@ defmodule Parrhesia.Telemetry do
|
||||
tag_values: &traffic_class_tag_values/1,
|
||||
reporter_options: [buckets: [1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
counter("parrhesia.query.requests.count",
|
||||
event_name: [:parrhesia, :query, :result],
|
||||
measurement: :count,
|
||||
tags: [:traffic_class, :operation, :outcome],
|
||||
tag_values: &query_result_tag_values/1
|
||||
),
|
||||
distribution("parrhesia.query.duration.ms",
|
||||
event_name: [:parrhesia, :query, :stop],
|
||||
measurement: :duration,
|
||||
unit: {:native, :millisecond},
|
||||
tags: [:traffic_class],
|
||||
tag_values: &traffic_class_tag_values/1,
|
||||
tags: [:traffic_class, :operation],
|
||||
tag_values: &query_stop_tag_values/1,
|
||||
reporter_options: [buckets: [1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
distribution("parrhesia.query.results.count",
|
||||
event_name: [:parrhesia, :query, :stop],
|
||||
measurement: :result_count,
|
||||
tags: [:traffic_class, :operation],
|
||||
tag_values: &query_stop_tag_values/1,
|
||||
reporter_options: [buckets: [0, 1, 5, 10, 25, 50, 100, 250, 500, 1000, 5000]]
|
||||
),
|
||||
distribution("parrhesia.fanout.duration.ms",
|
||||
event_name: [:parrhesia, :fanout, :stop],
|
||||
measurement: :duration,
|
||||
@@ -54,6 +80,25 @@ defmodule Parrhesia.Telemetry do
|
||||
tag_values: &traffic_class_tag_values/1,
|
||||
reporter_options: [buckets: [1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
counter("parrhesia.fanout.events_considered.count",
|
||||
event_name: [:parrhesia, :fanout, :stop],
|
||||
measurement: :considered,
|
||||
tags: [:traffic_class],
|
||||
tag_values: &traffic_class_tag_values/1
|
||||
),
|
||||
counter("parrhesia.fanout.events_enqueued.count",
|
||||
event_name: [:parrhesia, :fanout, :stop],
|
||||
measurement: :enqueued,
|
||||
tags: [:traffic_class],
|
||||
tag_values: &traffic_class_tag_values/1
|
||||
),
|
||||
distribution("parrhesia.fanout.batch_size",
|
||||
event_name: [:parrhesia, :fanout, :stop],
|
||||
measurement: :enqueued,
|
||||
tags: [:traffic_class],
|
||||
tag_values: &traffic_class_tag_values/1,
|
||||
reporter_options: [buckets: [0, 1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
last_value("parrhesia.connection.outbound_queue.depth",
|
||||
event_name: [:parrhesia, :connection, :outbound_queue],
|
||||
measurement: :depth,
|
||||
@@ -80,11 +125,153 @@ defmodule Parrhesia.Telemetry do
|
||||
tags: [:traffic_class],
|
||||
tag_values: &traffic_class_tag_values/1
|
||||
),
|
||||
counter("parrhesia.connection.outbound_queue.drained_frames.count",
|
||||
event_name: [:parrhesia, :connection, :outbound_queue, :drain],
|
||||
measurement: :count
|
||||
),
|
||||
distribution("parrhesia.connection.outbound_queue.drain_batch_size",
|
||||
event_name: [:parrhesia, :connection, :outbound_queue, :drain],
|
||||
measurement: :count,
|
||||
reporter_options: [buckets: [0, 1, 5, 10, 25, 50, 100, 250]]
|
||||
),
|
||||
counter("parrhesia.connection.outbound_queue.dropped_events.count",
|
||||
event_name: [:parrhesia, :connection, :outbound_queue, :drop],
|
||||
measurement: :count,
|
||||
tags: [:strategy],
|
||||
tag_values: &strategy_tag_values/1
|
||||
),
|
||||
last_value("parrhesia.listener.connections.active",
|
||||
event_name: [:parrhesia, :listener, :population],
|
||||
measurement: :connections,
|
||||
tags: [:listener_id],
|
||||
tag_values: &listener_tag_values/1,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
last_value("parrhesia.listener.subscriptions.active",
|
||||
event_name: [:parrhesia, :listener, :population],
|
||||
measurement: :subscriptions,
|
||||
tags: [:listener_id],
|
||||
tag_values: &listener_tag_values/1,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
counter("parrhesia.rate_limit.hits.count",
|
||||
event_name: [:parrhesia, :rate_limit, :hit],
|
||||
measurement: :count,
|
||||
tags: [:scope, :traffic_class],
|
||||
tag_values: &rate_limit_tag_values/1
|
||||
),
|
||||
last_value("parrhesia.process.mailbox.depth",
|
||||
event_name: [:parrhesia, :process, :mailbox],
|
||||
measurement: :depth,
|
||||
tags: [:process_type],
|
||||
tag_values: &process_tag_values/1,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
counter("parrhesia.db.query.count",
|
||||
event_name: [:parrhesia, :db, :query],
|
||||
measurement: :count,
|
||||
tags: [:repo_role],
|
||||
tag_values: &repo_query_tag_values/1
|
||||
),
|
||||
distribution("parrhesia.db.query.total_time.ms",
|
||||
event_name: [:parrhesia, :db, :query],
|
||||
measurement: :total_time,
|
||||
unit: {:native, :millisecond},
|
||||
tags: [:repo_role],
|
||||
tag_values: &repo_query_tag_values/1,
|
||||
reporter_options: [buckets: [1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
distribution("parrhesia.db.query.queue_time.ms",
|
||||
event_name: [:parrhesia, :db, :query],
|
||||
measurement: :queue_time,
|
||||
unit: {:native, :millisecond},
|
||||
tags: [:repo_role],
|
||||
tag_values: &repo_query_tag_values/1,
|
||||
reporter_options: [buckets: [0, 1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
distribution("parrhesia.db.query.query_time.ms",
|
||||
event_name: [:parrhesia, :db, :query],
|
||||
measurement: :query_time,
|
||||
unit: {:native, :millisecond},
|
||||
tags: [:repo_role],
|
||||
tag_values: &repo_query_tag_values/1,
|
||||
reporter_options: [buckets: [0, 1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
distribution("parrhesia.db.query.decode_time.ms",
|
||||
event_name: [:parrhesia, :db, :query],
|
||||
measurement: :decode_time,
|
||||
unit: {:native, :millisecond},
|
||||
tags: [:repo_role],
|
||||
tag_values: &repo_query_tag_values/1,
|
||||
reporter_options: [buckets: [0, 1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
distribution("parrhesia.db.query.idle_time.ms",
|
||||
event_name: [:parrhesia, :db, :query],
|
||||
measurement: :idle_time,
|
||||
unit: {:native, :millisecond},
|
||||
tags: [:repo_role],
|
||||
tag_values: &repo_query_tag_values/1,
|
||||
reporter_options: [buckets: [0, 1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
distribution("parrhesia.maintenance.purge_expired.duration.ms",
|
||||
event_name: [:parrhesia, :maintenance, :purge_expired, :stop],
|
||||
measurement: :duration,
|
||||
unit: {:native, :millisecond},
|
||||
reporter_options: [buckets: [1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
counter("parrhesia.maintenance.purge_expired.events.count",
|
||||
event_name: [:parrhesia, :maintenance, :purge_expired, :stop],
|
||||
measurement: :purged_events
|
||||
),
|
||||
distribution("parrhesia.maintenance.partition_retention.duration.ms",
|
||||
event_name: [:parrhesia, :maintenance, :partition_retention, :stop],
|
||||
measurement: :duration,
|
||||
unit: {:native, :millisecond},
|
||||
tags: [:status],
|
||||
tag_values: &status_tag_values/1,
|
||||
reporter_options: [buckets: [1, 5, 10, 25, 50, 100, 250, 500, 1000]]
|
||||
),
|
||||
counter("parrhesia.maintenance.partition_retention.dropped_partitions.count",
|
||||
event_name: [:parrhesia, :maintenance, :partition_retention, :stop],
|
||||
measurement: :dropped_partitions,
|
||||
tags: [:status],
|
||||
tag_values: &status_tag_values/1
|
||||
),
|
||||
last_value("parrhesia.vm.memory.total.bytes",
|
||||
event_name: [:parrhesia, :vm, :memory],
|
||||
measurement: :total,
|
||||
unit: :byte,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
last_value("parrhesia.vm.memory.processes.bytes",
|
||||
event_name: [:parrhesia, :vm, :memory],
|
||||
measurement: :processes,
|
||||
unit: :byte,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
last_value("parrhesia.vm.memory.system.bytes",
|
||||
event_name: [:parrhesia, :vm, :memory],
|
||||
measurement: :system,
|
||||
unit: :byte,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
last_value("parrhesia.vm.memory.atom.bytes",
|
||||
event_name: [:parrhesia, :vm, :memory],
|
||||
measurement: :atom,
|
||||
unit: :byte,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
last_value("parrhesia.vm.memory.binary.bytes",
|
||||
event_name: [:parrhesia, :vm, :memory],
|
||||
measurement: :binary,
|
||||
unit: :byte,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
),
|
||||
last_value("parrhesia.vm.memory.ets.bytes",
|
||||
event_name: [:parrhesia, :vm, :memory],
|
||||
measurement: :ets,
|
||||
unit: :byte,
|
||||
reporter_options: [prometheus_type: :gauge]
|
||||
)
|
||||
]
|
||||
end
|
||||
@@ -95,6 +282,22 @@ defmodule Parrhesia.Telemetry do
|
||||
:telemetry.execute(event_name, measurements, metadata)
|
||||
end
|
||||
|
||||
@spec emit_process_mailbox_depth(atom(), map()) :: :ok
|
||||
def emit_process_mailbox_depth(process_type, metadata \\ %{})
|
||||
when is_atom(process_type) and is_map(metadata) do
|
||||
case Process.info(self(), :message_queue_len) do
|
||||
{:message_queue_len, depth} ->
|
||||
emit(
|
||||
[:parrhesia, :process, :mailbox],
|
||||
%{depth: depth},
|
||||
Map.put(metadata, :process_type, process_type)
|
||||
)
|
||||
|
||||
nil ->
|
||||
:ok
|
||||
end
|
||||
end
|
||||
|
||||
defp periodic_measurements do
|
||||
[
|
||||
{__MODULE__, :emit_vm_memory, []}
|
||||
@@ -103,12 +306,119 @@ defmodule Parrhesia.Telemetry do
|
||||
|
||||
@doc false
|
||||
def emit_vm_memory do
|
||||
total = :erlang.memory(:total)
|
||||
emit([:parrhesia, :vm, :memory], %{total: total}, %{})
|
||||
emit(
|
||||
[:parrhesia, :vm, :memory],
|
||||
%{
|
||||
total: :erlang.memory(:total),
|
||||
processes: :erlang.memory(:processes),
|
||||
system: :erlang.memory(:system),
|
||||
atom: :erlang.memory(:atom),
|
||||
binary: :erlang.memory(:binary),
|
||||
ets: :erlang.memory(:ets)
|
||||
},
|
||||
%{}
|
||||
)
|
||||
end
|
||||
|
||||
defp traffic_class_tag_values(metadata) do
|
||||
traffic_class = metadata |> Map.get(:traffic_class, :generic) |> to_string()
|
||||
%{traffic_class: traffic_class}
|
||||
end
|
||||
|
||||
defp ingest_result_tag_values(metadata) do
|
||||
%{
|
||||
traffic_class: metadata |> Map.get(:traffic_class, :generic) |> to_string(),
|
||||
outcome: metadata |> Map.get(:outcome, :unknown) |> to_string(),
|
||||
reason: metadata |> Map.get(:reason, :unknown) |> to_string()
|
||||
}
|
||||
end
|
||||
|
||||
defp query_stop_tag_values(metadata) do
|
||||
%{
|
||||
traffic_class: metadata |> Map.get(:traffic_class, :generic) |> to_string(),
|
||||
operation: metadata |> Map.get(:operation, :query) |> to_string()
|
||||
}
|
||||
end
|
||||
|
||||
defp query_result_tag_values(metadata) do
|
||||
%{
|
||||
traffic_class: metadata |> Map.get(:traffic_class, :generic) |> to_string(),
|
||||
operation: metadata |> Map.get(:operation, :query) |> to_string(),
|
||||
outcome: metadata |> Map.get(:outcome, :unknown) |> to_string()
|
||||
}
|
||||
end
|
||||
|
||||
defp strategy_tag_values(metadata) do
|
||||
%{strategy: metadata |> Map.get(:strategy, :unknown) |> to_string()}
|
||||
end
|
||||
|
||||
defp listener_tag_values(metadata) do
|
||||
%{listener_id: metadata |> Map.get(:listener_id, :unknown) |> to_string()}
|
||||
end
|
||||
|
||||
defp rate_limit_tag_values(metadata) do
|
||||
%{
|
||||
scope: metadata |> Map.get(:scope, :unknown) |> to_string(),
|
||||
traffic_class: metadata |> Map.get(:traffic_class, :generic) |> to_string()
|
||||
}
|
||||
end
|
||||
|
||||
defp process_tag_values(metadata) do
|
||||
process_type = metadata |> Map.get(:process_type, :unknown) |> to_string()
|
||||
%{process_type: process_type}
|
||||
end
|
||||
|
||||
defp repo_query_tag_values(metadata) do
|
||||
%{repo_role: metadata |> Map.get(:repo_role, :unknown) |> to_string()}
|
||||
end
|
||||
|
||||
defp status_tag_values(metadata) do
|
||||
%{status: metadata |> Map.get(:status, :unknown) |> to_string()}
|
||||
end
|
||||
|
||||
defp attach_repo_query_handlers do
|
||||
:telemetry.detach(@repo_query_handler_id)
|
||||
|
||||
:telemetry.attach_many(
|
||||
@repo_query_handler_id,
|
||||
[[:parrhesia, :repo, :query], [:parrhesia, :read_repo, :query]],
|
||||
&__MODULE__.handle_repo_query_event/4,
|
||||
nil
|
||||
)
|
||||
|
||||
:ok
|
||||
rescue
|
||||
ArgumentError -> :ok
|
||||
end
|
||||
|
||||
@doc false
|
||||
def handle_repo_query_event(event_name, measurements, _metadata, _config) do
|
||||
repo_role =
|
||||
case event_name do
|
||||
[:parrhesia, :read_repo, :query] -> :read
|
||||
[:parrhesia, :repo, :query] -> :write
|
||||
end
|
||||
|
||||
total_time =
|
||||
Map.get(
|
||||
measurements,
|
||||
:total_time,
|
||||
Map.get(measurements, :queue_time, 0) +
|
||||
Map.get(measurements, :query_time, 0) +
|
||||
Map.get(measurements, :decode_time, 0)
|
||||
)
|
||||
|
||||
emit(
|
||||
[:parrhesia, :db, :query],
|
||||
%{
|
||||
count: 1,
|
||||
total_time: total_time,
|
||||
queue_time: Map.get(measurements, :queue_time, 0),
|
||||
query_time: Map.get(measurements, :query_time, 0),
|
||||
decode_time: Map.get(measurements, :decode_time, 0),
|
||||
idle_time: Map.get(measurements, :idle_time, 0)
|
||||
},
|
||||
%{repo_role: repo_role}
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -137,9 +137,16 @@ defmodule Parrhesia.TestSupport.TLSCerts do
|
||||
end
|
||||
|
||||
defp openssl!(args) do
|
||||
case System.cmd("/usr/bin/openssl", args, stderr_to_stdout: true) do
|
||||
case System.cmd(openssl_executable!(), args, stderr_to_stdout: true) do
|
||||
{output, 0} -> output
|
||||
{output, status} -> raise "openssl failed with status #{status}: #{output}"
|
||||
end
|
||||
end
|
||||
|
||||
defp openssl_executable! do
|
||||
case System.find_executable("openssl") do
|
||||
nil -> raise "openssl executable not found in PATH"
|
||||
path -> path
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -9,6 +9,7 @@ defmodule Parrhesia.Web.Connection do
|
||||
alias Parrhesia.API.RequestContext
|
||||
alias Parrhesia.API.Stream
|
||||
alias Parrhesia.Auth.Challenges
|
||||
alias Parrhesia.ConnectionStats
|
||||
alias Parrhesia.Negentropy.Sessions
|
||||
alias Parrhesia.Policy.ConnectionPolicy
|
||||
alias Parrhesia.Policy.EventPolicy
|
||||
@@ -16,6 +17,8 @@ defmodule Parrhesia.Web.Connection do
|
||||
alias Parrhesia.Protocol.Filter
|
||||
alias Parrhesia.Subscriptions.Index
|
||||
alias Parrhesia.Telemetry
|
||||
alias Parrhesia.Web.EventIngestLimiter
|
||||
alias Parrhesia.Web.IPEventIngestLimiter
|
||||
alias Parrhesia.Web.Listener
|
||||
|
||||
@default_max_subscriptions_per_connection 32
|
||||
@@ -27,7 +30,11 @@ defmodule Parrhesia.Web.Connection do
|
||||
@default_event_ingest_rate_limit 120
|
||||
@default_event_ingest_window_seconds 1
|
||||
@default_auth_max_age_seconds 600
|
||||
@default_websocket_ping_interval_seconds 30
|
||||
@default_websocket_pong_timeout_seconds 10
|
||||
@drain_outbound_queue :drain_outbound_queue
|
||||
@websocket_keepalive_ping :websocket_keepalive_ping
|
||||
@websocket_keepalive_timeout :websocket_keepalive_timeout
|
||||
@outbound_queue_pressure_threshold 0.75
|
||||
|
||||
@marmot_kinds MapSet.new([
|
||||
@@ -62,11 +69,18 @@ defmodule Parrhesia.Web.Connection do
|
||||
drain_scheduled?: false,
|
||||
max_frame_bytes: @default_max_frame_bytes,
|
||||
max_event_bytes: @default_max_event_bytes,
|
||||
event_ingest_limiter: EventIngestLimiter,
|
||||
remote_ip_event_ingest_limiter: IPEventIngestLimiter,
|
||||
max_event_ingest_per_window: @default_event_ingest_rate_limit,
|
||||
event_ingest_window_seconds: @default_event_ingest_window_seconds,
|
||||
event_ingest_window_started_at_ms: 0,
|
||||
event_ingest_count: 0,
|
||||
auth_max_age_seconds: @default_auth_max_age_seconds
|
||||
auth_max_age_seconds: @default_auth_max_age_seconds,
|
||||
websocket_ping_interval_seconds: @default_websocket_ping_interval_seconds,
|
||||
websocket_pong_timeout_seconds: @default_websocket_pong_timeout_seconds,
|
||||
websocket_keepalive_timeout_timer_ref: nil,
|
||||
websocket_awaiting_pong_payload: nil,
|
||||
track_population?: true
|
||||
|
||||
@type overflow_strategy :: :close | :drop_oldest | :drop_newest
|
||||
|
||||
@@ -96,61 +110,81 @@ defmodule Parrhesia.Web.Connection do
|
||||
drain_scheduled?: boolean(),
|
||||
max_frame_bytes: pos_integer(),
|
||||
max_event_bytes: pos_integer(),
|
||||
event_ingest_limiter: GenServer.server() | nil,
|
||||
remote_ip_event_ingest_limiter: GenServer.server() | nil,
|
||||
max_event_ingest_per_window: pos_integer(),
|
||||
event_ingest_window_seconds: pos_integer(),
|
||||
event_ingest_window_started_at_ms: integer(),
|
||||
event_ingest_count: non_neg_integer(),
|
||||
auth_max_age_seconds: pos_integer()
|
||||
auth_max_age_seconds: pos_integer(),
|
||||
websocket_ping_interval_seconds: non_neg_integer(),
|
||||
websocket_pong_timeout_seconds: pos_integer(),
|
||||
websocket_keepalive_timeout_timer_ref: reference() | nil,
|
||||
websocket_awaiting_pong_payload: binary() | nil,
|
||||
track_population?: boolean()
|
||||
}
|
||||
|
||||
@impl true
|
||||
def init(opts) do
|
||||
maybe_configure_exit_trapping(opts)
|
||||
auth_challenges = auth_challenges(opts)
|
||||
|
||||
state = %__MODULE__{
|
||||
listener: Listener.from_opts(opts),
|
||||
transport_identity: transport_identity(opts),
|
||||
max_subscriptions_per_connection: max_subscriptions_per_connection(opts),
|
||||
subscription_index: subscription_index(opts),
|
||||
auth_challenges: auth_challenges,
|
||||
auth_challenge: maybe_issue_auth_challenge(auth_challenges),
|
||||
relay_url: relay_url(opts),
|
||||
remote_ip: remote_ip(opts),
|
||||
negentropy_sessions: negentropy_sessions(opts),
|
||||
max_outbound_queue: max_outbound_queue(opts),
|
||||
outbound_overflow_strategy: outbound_overflow_strategy(opts),
|
||||
outbound_drain_batch_size: outbound_drain_batch_size(opts),
|
||||
max_frame_bytes: max_frame_bytes(opts),
|
||||
max_event_bytes: max_event_bytes(opts),
|
||||
max_event_ingest_per_window: max_event_ingest_per_window(opts),
|
||||
event_ingest_window_seconds: event_ingest_window_seconds(opts),
|
||||
event_ingest_window_started_at_ms: System.monotonic_time(:millisecond),
|
||||
auth_max_age_seconds: auth_max_age_seconds(opts)
|
||||
}
|
||||
state =
|
||||
%__MODULE__{
|
||||
listener: Listener.from_opts(opts),
|
||||
transport_identity: transport_identity(opts),
|
||||
max_subscriptions_per_connection: max_subscriptions_per_connection(opts),
|
||||
subscription_index: subscription_index(opts),
|
||||
auth_challenges: auth_challenges,
|
||||
auth_challenge: maybe_issue_auth_challenge(auth_challenges),
|
||||
relay_url: relay_url(opts),
|
||||
remote_ip: remote_ip(opts),
|
||||
negentropy_sessions: negentropy_sessions(opts),
|
||||
max_outbound_queue: max_outbound_queue(opts),
|
||||
outbound_overflow_strategy: outbound_overflow_strategy(opts),
|
||||
outbound_drain_batch_size: outbound_drain_batch_size(opts),
|
||||
max_frame_bytes: max_frame_bytes(opts),
|
||||
max_event_bytes: max_event_bytes(opts),
|
||||
event_ingest_limiter: event_ingest_limiter(opts),
|
||||
remote_ip_event_ingest_limiter: remote_ip_event_ingest_limiter(opts),
|
||||
max_event_ingest_per_window: max_event_ingest_per_window(opts),
|
||||
event_ingest_window_seconds: event_ingest_window_seconds(opts),
|
||||
event_ingest_window_started_at_ms: System.monotonic_time(:millisecond),
|
||||
auth_max_age_seconds: auth_max_age_seconds(opts),
|
||||
websocket_ping_interval_seconds: websocket_ping_interval_seconds(opts),
|
||||
websocket_pong_timeout_seconds: websocket_pong_timeout_seconds(opts),
|
||||
track_population?: track_population?(opts)
|
||||
}
|
||||
|> maybe_schedule_next_websocket_ping()
|
||||
|
||||
:ok = maybe_track_connection_open(state)
|
||||
Telemetry.emit_process_mailbox_depth(:connection)
|
||||
{:ok, state}
|
||||
end
|
||||
|
||||
@impl true
|
||||
def handle_in({payload, [opcode: :text]}, %__MODULE__{} = state) do
|
||||
if byte_size(payload) > state.max_frame_bytes do
|
||||
response =
|
||||
Protocol.encode_relay({
|
||||
:notice,
|
||||
"invalid: websocket frame exceeds max frame size"
|
||||
})
|
||||
result =
|
||||
if byte_size(payload) > state.max_frame_bytes do
|
||||
response =
|
||||
Protocol.encode_relay({
|
||||
:notice,
|
||||
"invalid: websocket frame exceeds max frame size"
|
||||
})
|
||||
|
||||
{:push, {:text, response}, state}
|
||||
else
|
||||
case Protocol.decode_client(payload) do
|
||||
{:ok, decoded_message} ->
|
||||
handle_decoded_message(decoded_message, state)
|
||||
{:push, {:text, response}, state}
|
||||
else
|
||||
case Protocol.decode_client(payload) do
|
||||
{:ok, decoded_message} ->
|
||||
handle_decoded_message(decoded_message, state)
|
||||
|
||||
{:error, reason} ->
|
||||
response = Protocol.encode_relay({:notice, Protocol.decode_error_notice(reason)})
|
||||
{:push, {:text, response}, state}
|
||||
{:error, reason} ->
|
||||
response = Protocol.encode_relay({:notice, Protocol.decode_error_notice(reason)})
|
||||
{:push, {:text, response}, state}
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
emit_connection_mailbox_depth(result)
|
||||
end
|
||||
|
||||
@impl true
|
||||
@@ -159,6 +193,18 @@ defmodule Parrhesia.Web.Connection do
|
||||
Protocol.encode_relay({:notice, "invalid: binary websocket frames are not supported"})
|
||||
|
||||
{:push, {:text, response}, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
@impl true
|
||||
def handle_control({payload, [opcode: :pong]}, %__MODULE__{} = state) when is_binary(payload) do
|
||||
{:ok, maybe_acknowledge_websocket_pong(state, payload)}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_control({_payload, [opcode: :ping]}, %__MODULE__{} = state) do
|
||||
{:ok, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
defp handle_decoded_message({:event, event}, state), do: handle_event_ingest(state, event)
|
||||
@@ -203,8 +249,10 @@ defmodule Parrhesia.Web.Connection do
|
||||
when is_reference(ref) and is_binary(subscription_id) and is_map(event) do
|
||||
if current_subscription_ref?(state, subscription_id, ref) do
|
||||
handle_fanout_events(state, [{subscription_id, event}])
|
||||
|> emit_connection_mailbox_depth()
|
||||
else
|
||||
{:ok, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
end
|
||||
|
||||
@@ -216,9 +264,12 @@ defmodule Parrhesia.Web.Connection do
|
||||
if current_subscription_ref?(state, subscription_id, ref) and
|
||||
not subscription_eose_sent?(state, subscription_id) do
|
||||
response = Protocol.encode_relay({:eose, subscription_id})
|
||||
|
||||
{:push, {:text, response}, mark_subscription_eose_sent(state, subscription_id)}
|
||||
|> emit_connection_mailbox_depth()
|
||||
else
|
||||
{:ok, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
end
|
||||
|
||||
@@ -234,20 +285,25 @@ defmodule Parrhesia.Web.Connection do
|
||||
|> drop_queued_subscription_events(subscription_id)
|
||||
|
||||
response = Protocol.encode_relay({:closed, subscription_id, stream_closed_reason(reason)})
|
||||
|
||||
{:push, {:text, response}, next_state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
else
|
||||
{:ok, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
end
|
||||
|
||||
def handle_info({:fanout_event, subscription_id, event}, %__MODULE__{} = state)
|
||||
when is_binary(subscription_id) and is_map(event) do
|
||||
handle_fanout_events(state, [{subscription_id, event}])
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_info({:fanout_events, fanout_events}, %__MODULE__{} = state)
|
||||
when is_list(fanout_events) do
|
||||
handle_fanout_events(state, fanout_events)
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_info(@drain_outbound_queue, %__MODULE__{} = state) do
|
||||
@@ -255,34 +311,85 @@ defmodule Parrhesia.Web.Connection do
|
||||
|
||||
if frames == [] do
|
||||
{:ok, next_state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
else
|
||||
{:push, frames, next_state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
end
|
||||
|
||||
def handle_info(@websocket_keepalive_ping, %__MODULE__{} = state) do
|
||||
state
|
||||
|> maybe_schedule_next_websocket_ping()
|
||||
|> maybe_send_websocket_keepalive_ping()
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_info({@websocket_keepalive_timeout, payload}, %__MODULE__{} = state)
|
||||
when is_binary(payload) do
|
||||
if websocket_keepalive_timeout_payload?(state, payload) do
|
||||
{:stop, :normal, {1001, "keepalive timeout"}, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
else
|
||||
{:ok, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
end
|
||||
|
||||
def handle_info({:EXIT, _from, :shutdown}, %__MODULE__{} = state) do
|
||||
close_with_drained_outbound_frames(state)
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_info({:EXIT, _from, {:shutdown, _detail}}, %__MODULE__{} = state) do
|
||||
close_with_drained_outbound_frames(state)
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
def handle_info(_message, %__MODULE__{} = state) do
|
||||
{:ok, state}
|
||||
|> emit_connection_mailbox_depth()
|
||||
end
|
||||
|
||||
@impl true
|
||||
def terminate(_reason, %__MODULE__{} = state) do
|
||||
:ok = maybe_track_subscription_delta(state, -map_size(state.subscriptions))
|
||||
:ok = maybe_track_connection_close(state)
|
||||
:ok = maybe_unsubscribe_all_stream_subscriptions(state)
|
||||
:ok = maybe_remove_index_owner(state)
|
||||
:ok = maybe_clear_auth_challenge(state)
|
||||
:ok = cancel_websocket_keepalive_timers(state)
|
||||
:ok
|
||||
end
|
||||
|
||||
defp handle_event_ingest(%__MODULE__{} = state, event) do
|
||||
event_id = Map.get(event, "id", "")
|
||||
traffic_class = traffic_class_for_event(event)
|
||||
|
||||
case maybe_allow_event_ingest(state) do
|
||||
{:ok, next_state} ->
|
||||
case authorize_listener_write(next_state, event) do
|
||||
:ok -> publish_event_response(next_state, event)
|
||||
{:error, reason} -> ingest_error_response(state, event_id, reason)
|
||||
end
|
||||
maybe_publish_ingested_event(next_state, state, event, event_id)
|
||||
|
||||
{:error, reason} ->
|
||||
maybe_emit_rate_limit_hit(reason, traffic_class)
|
||||
ingest_error_response(state, event_id, reason)
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_publish_ingested_event(next_state, state, event, event_id) do
|
||||
traffic_class = traffic_class_for_event(event)
|
||||
|
||||
with :ok <-
|
||||
maybe_allow_remote_ip_event_ingest(
|
||||
next_state.remote_ip,
|
||||
next_state.remote_ip_event_ingest_limiter
|
||||
),
|
||||
:ok <- maybe_allow_relay_event_ingest(next_state.event_ingest_limiter),
|
||||
:ok <- authorize_listener_write(next_state, event) do
|
||||
publish_event_response(next_state, event)
|
||||
else
|
||||
{:error, reason} ->
|
||||
maybe_emit_rate_limit_hit(reason, traffic_class)
|
||||
ingest_error_response(state, event_id, reason)
|
||||
end
|
||||
end
|
||||
@@ -388,6 +495,8 @@ defmodule Parrhesia.Web.Connection do
|
||||
)
|
||||
|
||||
{:error, :subscription_limit_reached} ->
|
||||
maybe_emit_rate_limit_hit(:subscription_limit_reached)
|
||||
|
||||
response =
|
||||
Protocol.encode_relay({
|
||||
:closed,
|
||||
@@ -414,6 +523,7 @@ defmodule Parrhesia.Web.Connection do
|
||||
:invalid_until,
|
||||
:invalid_limit,
|
||||
:invalid_search,
|
||||
:too_many_tag_values,
|
||||
:invalid_tag_filter
|
||||
] ->
|
||||
Filter.error_message(reason)
|
||||
@@ -462,6 +572,27 @@ defmodule Parrhesia.Web.Connection do
|
||||
restricted_count_notice(state, subscription_id, EventPolicy.error_message(reason))
|
||||
end
|
||||
|
||||
defp handle_count_error(state, subscription_id, reason)
|
||||
when reason in [
|
||||
:invalid_filters,
|
||||
:empty_filters,
|
||||
:too_many_filters,
|
||||
:invalid_filter,
|
||||
:invalid_filter_key,
|
||||
:invalid_ids,
|
||||
:invalid_authors,
|
||||
:invalid_kinds,
|
||||
:invalid_since,
|
||||
:invalid_until,
|
||||
:invalid_limit,
|
||||
:invalid_search,
|
||||
:too_many_tag_values,
|
||||
:invalid_tag_filter
|
||||
] do
|
||||
response = Protocol.encode_relay({:closed, subscription_id, Filter.error_message(reason)})
|
||||
{:push, {:text, response}, state}
|
||||
end
|
||||
|
||||
defp handle_count_error(state, subscription_id, reason) do
|
||||
response = Protocol.encode_relay({:closed, subscription_id, inspect(reason)})
|
||||
{:push, {:text, response}, state}
|
||||
@@ -541,6 +672,12 @@ defmodule Parrhesia.Web.Connection do
|
||||
defp error_message_for_ingest_failure(:event_rate_limited),
|
||||
do: "rate-limited: too many EVENT messages"
|
||||
|
||||
defp error_message_for_ingest_failure(:ip_event_rate_limited),
|
||||
do: "rate-limited: too many EVENT messages from this IP"
|
||||
|
||||
defp error_message_for_ingest_failure(:relay_event_rate_limited),
|
||||
do: "rate-limited: relay-wide EVENT ingress exceeded"
|
||||
|
||||
defp error_message_for_ingest_failure(:event_too_large),
|
||||
do: "invalid: event exceeds max event size"
|
||||
|
||||
@@ -648,6 +785,7 @@ defmodule Parrhesia.Web.Connection do
|
||||
:invalid_until,
|
||||
:invalid_limit,
|
||||
:invalid_search,
|
||||
:too_many_tag_values,
|
||||
:invalid_tag_filter,
|
||||
:auth_required,
|
||||
:pubkey_not_allowed,
|
||||
@@ -701,6 +839,7 @@ defmodule Parrhesia.Web.Connection do
|
||||
:invalid_until,
|
||||
:invalid_limit,
|
||||
:invalid_search,
|
||||
:too_many_tag_values,
|
||||
:invalid_tag_filter
|
||||
],
|
||||
do: Filter.error_message(reason)
|
||||
@@ -911,22 +1050,38 @@ defmodule Parrhesia.Web.Connection do
|
||||
telemetry_metadata = telemetry_metadata_for_fanout_events(fanout_events)
|
||||
|
||||
case enqueue_fanout_events(state, fanout_events) do
|
||||
{:ok, next_state} ->
|
||||
{:ok, next_state, stats} ->
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :fanout, :stop],
|
||||
%{duration: System.monotonic_time() - started_at},
|
||||
%{
|
||||
duration: System.monotonic_time() - started_at,
|
||||
considered: stats.considered,
|
||||
enqueued: stats.enqueued
|
||||
},
|
||||
telemetry_metadata
|
||||
)
|
||||
|
||||
{:ok, maybe_schedule_drain(next_state)}
|
||||
|
||||
{:close, next_state} ->
|
||||
{:close, next_state, stats} ->
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :connection, :outbound_queue, :overflow],
|
||||
%{count: 1},
|
||||
telemetry_metadata
|
||||
)
|
||||
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :fanout, :stop],
|
||||
%{
|
||||
duration: System.monotonic_time() - started_at,
|
||||
considered: stats.considered,
|
||||
enqueued: stats.enqueued
|
||||
},
|
||||
telemetry_metadata
|
||||
)
|
||||
|
||||
maybe_emit_rate_limit_hit(:outbound_queue_overflow, telemetry_metadata.traffic_class)
|
||||
|
||||
close_with_outbound_overflow(next_state)
|
||||
end
|
||||
end
|
||||
@@ -938,16 +1093,33 @@ defmodule Parrhesia.Web.Connection do
|
||||
{:stop, :normal, {1008, message}, [{:text, notice}], state}
|
||||
end
|
||||
|
||||
defp close_with_drained_outbound_frames(state) do
|
||||
{frames, next_state} = drain_all_outbound_frames(state)
|
||||
{:stop, :normal, {1012, "service restart"}, frames, next_state}
|
||||
end
|
||||
|
||||
defp enqueue_fanout_events(state, fanout_events) do
|
||||
Enum.reduce_while(fanout_events, {:ok, state}, fn
|
||||
{subscription_id, event}, {:ok, acc} when is_binary(subscription_id) and is_map(event) ->
|
||||
initial_stats = %{considered: 0, enqueued: 0}
|
||||
|
||||
Enum.reduce_while(fanout_events, {:ok, state, initial_stats}, fn
|
||||
{subscription_id, event}, {:ok, acc, stats}
|
||||
when is_binary(subscription_id) and is_map(event) ->
|
||||
case maybe_enqueue_fanout_event(acc, subscription_id, event) do
|
||||
{:ok, next_acc} -> {:cont, {:ok, next_acc}}
|
||||
{:close, next_acc} -> {:halt, {:close, next_acc}}
|
||||
{:ok, next_acc, enqueued?} ->
|
||||
next_stats = %{
|
||||
considered: stats.considered + 1,
|
||||
enqueued: stats.enqueued + if(enqueued?, do: 1, else: 0)
|
||||
}
|
||||
|
||||
{:cont, {:ok, next_acc, next_stats}}
|
||||
|
||||
{:close, next_acc} ->
|
||||
next_stats = %{stats | considered: stats.considered + 1}
|
||||
{:halt, {:close, next_acc, next_stats}}
|
||||
end
|
||||
|
||||
_invalid_event, {:ok, acc} ->
|
||||
{:cont, {:ok, acc}}
|
||||
_invalid_event, {:ok, acc, stats} ->
|
||||
{:cont, {:ok, acc, stats}}
|
||||
end)
|
||||
end
|
||||
|
||||
@@ -955,7 +1127,7 @@ defmodule Parrhesia.Web.Connection do
|
||||
if subscription_matches?(state, subscription_id, event) do
|
||||
enqueue_outbound(state, {subscription_id, event}, traffic_class_for_event(event))
|
||||
else
|
||||
{:ok, state}
|
||||
{:ok, state, false}
|
||||
end
|
||||
end
|
||||
|
||||
@@ -981,15 +1153,17 @@ defmodule Parrhesia.Web.Connection do
|
||||
}
|
||||
|
||||
emit_outbound_queue_depth(next_state, %{traffic_class: traffic_class})
|
||||
{:ok, next_state}
|
||||
{:ok, next_state, true}
|
||||
end
|
||||
|
||||
defp enqueue_outbound(
|
||||
%__MODULE__{outbound_overflow_strategy: :drop_newest} = state,
|
||||
_queue_entry,
|
||||
_traffic_class
|
||||
),
|
||||
do: {:ok, state}
|
||||
) do
|
||||
emit_outbound_queue_drop(:drop_newest)
|
||||
{:ok, state, false}
|
||||
end
|
||||
|
||||
defp enqueue_outbound(
|
||||
%__MODULE__{outbound_overflow_strategy: :drop_oldest} = state,
|
||||
@@ -1002,7 +1176,8 @@ defmodule Parrhesia.Web.Connection do
|
||||
next_state = %__MODULE__{state | outbound_queue: next_queue, outbound_queue_size: next_size}
|
||||
|
||||
emit_outbound_queue_depth(next_state, %{traffic_class: traffic_class})
|
||||
{:ok, next_state}
|
||||
emit_outbound_queue_drop(:drop_oldest)
|
||||
{:ok, next_state, true}
|
||||
end
|
||||
|
||||
defp enqueue_outbound(
|
||||
@@ -1039,6 +1214,25 @@ defmodule Parrhesia.Web.Connection do
|
||||
}
|
||||
|> maybe_schedule_drain()
|
||||
|
||||
emit_outbound_queue_drain(length(frames))
|
||||
emit_outbound_queue_depth(next_state)
|
||||
|
||||
{Enum.reverse(frames), next_state}
|
||||
end
|
||||
|
||||
defp drain_all_outbound_frames(%__MODULE__{} = state) do
|
||||
{frames, next_queue, remaining_size} =
|
||||
pop_frames(state.outbound_queue, state.outbound_queue_size, :infinity, [])
|
||||
|
||||
next_state =
|
||||
%__MODULE__{
|
||||
state
|
||||
| outbound_queue: next_queue,
|
||||
outbound_queue_size: remaining_size,
|
||||
drain_scheduled?: false
|
||||
}
|
||||
|
||||
emit_outbound_queue_drain(length(frames))
|
||||
emit_outbound_queue_depth(next_state)
|
||||
|
||||
{Enum.reverse(frames), next_state}
|
||||
@@ -1047,6 +1241,17 @@ defmodule Parrhesia.Web.Connection do
|
||||
defp pop_frames(queue, queue_size, _remaining_batch, acc) when queue_size == 0,
|
||||
do: {acc, queue, queue_size}
|
||||
|
||||
defp pop_frames(queue, queue_size, :infinity, acc) do
|
||||
case :queue.out(queue) do
|
||||
{{:value, {subscription_id, event}}, next_queue} ->
|
||||
frame = {:text, Protocol.encode_relay({:event, subscription_id, event})}
|
||||
pop_frames(next_queue, queue_size - 1, :infinity, [frame | acc])
|
||||
|
||||
{:empty, _same_queue} ->
|
||||
{acc, :queue.new(), 0}
|
||||
end
|
||||
end
|
||||
|
||||
defp pop_frames(queue, queue_size, remaining_batch, acc) when remaining_batch <= 0,
|
||||
do: {acc, queue, queue_size}
|
||||
|
||||
@@ -1070,6 +1275,93 @@ defmodule Parrhesia.Web.Connection do
|
||||
%__MODULE__{state | drain_scheduled?: true}
|
||||
end
|
||||
|
||||
defp maybe_schedule_next_websocket_ping(
|
||||
%__MODULE__{websocket_ping_interval_seconds: interval_seconds} = state
|
||||
)
|
||||
when interval_seconds <= 0,
|
||||
do: state
|
||||
|
||||
defp maybe_schedule_next_websocket_ping(
|
||||
%__MODULE__{websocket_ping_interval_seconds: interval_seconds} = state
|
||||
) do
|
||||
_timer_ref = Process.send_after(self(), @websocket_keepalive_ping, interval_seconds * 1_000)
|
||||
state
|
||||
end
|
||||
|
||||
defp maybe_send_websocket_keepalive_ping(
|
||||
%__MODULE__{websocket_ping_interval_seconds: interval_seconds} = state
|
||||
)
|
||||
when interval_seconds <= 0,
|
||||
do: {:ok, state}
|
||||
|
||||
defp maybe_send_websocket_keepalive_ping(
|
||||
%__MODULE__{websocket_awaiting_pong_payload: awaiting_payload} = state
|
||||
)
|
||||
when is_binary(awaiting_payload),
|
||||
do: {:ok, state}
|
||||
|
||||
defp maybe_send_websocket_keepalive_ping(%__MODULE__{} = state) do
|
||||
payload = Base.encode16(:crypto.strong_rand_bytes(8), case: :lower)
|
||||
|
||||
timeout_timer_ref =
|
||||
Process.send_after(
|
||||
self(),
|
||||
{@websocket_keepalive_timeout, payload},
|
||||
state.websocket_pong_timeout_seconds * 1_000
|
||||
)
|
||||
|
||||
next_state =
|
||||
%__MODULE__{
|
||||
state
|
||||
| websocket_keepalive_timeout_timer_ref: timeout_timer_ref,
|
||||
websocket_awaiting_pong_payload: payload
|
||||
}
|
||||
|
||||
{:push, {:ping, payload}, next_state}
|
||||
end
|
||||
|
||||
defp websocket_keepalive_timeout_payload?(
|
||||
%__MODULE__{websocket_awaiting_pong_payload: awaiting_payload},
|
||||
payload
|
||||
)
|
||||
when is_binary(awaiting_payload) and is_binary(payload) do
|
||||
Plug.Crypto.secure_compare(awaiting_payload, payload)
|
||||
end
|
||||
|
||||
defp websocket_keepalive_timeout_payload?(_state, _payload), do: false
|
||||
|
||||
defp maybe_acknowledge_websocket_pong(
|
||||
%__MODULE__{websocket_awaiting_pong_payload: awaiting_payload} = state,
|
||||
payload
|
||||
)
|
||||
when is_binary(awaiting_payload) and is_binary(payload) do
|
||||
if Plug.Crypto.secure_compare(awaiting_payload, payload) do
|
||||
:ok = cancel_timer(state.websocket_keepalive_timeout_timer_ref)
|
||||
|
||||
%__MODULE__{
|
||||
state
|
||||
| websocket_keepalive_timeout_timer_ref: nil,
|
||||
websocket_awaiting_pong_payload: nil
|
||||
}
|
||||
else
|
||||
state
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_acknowledge_websocket_pong(%__MODULE__{} = state, _payload), do: state
|
||||
|
||||
defp cancel_websocket_keepalive_timers(%__MODULE__{} = state) do
|
||||
:ok = cancel_timer(state.websocket_keepalive_timeout_timer_ref)
|
||||
:ok
|
||||
end
|
||||
|
||||
defp cancel_timer(timer_ref) when is_reference(timer_ref) do
|
||||
_ = Process.cancel_timer(timer_ref, async: true, info: false)
|
||||
:ok
|
||||
end
|
||||
|
||||
defp cancel_timer(_timer_ref), do: :ok
|
||||
|
||||
defp emit_outbound_queue_depth(state, metadata \\ %{}) do
|
||||
depth = state.outbound_queue_size
|
||||
|
||||
@@ -1095,6 +1387,11 @@ defmodule Parrhesia.Web.Connection do
|
||||
end
|
||||
end
|
||||
|
||||
defp emit_connection_mailbox_depth(result) do
|
||||
Telemetry.emit_process_mailbox_depth(:connection)
|
||||
result
|
||||
end
|
||||
|
||||
defp ensure_subscription_capacity(%__MODULE__{} = state, subscription_id) do
|
||||
cond do
|
||||
Map.has_key?(state.subscriptions, subscription_id) ->
|
||||
@@ -1110,12 +1407,26 @@ defmodule Parrhesia.Web.Connection do
|
||||
|
||||
defp put_subscription(%__MODULE__{} = state, subscription_id, subscription) do
|
||||
subscriptions = Map.put(state.subscriptions, subscription_id, subscription)
|
||||
%__MODULE__{state | subscriptions: subscriptions}
|
||||
next_state = %__MODULE__{state | subscriptions: subscriptions}
|
||||
|
||||
if Map.has_key?(state.subscriptions, subscription_id) do
|
||||
next_state
|
||||
else
|
||||
:ok = maybe_track_subscription_delta(next_state, 1)
|
||||
next_state
|
||||
end
|
||||
end
|
||||
|
||||
defp drop_subscription(%__MODULE__{} = state, subscription_id) do
|
||||
subscriptions = Map.delete(state.subscriptions, subscription_id)
|
||||
%__MODULE__{state | subscriptions: subscriptions}
|
||||
next_state = %__MODULE__{state | subscriptions: subscriptions}
|
||||
|
||||
if Map.has_key?(state.subscriptions, subscription_id) do
|
||||
:ok = maybe_track_subscription_delta(next_state, -1)
|
||||
next_state
|
||||
else
|
||||
next_state
|
||||
end
|
||||
end
|
||||
|
||||
defp drop_queued_subscription_events(
|
||||
@@ -1523,6 +1834,26 @@ defmodule Parrhesia.Web.Connection do
|
||||
|> Keyword.get(:max_event_ingest_per_window, @default_event_ingest_rate_limit)
|
||||
end
|
||||
|
||||
defp event_ingest_limiter(opts) when is_list(opts) do
|
||||
Keyword.get(opts, :event_ingest_limiter, EventIngestLimiter)
|
||||
end
|
||||
|
||||
defp event_ingest_limiter(opts) when is_map(opts) do
|
||||
Map.get(opts, :event_ingest_limiter, EventIngestLimiter)
|
||||
end
|
||||
|
||||
defp event_ingest_limiter(_opts), do: EventIngestLimiter
|
||||
|
||||
defp remote_ip_event_ingest_limiter(opts) when is_list(opts) do
|
||||
Keyword.get(opts, :remote_ip_event_ingest_limiter, IPEventIngestLimiter)
|
||||
end
|
||||
|
||||
defp remote_ip_event_ingest_limiter(opts) when is_map(opts) do
|
||||
Map.get(opts, :remote_ip_event_ingest_limiter, IPEventIngestLimiter)
|
||||
end
|
||||
|
||||
defp remote_ip_event_ingest_limiter(_opts), do: IPEventIngestLimiter
|
||||
|
||||
defp event_ingest_window_seconds(opts) when is_list(opts) do
|
||||
opts
|
||||
|> Keyword.get(:event_ingest_window_seconds)
|
||||
@@ -1571,6 +1902,80 @@ defmodule Parrhesia.Web.Connection do
|
||||
|> Keyword.get(:auth_max_age_seconds, @default_auth_max_age_seconds)
|
||||
end
|
||||
|
||||
defp websocket_ping_interval_seconds(opts) when is_list(opts) do
|
||||
opts
|
||||
|> Keyword.get(:websocket_ping_interval_seconds)
|
||||
|> normalize_websocket_ping_interval_seconds()
|
||||
end
|
||||
|
||||
defp websocket_ping_interval_seconds(opts) when is_map(opts) do
|
||||
opts
|
||||
|> Map.get(:websocket_ping_interval_seconds)
|
||||
|> normalize_websocket_ping_interval_seconds()
|
||||
end
|
||||
|
||||
defp websocket_ping_interval_seconds(_opts), do: configured_websocket_ping_interval_seconds()
|
||||
|
||||
defp normalize_websocket_ping_interval_seconds(value)
|
||||
when is_integer(value) and value >= 0,
|
||||
do: value
|
||||
|
||||
defp normalize_websocket_ping_interval_seconds(_value),
|
||||
do: configured_websocket_ping_interval_seconds()
|
||||
|
||||
defp configured_websocket_ping_interval_seconds do
|
||||
case Application.get_env(:parrhesia, :limits, [])
|
||||
|> Keyword.get(:websocket_ping_interval_seconds) do
|
||||
value when is_integer(value) and value >= 0 -> value
|
||||
_other -> @default_websocket_ping_interval_seconds
|
||||
end
|
||||
end
|
||||
|
||||
defp websocket_pong_timeout_seconds(opts) when is_list(opts) do
|
||||
opts
|
||||
|> Keyword.get(:websocket_pong_timeout_seconds)
|
||||
|> normalize_websocket_pong_timeout_seconds()
|
||||
end
|
||||
|
||||
defp websocket_pong_timeout_seconds(opts) when is_map(opts) do
|
||||
opts
|
||||
|> Map.get(:websocket_pong_timeout_seconds)
|
||||
|> normalize_websocket_pong_timeout_seconds()
|
||||
end
|
||||
|
||||
defp websocket_pong_timeout_seconds(_opts), do: configured_websocket_pong_timeout_seconds()
|
||||
|
||||
defp normalize_websocket_pong_timeout_seconds(value)
|
||||
when is_integer(value) and value > 0,
|
||||
do: value
|
||||
|
||||
defp normalize_websocket_pong_timeout_seconds(_value),
|
||||
do: configured_websocket_pong_timeout_seconds()
|
||||
|
||||
defp configured_websocket_pong_timeout_seconds do
|
||||
case Application.get_env(:parrhesia, :limits, [])
|
||||
|> Keyword.get(:websocket_pong_timeout_seconds) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> @default_websocket_pong_timeout_seconds
|
||||
end
|
||||
end
|
||||
|
||||
defp track_population?(opts) when is_list(opts), do: Keyword.get(opts, :track_population?, true)
|
||||
defp track_population?(opts) when is_map(opts), do: Map.get(opts, :track_population?, true)
|
||||
defp track_population?(_opts), do: true
|
||||
|
||||
defp maybe_configure_exit_trapping(opts) do
|
||||
if trap_exit?(opts) do
|
||||
Process.flag(:trap_exit, true)
|
||||
end
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
defp trap_exit?(opts) when is_list(opts), do: Keyword.get(opts, :trap_exit?, true)
|
||||
defp trap_exit?(opts) when is_map(opts), do: Map.get(opts, :trap_exit?, true)
|
||||
defp trap_exit?(_opts), do: true
|
||||
|
||||
defp request_context(%__MODULE__{} = state, subscription_id \\ nil) do
|
||||
%RequestContext{
|
||||
authenticated_pubkeys: state.authenticated_pubkeys,
|
||||
@@ -1622,4 +2027,90 @@ defmodule Parrhesia.Web.Connection do
|
||||
{:error, :event_rate_limited}
|
||||
end
|
||||
end
|
||||
|
||||
defp maybe_allow_remote_ip_event_ingest(_remote_ip, nil), do: :ok
|
||||
|
||||
defp maybe_allow_remote_ip_event_ingest(remote_ip, server) do
|
||||
IPEventIngestLimiter.allow(remote_ip, server)
|
||||
catch
|
||||
:exit, {:noproc, _details} -> :ok
|
||||
:exit, {:normal, _details} -> :ok
|
||||
end
|
||||
|
||||
defp maybe_allow_relay_event_ingest(nil), do: :ok
|
||||
|
||||
defp maybe_allow_relay_event_ingest(server) do
|
||||
EventIngestLimiter.allow(server)
|
||||
catch
|
||||
:exit, {:noproc, _details} -> :ok
|
||||
:exit, {:normal, _details} -> :ok
|
||||
end
|
||||
|
||||
defp maybe_track_connection_open(%__MODULE__{track_population?: false}), do: :ok
|
||||
|
||||
defp maybe_track_connection_open(%__MODULE__{} = state) do
|
||||
ConnectionStats.connection_open(listener_id(state))
|
||||
end
|
||||
|
||||
defp maybe_track_connection_close(%__MODULE__{track_population?: false}), do: :ok
|
||||
|
||||
defp maybe_track_connection_close(%__MODULE__{} = state) do
|
||||
ConnectionStats.connection_close(listener_id(state))
|
||||
end
|
||||
|
||||
defp maybe_track_subscription_delta(_state, 0), do: :ok
|
||||
defp maybe_track_subscription_delta(%__MODULE__{track_population?: false}, _delta), do: :ok
|
||||
|
||||
defp maybe_track_subscription_delta(%__MODULE__{} = state, delta) do
|
||||
ConnectionStats.subscriptions_change(listener_id(state), delta)
|
||||
end
|
||||
|
||||
defp listener_id(%__MODULE__{listener: %{id: id}}), do: id
|
||||
defp listener_id(_state), do: :unknown
|
||||
|
||||
defp emit_outbound_queue_drain(0), do: :ok
|
||||
|
||||
defp emit_outbound_queue_drain(count) when is_integer(count) and count > 0 do
|
||||
Telemetry.emit([:parrhesia, :connection, :outbound_queue, :drain], %{count: count}, %{})
|
||||
end
|
||||
|
||||
defp emit_outbound_queue_drop(strategy) do
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :connection, :outbound_queue, :drop],
|
||||
%{count: 1},
|
||||
%{strategy: strategy}
|
||||
)
|
||||
end
|
||||
|
||||
defp maybe_emit_rate_limit_hit(reason, traffic_class \\ :generic)
|
||||
|
||||
defp maybe_emit_rate_limit_hit(:event_rate_limited, traffic_class) do
|
||||
emit_rate_limit_hit(:event_ingest_per_connection, traffic_class)
|
||||
end
|
||||
|
||||
defp maybe_emit_rate_limit_hit(:ip_event_rate_limited, traffic_class) do
|
||||
emit_rate_limit_hit(:event_ingest_per_ip, traffic_class)
|
||||
end
|
||||
|
||||
defp maybe_emit_rate_limit_hit(:relay_event_rate_limited, traffic_class) do
|
||||
emit_rate_limit_hit(:event_ingest_relay, traffic_class)
|
||||
end
|
||||
|
||||
defp maybe_emit_rate_limit_hit(:subscription_limit_reached, traffic_class) do
|
||||
emit_rate_limit_hit(:subscriptions_per_connection, traffic_class)
|
||||
end
|
||||
|
||||
defp maybe_emit_rate_limit_hit(:outbound_queue_overflow, traffic_class) do
|
||||
emit_rate_limit_hit(:outbound_queue, traffic_class)
|
||||
end
|
||||
|
||||
defp maybe_emit_rate_limit_hit(_reason, _traffic_class), do: :ok
|
||||
|
||||
defp emit_rate_limit_hit(scope, traffic_class) do
|
||||
Telemetry.emit(
|
||||
[:parrhesia, :rate_limit, :hit],
|
||||
%{count: 1},
|
||||
%{scope: scope, traffic_class: traffic_class}
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -16,6 +16,7 @@ defmodule Parrhesia.Web.Endpoint do
|
||||
@spec reload_listener(Supervisor.supervisor(), atom()) :: :ok | {:error, term()}
|
||||
def reload_listener(supervisor \\ __MODULE__, listener_id) when is_atom(listener_id) do
|
||||
with :ok <- Supervisor.terminate_child(supervisor, {:listener, listener_id}),
|
||||
:ok <- clear_pem_cache(),
|
||||
{:ok, _pid} <- Supervisor.restart_child(supervisor, {:listener, listener_id}) do
|
||||
:ok
|
||||
else
|
||||
@@ -27,17 +28,44 @@ defmodule Parrhesia.Web.Endpoint do
|
||||
|
||||
@spec reload_all(Supervisor.supervisor()) :: :ok | {:error, term()}
|
||||
def reload_all(supervisor \\ __MODULE__) do
|
||||
supervisor
|
||||
|> Supervisor.which_children()
|
||||
|> Enum.filter(fn {id, _pid, _type, _modules} ->
|
||||
match?({:listener, _listener_id}, id)
|
||||
end)
|
||||
|> Enum.reduce_while(:ok, fn {{:listener, listener_id}, _pid, _type, _modules}, :ok ->
|
||||
case reload_listener(supervisor, listener_id) do
|
||||
:ok -> {:cont, :ok}
|
||||
{:error, _reason} = error -> {:halt, error}
|
||||
end
|
||||
end)
|
||||
listener_ids =
|
||||
supervisor
|
||||
|> Supervisor.which_children()
|
||||
|> Enum.flat_map(fn
|
||||
{{:listener, listener_id}, _pid, _type, _modules} -> [listener_id]
|
||||
_other -> []
|
||||
end)
|
||||
|
||||
with :ok <- terminate_listeners(supervisor, listener_ids),
|
||||
:ok <- clear_pem_cache() do
|
||||
restart_listeners(supervisor, listener_ids)
|
||||
end
|
||||
end
|
||||
|
||||
defp terminate_listeners(_supervisor, []), do: :ok
|
||||
|
||||
defp terminate_listeners(supervisor, [listener_id | rest]) do
|
||||
case Supervisor.terminate_child(supervisor, {:listener, listener_id}) do
|
||||
:ok -> terminate_listeners(supervisor, rest)
|
||||
{:error, _reason} = error -> error
|
||||
end
|
||||
end
|
||||
|
||||
defp restart_listeners(_supervisor, []), do: :ok
|
||||
|
||||
defp restart_listeners(supervisor, [listener_id | rest]) do
|
||||
case Supervisor.restart_child(supervisor, {:listener, listener_id}) do
|
||||
{:ok, _pid} -> restart_listeners(supervisor, rest)
|
||||
{:error, _reason} = error -> error
|
||||
end
|
||||
end
|
||||
|
||||
# OTP's ssl module caches PEM file contents by filename. When cert/key
|
||||
# files are replaced on disk, the cache must be cleared so the restarted
|
||||
# listener reads the updated files.
|
||||
defp clear_pem_cache do
|
||||
:ssl.clear_pem_cache()
|
||||
:ok
|
||||
end
|
||||
|
||||
@impl true
|
||||
|
||||
140
lib/parrhesia/web/event_ingest_limiter.ex
Normal file
140
lib/parrhesia/web/event_ingest_limiter.ex
Normal file
@@ -0,0 +1,140 @@
|
||||
defmodule Parrhesia.Web.EventIngestLimiter do
|
||||
@moduledoc """
|
||||
Relay-wide EVENT ingest rate limiting over a fixed time window.
|
||||
"""
|
||||
|
||||
use GenServer
|
||||
|
||||
@default_max_events_per_window 10_000
|
||||
@default_window_seconds 1
|
||||
@named_table :parrhesia_event_ingest_limiter
|
||||
@config_key :config
|
||||
|
||||
@spec start_link(keyword()) :: GenServer.on_start()
|
||||
def start_link(opts \\ []) do
|
||||
max_events_per_window =
|
||||
normalize_positive_integer(
|
||||
Keyword.get(opts, :max_events_per_window),
|
||||
max_events_per_window()
|
||||
)
|
||||
|
||||
window_ms =
|
||||
normalize_positive_integer(Keyword.get(opts, :window_seconds), window_seconds()) * 1000
|
||||
|
||||
init_arg = %{
|
||||
max_events_per_window: max_events_per_window,
|
||||
window_ms: window_ms,
|
||||
named_table?: Keyword.get(opts, :name, __MODULE__) == __MODULE__
|
||||
}
|
||||
|
||||
case Keyword.get(opts, :name, __MODULE__) do
|
||||
nil -> GenServer.start_link(__MODULE__, init_arg)
|
||||
name -> GenServer.start_link(__MODULE__, init_arg, name: name)
|
||||
end
|
||||
end
|
||||
|
||||
@spec allow(GenServer.server()) :: :ok | {:error, :relay_event_rate_limited}
|
||||
def allow(server \\ __MODULE__)
|
||||
|
||||
def allow(__MODULE__) do
|
||||
case fetch_named_config() do
|
||||
{:ok, max_events_per_window, window_ms} ->
|
||||
allow_counter(@named_table, max_events_per_window, window_ms)
|
||||
|
||||
:error ->
|
||||
:ok
|
||||
end
|
||||
end
|
||||
|
||||
def allow(server), do: GenServer.call(server, :allow)
|
||||
|
||||
@impl true
|
||||
def init(%{
|
||||
max_events_per_window: max_events_per_window,
|
||||
window_ms: window_ms,
|
||||
named_table?: named_table?
|
||||
}) do
|
||||
table = create_table(named_table?)
|
||||
|
||||
true = :ets.insert(table, {@config_key, max_events_per_window, window_ms})
|
||||
|
||||
{:ok,
|
||||
%{
|
||||
table: table,
|
||||
max_events_per_window: max_events_per_window,
|
||||
window_ms: window_ms
|
||||
}}
|
||||
end
|
||||
|
||||
@impl true
|
||||
def handle_call(:allow, _from, state) do
|
||||
{:reply, allow_counter(state.table, state.max_events_per_window, state.window_ms), state}
|
||||
end
|
||||
|
||||
defp normalize_positive_integer(value, _default) when is_integer(value) and value > 0, do: value
|
||||
defp normalize_positive_integer(_value, default), do: default
|
||||
|
||||
defp create_table(true) do
|
||||
:ets.new(@named_table, [
|
||||
:named_table,
|
||||
:set,
|
||||
:public,
|
||||
{:read_concurrency, true},
|
||||
{:write_concurrency, true}
|
||||
])
|
||||
end
|
||||
|
||||
defp create_table(false) do
|
||||
:ets.new(__MODULE__, [:set, :public, {:read_concurrency, true}, {:write_concurrency, true}])
|
||||
end
|
||||
|
||||
defp fetch_named_config do
|
||||
case :ets.lookup(@named_table, @config_key) do
|
||||
[{@config_key, max_events_per_window, window_ms}] -> {:ok, max_events_per_window, window_ms}
|
||||
_other -> :error
|
||||
end
|
||||
rescue
|
||||
ArgumentError -> :error
|
||||
end
|
||||
|
||||
defp allow_counter(table, max_events_per_window, window_ms) do
|
||||
window_id = System.monotonic_time(:millisecond) |> div(window_ms)
|
||||
key = {:window, window_id}
|
||||
|
||||
count = :ets.update_counter(table, key, {2, 1}, {key, 0})
|
||||
|
||||
if count == 1 do
|
||||
prune_expired_windows(table, window_id)
|
||||
end
|
||||
|
||||
if count <= max_events_per_window do
|
||||
:ok
|
||||
else
|
||||
{:error, :relay_event_rate_limited}
|
||||
end
|
||||
rescue
|
||||
ArgumentError -> :ok
|
||||
end
|
||||
|
||||
defp prune_expired_windows(table, window_id) do
|
||||
:ets.select_delete(table, [
|
||||
{{{:window, :"$1"}, :_}, [{:<, :"$1", window_id}], [true]}
|
||||
])
|
||||
end
|
||||
|
||||
defp max_events_per_window do
|
||||
case Application.get_env(:parrhesia, :limits, [])
|
||||
|> Keyword.get(:relay_max_event_ingest_per_window) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> @default_max_events_per_window
|
||||
end
|
||||
end
|
||||
|
||||
defp window_seconds do
|
||||
case Application.get_env(:parrhesia, :limits, [])
|
||||
|> Keyword.get(:relay_event_ingest_window_seconds) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> @default_window_seconds
|
||||
end
|
||||
end
|
||||
end
|
||||
169
lib/parrhesia/web/ip_event_ingest_limiter.ex
Normal file
169
lib/parrhesia/web/ip_event_ingest_limiter.ex
Normal file
@@ -0,0 +1,169 @@
|
||||
defmodule Parrhesia.Web.IPEventIngestLimiter do
|
||||
@moduledoc """
|
||||
Per-IP EVENT ingest rate limiting over a fixed time window.
|
||||
"""
|
||||
|
||||
use GenServer
|
||||
|
||||
@default_max_events_per_window 1_000
|
||||
@default_window_seconds 1
|
||||
@named_table :parrhesia_ip_event_ingest_limiter
|
||||
@config_key :config
|
||||
|
||||
@spec start_link(keyword()) :: GenServer.on_start()
|
||||
def start_link(opts \\ []) do
|
||||
max_events_per_window =
|
||||
normalize_positive_integer(
|
||||
Keyword.get(opts, :max_events_per_window),
|
||||
max_events_per_window()
|
||||
)
|
||||
|
||||
window_ms =
|
||||
normalize_positive_integer(Keyword.get(opts, :window_seconds), window_seconds()) * 1000
|
||||
|
||||
init_arg = %{
|
||||
max_events_per_window: max_events_per_window,
|
||||
window_ms: window_ms,
|
||||
named_table?: Keyword.get(opts, :name, __MODULE__) == __MODULE__
|
||||
}
|
||||
|
||||
case Keyword.get(opts, :name, __MODULE__) do
|
||||
nil -> GenServer.start_link(__MODULE__, init_arg)
|
||||
name -> GenServer.start_link(__MODULE__, init_arg, name: name)
|
||||
end
|
||||
end
|
||||
|
||||
@spec allow(tuple() | String.t() | nil, GenServer.server()) ::
|
||||
:ok | {:error, :ip_event_rate_limited}
|
||||
def allow(remote_ip, server \\ __MODULE__)
|
||||
|
||||
def allow(remote_ip, __MODULE__) do
|
||||
case normalize_remote_ip(remote_ip) do
|
||||
nil ->
|
||||
:ok
|
||||
|
||||
normalized_remote_ip ->
|
||||
case fetch_named_config() do
|
||||
{:ok, max_events_per_window, window_ms} ->
|
||||
allow_counter(@named_table, normalized_remote_ip, max_events_per_window, window_ms)
|
||||
|
||||
:error ->
|
||||
:ok
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def allow(remote_ip, server), do: GenServer.call(server, {:allow, remote_ip})
|
||||
|
||||
@impl true
|
||||
def init(%{
|
||||
max_events_per_window: max_events_per_window,
|
||||
window_ms: window_ms,
|
||||
named_table?: named_table?
|
||||
}) do
|
||||
table = create_table(named_table?)
|
||||
|
||||
true = :ets.insert(table, {@config_key, max_events_per_window, window_ms})
|
||||
|
||||
{:ok,
|
||||
%{
|
||||
table: table,
|
||||
max_events_per_window: max_events_per_window,
|
||||
window_ms: window_ms
|
||||
}}
|
||||
end
|
||||
|
||||
@impl true
|
||||
def handle_call({:allow, remote_ip}, _from, state) do
|
||||
reply =
|
||||
case normalize_remote_ip(remote_ip) do
|
||||
nil ->
|
||||
:ok
|
||||
|
||||
normalized_remote_ip ->
|
||||
allow_counter(
|
||||
state.table,
|
||||
normalized_remote_ip,
|
||||
state.max_events_per_window,
|
||||
state.window_ms
|
||||
)
|
||||
end
|
||||
|
||||
{:reply, reply, state}
|
||||
end
|
||||
|
||||
defp normalize_positive_integer(value, _default) when is_integer(value) and value > 0, do: value
|
||||
defp normalize_positive_integer(_value, default), do: default
|
||||
|
||||
defp create_table(true) do
|
||||
:ets.new(@named_table, [
|
||||
:named_table,
|
||||
:set,
|
||||
:public,
|
||||
{:read_concurrency, true},
|
||||
{:write_concurrency, true}
|
||||
])
|
||||
end
|
||||
|
||||
defp create_table(false) do
|
||||
:ets.new(__MODULE__, [:set, :public, {:read_concurrency, true}, {:write_concurrency, true}])
|
||||
end
|
||||
|
||||
defp fetch_named_config do
|
||||
case :ets.lookup(@named_table, @config_key) do
|
||||
[{@config_key, max_events_per_window, window_ms}] -> {:ok, max_events_per_window, window_ms}
|
||||
_other -> :error
|
||||
end
|
||||
rescue
|
||||
ArgumentError -> :error
|
||||
end
|
||||
|
||||
defp allow_counter(table, remote_ip, max_events_per_window, window_ms) do
|
||||
window_id = System.monotonic_time(:millisecond) |> div(window_ms)
|
||||
key = {:window, remote_ip, window_id}
|
||||
|
||||
count = :ets.update_counter(table, key, {2, 1}, {key, 0})
|
||||
|
||||
if count == 1 do
|
||||
prune_expired_windows(table, window_id)
|
||||
end
|
||||
|
||||
if count <= max_events_per_window do
|
||||
:ok
|
||||
else
|
||||
{:error, :ip_event_rate_limited}
|
||||
end
|
||||
rescue
|
||||
ArgumentError -> :ok
|
||||
end
|
||||
|
||||
defp prune_expired_windows(table, window_id) do
|
||||
:ets.select_delete(table, [
|
||||
{{{:window, :"$1", :"$2"}, :_}, [{:<, :"$2", window_id}], [true]}
|
||||
])
|
||||
end
|
||||
|
||||
defp normalize_remote_ip({_, _, _, _} = remote_ip), do: :inet.ntoa(remote_ip) |> to_string()
|
||||
|
||||
defp normalize_remote_ip({_, _, _, _, _, _, _, _} = remote_ip),
|
||||
do: :inet.ntoa(remote_ip) |> to_string()
|
||||
|
||||
defp normalize_remote_ip(remote_ip) when is_binary(remote_ip) and remote_ip != "", do: remote_ip
|
||||
defp normalize_remote_ip(_remote_ip), do: nil
|
||||
|
||||
defp max_events_per_window do
|
||||
case Application.get_env(:parrhesia, :limits, [])
|
||||
|> Keyword.get(:ip_max_event_ingest_per_window) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> @default_max_events_per_window
|
||||
end
|
||||
end
|
||||
|
||||
defp window_seconds do
|
||||
case Application.get_env(:parrhesia, :limits, [])
|
||||
|> Keyword.get(:ip_event_ingest_window_seconds) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> @default_window_seconds
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -21,6 +21,7 @@ defmodule Parrhesia.Web.Listener do
|
||||
id: atom(),
|
||||
enabled: boolean(),
|
||||
bind: %{ip: tuple(), port: pos_integer()},
|
||||
max_connections: pos_integer() | :infinity,
|
||||
transport: map(),
|
||||
proxy: map(),
|
||||
network: map(),
|
||||
@@ -167,12 +168,20 @@ defmodule Parrhesia.Web.Listener do
|
||||
_other -> listener.transport.scheme
|
||||
end
|
||||
|
||||
thousand_island_options =
|
||||
listener.bandit_options
|
||||
|> Keyword.get(:thousand_island_options, [])
|
||||
|> maybe_put_connection_limit(listener.max_connections)
|
||||
|
||||
[
|
||||
ip: listener.bind.ip,
|
||||
port: listener.bind.port,
|
||||
scheme: scheme,
|
||||
plug: {Parrhesia.Web.ListenerPlug, listener: listener}
|
||||
] ++ TLS.bandit_options(listener.transport.tls) ++ listener.bandit_options
|
||||
plug: {Parrhesia.Plug, listener: listener}
|
||||
] ++
|
||||
TLS.bandit_options(listener.transport.tls) ++
|
||||
[thousand_island_options: thousand_island_options] ++
|
||||
Keyword.delete(listener.bandit_options, :thousand_island_options)
|
||||
end
|
||||
|
||||
defp normalize_listeners(listeners) when is_list(listeners) do
|
||||
@@ -195,6 +204,7 @@ defmodule Parrhesia.Web.Listener do
|
||||
id = normalize_atom(fetch_value(listener, :id), :listener)
|
||||
enabled = normalize_boolean(fetch_value(listener, :enabled), true)
|
||||
bind = normalize_bind(fetch_value(listener, :bind), listener)
|
||||
max_connections = normalize_max_connections(fetch_value(listener, :max_connections), id)
|
||||
transport = normalize_transport(fetch_value(listener, :transport))
|
||||
proxy = normalize_proxy(fetch_value(listener, :proxy))
|
||||
network = normalize_access(fetch_value(listener, :network), %{allow_all?: true})
|
||||
@@ -207,6 +217,7 @@ defmodule Parrhesia.Web.Listener do
|
||||
id: id,
|
||||
enabled: enabled,
|
||||
bind: bind,
|
||||
max_connections: max_connections,
|
||||
transport: transport,
|
||||
proxy: proxy,
|
||||
network: network,
|
||||
@@ -233,6 +244,14 @@ defmodule Parrhesia.Web.Listener do
|
||||
}
|
||||
end
|
||||
|
||||
defp normalize_max_connections(value, _listener_id) when is_integer(value) and value > 0,
|
||||
do: value
|
||||
|
||||
defp normalize_max_connections(:infinity, _listener_id), do: :infinity
|
||||
defp normalize_max_connections("infinity", _listener_id), do: :infinity
|
||||
defp normalize_max_connections(_value, :metrics), do: 1_024
|
||||
defp normalize_max_connections(_value, _listener_id), do: 20_000
|
||||
|
||||
defp default_bind_ip(listener) do
|
||||
normalize_ip(fetch_value(listener, :ip), {0, 0, 0, 0})
|
||||
end
|
||||
@@ -349,6 +368,27 @@ defmodule Parrhesia.Web.Listener do
|
||||
defp normalize_bandit_options(options) when is_list(options), do: options
|
||||
defp normalize_bandit_options(_options), do: []
|
||||
|
||||
defp maybe_put_connection_limit(thousand_island_options, :infinity)
|
||||
when is_list(thousand_island_options),
|
||||
do: Keyword.put_new(thousand_island_options, :num_connections, :infinity)
|
||||
|
||||
defp maybe_put_connection_limit(thousand_island_options, max_connections)
|
||||
when is_list(thousand_island_options) and is_integer(max_connections) and
|
||||
max_connections > 0 do
|
||||
num_acceptors =
|
||||
case Keyword.get(thousand_island_options, :num_acceptors, 100) do
|
||||
value when is_integer(value) and value > 0 -> value
|
||||
_other -> 100
|
||||
end
|
||||
|
||||
per_acceptor_limit = ceil(max_connections / num_acceptors)
|
||||
Keyword.put_new(thousand_island_options, :num_connections, per_acceptor_limit)
|
||||
end
|
||||
|
||||
defp maybe_put_connection_limit(thousand_island_options, _max_connections)
|
||||
when is_list(thousand_island_options),
|
||||
do: thousand_island_options
|
||||
|
||||
defp normalize_access(access, defaults) when is_map(access) do
|
||||
%{
|
||||
public?:
|
||||
@@ -516,6 +556,7 @@ defmodule Parrhesia.Web.Listener do
|
||||
id: :public,
|
||||
enabled: true,
|
||||
bind: %{ip: {0, 0, 0, 0}, port: 4413},
|
||||
max_connections: 20_000,
|
||||
transport: %{scheme: :http, tls: TLS.default_config()},
|
||||
proxy: %{trusted_cidrs: [], honor_x_forwarded_for: true},
|
||||
network: %{public?: false, private_networks_only?: false, allow_cidrs: [], allow_all?: true},
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
defmodule Parrhesia.Web.ListenerPlug do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.Web.Listener
|
||||
alias Parrhesia.Web.Router
|
||||
|
||||
def init(opts), do: opts
|
||||
|
||||
def call(conn, opts) do
|
||||
conn
|
||||
|> Listener.put_conn(opts)
|
||||
|> Router.call([])
|
||||
end
|
||||
end
|
||||
@@ -35,6 +35,9 @@ defmodule Parrhesia.Web.Management do
|
||||
{:error, :stale_event} ->
|
||||
send_json(conn, 401, %{"ok" => false, "error" => "stale-auth-event"})
|
||||
|
||||
{:error, :replayed_auth_event} ->
|
||||
send_json(conn, 401, %{"ok" => false, "error" => "replayed-auth-event"})
|
||||
|
||||
{:error, :invalid_method_tag} ->
|
||||
send_json(conn, 401, %{"ok" => false, "error" => "auth-method-tag-mismatch"})
|
||||
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
defmodule Parrhesia.Web.Readiness do
|
||||
@moduledoc false
|
||||
|
||||
alias Parrhesia.PostgresRepos
|
||||
|
||||
@spec ready?() :: boolean()
|
||||
def ready? do
|
||||
process_ready?(Parrhesia.Subscriptions.Index) and
|
||||
process_ready?(Parrhesia.Auth.Challenges) and
|
||||
negentropy_ready?() and
|
||||
process_ready?(Parrhesia.Repo)
|
||||
repos_ready?()
|
||||
end
|
||||
|
||||
defp negentropy_ready? do
|
||||
@@ -29,4 +31,8 @@ defmodule Parrhesia.Web.Readiness do
|
||||
nil -> false
|
||||
end
|
||||
end
|
||||
|
||||
defp repos_ready? do
|
||||
Enum.all?(PostgresRepos.started_repos(), &process_ready?/1)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,32 +1,58 @@
|
||||
defmodule Parrhesia.Web.RelayInfo do
|
||||
@moduledoc """
|
||||
NIP-11 relay information document.
|
||||
|
||||
`document/1` builds the JSON-serialisable relay info map served on
|
||||
`GET /relay` with `Accept: application/nostr+json`, including supported NIPs,
|
||||
limitations, and the relay's advertised public key.
|
||||
"""
|
||||
|
||||
alias Parrhesia.API.Identity
|
||||
alias Parrhesia.Metadata
|
||||
alias Parrhesia.NIP43
|
||||
alias Parrhesia.Web.Listener
|
||||
|
||||
@spec document(Listener.t()) :: map()
|
||||
@spec document(map()) :: map()
|
||||
def document(listener) do
|
||||
%{
|
||||
"name" => "Parrhesia",
|
||||
document = %{
|
||||
"name" => Metadata.name(),
|
||||
"description" => "Nostr/Marmot relay",
|
||||
"pubkey" => relay_pubkey(),
|
||||
"self" => relay_pubkey(),
|
||||
"supported_nips" => supported_nips(),
|
||||
"software" => "https://git.teralink.net/self/parrhesia",
|
||||
"version" => Application.spec(:parrhesia, :vsn) |> to_string(),
|
||||
"limitation" => limitations(listener)
|
||||
}
|
||||
|
||||
if Metadata.hide_version?() do
|
||||
document
|
||||
else
|
||||
Map.put(document, "version", Metadata.version())
|
||||
end
|
||||
end
|
||||
|
||||
defp supported_nips do
|
||||
base = [1, 9, 11, 13, 17, 40, 42, 43, 44, 45, 50, 59, 62, 66, 70]
|
||||
base = [1, 9, 11, 13, 17, 40, 42, 44, 45, 50, 59, 62, 70]
|
||||
|
||||
with_nip43 =
|
||||
if NIP43.enabled?() do
|
||||
base ++ [43]
|
||||
else
|
||||
base
|
||||
end
|
||||
|
||||
with_nip66 =
|
||||
if Parrhesia.NIP66.enabled?() do
|
||||
with_nip43 ++ [66]
|
||||
else
|
||||
with_nip43
|
||||
end
|
||||
|
||||
with_negentropy =
|
||||
if negentropy_enabled?() do
|
||||
base ++ [77]
|
||||
with_nip66 ++ [77]
|
||||
else
|
||||
base
|
||||
with_nip66
|
||||
end
|
||||
|
||||
with_negentropy ++ [86, 98]
|
||||
@@ -38,7 +64,12 @@ defmodule Parrhesia.Web.RelayInfo do
|
||||
"max_subscriptions" =>
|
||||
Parrhesia.Config.get([:limits, :max_subscriptions_per_connection], 32),
|
||||
"max_filters" => Parrhesia.Config.get([:limits, :max_filters_per_req], 16),
|
||||
"auth_required" => Listener.relay_auth_required?(listener)
|
||||
"max_limit" => Parrhesia.Config.get([:limits, :max_filter_limit], 500),
|
||||
"max_event_tags" => Parrhesia.Config.get([:limits, :max_tags_per_event], 256),
|
||||
"min_pow_difficulty" => Parrhesia.Config.get([:policies, :min_pow_difficulty], 0),
|
||||
"auth_required" => Listener.relay_auth_required?(listener),
|
||||
"payment_required" => false,
|
||||
"restricted_writes" => restricted_writes?(listener)
|
||||
}
|
||||
end
|
||||
|
||||
@@ -54,4 +85,12 @@ defmodule Parrhesia.Web.RelayInfo do
|
||||
{:error, _reason} -> nil
|
||||
end
|
||||
end
|
||||
|
||||
defp restricted_writes?(listener) do
|
||||
listener.auth.nip42_required or
|
||||
(listener.baseline_acl.write != [] and
|
||||
Enum.any?(listener.baseline_acl.write, &(&1.action == :deny))) or
|
||||
Parrhesia.Config.get([:policies, :auth_required_for_writes], false) or
|
||||
Parrhesia.Config.get([:policies, :min_pow_difficulty], 0) > 0
|
||||
end
|
||||
end
|
||||
|
||||
61
mix.exs
61
mix.exs
@@ -4,11 +4,13 @@ defmodule Parrhesia.MixProject do
|
||||
def project do
|
||||
[
|
||||
app: :parrhesia,
|
||||
version: "0.5.0",
|
||||
version: "0.8.0",
|
||||
elixir: "~> 1.18",
|
||||
elixirc_paths: elixirc_paths(Mix.env()),
|
||||
start_permanent: Mix.env() == :prod,
|
||||
deps: deps(),
|
||||
aliases: aliases()
|
||||
aliases: aliases(),
|
||||
docs: docs()
|
||||
]
|
||||
end
|
||||
|
||||
@@ -20,8 +22,15 @@ defmodule Parrhesia.MixProject do
|
||||
]
|
||||
end
|
||||
|
||||
defp elixirc_paths(:test), do: ["lib", "test/support"]
|
||||
defp elixirc_paths(_env), do: ["lib"]
|
||||
|
||||
def cli do
|
||||
[preferred_envs: [precommit: :test, bench: :test]]
|
||||
[
|
||||
preferred_envs: [
|
||||
precommit: :test
|
||||
]
|
||||
]
|
||||
end
|
||||
|
||||
# Run "mix help deps" to learn about dependencies.
|
||||
@@ -49,6 +58,7 @@ defmodule Parrhesia.MixProject do
|
||||
|
||||
# Project tooling
|
||||
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
|
||||
{:ex_doc, "~> 0.34", only: :dev, runtime: false},
|
||||
{:deps_changelog, "~> 0.3"},
|
||||
{:igniter, "~> 0.6", only: [:dev, :test]}
|
||||
]
|
||||
@@ -60,12 +70,6 @@ defmodule Parrhesia.MixProject do
|
||||
"ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
|
||||
"ecto.reset": ["ecto.drop", "ecto.setup"],
|
||||
test: ["ecto.create --quiet", "ecto.migrate --quiet", "test"],
|
||||
"test.nak_e2e": ["cmd ./scripts/run_nak_e2e.sh"],
|
||||
"test.marmot_e2e": ["cmd ./scripts/run_marmot_e2e.sh"],
|
||||
"test.node_sync_e2e": ["cmd ./scripts/run_node_sync_e2e.sh"],
|
||||
"test.node_sync_docker_e2e": ["cmd ./scripts/run_node_sync_docker_e2e.sh"],
|
||||
bench: ["cmd ./scripts/run_bench_compare.sh"],
|
||||
# cov: ["cmd mix coveralls.lcov"],
|
||||
lint: ["format --check-formatted", "credo"],
|
||||
precommit: [
|
||||
"format",
|
||||
@@ -73,9 +77,44 @@ defmodule Parrhesia.MixProject do
|
||||
"credo --strict --all",
|
||||
"deps.unlock --unused",
|
||||
"test",
|
||||
# "test.nak_e2e",
|
||||
"test.marmot_e2e"
|
||||
"cmd just e2e marmot"
|
||||
]
|
||||
]
|
||||
end
|
||||
|
||||
defp docs do
|
||||
[
|
||||
main: "readme",
|
||||
output: "_build/doc",
|
||||
extras: [
|
||||
"README.md",
|
||||
"docs/LOCAL_API.md",
|
||||
"docs/SYNC.md",
|
||||
"docs/ARCH.md",
|
||||
"docs/CLUSTER.md",
|
||||
"BENCHMARK.md"
|
||||
],
|
||||
groups_for_modules: [
|
||||
"Embedded API": [
|
||||
Parrhesia.API.ACL,
|
||||
Parrhesia.API.Admin,
|
||||
Parrhesia.API.Auth,
|
||||
Parrhesia.API.Auth.Context,
|
||||
Parrhesia.API.Events,
|
||||
Parrhesia.API.Events.PublishResult,
|
||||
Parrhesia.API.Identity,
|
||||
Parrhesia.API.RequestContext,
|
||||
Parrhesia.API.Stream,
|
||||
Parrhesia.API.Sync
|
||||
],
|
||||
Runtime: [
|
||||
Parrhesia,
|
||||
Parrhesia.Plug,
|
||||
Parrhesia.Release,
|
||||
Parrhesia.Runtime
|
||||
]
|
||||
],
|
||||
nest_modules_by_prefix: [Parrhesia.API]
|
||||
]
|
||||
end
|
||||
end
|
||||
|
||||
8
mix.lock
8
mix.lock
@@ -8,19 +8,25 @@
|
||||
"db_connection": {:hex, :db_connection, "2.9.0", "a6a97c5c958a2d7091a58a9be40caf41ab496b0701d21e1d1abff3fa27a7f371", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "17d502eacaf61829db98facf6f20808ed33da6ccf495354a41e64fe42f9c509c"},
|
||||
"decimal": {:hex, :decimal, "2.3.0", "3ad6255aa77b4a3c4f818171b12d237500e63525c2fd056699967a3e7ea20f62", [:mix], [], "hexpm", "a4d66355cb29cb47c3cf30e71329e58361cfcb37c34235ef3bf1d7bf3773aeac"},
|
||||
"deps_changelog": {:hex, :deps_changelog, "0.3.5", "65981997d9bc893b8027a0c03da093a4083328c00b17f562df269c2b61d44073", [:mix], [], "hexpm", "298fcd7794395d8e61dba8d29ce8fcee09f1df4d48adb273a41e8f4a1736491e"},
|
||||
"earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
|
||||
"ecto": {:hex, :ecto, "3.13.5", "9d4a69700183f33bf97208294768e561f5c7f1ecf417e0fa1006e4a91713a834", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "df9efebf70cf94142739ba357499661ef5dbb559ef902b68ea1f3c1fabce36de"},
|
||||
"ecto_sql": {:hex, :ecto_sql, "3.13.5", "2f8282b2ad97bf0f0d3217ea0a6fff320ead9e2f8770f810141189d182dc304e", [:mix], [{:db_connection, "~> 2.4.1 or ~> 2.5", [hex: :db_connection, repo: "hexpm", optional: false]}, {:ecto, "~> 3.13.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:myxql, "~> 0.7", [hex: :myxql, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.19 or ~> 1.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:tds, "~> 2.1.1 or ~> 2.2", [hex: :tds, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.0 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "aa36751f4e6a2b56ae79efb0e088042e010ff4935fc8684e74c23b1f49e25fdc"},
|
||||
"elixir_make": {:hex, :elixir_make, "0.9.0", "6484b3cd8c0cee58f09f05ecaf1a140a8c97670671a6a0e7ab4dc326c3109726", [:mix], [], "hexpm", "db23d4fd8b757462ad02f8aa73431a426fe6671c80b200d9710caf3d1dd0ffdb"},
|
||||
"ex_doc": {:hex, :ex_doc, "0.40.1", "67542e4b6dde74811cfd580e2c0149b78010fd13001fda7cfeb2b2c2ffb1344d", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "bcef0e2d360d93ac19f01a85d58f91752d930c0a30e2681145feea6bd3516e00"},
|
||||
"file_system": {:hex, :file_system, "1.1.1", "31864f4685b0148f25bd3fbef2b1228457c0c89024ad67f7a81a3ffbc0bbad3a", [:mix], [], "hexpm", "7a15ff97dfe526aeefb090a7a9d3d03aa907e100e262a0f8f7746b78f8f87a5d"},
|
||||
"finch": {:hex, :finch, "0.21.0", "b1c3b2d48af02d0c66d2a9ebfb5622be5c5ecd62937cf79a88a7f98d48a8290c", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.6.2 or ~> 1.7", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 1.1", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "87dc6e169794cb2570f75841a19da99cfde834249568f2a5b121b809588a4377"},
|
||||
"glob_ex": {:hex, :glob_ex, "0.1.11", "cb50d3f1ef53f6ca04d6252c7fde09fd7a1cf63387714fe96f340a1349e62c93", [:mix], [], "hexpm", "342729363056e3145e61766b416769984c329e4378f1d558b63e341020525de4"},
|
||||
"hpax": {:hex, :hpax, "1.0.3", "ed67ef51ad4df91e75cc6a1494f851850c0bd98ebc0be6e81b026e765ee535aa", [:mix], [], "hexpm", "8eab6e1cfa8d5918c2ce4ba43588e894af35dbd8e91e6e55c817bca5847df34a"},
|
||||
"igniter": {:hex, :igniter, "0.7.4", "b5f9dd512eb1e672f1c141b523142b5b4602fcca231df5b4e362999df4b88e14", [:mix], [{:glob_ex, "~> 0.1.7", [hex: :glob_ex, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:owl, "~> 0.11", [hex: :owl, repo: "hexpm", optional: false]}, {:phx_new, "~> 1.7", [hex: :phx_new, repo: "hexpm", optional: true]}, {:req, "~> 0.5", [hex: :req, repo: "hexpm", optional: false]}, {:rewrite, ">= 1.1.1 and < 2.0.0-0", [hex: :rewrite, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.4", [hex: :sourceror, repo: "hexpm", optional: false]}, {:spitfire, ">= 0.1.3 and < 1.0.0-0", [hex: :spitfire, repo: "hexpm", optional: false]}], "hexpm", "971b240ee916a06b1af56381a262d9eeaff9610eddc299d61a213cd7a9d79efd"},
|
||||
"igniter": {:hex, :igniter, "0.7.6", "687d622c735e020f13cf480c83d0fce1cc899f4fbed547f5254b960ea82d3525", [:mix], [{:glob_ex, "~> 0.1.7", [hex: :glob_ex, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:owl, "~> 0.11", [hex: :owl, repo: "hexpm", optional: false]}, {:phx_new, "~> 1.7", [hex: :phx_new, repo: "hexpm", optional: true]}, {:req, "~> 0.5", [hex: :req, repo: "hexpm", optional: false]}, {:rewrite, ">= 1.1.1 and < 2.0.0-0", [hex: :rewrite, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.4", [hex: :sourceror, repo: "hexpm", optional: false]}, {:spitfire, ">= 0.1.3 and < 1.0.0-0", [hex: :spitfire, repo: "hexpm", optional: false]}], "hexpm", "424f41a41273fce0f7424008405ee073b5bd06359ca9396e841f83a669c01619"},
|
||||
"jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
|
||||
"lib_secp256k1": {:hex, :lib_secp256k1, "0.7.1", "53cad778b8da3a29e453a7a477517d99fb5f13f615c8050eb2db8fd1dce7a1db", [:make, :mix], [{:elixir_make, "~> 0.9", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "78bdd3661a17448aff5aeec5ca74c8ddbc09b01f0ecfa3ba1aba3e8ae47ab2b3"},
|
||||
"makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
|
||||
"makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
|
||||
"makeup_erlang": {:hex, :makeup_erlang, "1.0.3", "4252d5d4098da7415c390e847c814bad3764c94a814a0b4245176215615e1035", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "953297c02582a33411ac6208f2c6e55f0e870df7f80da724ed613f10e6706afd"},
|
||||
"mime": {:hex, :mime, "2.0.7", "b8d739037be7cd402aee1ba0306edfdef982687ee7e9859bee6198c1e7e2f128", [:mix], [], "hexpm", "6171188e399ee16023ffc5b76ce445eb6d9672e2e241d2df6050f3c771e80ccd"},
|
||||
"mint": {:hex, :mint, "1.7.1", "113fdb2b2f3b59e47c7955971854641c61f378549d73e829e1768de90fc1abf1", [:mix], [{:castore, "~> 0.1.0 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:hpax, "~> 0.1.1 or ~> 0.2.0 or ~> 1.0", [hex: :hpax, repo: "hexpm", optional: false]}], "hexpm", "fceba0a4d0f24301ddee3024ae116df1c3f4bb7a563a731f45fdfeb9d39a231b"},
|
||||
"nimble_options": {:hex, :nimble_options, "1.1.1", "e3a492d54d85fc3fd7c5baf411d9d2852922f66e69476317787a7b2bb000a61b", [:mix], [], "hexpm", "821b2470ca9442c4b6984882fe9bb0389371b8ddec4d45a9504f00a66f650b44"},
|
||||
"nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
|
||||
"nimble_pool": {:hex, :nimble_pool, "1.1.0", "bf9c29fbdcba3564a8b800d1eeb5a3c58f36e1e11d7b7fb2e084a643f645f06b", [:mix], [], "hexpm", "af2e4e6b34197db81f7aad230c1118eac993acc0dae6bc83bac0126d4ae0813a"},
|
||||
"owl": {:hex, :owl, "0.13.0", "26010e066d5992774268f3163506972ddac0a7e77bfe57fa42a250f24d6b876e", [:mix], [{:ucwidth, "~> 0.2", [hex: :ucwidth, repo: "hexpm", optional: true]}], "hexpm", "59bf9d11ce37a4db98f57cb68fbfd61593bf419ec4ed302852b6683d3d2f7475"},
|
||||
"plug": {:hex, :plug, "1.19.1", "09bac17ae7a001a68ae393658aa23c7e38782be5c5c00c80be82901262c394c0", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "560a0017a8f6d5d30146916862aaf9300b7280063651dd7e532b8be168511e62"},
|
||||
|
||||
1
nix/nostr-bench
Submodule
1
nix/nostr-bench
Submodule
Submodule nix/nostr-bench added at 8561b84864
2333
nix/nostr-bench-static.Cargo.lock
generated
Normal file
2333
nix/nostr-bench-static.Cargo.lock
generated
Normal file
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user