Source code for fleetmesh_node.commands.gossip_cmds

"""Gossip topics: create and publish rosters, admit another admin's, leave,
and flood a sealed wrap into a mesh. Every verb is the running daemon's
(it holds the keys and the mesh); this module is the operator's words for
them."""
from __future__ import annotations

import argparse

from fleetmesh_node.config.parameter import Parameter
from fleetmesh_node.planes.services.gossip.core import GossipMesh
from .adapter import CommandDispatcher
from .base import _ask, _peer, _short, _table, add_command, emit, fail, load_json_arg


def _show(r: dict) -> None:
    print('Gossip: %d topic(s), %d seen id(s), %d published, %d delivered, %d refused'
          % (len(r.get('topics', [])), r.get('seen', 0), r.get('published', 0),
             r.get('delivered', 0), r.get('refused', 0)))
    for t in r.get('topics', []):
        print('  %-40s mesh %d' % (t[:40], (r.get('mesh') or {}).get(t, 0)))


def _topics(rows: list) -> None:
    _table(['topic', 'admin', 'members', 'mesh', 'expires'],
           [[_short(r['admin']) + ':' + r['topic'].split(':', 1)[1] if ':' in r['topic'] else r['topic'],
             _short(r['admin']), len(r['members']), len(r['mesh']), r['expires']] for r in rows])


def _cmd_create(a: argparse.Namespace) -> int:
    if not a.name:
        fail('create requires --name <topic-name>')
    members = [_peer(a.dir, m) for m in (a.member or [])]
    if not members:
        fail('create requires at least one --member besides this node')
    r = _ask(a.dir, 'gossip.create', name=a.name, members=members, ttl_seconds=a.ttl,
             no_relay=bool(a.no_relay), timeout=60)

    def created(r: dict) -> None:
        print('topic %s' % r['topic'])
        print('roster %s, %d member(s), expires %s' % (r['event']['id'][:16], len(members) + 1,
                                                       next(t[1] for t in r['event']['tags'] if t[0] == 'expiration')))
        for url, (ok, why) in (r.get('relays') or {}).items():
            print('  %-40s %s %s' % (url, 'accepted' if ok else 'REFUSED', why))
        if not r.get('relays') and not a.no_relay:
            print('  (no relays configured; give the roster to the members with --json)')
    return emit(a, r, created)


def _cmd_admit(a: argparse.Namespace) -> int:
    if not a.event:
        fail('admit requires --event <json|@file>')
    r = _ask(a.dir, 'gossip.admit', event=load_json_arg(a.event, '--event'), timeout=15)
    return emit(a, r, lambda r: print('admitted %s' % r['topic']))


def _cmd_publish(a: argparse.Namespace) -> int:
    if not a.topic or not a.event:
        fail('publish requires --topic <id> and --event <sealed wrap json|@file>')
    r = _ask(a.dir, 'gossip.publish', topic=a.topic, envelope=load_json_arg(a.event, '--event'), timeout=30)
    return emit(a, r, lambda r: print('published %s into %s: sent to %d of %d mesh peer(s)'
                                      % (r['event_id'][:16], r['topic'][:40], len(r['sent_to']), r['mesh'])))


_cmd_map = {c.key: c for c in GossipMesh.COMMANDS}
dispatcher = CommandDispatcher('gossip', default_action='status')
dispatcher.add_command('status', _cmd_map['show'], human=_show, timeout=10)
dispatcher.add_command('topics', _cmd_map['topics'], human=_topics, timeout=10)
dispatcher.add_command('leave', _cmd_map['leave'], human=lambda r, a: print('left %s, pruned %d peer(s)' % (r['topic'], r['pruned'])), timeout=15)
dispatcher.add_custom(
    'create',
    handler=_cmd_create,
    parameters=(
        Parameter(key='name', name='name', description='topic name for create; the id becomes <this node pk>:<name>', type=str, default=''),
        Parameter(key='member', name='member', description='a member pubkey/did/npub/prefix for create (repeatable)', type=list, default=list, cli_name='--member'),
        Parameter(key='ttl', name='ttl', description='roster lifetime in seconds for create (default 30 days)', type=int, default=30 * 86400),
        Parameter(key='no_relay', name='no_relay', description='create: do not publish the roster to the configured relays', type=bool, default=False, cli_name='--no-relay'),
    ),
)
dispatcher.add_custom(
    'admit',
    handler=_cmd_admit,
    parameters=(
        Parameter(key='event', name='event', description='JSON event, or @file: a kind 30804 roster for admit, a sealed wrap for publish', type=str, default=''),
    ),
)
dispatcher.add_custom(
    'publish',
    handler=_cmd_publish,
    parameters=(
        Parameter(key='topic', name='topic', description='topic id for leave / publish', type=str, default=''),
        Parameter(key='event', name='event', description='JSON event, or @file: a kind 30804 roster for admit, a sealed wrap for publish', type=str, default=''),
    ),
)


[docs]def cmd_gossip(a: argparse.Namespace) -> int: return dispatcher.dispatch(a)
[docs]class GossipCommandProvider: """Registers the gossip topic commands."""
[docs] @classmethod def register(cls, sub: argparse._SubParsersAction) -> None: g = add_command(sub, 'gossip', cmd_gossip, 'gossip/1.0 group topics: create and publish rosters, flood sealed wraps', js=True, experimental=True) dispatcher.register_arguments(g, action_choices=('status', 'topics', 'create', 'admit', 'leave', 'publish'))