accordsync-fastapi 0.3.0__py3-none-any.whl

accordsync_fastapi/__init__.py

@@ -0,0 +1,7 @@
+"""Accord for FastAPI: `accord_router(...)` mounts the sync endpoints on an application."""
+
+from accordsync_server import PROTOCOL_VERSION
+
+from .router import CompactionScheduler, accord_router, router_server
+
+__all__ = ["PROTOCOL_VERSION", "CompactionScheduler", "accord_router", "router_server"]

accordsync_fastapi/__main__.py

@@ -0,0 +1,12 @@
+"""`python -m accordsync_fastapi migrate|compact`: the server's CLI (`python -m accordsync_server`).
+
+`migrate` needs ACCORD_DATABASE_URL (or --database-url); `compact` also needs the definition,
+`--definition module:attribute` (or ACCORD_SERVER).
+"""
+
+import sys
+
+from accordsync_server.__main__ import main
+
+if __name__ == "__main__":
+    sys.exit(main())

accordsync_fastapi/router.py

@@ -0,0 +1,156 @@
+"""`accord_router(...)`: the Accord endpoints as a FastAPI `APIRouter`.
+
+The router only translates requests: every status, header and body comes from
+`AccordServer.handle()` (ADR-Y07). Endpoints are plain `def`, run in FastAPI's thread pool
+(ADR-Y01); only reading the body is async, and it stops one byte past the body limit.
+"""
+
+from __future__ import annotations
+
+import logging
+import threading
+from collections.abc import AsyncIterator, Callable
+from contextlib import asynccontextmanager
+from typing import Any
+
+from accordsync_server import AccordServer, ServerDefinition, compact, create_pool
+from fastapi import APIRouter, Depends, Request
+from fastapi import Response as FastAPIResponse
+
+log = logging.getLogger("accordsync_fastapi")
+
+# Every method goes to `handle()`, which answers 404 / 204 (CORS preflight) exactly like the
+# TypeScript server, instead of FastAPI's 405.
+METHODS = ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"]
+PATHS = ("/v1/push", "/v1/pull", "/health")
+
+
+class CompactionScheduler:
+    """Runs `compact()` every `interval_ms` on a daemon thread (the TypeScript `serve` timer)."""
+
+    def __init__(self, server: AccordServer) -> None:
+        self.server = server
+        self.interval_s = server.definition.compaction.interval_ms / 1000
+        self._stop = threading.Event()
+        self._thread: threading.Thread | None = None
+
+    def start(self) -> None:
+        if self.interval_s <= 0 or self._thread is not None:
+            return
+        self._thread = threading.Thread(target=self._run, name="accord-compaction", daemon=True)
+        self._thread.start()
+
+    def stop(self) -> None:
+        self._stop.set()
+        if self._thread is not None:
+            self._thread.join(timeout=30)
+            self._thread = None
+
+    def _run(self) -> None:
+        while not self._stop.wait(self.interval_s):
+            try:
+                r = compact(self.server.pool, self.server.definition)
+                log.info(
+                    "compaction: %d records, %d ops folded below position %d, %d tombstones pruned",
+                    r["records"],
+                    r["opsFolded"],
+                    r["watermark"],
+                    r["tombstonesPruned"],
+                )
+            except Exception:
+                log.exception("compaction failed")
+
+
+def accord_router(
+    server_or_definition: AccordServer | ServerDefinition,
+    *,
+    database_url: str | None = None,
+    prefix: str = "",
+    pool_size: int = 20,
+    schedule_compaction: bool = True,
+) -> APIRouter:
+    """An `APIRouter` with `POST /v1/push`, `GET /v1/pull` and `GET /health` under `prefix`.
+
+    Given a `ServerDefinition`, the router owns a connection pool on `database_url`: it opens it
+    in the application's lifespan (or on the first request) and closes it at shutdown. Given an
+    `AccordServer`, the caller owns its pool. With `schedule_compaction` and a definition whose
+    `compaction.interval_ms` is above 0, the lifespan also compacts on that interval.
+    """
+    owns_pool = isinstance(server_or_definition, ServerDefinition)
+    if isinstance(server_or_definition, ServerDefinition):
+        if not database_url:
+            raise ValueError("accord_router(definition) needs database_url=...")
+        server = AccordServer(
+            server_or_definition, create_pool(database_url, size=pool_size, open=False)
+        )
+    else:
+        server = server_or_definition
+    scheduler = CompactionScheduler(server)
+    open_lock = threading.Lock()
+    opened = [not owns_pool]
+
+    def ensure_open() -> None:
+        if opened[0]:
+            return
+        with open_lock:
+            if not opened[0]:
+                server.pool.open()
+                opened[0] = True
+
+    @asynccontextmanager
+    async def lifespan(_app: Any) -> AsyncIterator[None]:
+        ensure_open()
+        if schedule_compaction:
+            scheduler.start()
+        try:
+            yield
+        finally:
+            scheduler.stop()
+            if owns_pool:
+                server.pool.close()
+
+    async def raw_body(request: Request) -> bytes:
+        """The body, read at most one byte past the limit (a larger body gets 413 anyway)."""
+        limit = server.max_body_bytes
+        chunks: list[bytes] = []
+        size = 0
+        async for chunk in request.stream():
+            chunks.append(chunk)
+            size += len(chunk)
+            if size > limit:
+                break
+        return b"".join(chunks)[: limit + 1]
+
+    def make_endpoint(path: str) -> Callable[..., FastAPIResponse]:
+        def endpoint(request: Request, body: bytes = Depends(raw_body)) -> FastAPIResponse:
+            ensure_open()
+            res = server.handle(
+                request.method,
+                path,
+                request.url.query,
+                dict(request.headers.items()),
+                body,
+            )
+            out = FastAPIResponse(content=res.body, status_code=res.status)
+            for name, value in res.headers:
+                out.headers.append(name, value)
+            return out
+
+        endpoint.__name__ = "accord_" + path.strip("/").replace("/", "_")
+        return endpoint
+
+    router = APIRouter(prefix=prefix, lifespan=lifespan)
+    for path in PATHS:
+        router.add_api_route(
+            path, make_endpoint(path), methods=METHODS, include_in_schema=path != "/health"
+        )
+    router.accord_server = server  # type: ignore[attr-defined]
+    return router
+
+
+def router_server(router: APIRouter) -> AccordServer:
+    """The `AccordServer` behind a router made by `accord_router` (e.g. for an admin task)."""
+    server = getattr(router, "accord_server", None)
+    if not isinstance(server, AccordServer):
+        raise TypeError("not a router made by accord_router()")
+    return server

accordsync_fastapi-0.3.0.dist-info/METADATA

@@ -0,0 +1,75 @@
+Metadata-Version: 2.5
+Name: accordsync-fastapi
+Version: 0.3.0
+Summary: Accord sync server for FastAPI: router, settings and CLI.
+Project-URL: Homepage, https://accord.benhattab.pro
+Project-URL: Source, https://github.com/crossben/accordsync-python
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: crdt,local-first,offline-first,sync
+Requires-Python: >=3.11
+Requires-Dist: accordsync-server<0.4,>=0.3
+Requires-Dist: fastapi>=0.115
+Description-Content-Type: text/markdown
+
+# accordsync-fastapi
+
+The Accord sync server for FastAPI: a router with `POST /v1/push`, `GET /v1/pull` and
+`GET /health`, and a CLI for migrations and compaction. All behaviour (auth, limits, CORS, rate
+limits, status codes, `Accord-Protocol` and `Retry-After` headers) comes from
+`accordsync-server`; this package only routes to it. Part of [Accord](https://accord.benhattab.pro).
+
+## Install
+
+```sh
+pip install accordsync-fastapi uvicorn
+```
+
+## Use
+
+```python
+from accordsync_core import define_schema, lww
+from accordsync_server import Access, Auth, define_server
+from accordsync_fastapi import accord_router
+from fastapi import FastAPI
+
+server = define_server(
+    schema=define_schema({"note": {"owner": lww(), "title": lww()}}),
+    scopes={"note": lambda r: [f"user:{r.fields.get('owner')}"]},
+    access=lambda claims: Access(read=[f"user:{claims['sub']}"], write=[f"user:{claims['sub']}"]),
+    auth=Auth.jwks("https://auth.example/.well-known/jwks.json", issuer="https://auth.example"),
+)
+
+app = FastAPI()
+app.include_router(accord_router(server, database_url="postgresql://...", prefix="/sync"))
+```
+
+Given a definition, the router owns a psycopg pool (`pool_size`, default 20): it opens it in the
+application's lifespan and closes it at shutdown. You can instead pass an
+`AccordServer(definition, pool)` whose pool you manage; `router_server(router)` returns the server
+behind a router. Endpoints are plain `def` functions run in FastAPI's thread pool.
+
+Run the migrations before serving:
+
+```sh
+ACCORD_DATABASE_URL=postgresql://... python -m accordsync_fastapi migrate
+```
+
+## Compaction
+
+With `compaction.interval_ms > 0` in the definition (default one hour), the router's lifespan
+compacts on that interval in a background thread of each process. With several worker processes,
+pass `schedule_compaction=False` and run compaction from cron instead:
+
+```sh
+ACCORD_DATABASE_URL=postgresql://... python -m accordsync_fastapi compact --definition myapp.sync:server
+```
+
+## Notes
+
+- Rate limits are per process (in memory). With several workers, each has its own buckets.
+- `/health` touches the database and answers 503 when it is unreachable.
+- Put TLS and request-size limits of your proxy in front as usual; the body limit
+  (`limits.max_body_bytes`) is enforced while reading the body.
+- `examples/fastapi_app` in this repository serves the conformance profile and passes the shared
+  server conformance suite (68/68). Its control API is for tests only (`ACCORD_CONTROL=1`).

accordsync_fastapi-0.3.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+accordsync_fastapi/__init__.py,sha256=Z231itrprWDGuQ1vzDid9XVClza4FF1DF2GLc2rALJw,300
+accordsync_fastapi/__main__.py,sha256=nv83WBIZYgvdsAPDX5pLYQ2WMhjliJBV3mbah2IlFp8,358
+accordsync_fastapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+accordsync_fastapi/router.py,sha256=PGPoH9GeBKrfNPltrDmeXn11MOhROg4APrfT7xhpsxo,5792
+accordsync_fastapi-0.3.0.dist-info/METADATA,sha256=ico379sLvI633etPnlZp4yU-AZw2VTjgPtGI10fesNE,2977
+accordsync_fastapi-0.3.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+accordsync_fastapi-0.3.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+accordsync_fastapi-0.3.0.dist-info/RECORD,,

accordsync_fastapi-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

accordsync_fastapi-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.