Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 dmg
|
ee3b4eca35 | ||
|
dmg
|
9f3f27bb45 |
@@ -17,7 +17,7 @@ jobs:
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: temurin
|
||||
java-version: 17
|
||||
java-version: 25
|
||||
cache: gradle
|
||||
|
||||
- name: Validate conventional commits
|
||||
@@ -35,6 +35,6 @@ jobs:
|
||||
- name: Upload development artifact
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: spigot-event-producer-${{ github.sha }}
|
||||
name: purpur-event-producer-${{ github.sha }}
|
||||
path: build/libs/*.jar
|
||||
if-no-files-found: error
|
||||
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: temurin
|
||||
java-version: 17
|
||||
java-version: 25
|
||||
cache: gradle
|
||||
|
||||
- name: Set up Node.js
|
||||
@@ -86,8 +86,8 @@ jobs:
|
||||
if: steps.release.outputs.created == 'true'
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: spigot-event-producer-${{ steps.release.outputs.version }}
|
||||
path: build/libs/spigot-event-producer-${{ steps.release.outputs.version }}.jar
|
||||
name: purpur-event-producer-${{ steps.release.outputs.version }}
|
||||
path: build/libs/purpur-event-producer-${{ steps.release.outputs.version }}.jar
|
||||
if-no-files-found: error
|
||||
|
||||
- name: Create Gitea release and upload plugin
|
||||
@@ -101,7 +101,7 @@ jobs:
|
||||
PREVIOUS_TAG: ${{ steps.previous_tag.outputs.value }}
|
||||
run: |
|
||||
api_url="${GITEA_SERVER_URL}/api/v1"
|
||||
jar="build/libs/spigot-event-producer-${VERSION}.jar"
|
||||
jar="build/libs/purpur-event-producer-${VERSION}.jar"
|
||||
export RELEASE_BODY
|
||||
if [ -n "$PREVIOUS_TAG" ]; then
|
||||
RELEASE_BODY=$(git log --pretty='format:- %s (%h)' "${PREVIOUS_TAG}..HEAD")
|
||||
@@ -138,4 +138,4 @@ jobs:
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary "@${jar}" \
|
||||
"${api_url}/repos/${REPOSITORY}/releases/${release_id}/assets?name=spigot-event-producer-${VERSION}.jar"
|
||||
"${api_url}/repos/${REPOSITORY}/releases/${release_id}/assets?name=purpur-event-producer-${VERSION}.jar"
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# purpur-event-producer agent entrypoint
|
||||
|
||||
The canonical stories, engineering guidance, and **all process documents** are in the private [SoMC OKF wiki](https://git.garvis.dev/dmg/somc-okf/src/branch/main/index.md).
|
||||
|
||||
Before work, read the sibling `../somc-okf/index.md`, `../somc-okf/processes/index.md`, `../somc-okf/projects/purpur-event-producer/index.md`, `engineering.md` in that project section, and relevant `../somc-okf/user-stories/purpur-event-producer/` stories. Also follow the parent workspace `AGENTS.md` when present.
|
||||
|
||||
For standalone checkouts, start at the [project page](https://git.garvis.dev/dmg/somc-okf/src/branch/main/projects/purpur-event-producer/index.md) and [shared process](https://git.garvis.dev/dmg/somc-okf/src/branch/main/processes/development.md). Obtain wiki access before feature work; do not recreate a local knowledge bundle. Source builds do not require private wiki access.
|
||||
|
||||
Development follows [Development cycle](https://git.garvis.dev/dmg/somc-okf/src/branch/main/runbooks/development-cycle.md): approved stories, failing tests, passing implementation, verification, then source/wiki commit and push. GitOps updates are committed locally **without pushing**; only [Do release](https://git.garvis.dev/dmg/somc-okf/src/branch/main/runbooks/do-release.md) authorizes a reviewed GitOps push.
|
||||
@@ -1,18 +1,20 @@
|
||||
# Spigot Event Producer
|
||||
# Purpur Event Producer
|
||||
|
||||
A Spigot 26.2 plugin that records Minecraft activity as CloudEvents 1.0, persists it in a local SQLite outbox, and sends newline-delimited batches to `game-ingest-server`.
|
||||
A Purpur 26.2 plugin that records Minecraft activity as CloudEvents 1.0, persists it in a local SQLite outbox, and sends newline-delimited batches to `game-ingest-server`.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Spigot 26.2
|
||||
- Java 17 or newer
|
||||
- Purpur 26.2 build 2618
|
||||
- Java 25
|
||||
- Network access to the ingest endpoint
|
||||
|
||||
The repository, checkout and new artifacts use `purpur-event-producer`. Runtime `SpigotEventProducer`, Java entrypoint/packages, existing configuration/server UUID and `plugins/SpigotEventProducer/event-outbox.sqlite3` remain unchanged, as do CloudEvent types/source/payloads and delivery semantics. The SQLite driver stays bundled. Replace the old JAR rather than installing both distributions. Old tags/assets remain available; new releases no longer support Java 17.
|
||||
|
||||
## Build and install
|
||||
|
||||
```bash
|
||||
./gradlew clean test jar
|
||||
cp build/libs/spigot-event-producer-0.1.0-SNAPSHOT.jar /path/to/server/plugins/
|
||||
./gradlew clean check jar
|
||||
cp build/libs/purpur-event-producer-0.1.0-SNAPSHOT.jar /path/to/server/plugins/
|
||||
```
|
||||
|
||||
Start the Minecraft server once to create `plugins/SpigotEventProducer/config.yml`. Set a meaningful, stable `server-name`. When `server-id` is empty, the plugin generates and persists a UUID. Do not reuse that generated UUID on another server.
|
||||
@@ -52,7 +54,7 @@ Public chat events contain the complete message text.
|
||||
|
||||
Private-message events recognize `/msg`, `/message`, `/tell`, `/w`, `/whisper`, `/pm`, `/reply`, and `/r`, including namespaced variants such as `/minecraft:tell`. Explicit commands contain the destination token. Reply commands set `reply: true` and omit the recipient so downstream processing can infer it from earlier ordered events. The event also reports whether the command was cancelled.
|
||||
|
||||
Spigot has no universal private-message event. Commands implemented with unrelated aliases or entirely custom plugin logic will not be recognized until their syntax is added. A recognized command event reports observation of the command, not guaranteed delivery to its recipient.
|
||||
The Bukkit-compatible server API has no universal private-message event. Commands implemented with unrelated aliases or entirely custom plugin logic will not be recognized until their syntax is added. A recognized command event reports observation of the command, not guaranteed delivery to its recipient.
|
||||
|
||||
### Location snapshots
|
||||
|
||||
@@ -114,7 +116,7 @@ Gitea Actions runs the Gradle checks for every push and pull request and stores
|
||||
- `feat:` creates a minor release;
|
||||
- a breaking-change footer or `!` creates a major release.
|
||||
|
||||
A successful release creates a `vX.Y.Z` tag and attaches `spigot-event-producer-X.Y.Z.jar` permanently to the corresponding Gitea Release. The release workflow requires a repository secret named `RELEASE_TOKEN` with repository contents write permission.
|
||||
A successful release creates a `vX.Y.Z` tag and attaches `purpur-event-producer-X.Y.Z.jar` permanently to the corresponding Gitea Release. The release workflow requires a repository secret named `RELEASE_TOKEN` with repository contents write permission.
|
||||
|
||||
For a local versioned build:
|
||||
|
||||
|
||||
+7
-4
@@ -9,12 +9,12 @@ version = providers.gradleProperty("releaseVersion")
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
maven("https://hub.spigotmc.org/nexus/content/repositories/snapshots/")
|
||||
maven("https://repo.purpurmc.org/snapshots/")
|
||||
}
|
||||
|
||||
java {
|
||||
toolchain {
|
||||
languageVersion = JavaLanguageVersion.of(17)
|
||||
languageVersion = JavaLanguageVersion.of(25)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -23,10 +23,10 @@ tasks.withType<JavaCompile>().configureEach {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly("org.spigotmc:spigot-api:26.2-R0.1-SNAPSHOT")
|
||||
compileOnly("org.purpurmc.purpur:purpur-api:26.2.build.2618-stable")
|
||||
implementation("org.xerial:sqlite-jdbc:3.50.3.0")
|
||||
|
||||
testImplementation("org.spigotmc:spigot-api:26.2-R0.1-SNAPSHOT")
|
||||
testImplementation("org.purpurmc.purpur:purpur-api:26.2.build.2618-stable")
|
||||
testImplementation(platform("org.junit:junit-bom:5.13.4"))
|
||||
testImplementation("org.junit.jupiter:junit-jupiter")
|
||||
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
|
||||
@@ -34,6 +34,9 @@ dependencies {
|
||||
|
||||
tasks.test {
|
||||
useJUnitPlatform()
|
||||
dependsOn(tasks.jar)
|
||||
systemProperty("distribution.jar", tasks.jar.get().archiveFile.get().asFile.absolutePath)
|
||||
systemProperty("distribution.version", project.version.toString())
|
||||
}
|
||||
|
||||
val pluginVersion = version
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
---
|
||||
type: Index
|
||||
title: Spigot Event Producer Design
|
||||
description: Entry point for the Spigot Event Producer OKF knowledge bundle.
|
||||
okf_version: "0.1"
|
||||
---
|
||||
|
||||
# Spigot Event Producer Design
|
||||
|
||||
This bundle documents the user-visible and operational behavior of the Spigot plugin that captures Minecraft activity and delivers it as CloudEvents.
|
||||
|
||||
## Explore
|
||||
|
||||
- [User stories](user-stories/index.md)
|
||||
- [Design log](log.md)
|
||||
- [Project README](../README.md)
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
type: Log
|
||||
title: Design Log
|
||||
description: Chronological record of material changes to the design knowledge bundle.
|
||||
---
|
||||
|
||||
# Design Log
|
||||
|
||||
## 2026-08-08
|
||||
|
||||
- Established the OKF v0.1 design bundle.
|
||||
- Documented the existing configuration, event production, activity capture, snapshots, durable delivery, and release workflows as user stories.
|
||||
- Made snapshot collection skip Bukkit registry entries whose keys are unavailable.
|
||||
@@ -1,16 +0,0 @@
|
||||
---
|
||||
type: Index
|
||||
title: User Stories
|
||||
description: Catalog of user stories for the Spigot Event Producer.
|
||||
---
|
||||
|
||||
# User Stories
|
||||
|
||||
1. [US-001: Configure the event producer](us-001-configure-event-producer.md)
|
||||
2. [US-002: Produce standard CloudEvents](us-002-produce-standard-cloud-events.md)
|
||||
3. [US-003: Capture player and server activity](us-003-capture-player-activity.md)
|
||||
4. [US-004: Capture periodic player snapshots](us-004-capture-player-snapshots.md)
|
||||
5. [US-005: Deliver events durably](us-005-deliver-events-durably.md)
|
||||
6. [US-006: Build and release the plugin](us-006-build-and-release-plugin.md)
|
||||
|
||||
Return to the [design index](../index.md).
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
type: User Story
|
||||
title: "US-001: Configure the event producer"
|
||||
description: Allow a server operator to identify a Minecraft server and tune event capture and delivery safely.
|
||||
status: done
|
||||
---
|
||||
|
||||
# US-001: Configure the event producer
|
||||
|
||||
As a **Minecraft server operator**, I want to configure the producer for my server and ingest service so that emitted events are identifiable and fit my operating limits.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [x] A human-readable server name and stable server UUID can be configured.
|
||||
- [x] When no server UUID is supplied, the plugin generates one and persists it for later starts.
|
||||
- [x] The ingest URL, send interval, snapshot interval, HTTP timeout, batch limits, dispatch thresholds, statistic chunk size, and per-tick statistic budget are configurable.
|
||||
- [x] Blank required values, non-positive limits, overlong server names, invalid UUIDs, and statistic chunks without sufficient batch headroom prevent initialization.
|
||||
- [x] Initialization errors are logged and leave the plugin disabled rather than partially running.
|
||||
|
||||
## Related
|
||||
|
||||
- [US-002: Produce standard CloudEvents](us-002-produce-standard-cloud-events.md)
|
||||
- [US-005: Deliver events durably](us-005-deliver-events-durably.md)
|
||||
- [Configuration reference](../../README.md#configuration)
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
type: User Story
|
||||
title: "US-002: Produce standard CloudEvents"
|
||||
description: Represent captured Minecraft activity as consistently identifiable CloudEvents 1.0 records.
|
||||
status: done
|
||||
---
|
||||
|
||||
# US-002: Produce standard CloudEvents
|
||||
|
||||
As an **event consumer**, I want Minecraft activity represented by a consistent CloudEvents envelope so that I can process records from multiple servers and players reliably.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [x] Every record is a structured CloudEvents 1.0 JSON object with a unique stable event ID, UTC time, source, type, and JSON content type.
|
||||
- [x] Event types use the `games.dmg.minecraft.*` namespace.
|
||||
- [x] Every event includes the stable server ID, server name, and game version as extensions and in its data.
|
||||
- [x] Player events include the player UUID as an extension and include the player UUID and current name in their data.
|
||||
- [x] An event retains the same ID and payload while it is retried from the outbox.
|
||||
|
||||
## Related
|
||||
|
||||
- [US-001: Configure the event producer](us-001-configure-event-producer.md)
|
||||
- [US-003: Capture player and server activity](us-003-capture-player-activity.md)
|
||||
- [US-004: Capture periodic player snapshots](us-004-capture-player-snapshots.md)
|
||||
- [Event reference](../../README.md#events)
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
type: User Story
|
||||
title: "US-003: Capture player and server activity"
|
||||
description: Record server lifecycle, player sessions, public chat, and recognized private messages.
|
||||
status: done
|
||||
---
|
||||
|
||||
# US-003: Capture player and server activity
|
||||
|
||||
As a **server analyst**, I want significant server and player activity captured so that I can reconstruct participation and communication activity downstream.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [x] Plugin startup and shutdown produce server lifecycle events.
|
||||
- [x] Player joins and quits produce events with player identity.
|
||||
- [x] Non-cancelled public chat produces an event containing the complete message and whether the Bukkit event was asynchronous.
|
||||
- [x] Recognized explicit private-message commands capture the command, recipient token, and complete message.
|
||||
- [x] Recognized reply commands are marked as replies and omit a recipient.
|
||||
- [x] Private-message observations report whether the underlying command was cancelled.
|
||||
- [x] Standard aliases and namespaced variants documented by the project are recognized.
|
||||
|
||||
## Related
|
||||
|
||||
- [US-002: Produce standard CloudEvents](us-002-produce-standard-cloud-events.md)
|
||||
- [US-005: Deliver events durably](us-005-deliver-events-durably.md)
|
||||
- [Chat and private-message behavior](../../README.md#chat-and-private-messages)
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
type: User Story
|
||||
title: "US-004: Capture periodic player snapshots"
|
||||
description: Periodically capture player location and comprehensive Bukkit statistics without monopolizing a server tick.
|
||||
status: done
|
||||
---
|
||||
|
||||
# US-004: Capture periodic player snapshots
|
||||
|
||||
As a **server analyst**, I want periodic player location and statistic snapshots so that I can analyze movement and gameplay progression over time.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [x] Each configured interval captures every online player's world identity, coordinates, orientation, game mode, and biome.
|
||||
- [x] Registry-backed snapshot values use Bukkit's stable `Keyed` contract so collection remains compatible with the supported Purpur runtime.
|
||||
- [x] Unkeyed registry entries such as `EntityType.UNKNOWN` are skipped without throwing or interrupting snapshot collection.
|
||||
- [x] Every Bukkit untyped, block, item, and entity statistic combination accepted by Bukkit is captured, including zero values.
|
||||
- [x] Invalid statistic subtype combinations are skipped without stopping the snapshot.
|
||||
- [x] Statistic reads are spread across ticks according to a configurable operation budget and run through Bukkit scheduling.
|
||||
- [x] A player is not queued for a second statistic capture while an earlier capture remains queued or active.
|
||||
- [x] Statistics are partitioned by category and configured JSON size, with shared snapshot metadata and one-based part information.
|
||||
- [x] Empty statistic categories still emit an explicit part.
|
||||
- [x] Offline players are removed safely from queued or active capture work.
|
||||
|
||||
## Related
|
||||
|
||||
- [US-001: Configure the event producer](us-001-configure-event-producer.md)
|
||||
- [US-002: Produce standard CloudEvents](us-002-produce-standard-cloud-events.md)
|
||||
- [Snapshot behavior](../../README.md#location-snapshots)
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
type: User Story
|
||||
title: "US-005: Deliver events durably"
|
||||
description: Persist events locally and deliver ordered, bounded batches without blocking the Minecraft server thread.
|
||||
status: done
|
||||
---
|
||||
|
||||
# US-005: Deliver events durably
|
||||
|
||||
As a **server operator**, I want captured events buffered durably and retried after ingest failures so that temporary outages do not silently lose activity.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [x] Events are persisted in an ordered local SQLite outbox before delivery.
|
||||
- [x] Persistence and HTTP delivery use dedicated workers rather than performing SQLite or network work on the Bukkit server thread.
|
||||
- [x] Delivery uses newline-delimited JSON batches bounded by configured event and byte limits.
|
||||
- [x] Delivery is requested periodically and may also be requested when an event-count or byte threshold is reached.
|
||||
- [x] Events are acknowledged and removed only after the ingest endpoint returns HTTP `202 Accepted`.
|
||||
- [x] Failed deliveries remain in the outbox and are retried with bounded exponential backoff.
|
||||
- [x] Stable event IDs provide at-least-once delivery semantics suitable for downstream deduplication.
|
||||
- [x] Shutdown waits for the shutdown event to be persisted and drains pending persistence work before closing the outbox.
|
||||
|
||||
## Related
|
||||
|
||||
- [US-001: Configure the event producer](us-001-configure-event-producer.md)
|
||||
- [US-002: Produce standard CloudEvents](us-002-produce-standard-cloud-events.md)
|
||||
- [Delivery and durability](../../README.md#delivery-and-durability)
|
||||
@@ -1,25 +0,0 @@
|
||||
---
|
||||
type: User Story
|
||||
title: "US-006: Build and release the plugin"
|
||||
description: Give maintainers repeatable Java builds, automated verification, and versioned Gitea releases.
|
||||
status: done
|
||||
---
|
||||
|
||||
# US-006: Build and release the plugin
|
||||
|
||||
As a **plugin maintainer**, I want automated builds and releases so that tested, correctly versioned plugin artifacts can be distributed consistently.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [x] The Gradle project compiles against Java 17 and the supported Spigot API.
|
||||
- [x] Automated tests run as part of the Gradle check lifecycle.
|
||||
- [x] Pushes and pull requests build and test the plugin in Gitea Actions.
|
||||
- [x] Pull requests validate conventional commit messages.
|
||||
- [x] CI stores a development JAR as a workflow artifact.
|
||||
- [x] Main-branch conventional commits drive semantic versioning.
|
||||
- [x] A successful release builds a versioned JAR and attaches it to the corresponding Gitea release.
|
||||
|
||||
## Related
|
||||
|
||||
- [Build and release documentation](../../README.md#releases)
|
||||
- [User-story catalog](index.md)
|
||||
+1
-1
@@ -1 +1 @@
|
||||
rootProject.name = "spigot-event-producer"
|
||||
rootProject.name = "purpur-event-producer"
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
package games.dmg.spigotevents;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
import java.io.DataInputStream;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.util.Map;
|
||||
import java.util.jar.JarFile;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.yaml.snakeyaml.Yaml;
|
||||
|
||||
class PurpurDistributionTest {
|
||||
@Test
|
||||
void packagesNewNameWithoutChangingRuntimeIdentityOrBundlingTheApi() throws Exception {
|
||||
Path artifact = Path.of(System.getProperty("distribution.jar"));
|
||||
String version = System.getProperty("distribution.version");
|
||||
assertEquals("purpur-event-producer-" + version + ".jar", artifact.getFileName().toString());
|
||||
try (var jar = new JarFile(artifact.toFile())) {
|
||||
Map<?, ?> metadata = new Yaml().load(jar.getInputStream(jar.getJarEntry("plugin.yml")));
|
||||
assertEquals(version, metadata.get("version"));
|
||||
assertEquals("SpigotEventProducer", metadata.get("name"), "Retain the data directory and persistent namespace");
|
||||
assertEquals("games.dmg.spigotevents.SpigotEventProducerPlugin", metadata.get("main"));
|
||||
assertFalse(metadata.containsKey("permissions"));
|
||||
assertFalse(metadata.containsKey("commands"));
|
||||
assertNotNull(jar.getJarEntry("org/sqlite/JDBC.class"), "The SQLite driver must remain bundled");
|
||||
assertNotNull(jar.getJarEntry("META-INF/services/java.sql.Driver"));
|
||||
assertEquals("true", jar.getManifest().getMainAttributes().getValue("Multi-Release"));
|
||||
assertFalse(jar.stream().anyMatch(entry -> entry.getName().startsWith("org/bukkit/")
|
||||
|| entry.getName().startsWith("org/purpurmc/") || entry.getName().endsWith("Test.class")));
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void pluginBytecodeTargetsJava25() throws Exception {
|
||||
try (var jar = new JarFile(System.getProperty("distribution.jar"));
|
||||
var bytecode = new DataInputStream(jar.getInputStream(
|
||||
jar.getJarEntry("games/dmg/spigotevents/SpigotEventProducerPlugin.class")))) {
|
||||
assertEquals(0xCAFEBABE, bytecode.readInt());
|
||||
bytecode.readUnsignedShort();
|
||||
assertEquals(69, bytecode.readUnsignedShort());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void releaseAndCiAgreeWithThePurpurDistributionNameAndToolchain() throws Exception {
|
||||
String build = Files.readString(Path.of("build.gradle.kts"));
|
||||
assertTrue(build.contains("purpur-api:26.2.build.2618-stable"));
|
||||
assertFalse(build.contains("org.spigotmc:spigot-api"));
|
||||
for (String workflow : new String[] {"ci.yml", "release.yml"}) {
|
||||
String content = Files.readString(Path.of(".gitea/workflows", workflow));
|
||||
assertTrue(content.contains("java-version: 25"));
|
||||
assertTrue(content.contains("purpur-event-producer-"), workflow);
|
||||
assertFalse(content.contains("spigot-event-producer-"), workflow);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user