From dc616e0f340f28b320253bf9a70778a07b885ffd Mon Sep 17 00:00:00 2001 From: Kostya Date: Sun, 11 Oct 2026 17:15:39 +0300 Subject: server: add versioned sync endpoint for polling clients The spec has clients pull updates every half second or so, by fetching everything, only changes, or something in between. Take the middle road: the engine keeps a version that moves on every change, and GET /api/sync?since={version} answers {"changed": false} when nothing has happened, which is almost every poll. Otherwise it returns a snapshot of the event summaries, the user directory and the caller's account, with the version to send next time. A client looking at one event refetches its details from /api/events/{name} only when the version moves. The lock filter bumps the version after every state-changing request, still inside the write lock, so a reader can never pick up new data under an old version. CORS preflights now take the read lock, since they change nothing. A session that times out also bumps the version, so other users see that user go offline. The user directory rows move into a helper that /api/users and the snapshot share. --- .../java/market/guess/server/EngineBootstrap.java | 1 + .../java/market/guess/server/EngineLockFilter.java | 7 +- .../java/market/guess/server/ServerEngine.java | 10 +++ .../main/java/market/guess/server/SyncServlet.java | 50 +++++++++++++ .../java/market/guess/server/UsersServlet.java | 12 ++-- .../test/java/market/guess/server/SyncTest.java | 83 ++++++++++++++++++++++ 6 files changed, 157 insertions(+), 6 deletions(-) create mode 100644 server/src/main/java/market/guess/server/SyncServlet.java create mode 100644 server/src/test/java/market/guess/server/SyncTest.java (limited to 'server') diff --git a/server/src/main/java/market/guess/server/EngineBootstrap.java b/server/src/main/java/market/guess/server/EngineBootstrap.java index 9746cef..6b56abf 100644 --- a/server/src/main/java/market/guess/server/EngineBootstrap.java +++ b/server/src/main/java/market/guess/server/EngineBootstrap.java @@ -19,6 +19,7 @@ public final class EngineBootstrap implements ServletContextListener, HttpSessio var engine = ServerEngine.from(se.getSession().getServletContext()); if (engine != null) { engine.sessions().release(se.getSession()); + engine.changed(); // a timed-out user shows as offline to everyone else } } } diff --git a/server/src/main/java/market/guess/server/EngineLockFilter.java b/server/src/main/java/market/guess/server/EngineLockFilter.java index 181d96b..db2b580 100644 --- a/server/src/main/java/market/guess/server/EngineLockFilter.java +++ b/server/src/main/java/market/guess/server/EngineLockFilter.java @@ -16,10 +16,15 @@ public final class EngineLockFilter extends HttpFilter { @Override protected void doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain) throws IOException, ServletException { - var held = "GET".equals(req.getMethod()) ? lock.readLock() : lock.writeLock(); + var method = req.getMethod(); + var write = !"GET".equals(method) && !"HEAD".equals(method) && !"OPTIONS".equals(method); + var held = write ? lock.writeLock() : lock.readLock(); held.lock(); try { chain.doFilter(req, res); + if (write) { + ServerEngine.from(getServletContext()).changed(); + } } finally { held.unlock(); } diff --git a/server/src/main/java/market/guess/server/ServerEngine.java b/server/src/main/java/market/guess/server/ServerEngine.java index 41b8786..13891a1 100644 --- a/server/src/main/java/market/guess/server/ServerEngine.java +++ b/server/src/main/java/market/guess/server/ServerEngine.java @@ -2,6 +2,7 @@ package market.guess.server; import jakarta.servlet.ServletContext; import java.time.Clock; +import java.util.concurrent.atomic.AtomicLong; import market.guess.api.AccountContext; import market.guess.api.CatalogContext; import market.guess.api.GuessMarketContext; @@ -33,6 +34,7 @@ public final class ServerEngine { private final AccountContext accounts; private final GuessMarketContext market; private final Sessions sessions; + private final AtomicLong version = new AtomicLong(); public ServerEngine(Clock clock) { var marketInfra = new MarketContext(events, users); @@ -86,4 +88,12 @@ public final class ServerEngine { public Sessions sessions() { return sessions; } + + public long version() { + return version.get(); + } + + public void changed() { + version.incrementAndGet(); + } } diff --git a/server/src/main/java/market/guess/server/SyncServlet.java b/server/src/main/java/market/guess/server/SyncServlet.java new file mode 100644 index 0000000..5d41481 --- /dev/null +++ b/server/src/main/java/market/guess/server/SyncServlet.java @@ -0,0 +1,50 @@ +package market.guess.server; + +import jakarta.servlet.annotation.WebServlet; +import jakarta.servlet.http.HttpServlet; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.List; +import java.util.Map; +import market.guess.model.event.EventSummaryDTO; +import market.guess.model.ledger.LedgerDTO; + +/** + * GET /api/sync?since={version}: what a polling client needs to refresh. If nothing changed since + * {@code version} it gets {@code {"changed": false}}; otherwise a snapshot of event summaries, the + * user directory and its own account, with the version to send next time. Details of the event a + * client is looking at are fetched from /api/events/{name} only when the version moves. + */ +@WebServlet("/api/sync") +public final class SyncServlet extends HttpServlet { + record Snapshot( + boolean changed, + long version, + List events, + List users, + LedgerDTO account) {} + + @Override + protected void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException { + var user = Sessions.requireUser(req, res); + if (user == null) { + return; + } + var engine = ServerEngine.from(getServletContext()); + var version = engine.version(); + if (String.valueOf(version).equals(req.getParameter("since"))) { + Json.send(res, HttpServletResponse.SC_OK, Map.of("changed", false, "version", version)); + return; + } + Json.send( + res, + HttpServletResponse.SC_OK, + new Snapshot( + true, + version, + engine.catalog().getAllEvents().getData(), + UsersServlet.rows(engine), + engine.accounts().getAccount(user).getData())); + } +} diff --git a/server/src/main/java/market/guess/server/UsersServlet.java b/server/src/main/java/market/guess/server/UsersServlet.java index 511ede2..d919892 100644 --- a/server/src/main/java/market/guess/server/UsersServlet.java +++ b/server/src/main/java/market/guess/server/UsersServlet.java @@ -5,6 +5,7 @@ import jakarta.servlet.http.HttpServlet; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import java.io.IOException; +import java.util.List; /** * GET /api/users: every account on the server with the facts the spec asks to show about other @@ -19,9 +20,11 @@ public final class UsersServlet extends HttpServlet { if (Sessions.requireUser(req, res) == null) { return; } - var engine = ServerEngine.from(getServletContext()); - var rows = - engine.users().getAll().stream() + Json.send(res, HttpServletResponse.SC_OK, rows(ServerEngine.from(getServletContext()))); + } + + static List rows(ServerEngine engine) { + return engine.users().getAll().stream() .map( u -> new UserRow( @@ -30,7 +33,6 @@ public final class UsersServlet extends HttpServlet { engine.events().getAll().stream() .anyMatch(e -> u.getName().equalsIgnoreCase(e.getMarketMaker())), engine.sessions().isOnline(u.getName()))) - .toList(); - Json.send(res, HttpServletResponse.SC_OK, rows); + .toList(); } } diff --git a/server/src/test/java/market/guess/server/SyncTest.java b/server/src/test/java/market/guess/server/SyncTest.java new file mode 100644 index 0000000..23c1c5f --- /dev/null +++ b/server/src/test/java/market/guess/server/SyncTest.java @@ -0,0 +1,83 @@ +package market.guess.server; + +import static market.guess.server.EventsTest.loggedIn; +import static market.guess.server.EventsTest.upload; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; +import java.net.http.HttpClient; +import java.net.http.HttpRequest; +import java.net.http.HttpResponse; +import java.nio.file.Path; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +class SyncTest { + @TempDir static Path base; + static TestServer server; + + @BeforeAll + static void start() throws Exception { + server = new TestServer(base); + } + + @AfterAll + static void stop() throws Exception { + server.close(); + } + + private static JsonObject sync(HttpClient client, long since) throws Exception { + var res = server.get(client, "/sync?since=" + since); + assertEquals(200, res.statusCode(), res.body()); + return JsonParser.parseString(res.body()).getAsJsonObject(); + } + + @Test + void pollsAreCheapUntilSomethingChanges() throws Exception { + var pia = loggedIn(server, "Pia"); + var first = sync(pia, -1); + assertTrue(first.get("changed").getAsBoolean()); + assertTrue(first.has("events") && first.has("users"), first.toString()); + assertEquals("Pia", first.getAsJsonObject("account").get("owner").getAsString()); + var version = first.get("version").getAsLong(); + + var idle = sync(pia, version); + assertFalse(idle.get("changed").getAsBoolean()); + assertFalse(idle.has("events"), "an unchanged poll should not carry data"); + + var quinn = loggedIn(server, "Quinn"); + server.post(quinn, "/user/deposit", "amount", "42"); + assertEquals(200, upload(server, quinn, "small.xml").statusCode()); + + var after = sync(pia, version); + assertTrue(after.get("changed").getAsBoolean()); + assertNotEquals(version, after.get("version").getAsLong()); + assertTrue(after.toString().contains("Mujtaba is Dead"), after.toString()); + assertTrue(after.toString().contains("\"balance\":\"42.00\""), after.toString()); + } + + @Test + void preflightsDoNotBumpTheVersion() throws Exception { + var client = loggedIn(server, "Ray"); + var version = sync(client, -1).get("version").getAsLong(); + client.send( + server + .request("/sync") + .method("OPTIONS", HttpRequest.BodyPublishers.noBody()) + .header("Origin", "http://localhost:5173") + .build(), + HttpResponse.BodyHandlers.discarding()); + assertFalse(sync(client, version).get("changed").getAsBoolean()); + } + + @Test + void requiresLogin() throws Exception { + assertEquals(401, server.get(TestServer.client(), "/sync?since=0").statusCode()); + } +} -- cgit v1.2.3