feat(2.7.0): Roadmap im DC, Testinstanz mit Testtor, Supervisor und MCP
Sammelcommit fuer den ueber mehrere Sitzungen gewachsenen, bisher nicht
eingecheckten Stand. Getrennte Commits waeren ehrlicher gewesen, sind es
nachtraeglich aber nicht mehr: BugRepo, changelog.json und die Doku tragen
Aenderungen aus allen Straengen gleichzeitig, und keine Zwischenstufe waere
lauffaehig.
ROADMAP IM DEPLOYMENTCENTER (2.7.0)
Planungsstand, Reihenfolge und Zustaendigkeit lagen in handgepflegten
Markdown-Dateien neben einem Bugtracker, der genau diese drei Dinge bereits
fuehrt. Zwei Pfleger fuer dasselbe Feld - Drift war eine Frage der Zeit.
Ab jetzt: Zustand im DC, Begruendung in der Datei. Kein Feld hat zwei Pfleger.
- Migration 016: epic, roadmap_rank, target_build, defer_trigger,
doc_anchor, Status "deferred", Tabelle roadmap_epics.
KEINE Roadmap-Tabelle - ein Eintrag ist ein bugtracker_item.
- Zugehoerigkeit ist ein Feld: Ein Item steht auf der Roadmap, wenn es ein
epic hat. Ein zweites Kennzeichen daneben koennte auseinanderlaufen.
- Kennung ist die Item-ID. Handvergebene Kuerzel ("A12") erzeugen die
schlimmste Fehlerart: Beide Seiten stimmig, Verschiedenes gemeint, weil
die Kennung nach einer Loeschung neu vergeben wurde.
- Zurueckstellen verlangt defer_trigger. Ohne benannten Anlass ist ein
Vorhaben nicht zurueckgestellt, sondern vergessen. Die Regel sitzt im
Repository, damit sie auf allen drei Schreibwegen gleich greift.
- Modules/Bugtracker/Roadmap.php, /api/bugtracker/v1/roadmap.php,
WebUI-Modul mit Filtern, cli/roadmap.php --write/--check,
dc_roadmap und dc_roadmap_set im MCP-Adapter.
- cli/roadmap.php --write ERZEUGT den Zustandsteil der Markdown-Datei;
--check prueft nur die Prosa. Was erzeugt wird, kann nicht driften.
- docs/ROADMAP_MIGRATION.md: Uebernahme fuer die anderen Projekte.
TESTINSTANZ UND TESTTOR
- dc-dev.mhdf.de: zweite Installation, eigene DB, eigene Schluessel,
Basic-Auth davor, Rocket.Chat aus.
- 124 Testfaelle in tests/e2e gegen API, Rechte, Migrationen, Sperre.
- scripts/deploy.py bringt vor jedem Upload erst den anstehenden Stand auf
die Testinstanz und laesst dann den Testlauf laufen. Erst bei
Rueckgabewert 0 geht etwas auf die Produktion (--ohne-test als Notausgang).
Andersherum prueft der Lauf aelteren Code als den, der gleich hochgeht.
- tests/ ist aus dem Produktiv-Deploy ausgeschlossen; testctl.php kann
nicht versehentlich auf dc.mhdf.de landen.
- Ein Lauf mit mehr uebersprungenen als geprueften Faellen endet mit
Rueckgabewert 2 statt 0. Nichts ist kaputt, geprueft wurde es aber auch
nicht - der Unterschied darf nicht am Rueckgabewert verschwinden.
SUPERVISOR, PROJEKTLANDSCHAFT, NACHPRUEFUNG (2.6.0/2.6.1)
- Migration 013: projektuebergreifend melden (dev_agent, evidence,
triage_external, affects).
- Migration 014: supervisor_findings, Katalog, fuenf serverseitige
Detektoren im Tick.
- Migration 015: Nachpruefung als Arbeitsschlange statt Benachrichtigung.
- DEV-Lizenzschluessel zur Selbstbedienung, dc-testkit fuer die Test-VM.
- MCP-Adapter: 15 Werkzeuge, ohne Fremdabhaengigkeiten, mit Abgrenzung
von Fremddaten gegen Prompt-Injektion.
BEHOBEN
- observe und status im Supervisor legten den Zustand des Befundes als
"status" in die Antwort. Http::ok() merged ['status' => 'success']
darunter, also gewann der Befundzustand - eine angenommene Meldung kam
als status="open" an. Heisst jetzt finding_status. War Item #59.
Migrationen 013-016 sind auf dem Produktivserver noch NICHT ausgefuehrt.
Ohne sie bricht das WebUI, weil die Roadmap-Ansicht bei jedem Seitenaufruf
gegen bugtracker_items.epic abfragt.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Deploymentcenter Bot
co-authored by
Claude Opus 5
Claude Opus 5
parent
9d0261306c
commit
1d5ac92051
@@ -60,7 +60,19 @@ if ($isWrite && $method !== 'POST') {
|
||||
|
||||
$context = ApiAuth::requireScope($db, $isWrite ? 'bugtracker:manage' : 'bugtracker:read');
|
||||
$author = $context['actor'];
|
||||
|
||||
// Zwei Einschraenkungen, weil Lesen und Schreiben hier verschieden weit reichen.
|
||||
//
|
||||
// $boundProject gilt beim Schreiben und kennt keine Ausnahme: auch ein
|
||||
// Werkbank-Token uebernimmt und schliesst nur Items im eigenen Projekt. Sonst
|
||||
// zoege ein Agent, der in Projekt X arbeitet, ueber ?action=next Arbeit aus
|
||||
// einem fremden Backlog an sich.
|
||||
//
|
||||
// $readProject gilt beim Lesen und laesst Werkbank-Token durch: ein Agent, der
|
||||
// entscheiden soll, ob ein Fehler ins eigene oder ins fremde Projekt gehoert,
|
||||
// muss die Landschaft sehen.
|
||||
$boundProject = ApiAuth::projectFilter($context);
|
||||
$readProject = ApiAuth::projectFilter($context, true);
|
||||
|
||||
$itemId = resolveItemId();
|
||||
|
||||
@@ -72,7 +84,11 @@ switch ($action) {
|
||||
// no break - Http::ok beendet die Anfrage
|
||||
|
||||
case 'stats':
|
||||
$slug = Http::str('project_slug') ?? $boundProject;
|
||||
// Die Bindung geht der Anfrage vor. Vorher stand hier
|
||||
// "Http::str('project_slug') ?? $boundProject" - damit konnte ein an
|
||||
// Projekt X gebundenes Token die Zahlen jedes anderen Projekts abrufen,
|
||||
// indem es den Slug einfach mitschickte.
|
||||
$slug = $readProject ?? Http::str('project_slug');
|
||||
Http::ok(['stats' => $repo->getStats($slug)]);
|
||||
|
||||
case 'get':
|
||||
@@ -81,11 +97,11 @@ switch ($action) {
|
||||
if ($item === null) {
|
||||
Http::fail(404, 'not_found', sprintf('Item #%d existiert nicht.', $itemId));
|
||||
}
|
||||
ApiAuth::enforceProject($context, (string)$item['project_slug']);
|
||||
ApiAuth::enforceProject($context, (string)$item['project_slug'], true);
|
||||
Http::ok(['item' => $item]);
|
||||
|
||||
case 'list':
|
||||
$filters = collectFilters($boundProject);
|
||||
$filters = collectFilters($readProject);
|
||||
$result = $repo->getItems($filters);
|
||||
Http::ok([
|
||||
'count' => count($result['items']),
|
||||
@@ -113,6 +129,14 @@ switch ($action) {
|
||||
|
||||
case 'next':
|
||||
$filters = collectFilters($boundProject);
|
||||
|
||||
// Der Rueckkanal: zusaetzlich zu den eigenen Items auch fremde, die auf
|
||||
// Nachpruefung warten und bei denen dieses Projekt als betroffen
|
||||
// vermerkt ist. Nur dort - siehe assertProject().
|
||||
if ($boundProject !== null) {
|
||||
$filters['include_affected_verification'] = $boundProject;
|
||||
}
|
||||
|
||||
$limit = Http::int('limit', 1);
|
||||
$claimedItems = $repo->claimNext($author, $filters, $limit);
|
||||
Http::ok([
|
||||
@@ -125,7 +149,8 @@ switch ($action) {
|
||||
|
||||
case 'release':
|
||||
requireItemId($itemId);
|
||||
assertProject($repo, $context, $itemId);
|
||||
// Zurueckgeben duerfen heisst: was man haelt, auch loslassen koennen.
|
||||
assertProject($repo, $context, $itemId, false, true);
|
||||
|
||||
if (!$repo->releaseItem($itemId, $author, Http::str('note'))) {
|
||||
Http::fail(409, 'not_claimed', sprintf(
|
||||
@@ -138,7 +163,7 @@ switch ($action) {
|
||||
|
||||
case 'comment':
|
||||
requireItemId($itemId);
|
||||
assertProject($repo, $context, $itemId);
|
||||
assertProject($repo, $context, $itemId, true, true);
|
||||
|
||||
$comment = Http::str('comment');
|
||||
if ($comment === null) {
|
||||
@@ -157,7 +182,9 @@ switch ($action) {
|
||||
|
||||
case 'status':
|
||||
requireItemId($itemId);
|
||||
assertProject($repo, $context, $itemId);
|
||||
// Der Pruefende schliesst mit dem Status ab - auch bei einem fremden
|
||||
// Item, das er zur Nachpruefung haelt.
|
||||
assertProject($repo, $context, $itemId, false, true);
|
||||
|
||||
$status = Http::str('status');
|
||||
if ($status === null) {
|
||||
@@ -166,7 +193,16 @@ switch ($action) {
|
||||
]);
|
||||
}
|
||||
|
||||
if (!$repo->updateStatus($itemId, $status, Http::str('notes'), $author)) {
|
||||
try {
|
||||
$changed = $repo->updateStatus($itemId, $status, Http::str('notes'), $author);
|
||||
} catch (\InvalidArgumentException $e) {
|
||||
// Etwa: zurueckstellen ohne Ausloeser. Das ist eine verletzte
|
||||
// Regel, kein unbekannter Status - und verdient deshalb eine
|
||||
// Meldung, die sagt, was fehlt.
|
||||
Http::fail(400, 'invalid_transition', $e->getMessage());
|
||||
}
|
||||
|
||||
if (!$changed) {
|
||||
Http::fail(400, 'invalid_status', sprintf(
|
||||
'Status "%s" ist unbekannt oder Item #%d existiert nicht.',
|
||||
$status,
|
||||
@@ -180,7 +216,13 @@ switch ($action) {
|
||||
requireItemId($itemId);
|
||||
assertProject($repo, $context, $itemId);
|
||||
|
||||
if (!$repo->updateItemDetails($itemId, Http::body(), $author)) {
|
||||
try {
|
||||
$updated = $repo->updateItemDetails($itemId, Http::body(), $author);
|
||||
} catch (\InvalidArgumentException $e) {
|
||||
Http::fail(400, 'invalid_update', $e->getMessage());
|
||||
}
|
||||
|
||||
if (!$updated) {
|
||||
Http::fail(404, 'not_found', sprintf('Item #%d existiert nicht.', $itemId));
|
||||
}
|
||||
Http::ok(['message' => sprintf('Item #%d aktualisiert.', $itemId)]);
|
||||
@@ -283,10 +325,39 @@ function requireItemId(int $itemId): void
|
||||
}
|
||||
}
|
||||
|
||||
/** Stellt sicher, dass ein projektgebundenes Token das Item anfassen darf. */
|
||||
function assertProject(BugRepo $repo, array $context, int $itemId): void
|
||||
{
|
||||
if (ApiAuth::projectFilter($context) === null) {
|
||||
/**
|
||||
* Stellt sicher, dass ein projektgebundenes Token das Item anfassen darf.
|
||||
*
|
||||
* $allowWorkbench laesst Werkbank-Token auch an fremde Items. Das ist nur fuer
|
||||
* Kommentare gesetzt: wer aus einem anderen Projekt heraus melden darf, muss
|
||||
* auch nachreichen koennen, was er inzwischen herausgefunden hat. Uebernehmen,
|
||||
* abschliessen oder den Status aendern bleibt dem besitzenden Projekt
|
||||
* vorbehalten - dort weiss man, was ein "resolved" bedeutet.
|
||||
*/
|
||||
/**
|
||||
* Projektschranke fuer Schreibzugriffe auf ein einzelnes Item.
|
||||
*
|
||||
* $allowLeaseHolder oeffnet sie fuer den, der das Item gerade haelt. Das ist
|
||||
* kein Schlupfloch, sondern die Kehrseite der Nachpruefung: Ein Agent kann ein
|
||||
* FREMDES Item nur ueber ?action=next in die Hand bekommen, und dort gibt
|
||||
* BugRepo nur Items heraus, die auf Nachpruefung warten und bei denen sein
|
||||
* Projekt als betroffen vermerkt ist (siehe include_affected_verification).
|
||||
* Wer auf diesem Weg etwas haelt, muss es auch kommentieren, im Status setzen
|
||||
* und zurueckgeben duerfen - sonst haette er eine Aufgabe, die er nicht
|
||||
* abschliessen kann.
|
||||
*
|
||||
* Bewusst NICHT geoeffnet: resolve und update. Was in einem fremden Projekt
|
||||
* als "behoben in Build X" gilt, entscheidet dieses Projekt. Der Pruefende
|
||||
* bestaetigt (status) oder meldet erneut - mehr braucht er nicht.
|
||||
*/
|
||||
function assertProject(
|
||||
BugRepo $repo,
|
||||
array $context,
|
||||
int $itemId,
|
||||
bool $allowWorkbench = false,
|
||||
bool $allowLeaseHolder = false
|
||||
): void {
|
||||
if (ApiAuth::projectFilter($context, $allowWorkbench) === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -295,7 +366,15 @@ function assertProject(BugRepo $repo, array $context, int $itemId): void
|
||||
Http::fail(404, 'not_found', sprintf('Item #%d existiert nicht.', $itemId));
|
||||
}
|
||||
|
||||
ApiAuth::enforceProject($context, (string)$item['project_slug']);
|
||||
if ($allowLeaseHolder
|
||||
&& ($item['claimed_by'] ?? null) === ($context['actor'] ?? null)
|
||||
&& $item['lease_until'] !== null
|
||||
&& strtotime((string)$item['lease_until']) > time()
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
ApiAuth::enforceProject($context, (string)$item['project_slug'], $allowWorkbench);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -17,22 +17,85 @@ require_once __DIR__ . '/../../../../src/bootstrap.php';
|
||||
use Deploymentcenter\Core\ApiAuth;
|
||||
use Deploymentcenter\Core\Db;
|
||||
use Deploymentcenter\Core\Http;
|
||||
use Deploymentcenter\Core\ProjectLinks;
|
||||
use Deploymentcenter\Modules\Bugtracker\BugRepo;
|
||||
|
||||
Http::beginJson(['GET', 'OPTIONS'], true);
|
||||
Http::beginJson(['GET', 'POST', 'OPTIONS'], true);
|
||||
|
||||
if (Http::method() !== 'GET') {
|
||||
Http::fail(405, 'method_not_allowed', 'Dieser Endpunkt erwartet GET.');
|
||||
if (!in_array(Http::method(), ['GET', 'POST'], true)) {
|
||||
Http::fail(405, 'method_not_allowed', 'Dieser Endpunkt erwartet GET oder POST.');
|
||||
}
|
||||
|
||||
$db = Db::init();
|
||||
$context = ApiAuth::requireScope($db, 'bugtracker:read');
|
||||
$context = ApiAuth::requireScope($db, Http::method() === 'POST' ? 'bugtracker:report' : 'bugtracker:read');
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// POST: Beziehung des eigenen Projekts zu einem anderen festhalten.
|
||||
// ---------------------------------------------------------------------------
|
||||
// Ersetzt die von Hand gepflegte Zeile "Deploymentcenter-Anbindung: SDK 2.5.1"
|
||||
// in jeder Projekt-CLAUDE.md. Eine Angabe, die an N Stellen nachgezogen werden
|
||||
// muss, ist nach dem ersten Vergessen falsch - und zwar schweigend.
|
||||
//
|
||||
// from_slug kommt wie reported_from aus der Token-Bindung, nicht aus dem Body:
|
||||
// ein Projekt traegt seine eigene Anbindung ein, nicht die eines anderen.
|
||||
if (Http::method() === 'POST') {
|
||||
$home = ApiAuth::homeProject($context);
|
||||
|
||||
if ($home === null) {
|
||||
Http::fail(
|
||||
400,
|
||||
'no_home_project',
|
||||
'Dieses Token ist an kein Projekt gebunden. Eine Beziehung braucht aber ein Projekt, '
|
||||
. 'von dem aus sie gilt.'
|
||||
);
|
||||
}
|
||||
|
||||
$target = is_string(Http::input('to_slug')) ? trim((string)Http::input('to_slug')) : null;
|
||||
|
||||
if ($target === null || $target === '' || $target === $home) {
|
||||
Http::fail(
|
||||
400,
|
||||
'invalid_target',
|
||||
'Das Feld "to_slug" muss ein anderes Projekt als das eigene bezeichnen.'
|
||||
);
|
||||
}
|
||||
|
||||
$kind = is_string(Http::input('kind')) ? (string)Http::input('kind') : 'uses_sdk';
|
||||
|
||||
if (!in_array($kind, ProjectLinks::KINDS, true)) {
|
||||
Http::fail(400, 'invalid_kind', 'Unbekannte Art der Beziehung.', null, [
|
||||
'allowed' => ProjectLinks::KINDS,
|
||||
]);
|
||||
}
|
||||
|
||||
$version = is_string(Http::input('integrated_version'))
|
||||
? trim((string)Http::input('integrated_version'))
|
||||
: null;
|
||||
|
||||
$links = new ProjectLinks($db);
|
||||
|
||||
if (!$links->record($home, $target, $kind, $version !== '' ? $version : null)) {
|
||||
Http::fail(500, 'link_failed', 'Die Beziehung konnte nicht gespeichert werden.');
|
||||
}
|
||||
|
||||
Http::ok([
|
||||
'from_slug' => $home,
|
||||
'to_slug' => $target,
|
||||
'kind' => $kind,
|
||||
'integrated_version' => $version,
|
||||
'message' => $version !== null
|
||||
? sprintf('"%s" nutzt "%s" in Fassung %s.', $home, $target, $version)
|
||||
: sprintf('Beziehung "%s" -> "%s" festgehalten.', $home, $target),
|
||||
]);
|
||||
}
|
||||
|
||||
$repo = new BugRepo($db);
|
||||
$projects = $repo->getProjects();
|
||||
|
||||
// Ein projektgebundenes Token sieht nur sein eigenes Projekt.
|
||||
$bound = ApiAuth::projectFilter($context);
|
||||
// Ein Laufzeit-Token sieht nur sein eigenes Projekt. Ein Werkbank-Token sieht
|
||||
// alle: es soll ja gerade entscheiden koennen, wohin ein Fehler gehoert - und
|
||||
// dafuer muss es die Nachbarn kennen.
|
||||
$bound = ApiAuth::projectFilter($context, true);
|
||||
if ($bound !== null) {
|
||||
$projects = array_values(array_filter(
|
||||
$projects,
|
||||
@@ -40,18 +103,30 @@ if ($bound !== null) {
|
||||
));
|
||||
}
|
||||
|
||||
// Das Heimatprojekt bleibt auch beim Werkbank-Token bekannt. Es ist der
|
||||
// Bezugspunkt, gegen den die Beziehungen ausgewiesen werden.
|
||||
$home = ApiAuth::homeProject($context);
|
||||
$links = new ProjectLinks($db);
|
||||
|
||||
Http::ok([
|
||||
'count' => count($projects),
|
||||
'projects' => array_map(static function (array $p): array {
|
||||
'count' => count($projects),
|
||||
'home_project' => $home,
|
||||
'projects' => array_map(static function (array $p) use ($links, $home): array {
|
||||
$slug = (string)$p['slug'];
|
||||
|
||||
return [
|
||||
'id' => (int)$p['id'],
|
||||
'slug' => (string)$p['slug'],
|
||||
'slug' => $slug,
|
||||
'name' => (string)$p['name'],
|
||||
'notes' => $p['notes'] ?? null,
|
||||
'repo_url' => $p['repo_url'] ?? null,
|
||||
'default_agent' => $p['default_agent'] ?? null,
|
||||
'open_items' => (int)($p['open_items'] ?? 0),
|
||||
'critical_items' => (int)($p['critical_items'] ?? 0),
|
||||
|
||||
// Wie haengt dieses Projekt mit dem eigenen zusammen? null heisst
|
||||
// schlicht "gar nicht" und ist der Normalfall.
|
||||
'relation' => $home !== null ? $links->between($home, $slug) : null,
|
||||
];
|
||||
}, $projects),
|
||||
]);
|
||||
|
||||
@@ -23,6 +23,14 @@ use Deploymentcenter\Core\Http;
|
||||
use Deploymentcenter\Modules\Bugtracker\BugRepo;
|
||||
use Deploymentcenter\Modules\License\RateLimiter;
|
||||
|
||||
/**
|
||||
* Mindestlaenge der Begruendung bei einer Meldung gegen ein fremdes Projekt.
|
||||
*
|
||||
* Kurz genug, dass ein Satz reicht - lang genug, dass "Bug" oder "kaputt"
|
||||
* nicht durchgeht.
|
||||
*/
|
||||
const MIN_EVIDENCE_LENGTH = 40;
|
||||
|
||||
Http::beginJson(['POST', 'OPTIONS'], true);
|
||||
|
||||
if (Http::method() !== 'POST') {
|
||||
@@ -49,12 +57,58 @@ $environment = is_string($data['environment'] ?? null) ? $data['environment'] :
|
||||
$context = ApiAuth::requireScope($db, 'bugtracker:report', $environment, false);
|
||||
|
||||
$projectSlug = is_string($data['project_slug'] ?? null) ? trim($data['project_slug']) : null;
|
||||
ApiAuth::enforceProject($context, $projectSlug);
|
||||
|
||||
// Ein projektgebundenes Token schreibt immer in sein eigenes Projekt.
|
||||
$boundProject = ApiAuth::projectFilter($context);
|
||||
if ($boundProject !== null) {
|
||||
$data['project_slug'] = $boundProject;
|
||||
// Werkbank-Token duerfen in ein fremdes Projekt melden - ein Agent, der das SDK
|
||||
// in Projekt X integriert und dabei einen Fehler im Deploymentcenter findet,
|
||||
// muss ihn dort ablegen koennen. Laufzeit-Token duerfen das nicht: sie stecken
|
||||
// im ausgelieferten Client und sind extrahierbar.
|
||||
ApiAuth::enforceProject($context, $projectSlug, true);
|
||||
|
||||
$homeProject = ApiAuth::homeProject($context);
|
||||
|
||||
// Ein Laufzeit-Token schreibt immer in sein eigenes Projekt.
|
||||
if ($homeProject !== null && !ApiAuth::isWorkbench($context)) {
|
||||
$data['project_slug'] = $homeProject;
|
||||
}
|
||||
|
||||
// --- Fremdmeldung? ----------------------------------------------------------
|
||||
$target = is_string($data['project_slug'] ?? null) ? trim($data['project_slug']) : null;
|
||||
$isForeign = $homeProject !== null
|
||||
&& $target !== null && $target !== ''
|
||||
&& $target !== $homeProject;
|
||||
|
||||
// Die Herkunft wird aus der Token-Bindung abgeleitet und niemals aus dem Body
|
||||
// uebernommen. Nur so ist sie bezeugt statt behauptet - und nur dann traegt das
|
||||
// Signal "drei Projekte melden dasselbe" ueberhaupt etwas.
|
||||
$rawEvidence = $data['evidence'] ?? null;
|
||||
unset($data['reported_from'], $data['evidence']);
|
||||
|
||||
if ($isForeign) {
|
||||
$evidence = is_string($rawEvidence) ? trim($rawEvidence) : null;
|
||||
|
||||
// Begruendungspflicht. Ein Agent in Projekt X kann kaum unterscheiden, ob
|
||||
// das fremde Projekt kaputt ist oder ob X es falsch benutzt; die
|
||||
// Voreinstellung eines hilfsbereiten Modells ist im Zweifel "melde es".
|
||||
// Etwas ausformulieren zu muessen kostet einen Reflex fast immer den Kopf.
|
||||
if ($evidence === null || mb_strlen($evidence) < MIN_EVIDENCE_LENGTH) {
|
||||
Http::fail(
|
||||
400,
|
||||
'missing_evidence',
|
||||
sprintf(
|
||||
'Eine Meldung gegen das fremde Projekt "%s" verlangt das Feld "evidence" '
|
||||
. '(mindestens %d Zeichen): was wurde beobachtet, und warum liegt die '
|
||||
. 'Ursache dort und nicht in "%s"?',
|
||||
$target,
|
||||
MIN_EVIDENCE_LENGTH,
|
||||
$homeProject
|
||||
),
|
||||
null,
|
||||
['home_project' => $homeProject, 'target_project' => $target]
|
||||
);
|
||||
}
|
||||
|
||||
$data['reported_from'] = $homeProject;
|
||||
$data['evidence'] = $evidence;
|
||||
}
|
||||
|
||||
// Der Absender wird aus dem Token abgeleitet und kann nicht frei gewaehlt
|
||||
@@ -72,11 +126,41 @@ if (empty($data['client_ref'])) {
|
||||
$repo = new BugRepo($db);
|
||||
$result = $repo->reportItem($data);
|
||||
|
||||
$message = $result['idempotent_hit']
|
||||
? 'Bereits erfasst (identische client_ref) - kein Duplikat angelegt.'
|
||||
: ($result['is_new']
|
||||
? ($result['type'] === 'bug' ? 'Bug erfasst.' : 'Feature Request erfasst.')
|
||||
: 'Wiederkehrendes Vorkommnis - Zaehler erhoeht.');
|
||||
// Bekannt und in einer spaeteren Fassung behoben. Diese Antwort geht jeder
|
||||
// anderen vor: Sie beendet die Frage, statt sie einzusortieren. Der Melder
|
||||
// prueft eine Fassung, in der der Fix noch nicht steckt - er soll aufhoeren zu
|
||||
// suchen und aktualisieren, nicht ein weiteres Item anlegen.
|
||||
// Der Fix hat nicht getragen. Kein neues Item - das bestehende ist zurueck in
|
||||
// der Arbeitsschlange, und der Beleg haengt daran.
|
||||
if (!empty($result['fix_insufficient'])) {
|
||||
$message = sprintf(
|
||||
'Der Fix traegt nicht. Item #%d steht wieder auf "fix_insufficient" und liegt in der '
|
||||
. 'Arbeitsschlange - kein neues Item angelegt, der Beleg haengt am bestehenden.',
|
||||
$result['id']
|
||||
);
|
||||
} elseif (isset($result['known_fixed_in'])) {
|
||||
$message = sprintf(
|
||||
'Bekannt und behoben in Build "%s" - du hast "%s" geprueft. Kein neues Item angelegt. '
|
||||
. 'Aktualisiere und pruefe erneut; tritt es dann immer noch auf, ist es eine Regression '
|
||||
. 'und gehoert gemeldet.',
|
||||
$result['known_fixed_in'],
|
||||
$result['reported_build']
|
||||
);
|
||||
} elseif ($isForeign) {
|
||||
$message = $result['is_new']
|
||||
? sprintf(
|
||||
'Im Eingang von "%s" hinterlegt. Wird dort gesichtet und zaehlt erst nach '
|
||||
. 'Bestaetigung in die Statistik.',
|
||||
$target
|
||||
)
|
||||
: sprintf('Bereits bekannt - "%s" ist als betroffen vermerkt.', $homeProject);
|
||||
} else {
|
||||
$message = $result['idempotent_hit']
|
||||
? 'Bereits erfasst (identische client_ref) - kein Duplikat angelegt.'
|
||||
: ($result['is_new']
|
||||
? ($result['type'] === 'bug' ? 'Bug erfasst.' : 'Feature Request erfasst.')
|
||||
: 'Wiederkehrendes Vorkommnis - Zaehler erhoeht.');
|
||||
}
|
||||
|
||||
Http::ok([
|
||||
'item_id' => $result['id'],
|
||||
@@ -90,6 +174,17 @@ Http::ok([
|
||||
'environment' => $result['environment'],
|
||||
'push_id' => $result['push_id'] ?? null,
|
||||
'regression_of' => $result['regression_of'] ?? null,
|
||||
// Gesetzt, wenn der Fehler bereits in einer spaeteren Fassung behoben ist
|
||||
// als der, die gemeldet wurde. Dann wurde NICHTS angelegt und nichts
|
||||
// hochgezaehlt - die Antwort ist eine Auskunft.
|
||||
'known_fixed_in' => $result['known_fixed_in'] ?? null,
|
||||
'reported_build' => $result['reported_build'] ?? null,
|
||||
// Gesetzt, wenn der gemeldete Fehler ein Item betrifft, dessen Fix noch
|
||||
// nicht bestaetigt war. Dann wurde kein neues Item angelegt - das
|
||||
// bestehende wechselte auf fix_insufficient.
|
||||
'fix_insufficient' => !empty($result['fix_insufficient']),
|
||||
'reported_from' => $result['reported_from'] ?? null,
|
||||
'affects' => $result['affects'] ?? [],
|
||||
'url' => Http::baseUrl() . '/index.php#tab-bugtracker',
|
||||
'message' => $message,
|
||||
], $result['is_new'] ? 201 : 200);
|
||||
|
||||
@@ -0,0 +1,317 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* /api/bugtracker/v1/roadmap.php
|
||||
*
|
||||
* Die Roadmap - Vorhaben mit Themenbereich, Reihenfolge und Zielfassung.
|
||||
*
|
||||
* GET ?action=list Eintraege, gefiltert (bugtracker:read)
|
||||
* GET ?action=epics Themenbereiche samt Zaehlung (bugtracker:read)
|
||||
* GET ?action=next "Als Naechstes" (bugtracker:read)
|
||||
* GET ?action=active Wer arbeitet gerade woran (bugtracker:read)
|
||||
* GET ?action=render Der erzeugte Markdown-Block (bugtracker:read)
|
||||
* POST ?action=set Bereich/Rang/Ziel/Anker setzen (bugtracker:manage)
|
||||
* POST ?action=move Eintrag eine Position schieben (bugtracker:manage)
|
||||
* POST ?action=reorder Reihenfolge eines Bereichs neu (bugtracker:manage)
|
||||
* POST ?action=epic Themenbereich anlegen/aendern (bugtracker:manage)
|
||||
*
|
||||
* KEINE eigene Datenhaltung. Ein Roadmap-Eintrag ist ein bugtracker_item mit
|
||||
* gesetztem `epic`; dieser Endpunkt ist die Sicht darauf. Anlegen laeuft
|
||||
* weiterhin ueber /report, Abschliessen ueber /manage - sonst gaebe es zwei
|
||||
* Wege zu denselben Daten und damit zwei Stellen, an denen Regeln gelten
|
||||
* muessten.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
require_once __DIR__ . '/../../../../src/bootstrap.php';
|
||||
|
||||
use Deploymentcenter\Core\ApiAuth;
|
||||
use Deploymentcenter\Core\Db;
|
||||
use Deploymentcenter\Core\Http;
|
||||
use Deploymentcenter\Modules\Bugtracker\BugRepo;
|
||||
use Deploymentcenter\Modules\Bugtracker\Roadmap;
|
||||
|
||||
Http::beginJson(['GET', 'POST', 'OPTIONS'], true);
|
||||
|
||||
const READ_ACTIONS = ['list', 'epics', 'next', 'active', 'render', 'check'];
|
||||
const WRITE_ACTIONS = ['set', 'move', 'reorder', 'epic'];
|
||||
|
||||
$action = strtolower(Http::str('action') ?? 'list');
|
||||
|
||||
if (!in_array($action, READ_ACTIONS, true) && !in_array($action, WRITE_ACTIONS, true)) {
|
||||
Http::fail(404, 'unknown_action', sprintf('Unbekannte Aktion "%s".', $action), null, [
|
||||
'available' => array_merge(READ_ACTIONS, WRITE_ACTIONS),
|
||||
]);
|
||||
}
|
||||
|
||||
$isWrite = in_array($action, WRITE_ACTIONS, true);
|
||||
|
||||
if ($isWrite && Http::method() !== 'POST') {
|
||||
Http::fail(405, 'method_not_allowed', sprintf('Die Aktion "%s" erwartet POST.', $action));
|
||||
}
|
||||
|
||||
$db = Db::init();
|
||||
$repo = new BugRepo($db);
|
||||
$roadmap = new Roadmap($db);
|
||||
|
||||
$context = ApiAuth::requireScope($db, $isWrite ? 'bugtracker:manage' : 'bugtracker:read');
|
||||
$author = $context['actor'];
|
||||
|
||||
// Lesen darf die Landschaft sehen, Schreiben nur das eigene Projekt.
|
||||
//
|
||||
// Dieselbe Trennung wie in /manage, und aus demselben Grund: Ein Agent soll
|
||||
// erkennen koennen, wo sein Projekt in der Gesamtplanung steht - aber die
|
||||
// Reihenfolge fremder Vorhaben legt er nicht fest.
|
||||
$readProject = ApiAuth::projectFilter($context, true);
|
||||
$writeProject = ApiAuth::projectFilter($context);
|
||||
|
||||
$requested = Http::str('project_slug') ?? Http::str('project') ?? 'all';
|
||||
$scope = $readProject ?? $requested;
|
||||
|
||||
switch ($action) {
|
||||
case 'epics':
|
||||
Http::ok([
|
||||
'epics' => $roadmap->epics($scope),
|
||||
'orphans' => $roadmap->orphanEpics($scope),
|
||||
'stats' => $roadmap->stats($scope),
|
||||
]);
|
||||
|
||||
case 'next':
|
||||
Http::ok([
|
||||
'items' => $roadmap->nextUp($scope, Http::int('limit', 5) ?: 5),
|
||||
]);
|
||||
|
||||
case 'active':
|
||||
Http::ok([
|
||||
'items' => $roadmap->activeWork($scope),
|
||||
]);
|
||||
|
||||
case 'render': {
|
||||
$project = requireProject($scope);
|
||||
Http::ok([
|
||||
'project_slug' => $project,
|
||||
'markdown' => $roadmap->renderBlock($project),
|
||||
]);
|
||||
}
|
||||
|
||||
case 'check': {
|
||||
// Der Abgleich braucht den Dateiinhalt. Er kommt mitgeschickt, statt
|
||||
// dass der Server ihn liest: Die Datei liegt im Repository des
|
||||
// Projekts, oft auf einer anderen Maschine. Der Server kennt sie nicht
|
||||
// und soll auch nicht anfangen, in Verzeichnissen zu suchen.
|
||||
$project = requireProject($scope);
|
||||
$content = Http::str('content');
|
||||
|
||||
if ($content === null) {
|
||||
Http::fail(400, 'missing_content', 'Das Feld "content" mit dem Dateiinhalt fehlt.');
|
||||
}
|
||||
|
||||
$tmp = tempnam(sys_get_temp_dir(), 'dcrm');
|
||||
if ($tmp === false) {
|
||||
Http::fail(500, 'tmp_failed', 'Konnte den Inhalt nicht zwischenspeichern.');
|
||||
}
|
||||
|
||||
file_put_contents($tmp, $content);
|
||||
$result = $roadmap->check($project, $tmp);
|
||||
@unlink($tmp);
|
||||
|
||||
Http::ok($result);
|
||||
}
|
||||
|
||||
case 'list': {
|
||||
$filters = [
|
||||
'project_slug' => $scope,
|
||||
'on_roadmap' => true,
|
||||
'epic' => Http::str('epic') ?? 'all',
|
||||
'status' => resolveStatusFilter(Http::str('status')),
|
||||
'type' => Http::str('type') ?? 'all',
|
||||
'severity' => Http::str('severity') ?? 'all',
|
||||
'target_build' => Http::str('target_build') ?? 'all',
|
||||
'claimed_by' => Http::str('claimed_by') ?? '',
|
||||
'search' => Http::str('q') ?? '',
|
||||
'order' => 'roadmap',
|
||||
'limit' => Http::int('limit', 200) ?: 200,
|
||||
'offset' => Http::int('offset', 0) ?: 0,
|
||||
];
|
||||
|
||||
$result = $repo->getItems($filters);
|
||||
$result['stats'] = $roadmap->stats($scope);
|
||||
|
||||
Http::ok($result);
|
||||
}
|
||||
|
||||
case 'set': {
|
||||
$itemId = Http::int('id', 0) ?: 0;
|
||||
if ($itemId < 1) {
|
||||
Http::fail(400, 'missing_id', 'Das Feld "id" fehlt.');
|
||||
}
|
||||
|
||||
assertOwnProject($repo, $writeProject, $itemId);
|
||||
|
||||
// Nur die Roadmap-Felder. Titel, Schweregrad und Status laufen
|
||||
// weiterhin ueber /manage - ein zweiter Schreibweg auf dieselben
|
||||
// Spalten waere eine zweite Stelle, an der Regeln gelten muessten.
|
||||
$updates = [];
|
||||
foreach (['epic', 'target_build', 'defer_trigger', 'doc_anchor'] as $field) {
|
||||
if (Http::input($field) !== null) {
|
||||
$updates[$field] = Http::str($field);
|
||||
}
|
||||
}
|
||||
|
||||
// Ein leerer Wert loescht die Reihenfolge, statt sie auf 0 zu setzen.
|
||||
// Sonst waere "keine Meinung" nicht mehr ausdrueckbar - und Rang 0
|
||||
// sortierte den Eintrag ausgerechnet an die Spitze.
|
||||
if (Http::input('roadmap_rank') !== null) {
|
||||
$raw = Http::str('roadmap_rank');
|
||||
$updates['roadmap_rank'] = ($raw !== null && is_numeric($raw)) ? (int)$raw : null;
|
||||
}
|
||||
|
||||
// Zurueckstellen laeuft ueber diesen Weg mit, weil Status und
|
||||
// Ausloeser zusammen ankommen muessen - getrennt gesetzt entstuende
|
||||
// genau der Eintrag ohne Ausloeser, den die Regel verhindern soll.
|
||||
$status = Http::str('status');
|
||||
if ($status !== null) {
|
||||
$updates['status'] = $status;
|
||||
}
|
||||
|
||||
if ($updates === []) {
|
||||
Http::fail(400, 'nothing_to_do', 'Keines der Roadmap-Felder wurde mitgeschickt.', null, [
|
||||
'fields' => ['epic', 'roadmap_rank', 'target_build', 'defer_trigger', 'doc_anchor', 'status'],
|
||||
]);
|
||||
}
|
||||
|
||||
try {
|
||||
if (!$repo->updateItemDetails($itemId, $updates, $author)) {
|
||||
Http::fail(404, 'not_found', sprintf('Item #%d existiert nicht.', $itemId));
|
||||
}
|
||||
} catch (\InvalidArgumentException $e) {
|
||||
Http::fail(400, 'invalid_update', $e->getMessage());
|
||||
}
|
||||
|
||||
Http::ok(['message' => sprintf('Roadmap-Angaben zu #%d gesetzt.', $itemId)]);
|
||||
}
|
||||
|
||||
case 'move': {
|
||||
$itemId = Http::int('id', 0) ?: 0;
|
||||
if ($itemId < 1) {
|
||||
Http::fail(400, 'missing_id', 'Das Feld "id" fehlt.');
|
||||
}
|
||||
|
||||
assertOwnProject($repo, $writeProject, $itemId);
|
||||
|
||||
$direction = strtolower(Http::str('direction') ?? 'up');
|
||||
if (!in_array($direction, ['up', 'down'], true)) {
|
||||
Http::fail(400, 'invalid_direction', 'Erlaubt sind "up" und "down".');
|
||||
}
|
||||
|
||||
if (!$roadmap->move($itemId, $direction)) {
|
||||
Http::fail(409, 'cannot_move', sprintf(
|
||||
'#%d laesst sich nicht weiter nach %s schieben - '
|
||||
. 'schon am Rand des Bereichs, oder ohne Bereich.',
|
||||
$itemId,
|
||||
$direction === 'up' ? 'oben' : 'unten'
|
||||
));
|
||||
}
|
||||
|
||||
Http::ok(['message' => sprintf('#%d verschoben.', $itemId)]);
|
||||
}
|
||||
|
||||
case 'reorder': {
|
||||
$project = requireProject($writeProject ?? $requested);
|
||||
$epic = Http::str('epic');
|
||||
$ids = Http::input('ids');
|
||||
|
||||
if ($epic === null || !is_array($ids) || $ids === []) {
|
||||
Http::fail(400, 'missing_fields', 'Es werden "epic" und "ids" (Liste) erwartet.');
|
||||
}
|
||||
|
||||
$touched = $roadmap->reorder($project, $epic, array_map('intval', $ids));
|
||||
|
||||
Http::ok([
|
||||
'message' => sprintf('%d Eintrag/Eintraege neu gereiht.', $touched),
|
||||
'touched' => $touched,
|
||||
]);
|
||||
}
|
||||
|
||||
case 'epic': {
|
||||
$project = requireProject($writeProject ?? $requested);
|
||||
$epic = Http::str('epic');
|
||||
$title = Http::str('title');
|
||||
|
||||
if ($epic === null || $title === null) {
|
||||
Http::fail(400, 'missing_fields', 'Es werden "epic" und "title" erwartet.');
|
||||
}
|
||||
|
||||
$roadmap->saveEpic(
|
||||
$project,
|
||||
$epic,
|
||||
$title,
|
||||
Http::str('summary'),
|
||||
Http::int('sort_order', 100) ?: 100
|
||||
);
|
||||
|
||||
Http::ok(['message' => sprintf('Themenbereich "%s" gespeichert.', $epic)]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Verlangt ein konkretes Projekt.
|
||||
*
|
||||
* "all" ist beim Lesen sinnvoll und beim Schreiben oder Erzeugen nicht - eine
|
||||
* Datei gehoert zu genau einem Repository.
|
||||
*/
|
||||
function requireProject(?string $slug): string
|
||||
{
|
||||
if ($slug === null || $slug === '' || $slug === 'all') {
|
||||
Http::fail(400, 'missing_project', 'Diese Aktion braucht ein konkretes "project_slug".');
|
||||
}
|
||||
|
||||
return $slug;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ein Roadmap-Eintrag wird nur im eigenen Projekt umsortiert.
|
||||
*
|
||||
* Dieselbe Schranke wie beim Uebernehmen von Arbeit: Wer in Projekt X
|
||||
* arbeitet, ordnet nicht die Planung von Projekt Y.
|
||||
*/
|
||||
function assertOwnProject(BugRepo $repo, ?string $bound, int $itemId): void
|
||||
{
|
||||
if ($bound === null) {
|
||||
return; // Master-Token oder Oberflaeche
|
||||
}
|
||||
|
||||
$item = $repo->getItemDetails($itemId);
|
||||
if ($item === null) {
|
||||
Http::fail(404, 'not_found', sprintf('Item #%d existiert nicht.', $itemId));
|
||||
}
|
||||
|
||||
if ((string)$item['project_slug'] !== $bound) {
|
||||
Http::fail(403, 'foreign_project', sprintf(
|
||||
'Item #%d gehoert zu "%s". Fremde Roadmaps werden nicht umsortiert.',
|
||||
$itemId,
|
||||
(string)$item['project_slug']
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Uebersetzt eine Lage-Auswahl in die zugehoerigen Status.
|
||||
*
|
||||
* Elf Status sind fuer die Ablage richtig und fuer einen Filter zu viele. Wer
|
||||
* "offen" waehlt, meint keine ENUM-Konstante, sondern eine Lage - deshalb hier
|
||||
* die Gruppen aus Roadmap::STATUS_GROUPS, mit den Einzelstatus als Rueckfall.
|
||||
*/
|
||||
function resolveStatusFilter(?string $value): string
|
||||
{
|
||||
if ($value === null || $value === '' || $value === 'all') {
|
||||
return 'all';
|
||||
}
|
||||
|
||||
if (isset(Roadmap::STATUS_GROUPS[$value])) {
|
||||
return implode(',', Roadmap::STATUS_GROUPS[$value]);
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
@@ -5,7 +5,14 @@
|
||||
*
|
||||
* POST /api/license/v1/validate Lizenz und Hardware pruefen (oeffentlich)
|
||||
* POST /api/license/v1/deactivate Aktivierung freigeben (authentifiziert)
|
||||
* POST /api/license/v1/dev-key Entwicklungsschluessel abholen (license:dev)
|
||||
* GET /api/license/v1/status Verfuegbarkeitspruefung
|
||||
*
|
||||
* ACHTUNG, ZWEI ANTWORTFORMATE IN EINER DATEI: validate und deactivate
|
||||
* antworten ohne den status/error-Umschlag der uebrigen API - das ist ein
|
||||
* ausgerollter Vertrag, siehe die Begruendung weiter unten. dev-key ist neu und
|
||||
* folgt deshalb dem Hausformat (status: success). Wer hier etwas ergaenzt,
|
||||
* nimmt das Hausformat; der Sonderfall gilt nur fuer die beiden alten Wege.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
@@ -15,6 +22,7 @@ require_once __DIR__ . '/../../../../src/bootstrap.php';
|
||||
use Deploymentcenter\Core\ApiAuth;
|
||||
use Deploymentcenter\Core\Db;
|
||||
use Deploymentcenter\Core\Http;
|
||||
use Deploymentcenter\Modules\License\DevKeys;
|
||||
use Deploymentcenter\Modules\License\LicenseService;
|
||||
use Deploymentcenter\Modules\License\RateLimiter;
|
||||
|
||||
@@ -55,12 +63,106 @@ switch ($action) {
|
||||
ApiAuth::requireScope($db, 'license:deactivate');
|
||||
Http::raw($service->deactivate(Http::body(), $ip));
|
||||
|
||||
// ------------------------------------------------------------------
|
||||
// Entwicklungsschluessel zur Selbstbedienung
|
||||
//
|
||||
// Damit ein Agent auf der Testmaschine ueberhaupt etwas pruefen kann,
|
||||
// braucht er einen gueltigen Schluessel - fuer die Lizenzpruefung selbst
|
||||
// und seit 2.4 auch fuer den Zugang zur Release-Ablage. Ihn von Hand
|
||||
// auszustellen und weiterzureichen war der einzige Weg; das Ergebnis waren
|
||||
// unbefristete Schluessel in Chatverlaeufen. Herleitung in DevKeys.
|
||||
//
|
||||
// Antwortet im Hausformat, nicht im Sonderformat der Lizenzpruefung.
|
||||
// ------------------------------------------------------------------
|
||||
case 'dev-key':
|
||||
if (Http::method() !== 'POST') {
|
||||
Http::fail(405, 'method_not_allowed', 'Diese Aktion erwartet POST.');
|
||||
}
|
||||
|
||||
// Enger gedrosselt als der Rest des Moduls: Ein Schluessel wird einmal
|
||||
// je Testlauf geholt, nicht im Sekundentakt. Wer haeufiger anfragt, hat
|
||||
// eine Schleife gebaut - und legt sonst Zeilen an, bis die Grenze aus
|
||||
// DevKeys::MAX_PER_PROJECT greift.
|
||||
$devLimiter = new RateLimiter($db, 10, 60, 'license_dev');
|
||||
if (!$devLimiter->check($ip)) {
|
||||
Http::fail(429, 'rate_limited', 'Zu viele Anfragen nach Entwicklungsschluesseln.');
|
||||
}
|
||||
|
||||
// allowSession bewusst aus: Dieser Weg ist fuer Werkbank-Token auf
|
||||
// Testmaschinen, nicht fuer einen angemeldeten Browser. Wer im WebUI
|
||||
// sitzt, legt Lizenzen dort an.
|
||||
$context = ApiAuth::requireScope($db, 'license:dev', null, false);
|
||||
|
||||
$slug = Http::str('project_slug') ?? Http::str('product');
|
||||
if ($slug === null) {
|
||||
Http::fail(400, 'missing_project', 'Es fehlt project_slug.');
|
||||
}
|
||||
|
||||
// allowWorkbench bleibt aus. Ein Werkbank-Token darf projektuebergreifend
|
||||
// melden - aber ein Lizenzschluessel ist etwas anderes als eine Meldung:
|
||||
// Er oeffnet die Release-Ablage eines Produkts. Wer fuer ein fremdes
|
||||
// Projekt testet, braucht dafuer dessen Token.
|
||||
ApiAuth::enforceProject($context, $slug);
|
||||
|
||||
$identity = Http::str('instance_id')
|
||||
?? Http::str('hostname')
|
||||
?? ($context['token']['owner_identity'] ?? null);
|
||||
|
||||
if ($identity === null || $identity === '') {
|
||||
Http::fail(
|
||||
400,
|
||||
'missing_identity',
|
||||
'Es fehlt instance_id - die Kennung der Maschine, die den Schluessel bekommt. '
|
||||
. 'Ohne sie liesse sich ein wiederholter Aufruf nicht demselben Schluessel zuordnen.'
|
||||
);
|
||||
}
|
||||
|
||||
$devAction = strtolower(Http::str('action_mode') ?? 'issue');
|
||||
|
||||
try {
|
||||
if ($devAction === 'revoke') {
|
||||
$removed = DevKeys::revoke($db, $slug, (string)$identity, $context['actor']);
|
||||
|
||||
Http::ok([
|
||||
'project_slug' => $slug,
|
||||
'revoked' => $removed,
|
||||
'message' => $removed
|
||||
? 'Entwicklungsschluessel zurueckgegeben.'
|
||||
: 'Fuer diese Maschine war kein Entwicklungsschluessel vergeben.',
|
||||
]);
|
||||
}
|
||||
|
||||
$result = DevKeys::issue(
|
||||
$db,
|
||||
$slug,
|
||||
(string)$identity,
|
||||
Http::input('ttl_days') !== null ? Http::int('ttl_days') : null,
|
||||
$context['actor']
|
||||
);
|
||||
} catch (RuntimeException $e) {
|
||||
Http::fail(409, 'dev_key_denied', $e->getMessage());
|
||||
}
|
||||
|
||||
Http::ok([
|
||||
'license_key' => $result['license_key'],
|
||||
'project_slug' => $result['project_slug'],
|
||||
'instance_id' => $result['identity'],
|
||||
'expires_at' => $result['expires_at'],
|
||||
'max_activations' => $result['max_activations'],
|
||||
'activations_used' => $result['activations_used'],
|
||||
'created' => $result['created'],
|
||||
'renewed' => $result['renewed'],
|
||||
'message' => $result['created']
|
||||
? 'Entwicklungsschluessel ausgestellt. Er ist befristet und gilt nur fuer diese Maschine.'
|
||||
: 'Bestehender Entwicklungsschluessel verlaengert.',
|
||||
], $result['created'] ? 201 : 200);
|
||||
|
||||
case 'status':
|
||||
Http::raw(['status' => 'ok', 'module' => 'license', 'version' => '2.0']);
|
||||
|
||||
default:
|
||||
Http::fail(404, 'unknown_action', 'Endpunkt nicht gefunden.', null, [
|
||||
'available' => ['validate', 'deactivate', 'status'],
|
||||
'available' => ['validate', 'deactivate', 'dev-key', 'status'],
|
||||
]);
|
||||
}
|
||||
|
||||
@@ -79,7 +181,11 @@ function resolveLicenseAction(): string
|
||||
$last = strtolower((string)end($segments));
|
||||
|
||||
return match ($last) {
|
||||
'validate', 'deactivate', 'status' => $last,
|
||||
'validate', 'deactivate', 'status', 'dev-key' => $last,
|
||||
// Ein Tippfehler bei der Selbstbedienung soll nicht stillschweigend zur
|
||||
// Verfuegbarkeitspruefung werden - sonst sucht jemand lange nach dem
|
||||
// Grund, warum "kein Schluessel kommt, aber alles ok meldet".
|
||||
'devkey', 'dev_key' => 'dev-key',
|
||||
default => 'status',
|
||||
};
|
||||
}
|
||||
|
||||
+329
-2
@@ -15,6 +15,7 @@ require_once __DIR__ . '/../../src/bootstrap.php';
|
||||
use Deploymentcenter\Core\Config;
|
||||
use Deploymentcenter\Core\Http;
|
||||
use Deploymentcenter\Modules\Bugtracker\BugRepo;
|
||||
use Deploymentcenter\Modules\Supervisor\FindingRepo;
|
||||
use Deploymentcenter\Modules\Watchdog\EventLog;
|
||||
use Deploymentcenter\Core\TokenManager;
|
||||
|
||||
@@ -118,6 +119,21 @@ $spec = [
|
||||
'file_path' => ['type' => 'string'],
|
||||
'line_no' => ['type' => 'integer'],
|
||||
'context' => ['type' => 'object', 'description' => 'Beliebiger strukturierter Zusatzkontext'],
|
||||
'evidence' => [
|
||||
'type' => 'string',
|
||||
'minLength' => 40,
|
||||
'description' =>
|
||||
'Pflicht, wenn project_slug ein fremdes Projekt bezeichnet: was wurde '
|
||||
. 'beobachtet, und warum liegt die Ursache dort und nicht im eigenen '
|
||||
. 'Projekt? Wird bei einer Meldung ins eigene Projekt ignoriert.',
|
||||
],
|
||||
'reported_from' => [
|
||||
'type' => 'string',
|
||||
'readOnly' => true,
|
||||
'description' =>
|
||||
'Herkunft der Meldung. Wird vom Server aus der Token-Bindung '
|
||||
. 'abgeleitet; ein Wert im Body wird verworfen.',
|
||||
],
|
||||
],
|
||||
],
|
||||
'Release' => [
|
||||
@@ -226,7 +242,38 @@ $spec = [
|
||||
'post' => [
|
||||
'tags' => ['Bugtracker'],
|
||||
'summary' => 'Bug, Feature Request oder Idee melden',
|
||||
'description' => 'Benoetigt den Scope bugtracker:report. Gleiche Fehler werden automatisch zusammengefasst und hochgezaehlt.',
|
||||
'description' =>
|
||||
"Benoetigt den Scope bugtracker:report. Gleiche Fehler werden automatisch "
|
||||
. "zusammengefasst und hochgezaehlt.\n\n"
|
||||
. "**Meldung gegen ein fremdes Projekt.** Ein Token vom Typ dev_agent "
|
||||
. "(Werkbank-Token: Claude Code, MCP-Adapter, CI) darf project_slug auf ein "
|
||||
. "anderes Projekt setzen - etwa wenn beim Integrieren des SDK ein Fehler im "
|
||||
. "Deploymentcenter selbst auffaellt. Laufzeit-Token duerfen das nicht; sie "
|
||||
. "stecken im ausgelieferten Client und sind extrahierbar.\n\n"
|
||||
. "Fuer solche Meldungen gilt:\n"
|
||||
. "- `evidence` ist Pflicht (mindestens 40 Zeichen): was wurde beobachtet, "
|
||||
. "und warum liegt die Ursache dort und nicht im eigenen Projekt?\n"
|
||||
. "- `reported_from` wird aus der Token-Bindung abgeleitet und aus dem Body "
|
||||
. "ignoriert - die Herkunft ist bezeugt, nicht behauptet.\n"
|
||||
. "- Das Item landet im Status `triage_external` und zaehlt erst nach "
|
||||
. "Bestaetigung in die Statistik.\n"
|
||||
. "- Der Schweregrad wird auf `medium` gedeckelt; `high` und `critical` "
|
||||
. "vergibt die empfangende Seite.\n"
|
||||
. "- Meldet ein zweites Projekt dieselbe Sache, entsteht kein neues Item - "
|
||||
. "es waechst die Liste der Betroffenen (`affects`).\n\n"
|
||||
. "**Schicke immer `build_version`.** Trifft die Meldung auf ein bereits "
|
||||
. "behobenes Item, entscheidet der Vergleich mit dessen `resolved_in_build` "
|
||||
. "ueber drei sehr verschiedene Ausgaenge - ohne die Angabe faellt die "
|
||||
. "Entscheidung im Zweifel auf den unguenstigsten:\n"
|
||||
. "- **aeltere Fassung als der Fix** -> es passiert nichts. Die Antwort traegt "
|
||||
. "`known_fixed_in`, kein Item wird angelegt und kein Zaehler erhoeht. "
|
||||
. "Aktualisieren und erneut pruefen.\n"
|
||||
. "- **Fix war noch nicht bestaetigt** (`resolved`, `awaiting_verification`, "
|
||||
. "`in_verification`) -> das bestehende Item wechselt auf `fix_insufficient` "
|
||||
. "und liegt wieder in der Arbeitsschlange. `fix_insufficient: true` in der "
|
||||
. "Antwort. Kein neues Item: Versuch und Fehlschlag gehoeren auf einen Strang.\n"
|
||||
. "- **Item war bestaetigt geschlossen** -> Regression, neues Item mit "
|
||||
. "`regression_of` auf das alte.",
|
||||
'requestBody' => [
|
||||
'required' => true,
|
||||
'content' => ['application/json' => ['schema' => ['$ref' => '#/components/schemas/ReportRequest']]],
|
||||
@@ -234,7 +281,9 @@ $spec = [
|
||||
'responses' => [
|
||||
'201' => ['description' => 'Neu angelegt'],
|
||||
'200' => ['description' => 'Bestehendes Item aktualisiert (Duplikat oder Idempotenz-Treffer)'],
|
||||
'400' => $errorResponse,
|
||||
'401' => $errorResponse,
|
||||
'403' => $errorResponse,
|
||||
'429' => $errorResponse,
|
||||
],
|
||||
],
|
||||
@@ -300,7 +349,14 @@ $spec = [
|
||||
'get' => [
|
||||
'tags' => ['Bugtracker'],
|
||||
'summary' => 'Projekte auflisten (Discovery)',
|
||||
'description' => 'Benoetigt den Scope bugtracker:read.',
|
||||
'description' =>
|
||||
"Benoetigt den Scope bugtracker:read.\n\n"
|
||||
. "Jeder Eintrag traegt `relation`: wie das Projekt mit dem eigenen "
|
||||
. "zusammenhaengt (`uses_sdk`, `depends_on`, `shares_code`, Richtung und "
|
||||
. "integrierte Fassung). `null` heisst schlicht: gar nicht.\n\n"
|
||||
. "Ein Laufzeit-Token sieht nur sein eigenes Projekt. Ein Werkbank-Token "
|
||||
. "(dev_agent) sieht alle - es soll ja entscheiden koennen, wohin ein "
|
||||
. "Fehler gehoert, und dafuer muss es die Nachbarn kennen.",
|
||||
'responses' => ['200' => ['description' => 'Projektliste'], '401' => $errorResponse],
|
||||
],
|
||||
],
|
||||
@@ -350,6 +406,169 @@ $spec = [
|
||||
],
|
||||
],
|
||||
|
||||
'/api/bugtracker/v1/roadmap.php' => [
|
||||
'get' => [
|
||||
'tags' => ['Bugtracker'],
|
||||
'summary' => 'Roadmap lesen',
|
||||
'description' =>
|
||||
"Scope bugtracker:read.\n\n"
|
||||
. "**Keine eigene Datenhaltung.** Ein Roadmap-Eintrag ist ein "
|
||||
. "bugtracker_item mit gesetztem `epic`; dieser Endpunkt ist die Sicht "
|
||||
. "darauf. Angelegt wird ueber `/report`, abgeschlossen ueber `/manage`.\n\n"
|
||||
. "- `action=list` Eintraege, nach Bereich und Reihenfolge sortiert\n"
|
||||
. "- `action=epics` Themenbereiche samt Zaehlung je Lage\n"
|
||||
. "- `action=next` die vorderen Eintraege der Warteschlange\n"
|
||||
. "- `action=active` wer haelt gerade welches Item\n"
|
||||
. "- `action=render` der erzeugte Markdown-Block fuer die Projektdatei\n"
|
||||
. "- `action=check` Abgleich einer mitgeschickten Datei (`content`) gegen "
|
||||
. "die Items\n\n"
|
||||
. "`status` nimmt eine Lage statt eines ENUM-Werts: `aktiv`, `offen`, "
|
||||
. "`arbeit`, `erledigt`, `zurueckgestellt`, `verworfen`. Einzelstatus "
|
||||
. "funktionieren weiterhin.",
|
||||
'parameters' => [
|
||||
['name' => 'action', 'in' => 'query', 'schema' => ['type' => 'string', 'enum' => ['list', 'epics', 'next', 'active', 'render', 'check'], 'default' => 'list']],
|
||||
['name' => 'project_slug', 'in' => 'query', 'schema' => ['type' => 'string']],
|
||||
['name' => 'epic', 'in' => 'query', 'schema' => ['type' => 'string'], 'description' => 'Themenbereich, z. B. "A"'],
|
||||
['name' => 'status', 'in' => 'query', 'schema' => ['type' => 'string'], 'description' => 'Lage oder kommagetrennte Einzelstatus'],
|
||||
['name' => 'target_build', 'in' => 'query', 'schema' => ['type' => 'string']],
|
||||
['name' => 'claimed_by', 'in' => 'query', 'schema' => ['type' => 'string']],
|
||||
['name' => 'q', 'in' => 'query', 'schema' => ['type' => 'string'], 'description' => 'Volltextsuche'],
|
||||
['name' => 'limit', 'in' => 'query', 'schema' => ['type' => 'integer', 'default' => 200, 'maximum' => 500]],
|
||||
],
|
||||
'responses' => ['200' => ['description' => 'Roadmap-Eintraege bzw. Bereiche'], '401' => $errorResponse],
|
||||
],
|
||||
'post' => [
|
||||
'tags' => ['Bugtracker'],
|
||||
'summary' => 'Roadmap-Angaben setzen',
|
||||
'description' =>
|
||||
"Scope bugtracker:manage. Nur im eigenen Projekt - fremde Planung wird "
|
||||
. "nicht umsortiert.\n\n"
|
||||
. "- `action=set&id=` setzt `epic`, `roadmap_rank`, `target_build`, "
|
||||
. "`defer_trigger`, `doc_anchor` und optional `status`\n"
|
||||
. "- `action=move&id=` schiebt einen Eintrag eine Position (`direction=up|down`)\n"
|
||||
. "- `action=reorder` vergibt die Reihenfolge eines Bereichs neu (`epic`, `ids[]`)\n"
|
||||
. "- `action=epic` legt einen Themenbereich an oder aendert ihn\n\n"
|
||||
. "**Zurueckstellen verlangt einen Ausloeser.** `status=deferred` ohne "
|
||||
. "`defer_trigger` wird mit 400 abgelehnt: Ohne benannten Anlass ist ein "
|
||||
. "Vorhaben nicht zurueckgestellt, sondern vergessen.",
|
||||
'parameters' => [
|
||||
['name' => 'action', 'in' => 'query', 'required' => true, 'schema' => ['type' => 'string', 'enum' => ['set', 'move', 'reorder', 'epic']]],
|
||||
['name' => 'id', 'in' => 'query', 'schema' => ['type' => 'integer']],
|
||||
],
|
||||
'responses' => [
|
||||
'200' => ['description' => 'Erfolg'],
|
||||
'400' => ['description' => 'Regelverletzung, etwa Zurueckstellen ohne Ausloeser'],
|
||||
'403' => ['description' => 'Item gehoert einem anderen Projekt'],
|
||||
'401' => $errorResponse,
|
||||
],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/supervisor/v1/observe' => [
|
||||
'post' => [
|
||||
'tags' => ['Supervisor'],
|
||||
'summary' => 'Befund einliefern',
|
||||
'description' =>
|
||||
"Scope supervisor:report.\n\n"
|
||||
. "Ein Befund ist keine Fehlermeldung. Er behauptet nicht, dass etwas kaputt "
|
||||
. "ist, sondern dass etwas ungewoehnlich ist - deshalb loest er keine "
|
||||
. "Benachrichtigung aus. Die Einstufung trifft die empfangende Seite, die den "
|
||||
. "Flottenblick hat; `severity_hint` heisst darum Hinweis und nicht "
|
||||
. "Schweregrad.\n\n"
|
||||
. "`client_ref` bewusst aus Detektor, Gegenstand und Fassung bauen statt "
|
||||
. "zufaellig zu erzeugen: derselbe Befund darf beliebig oft gemeldet werden "
|
||||
. "und erhoeht dann nur den Zaehler. Ein Beobachter, der minuetlich nachsieht, "
|
||||
. "legt sonst 1.440 Eintraege am Tag an. Fehlt das Feld, baut der Server es "
|
||||
. "selbst zusammen.\n\n"
|
||||
. "Die Liste gueltiger Detektornamen liefert `?action=catalog`. Ein "
|
||||
. "unbekannter Name wird angenommen, in der Antwort aber mit "
|
||||
. "`known_detector: false` gekennzeichnet - stilles Verwerfen waere "
|
||||
. "schlimmer, denn dann suchte jemand nach Befunden, die nie ankamen.",
|
||||
'requestBody' => [
|
||||
'required' => true,
|
||||
'content' => ['application/json' => ['schema' => [
|
||||
'type' => 'object',
|
||||
'required' => ['detector'],
|
||||
'properties' => [
|
||||
'project_slug' => ['type' => 'string'],
|
||||
'detector' => ['type' => 'string', 'example' => 'trend.monotonic'],
|
||||
'subject' => ['type' => 'string', 'example' => 'memory.working_set'],
|
||||
'instance' => ['type' => 'string', 'example' => 'kunde-4711/app-01'],
|
||||
'severity_hint' => ['type' => 'string', 'enum' => FindingRepo::SEVERITY_HINTS],
|
||||
'observed' => ['type' => 'object', 'description' => 'Was wurde gemessen?'],
|
||||
'baseline' => ['type' => 'object', 'description' => 'Wogegen?'],
|
||||
'build' => ['type' => 'string'],
|
||||
'commit_sha' => ['type' => 'string'],
|
||||
'environment' => ['type' => 'string', 'enum' => FindingRepo::ENVIRONMENTS],
|
||||
'client_ref' => ['type' => 'string'],
|
||||
],
|
||||
]]],
|
||||
],
|
||||
'responses' => [
|
||||
'201' => ['description' => 'Neuer Befund - finding_id, finding_status, '
|
||||
. 'occurrence_count, known_detector'],
|
||||
'200' => ['description' => 'Bekannter Befund, Zaehler erhoeht'],
|
||||
'400' => $errorResponse,
|
||||
'401' => $errorResponse,
|
||||
'429' => $errorResponse,
|
||||
],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/supervisor/v1/findings' => [
|
||||
'get' => [
|
||||
'tags' => ['Supervisor'],
|
||||
'summary' => 'Befunde abfragen',
|
||||
'description' =>
|
||||
"Scope supervisor:read. Filter: project_slug, detector, status, instance, "
|
||||
. "build, environment, since, limit, offset.\n\n"
|
||||
. "`detector` nimmt auch einen Familiennamen: \"deviation\" liefert "
|
||||
. "deviation.self und deviation.fleet.\n\n"
|
||||
. "`status` ist standardmaessig \"active\" (open und acknowledged).",
|
||||
'responses' => ['200' => ['description' => 'Befundliste'], '401' => $errorResponse],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/supervisor/v1/summary' => [
|
||||
'get' => [
|
||||
'tags' => ['Supervisor'],
|
||||
'summary' => 'Befunde je Detektor zaehlen',
|
||||
'description' => 'Scope supervisor:read. Der Ueberblick vor dem Einzelbefund.',
|
||||
'responses' => ['200' => ['description' => 'Zaehlung'], '401' => $errorResponse],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/supervisor/v1/catalog' => [
|
||||
'get' => [
|
||||
'tags' => ['Supervisor'],
|
||||
'summary' => 'Detektor-Katalog',
|
||||
'description' =>
|
||||
"Scope supervisor:read. Alle bekannten Detektoren mit Herkunft (client oder "
|
||||
. "server), wonach sie suchen und was sie dafuer brauchen.\n\n"
|
||||
. "Die Namen sind stabil und wandern nicht - nur so bleiben Befunde aus "
|
||||
. "verschiedenen Projekten vergleichbar.",
|
||||
'responses' => ['200' => ['description' => 'Katalog'], '401' => $errorResponse],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/supervisor/v1/status' => [
|
||||
'post' => [
|
||||
'tags' => ['Supervisor'],
|
||||
'summary' => 'Befund einstufen',
|
||||
'description' =>
|
||||
"Scope supervisor:manage - bewusst getrennt von supervisor:report. Ein "
|
||||
. "Beobachter auf Kundenhardware darf melden, aber nicht entscheiden, dass "
|
||||
. "seine eigene Meldung erledigt ist.\n\n"
|
||||
. "Status: open, acknowledged, promoted, resolved, ignored.",
|
||||
'responses' => [
|
||||
'200' => ['description' => 'Geaendert'],
|
||||
'400' => $errorResponse,
|
||||
'401' => $errorResponse,
|
||||
'404' => $errorResponse,
|
||||
],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/updateservice/v1/check' => [
|
||||
'get' => [
|
||||
'tags' => ['UpdateService'],
|
||||
@@ -663,6 +882,64 @@ $spec = [
|
||||
],
|
||||
],
|
||||
|
||||
'/api/setup/v1/agent' => [
|
||||
'post' => [
|
||||
'tags' => ['Setup'],
|
||||
'summary' => 'Watchdog-Agent fuer die Maschine selbst',
|
||||
'description' =>
|
||||
"Scope `setup:install`. Legt den Monitor an, stellt ein Token mit genau "
|
||||
. "`watchdog:ping` aus und liefert das fertige Skript fuer diesen Host - "
|
||||
. "Shell unter Linux, PowerShell unter Windows.\n\n"
|
||||
. "Gedacht fuer den Installer, der ohnehin auf dem Zielsystem laeuft: der Weg "
|
||||
. "ueber die Oberflaeche verlangte Monitor anlegen, Token erzeugen, Skript "
|
||||
. "herunterladen, kopieren und einplanen - fuenf Schritte an einem anderen "
|
||||
. "Rechner.\n\n"
|
||||
. "Einen bereits vorhandenen Monitor gleichen Namens lehnt der Endpunkt mit "
|
||||
. "`409 monitor_exists` ab. Sonst uebernaehme eine zweite Maschine "
|
||||
. "stillschweigend die Historie der ersten; `overwrite: true` erlaubt es "
|
||||
. "ausdruecklich.\n\n"
|
||||
. "Das Skript enthaelt das Token im Klartext und wird nur einmal ausgeliefert.",
|
||||
'requestBody' => [
|
||||
'required' => true,
|
||||
'content' => ['application/json' => ['schema' => [
|
||||
'type' => 'object',
|
||||
'required' => ['project', 'source'],
|
||||
'properties' => [
|
||||
'project' => ['type' => 'string', 'description' => 'Produkt, an das das Token gebunden wird.'],
|
||||
'source' => ['type' => 'string', 'description' => 'Name des Monitors im Dashboard.'],
|
||||
'os' => ['type' => 'string', 'enum' => ['linux', 'windows'], 'default' => 'linux'],
|
||||
'interval' => ['type' => 'integer', 'default' => 60, 'description' => 'Erwarteter Abstand der Heartbeats in Sekunden (30 bis 3600).'],
|
||||
'group' => ['type' => 'string', 'description' => 'Gruppierung im Dashboard.'],
|
||||
'parent' => ['type' => 'string', 'description' => 'Uebergeordneter Monitor, etwa der Hypervisor.'],
|
||||
'overwrite' => ['type' => 'boolean', 'default' => false, 'description' => 'Einen bestehenden Monitor gleichen Namens uebernehmen.'],
|
||||
],
|
||||
]]],
|
||||
],
|
||||
'responses' => [
|
||||
'201' => [
|
||||
'description' => 'Monitor eingerichtet, Skript enthaelt das Token',
|
||||
'content' => ['application/json' => ['schema' => [
|
||||
'type' => 'object',
|
||||
'properties' => [
|
||||
'source' => ['type' => 'string'],
|
||||
'os' => ['type' => 'string'],
|
||||
'filename' => ['type' => 'string'],
|
||||
'script' => ['type' => 'string'],
|
||||
'schedule' => ['type' => 'string', 'description' => 'Einplanungsbefehl; {PFAD} steht fuer den Ablageort.'],
|
||||
'interval' => ['type' => 'integer'],
|
||||
'token_id' => ['type' => 'string'],
|
||||
'existing' => ['type' => 'boolean'],
|
||||
],
|
||||
]]],
|
||||
],
|
||||
'401' => $errorResponse,
|
||||
'403' => $errorResponse,
|
||||
'404' => $errorResponse,
|
||||
'409' => $errorResponse,
|
||||
],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/watchdog/v1/ping' => [
|
||||
'post' => [
|
||||
'tags' => ['Watchdog'],
|
||||
@@ -874,6 +1151,56 @@ $spec = [
|
||||
],
|
||||
],
|
||||
|
||||
'/api/license/v1/dev-key' => [
|
||||
'post' => [
|
||||
'tags' => ['Lizenz'],
|
||||
'summary' => 'Entwicklungsschluessel abholen (Selbstbedienung)',
|
||||
'description' =>
|
||||
"Scope `license:dev`. Gedacht fuer Werkbank-Token auf Testmaschinen.\n\n"
|
||||
. "**Antwortet im Hausformat** (`status: \"success\"`) - anders als `validate` und "
|
||||
. "`deactivate` daneben, die ihr abweichendes Altformat behalten.\n\n"
|
||||
. "**Der Aufruf ist wiederholbar.** Fuer dieselbe Kombination aus `project_slug` "
|
||||
. "und `instance_id` kommt derselbe Schluessel zurueck und seine Frist wird "
|
||||
. "verlaengert. Ein Testskript darf ihn deshalb an den Anfang jedes Laufs setzen, "
|
||||
. "ohne bei jedem Lauf einen weiteren Schluessel zu hinterlassen. `created` sagt, "
|
||||
. "ob er neu ist.\n\n"
|
||||
. "Der ausgestellte Schluessel ist eine gewoehnliche Lizenz: befristet (Vorgabe 30 "
|
||||
. "Tage, einstellbar ueber `license.dev_ttl_days`), mit wenigen Aktivierungen, und "
|
||||
. "in `customer_email` als Testschluessel markiert. Er oeffnet damit auch die "
|
||||
. "Release-Ablage des Produkts - die `.htpasswd` wird beim Ausstellen sofort "
|
||||
. "nachgezogen.\n\n"
|
||||
. "Projektgebundene Token kommen nur an ihr eigenes Projekt; die Ausnahme fuer "
|
||||
. "Werkbank-Token gilt hier **nicht**. Ein Lizenzschluessel oeffnet Pakete, eine "
|
||||
. "Meldung tut das nicht.\n\n"
|
||||
. "Zum Zurueckgeben `action_mode: \"revoke\"` senden. Abgelaufene Schluessel "
|
||||
. "verschwinden ohnehin von selbst.\n\n"
|
||||
. "Begrenzt auf 10 Anfragen pro Minute und IP, und auf 12 gleichzeitig gueltige "
|
||||
. "Schluessel je Projekt.",
|
||||
'requestBody' => [
|
||||
'required' => true,
|
||||
'content' => ['application/json' => ['schema' => [
|
||||
'type' => 'object',
|
||||
'required' => ['project_slug', 'instance_id'],
|
||||
'properties' => [
|
||||
'project_slug' => ['type' => 'string', 'description' => 'Slug aus dc_projects.'],
|
||||
'instance_id' => ['type' => 'string', 'example' => 'testvm', 'description' => 'Kennung der Maschine. Ueber sie findet ein wiederholter Aufruf denselben Schluessel wieder; ein FQDN wird auf den kurzen Namen gekuerzt.'],
|
||||
'ttl_days' => ['type' => 'integer', 'example' => 30, 'description' => 'Gewuenschte Laufzeit, begrenzt auf 90 Tage.'],
|
||||
'action_mode' => ['type' => 'string', 'enum' => ['issue', 'revoke'], 'default' => 'issue'],
|
||||
],
|
||||
]]],
|
||||
],
|
||||
'responses' => [
|
||||
'200' => ['description' => 'Bestehender Schluessel verlaengert oder zurueckgegeben'],
|
||||
'201' => ['description' => 'Neuer Schluessel ausgestellt'],
|
||||
'400' => $errorResponse,
|
||||
'401' => $errorResponse,
|
||||
'403' => $errorResponse,
|
||||
'409' => $errorResponse,
|
||||
'429' => $errorResponse,
|
||||
],
|
||||
],
|
||||
],
|
||||
|
||||
'/api/license/v1/status' => [
|
||||
'get' => [
|
||||
'tags' => ['Lizenz'],
|
||||
|
||||
@@ -0,0 +1,239 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* /api/supervisor/v1/...
|
||||
*
|
||||
* Eingang und Abfrage der Supervisor-Befunde.
|
||||
*
|
||||
* POST ?action=observe Befund einliefern (supervisor:report)
|
||||
* GET ?action=findings Befunde abfragen (supervisor:read)
|
||||
* GET ?action=summary Zaehlung je Detektor (supervisor:read)
|
||||
* GET ?action=catalog Der Detektor-Katalog (supervisor:read)
|
||||
* POST ?action=status Befund einstufen (supervisor:read)
|
||||
*
|
||||
* Ein Befund ist keine Fehlermeldung. Er behauptet nicht, dass etwas kaputt
|
||||
* ist, sondern dass etwas ungewoehnlich ist - deshalb loest er hier auch
|
||||
* keine Benachrichtigung aus.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
require_once __DIR__ . '/../../../../src/bootstrap.php';
|
||||
|
||||
use Deploymentcenter\Core\ApiAuth;
|
||||
use Deploymentcenter\Core\Config;
|
||||
use Deploymentcenter\Core\Db;
|
||||
use Deploymentcenter\Core\Http;
|
||||
use Deploymentcenter\Modules\License\RateLimiter;
|
||||
use Deploymentcenter\Modules\Supervisor\Catalog;
|
||||
use Deploymentcenter\Modules\Supervisor\FindingRepo;
|
||||
|
||||
const READ_ACTIONS = ['findings', 'summary', 'catalog'];
|
||||
const WRITE_ACTIONS = ['observe', 'status'];
|
||||
|
||||
/**
|
||||
* Aktion aus ?action= oder dem letzten Pfadsegment - wie beim Watchdog, damit
|
||||
* beide Schreibweisen funktionieren:
|
||||
* POST /api/supervisor/v1/observe
|
||||
* POST /api/supervisor/v1/?action=observe
|
||||
*/
|
||||
function resolveSupervisorAction(): string
|
||||
{
|
||||
$explicit = Http::str('action');
|
||||
if ($explicit !== null) {
|
||||
return strtolower($explicit);
|
||||
}
|
||||
|
||||
$segments = array_values(array_filter(
|
||||
explode('/', trim(Http::path(), '/')),
|
||||
static fn(string $s): bool => $s !== ''
|
||||
));
|
||||
|
||||
$last = strtolower((string)end($segments));
|
||||
|
||||
return match ($last) {
|
||||
'observe' => 'observe',
|
||||
'summary' => 'summary',
|
||||
'catalog' => 'catalog',
|
||||
'status' => 'status',
|
||||
default => 'findings',
|
||||
};
|
||||
}
|
||||
|
||||
Http::beginJson(['GET', 'POST', 'OPTIONS'], true);
|
||||
|
||||
$action = resolveSupervisorAction();
|
||||
|
||||
if (!in_array($action, READ_ACTIONS, true) && !in_array($action, WRITE_ACTIONS, true)) {
|
||||
Http::fail(404, 'unknown_action', sprintf('Unbekannte Aktion "%s".', $action), null, [
|
||||
'available' => array_merge(READ_ACTIONS, WRITE_ACTIONS),
|
||||
]);
|
||||
}
|
||||
|
||||
$isWrite = in_array($action, WRITE_ACTIONS, true);
|
||||
|
||||
if ($isWrite && Http::method() !== 'POST') {
|
||||
Http::fail(405, 'method_not_allowed', sprintf('Die Aktion "%s" erwartet POST.', $action));
|
||||
}
|
||||
|
||||
$db = Db::init();
|
||||
|
||||
// Ein Beobachter meldet regelmaessig. Bricht seine Zustandsverwaltung, sendet
|
||||
// er im Sekundentakt - dann soll er gedrosselt werden und nicht die Tabelle
|
||||
// fuellen.
|
||||
if ($action === 'observe') {
|
||||
$limiter = new RateLimiter(
|
||||
$db,
|
||||
(int)Config::get('supervisor.observe_rate', 120),
|
||||
60,
|
||||
'sv_observe'
|
||||
);
|
||||
|
||||
if (!$limiter->check(Http::clientIp())) {
|
||||
Http::fail(429, 'rate_limited', 'Zu viele Befunde. Bitte Sendefrequenz reduzieren.');
|
||||
}
|
||||
}
|
||||
|
||||
// Drei Rechte, drei Rollen:
|
||||
// observe - der Beobachter auf der Kundenmaschine, meldet nur
|
||||
// status - die Sichtung, entscheidet ueber Befunde
|
||||
// Rest - Lesen
|
||||
//
|
||||
// Beim Einliefern ist die Sitzung bewusst nicht erlaubt: das ist die
|
||||
// Maschinenschnittstelle.
|
||||
$scope = match ($action) {
|
||||
'observe' => 'supervisor:report',
|
||||
'status' => 'supervisor:manage',
|
||||
default => 'supervisor:read',
|
||||
};
|
||||
|
||||
$context = ApiAuth::requireScope($db, $scope, null, $action !== 'observe');
|
||||
|
||||
$repo = new FindingRepo($db);
|
||||
|
||||
switch ($action) {
|
||||
|
||||
// ---------------------------------------------------------------- lesen
|
||||
case 'catalog':
|
||||
Http::ok([
|
||||
'count' => count(Catalog::DETECTORS),
|
||||
'detectors' => Catalog::DETECTORS,
|
||||
]);
|
||||
// no break - Http::ok beendet die Anfrage
|
||||
|
||||
case 'summary':
|
||||
$slug = ApiAuth::projectFilter($context, true) ?? Http::str('project_slug');
|
||||
Http::ok([
|
||||
'project_slug' => $slug,
|
||||
'by_detector' => $repo->byDetector($slug),
|
||||
]);
|
||||
|
||||
case 'findings':
|
||||
$bound = ApiAuth::projectFilter($context, true);
|
||||
|
||||
$result = $repo->search([
|
||||
'project_slug' => $bound ?? Http::str('project_slug') ?? 'all',
|
||||
'detector' => Http::str('detector'),
|
||||
'status' => Http::str('status'),
|
||||
'instance' => Http::str('instance'),
|
||||
'build' => Http::str('build'),
|
||||
'environment' => Http::str('environment'),
|
||||
'since' => Http::str('since'),
|
||||
'limit' => Http::int('limit', 50),
|
||||
'offset' => Http::int('offset', 0),
|
||||
]);
|
||||
|
||||
Http::ok($result);
|
||||
|
||||
// ------------------------------------------------------------ schreiben
|
||||
case 'observe':
|
||||
$data = Http::body();
|
||||
|
||||
if ($data === []) {
|
||||
Http::fail(400, 'empty_body', 'Der Request-Body ist leer.');
|
||||
}
|
||||
|
||||
$projectSlug = is_string($data['project_slug'] ?? null) ? trim($data['project_slug']) : null;
|
||||
ApiAuth::enforceProject($context, $projectSlug);
|
||||
|
||||
// Ein projektgebundenes Token meldet immer fuer sein eigenes Projekt.
|
||||
// Anders als beim Bugtracker gibt es hier keine Ausnahme fuer
|
||||
// Werkbank-Token: ein Befund ist eine Beobachtung an einer laufenden
|
||||
// Installation, und die macht man nicht stellvertretend fuer ein
|
||||
// fremdes Projekt.
|
||||
$home = ApiAuth::homeProject($context);
|
||||
if ($home !== null) {
|
||||
$data['project_slug'] = $home;
|
||||
}
|
||||
|
||||
// Die Herkunft wird abgeleitet, nicht uebernommen - ein Client darf
|
||||
// seine Befunde nicht als serverseitig ermittelt ausgeben.
|
||||
$data['origin'] = Catalog::ORIGIN_CLIENT;
|
||||
|
||||
try {
|
||||
$result = $repo->record($data);
|
||||
} catch (\InvalidArgumentException $e) {
|
||||
Http::fail(400, 'invalid_finding', $e->getMessage());
|
||||
}
|
||||
|
||||
Http::ok([
|
||||
'finding_id' => $result['id'],
|
||||
'is_new' => $result['is_new'],
|
||||
'occurrence_count' => $result['occurrence_count'],
|
||||
'detector' => $result['detector'],
|
||||
// NICHT 'status'. Http::ok() legt ['status' => 'success'] als
|
||||
// Umschlag darum und merged dieses Feld darueber - der Zustand des
|
||||
// Befundes ueberschrieb also die Erfolgsmeldung. Jeder Client, der
|
||||
// wie dokumentiert auf status === "success" prueft, brach
|
||||
// ausgerechnet an dem Endpunkt, den ein meldender Client am
|
||||
// haeufigsten aufruft.
|
||||
'finding_status' => $result['status'],
|
||||
'client_ref' => $result['client_ref'],
|
||||
// Ein unbekannter Detektorname wird angenommen, aber gemeldet.
|
||||
// Still verwerfen waere schlimmer: dann suchte jemand tagelang
|
||||
// nach Befunden, die nie ankamen.
|
||||
'known_detector' => $result['known_detector'],
|
||||
'message' => $result['known_detector']
|
||||
? ($result['is_new'] ? 'Befund aufgenommen.' : 'Bekannter Befund - Zaehler erhoeht.')
|
||||
: sprintf(
|
||||
'Befund aufgenommen. Achtung: "%s" steht nicht im Katalog - Tippfehler, '
|
||||
. 'oder der Katalog muss erweitert werden.',
|
||||
$result['detector']
|
||||
),
|
||||
], $result['is_new'] ? 201 : 200);
|
||||
|
||||
case 'status':
|
||||
$id = Http::int('id', 0);
|
||||
|
||||
if ($id <= 0) {
|
||||
Http::fail(400, 'missing_id', 'Es wurde keine Befund-ID uebergeben.');
|
||||
}
|
||||
|
||||
$finding = $repo->get($id);
|
||||
if ($finding === null) {
|
||||
Http::fail(404, 'not_found', sprintf('Befund #%d existiert nicht.', $id));
|
||||
}
|
||||
|
||||
ApiAuth::enforceProject($context, (string)$finding['project_slug'], true);
|
||||
|
||||
$status = Http::str('status');
|
||||
if ($status === null || !in_array($status, FindingRepo::STATUSES, true)) {
|
||||
Http::fail(400, 'invalid_status', 'Ungueltiger Status.', null, [
|
||||
'allowed' => FindingRepo::STATUSES,
|
||||
]);
|
||||
}
|
||||
|
||||
if (!$repo->setStatus($id, $status, $context['actor'])) {
|
||||
Http::fail(500, 'update_failed', sprintf('Befund #%d konnte nicht geaendert werden.', $id));
|
||||
}
|
||||
|
||||
Http::ok([
|
||||
'finding_id' => $id,
|
||||
// Aus demselben Grund wie bei 'observe' nicht 'status': Der
|
||||
// gesetzte Zustand ueberschriebe sonst die Erfolgsmeldung des
|
||||
// Umschlags. Hier faellt es weniger auf, weil ein Mensch die
|
||||
// Einstufung ausloest - der Fehler ist derselbe.
|
||||
'finding_status' => $status,
|
||||
'message' => sprintf('Befund #%d auf "%s" gesetzt.', $id, $status),
|
||||
]);
|
||||
}
|
||||
Reference in New Issue
Block a user