accordsync-django 0.3.0__tar.gz

accordsync_django-0.3.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+/interop/node/node_modules/

accordsync_django-0.3.0/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.

accordsync_django-0.3.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.5
+Name: accordsync-django
+Version: 0.3.0
+Summary: Accord sync server for Django: app, URLs and management commands.
+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: django>=5.1
+Description-Content-Type: text/markdown
+
+# accordsync-django
+
+The Accord sync server for Django: an app with the `/v1/push`, `/v1/pull` and `/health` URLs,
+management commands `accord_migrate` and `accord_compact`, and a system check. All behaviour
+comes from `accordsync-server`; this package only routes to it. Part of
+[Accord](https://accord.benhattab.pro).
+
+## Install
+
+```sh
+pip install accordsync-django
+```
+
+## Configure
+
+```python
+# settings.py
+INSTALLED_APPS = [..., "accordsync_django"]
+ACCORD_SERVER = "myapp.sync:server"  # a ServerDefinition made with define_server(...)
+ACCORD_DATABASE_URL = "postgresql://..."  # optional, see below
+ACCORD_POOL_SIZE = 20  # optional
+ACCORD_SCHEDULE_COMPACTION = True  # optional
+
+# urls.py
+urlpatterns = [path("sync/", include("accordsync_django.urls")), ...]
+```
+
+The database is `ACCORD_DATABASE_URL` (setting, else environment variable), or else the
+`default` database's settings, which must then use `django.db.backends.postgresql`. The sync
+server uses its own psycopg connection pool, opened on the first request, never Django's ORM
+connections. The views are CSRF-exempt, opt out of `ATOMIC_REQUESTS`, and need no session or auth
+middleware (requests authenticate with the JWT in `Authorization`).
+
+`manage.py check` reports `accordsync.E001` when `ACCORD_SERVER` is missing, cannot be imported or
+is not a `ServerDefinition`, and `accordsync.E002` when no PostgreSQL database is configured.
+
+```sh
+python manage.py accord_migrate
+```
+
+## Compaction
+
+With `compaction.interval_ms > 0` in the definition (default one hour), each process compacts on
+that interval in a background thread started by its first sync request. With several worker
+processes, set `ACCORD_SCHEDULE_COMPACTION = False` and run from cron:
+
+```sh
+python manage.py accord_compact
+```
+
+## Notes
+
+- Serve with a threaded WSGI server (e.g. waitress, gunicorn `--threads`); each request holds a
+  thread while it waits on PostgreSQL.
+- Rate limits are per process (in memory).
+- `examples/django_app` in this repository serves the conformance profile with waitress and
+  passes the shared server conformance suite (68/68). Its control API is for tests only
+  (`ACCORD_CONTROL=1`).

accordsync_django-0.3.0/README.md

@@ -0,0 +1,58 @@
+# accordsync-django
+
+The Accord sync server for Django: an app with the `/v1/push`, `/v1/pull` and `/health` URLs,
+management commands `accord_migrate` and `accord_compact`, and a system check. All behaviour
+comes from `accordsync-server`; this package only routes to it. Part of
+[Accord](https://accord.benhattab.pro).
+
+## Install
+
+```sh
+pip install accordsync-django
+```
+
+## Configure
+
+```python
+# settings.py
+INSTALLED_APPS = [..., "accordsync_django"]
+ACCORD_SERVER = "myapp.sync:server"  # a ServerDefinition made with define_server(...)
+ACCORD_DATABASE_URL = "postgresql://..."  # optional, see below
+ACCORD_POOL_SIZE = 20  # optional
+ACCORD_SCHEDULE_COMPACTION = True  # optional
+
+# urls.py
+urlpatterns = [path("sync/", include("accordsync_django.urls")), ...]
+```
+
+The database is `ACCORD_DATABASE_URL` (setting, else environment variable), or else the
+`default` database's settings, which must then use `django.db.backends.postgresql`. The sync
+server uses its own psycopg connection pool, opened on the first request, never Django's ORM
+connections. The views are CSRF-exempt, opt out of `ATOMIC_REQUESTS`, and need no session or auth
+middleware (requests authenticate with the JWT in `Authorization`).
+
+`manage.py check` reports `accordsync.E001` when `ACCORD_SERVER` is missing, cannot be imported or
+is not a `ServerDefinition`, and `accordsync.E002` when no PostgreSQL database is configured.
+
+```sh
+python manage.py accord_migrate
+```
+
+## Compaction
+
+With `compaction.interval_ms > 0` in the definition (default one hour), each process compacts on
+that interval in a background thread started by its first sync request. With several worker
+processes, set `ACCORD_SCHEDULE_COMPACTION = False` and run from cron:
+
+```sh
+python manage.py accord_compact
+```
+
+## Notes
+
+- Serve with a threaded WSGI server (e.g. waitress, gunicorn `--threads`); each request holds a
+  thread while it waits on PostgreSQL.
+- Rate limits are per process (in memory).
+- `examples/django_app` in this repository serves the conformance profile with waitress and
+  passes the shared server conformance suite (68/68). Its control API is for tests only
+  (`ACCORD_CONTROL=1`).

accordsync_django-0.3.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "accordsync-django"
+version = "0.3.0"
+description = "Accord sync server for Django: app, URLs and management commands."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+keywords = ["offline-first", "sync", "crdt", "local-first"]
+dependencies = [
+    "accordsync-server>=0.3,<0.4",
+    "django>=5.1",
+]
+
+[project.urls]
+Homepage = "https://accord.benhattab.pro"
+Source = "https://github.com/crossben/accordsync-python"
+
+[build-system]
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/accordsync_django"]

accordsync_django-0.3.0/src/accordsync_django/__init__.py

@@ -0,0 +1,5 @@
+"""Accord for Django: the `accordsync_django` app (URLs, settings, management commands, checks)."""
+
+from accordsync_server import PROTOCOL_VERSION
+
+__all__ = ["PROTOCOL_VERSION"]

accordsync_django-0.3.0/src/accordsync_django/apps.py

@@ -0,0 +1,10 @@
+from django.apps import AppConfig
+
+
+class AccordConfig(AppConfig):
+    name = "accordsync_django"
+    label = "accordsync"
+    verbose_name = "Accord sync"
+
+    def ready(self) -> None:
+        from . import checks  # noqa: F401  (registers the system check)

accordsync_django-0.3.0/src/accordsync_django/checks.py

@@ -0,0 +1,24 @@
+"""`manage.py check`: ACCORD_SERVER names a ServerDefinition and a PostgreSQL database is set."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from django.core.checks import CheckMessage, Error, register
+from django.core.exceptions import ImproperlyConfigured
+
+from .conf import database_url, load_definition
+
+
+@register()
+def check_accord(app_configs: Any = None, **kwargs: Any) -> list[CheckMessage]:
+    errors: list[CheckMessage] = []
+    try:
+        load_definition()
+    except ImproperlyConfigured as e:
+        errors.append(Error(str(e), id="accordsync.E001"))
+    try:
+        database_url()
+    except ImproperlyConfigured as e:
+        errors.append(Error(str(e), id="accordsync.E002"))
+    return errors

accordsync_django-0.3.0/src/accordsync_django/conf.py

@@ -0,0 +1,106 @@
+"""Settings: `ACCORD_SERVER` (the definition) and the database the sync server uses.
+
+- `ACCORD_SERVER = "module:attribute"` names a `ServerDefinition` (required).
+- `ACCORD_DATABASE_URL` (setting, else environment variable) is a PostgreSQL URL; without it the
+  URL is built from `DATABASES["default"]`, which must then use the PostgreSQL backend.
+- `ACCORD_POOL_SIZE` (default 20) and `ACCORD_SCHEDULE_COMPACTION` (default True).
+
+The sync server uses its own psycopg pool, never Django's connections (ADR-Y10).
+"""
+
+from __future__ import annotations
+
+import atexit
+import importlib
+import logging
+import os
+import threading
+from typing import Any
+from urllib.parse import quote
+
+from accordsync_server import AccordServer, ServerDefinition, compact, create_pool
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+
+log = logging.getLogger("accordsync_django")
+
+
+def load_definition() -> ServerDefinition:
+    spec = getattr(settings, "ACCORD_SERVER", None)
+    if not spec or not isinstance(spec, str):
+        raise ImproperlyConfigured('ACCORD_SERVER must be set to "module:attribute"')
+    module, _, attr = spec.partition(":")
+    try:
+        value = getattr(importlib.import_module(module), attr or "server")
+    except (ImportError, AttributeError) as e:
+        raise ImproperlyConfigured(f"ACCORD_SERVER {spec!r} cannot be imported: {e}") from e
+    if not isinstance(value, ServerDefinition):
+        raise ImproperlyConfigured(
+            f"ACCORD_SERVER {spec!r} is not a ServerDefinition (use define_server(...))"
+        )
+    return value
+
+
+def database_url() -> str:
+    url = getattr(settings, "ACCORD_DATABASE_URL", None) or os.environ.get("ACCORD_DATABASE_URL")
+    if url:
+        return str(url)
+    db: dict[str, Any] = settings.DATABASES.get("default", {})
+    if db.get("ENGINE") != "django.db.backends.postgresql":
+        raise ImproperlyConfigured(
+            "set ACCORD_DATABASE_URL, or use django.db.backends.postgresql for the default database"
+        )
+    user = quote(str(db.get("USER") or ""), safe="")
+    password = quote(str(db.get("PASSWORD") or ""), safe="")
+    auth = f"{user}:{password}@" if password else (f"{user}@" if user else "")
+    host = str(db.get("HOST") or "localhost")
+    port = f":{db['PORT']}" if db.get("PORT") else ""
+    return f"postgresql://{auth}{host}{port}/{quote(str(db.get('NAME') or ''), safe='')}"
+
+
+class _Scheduler:
+    def __init__(self, server: AccordServer) -> None:
+        self.server = server
+        self.interval_s = server.definition.compaction.interval_ms / 1000
+        self.stop = threading.Event()
+
+    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")
+
+
+_lock = threading.Lock()
+_server: AccordServer | None = None
+
+
+def get_server() -> AccordServer:
+    """The process's `AccordServer`, created (pool opened, compaction scheduled) on first use."""
+    global _server
+    if _server is not None:
+        return _server
+    with _lock:
+        if _server is None:
+            server = AccordServer(
+                load_definition(),
+                create_pool(database_url(), size=int(getattr(settings, "ACCORD_POOL_SIZE", 20))),
+            )
+            atexit.register(server.pool.close)
+            if getattr(settings, "ACCORD_SCHEDULE_COMPACTION", True):
+                sched = _Scheduler(server)
+                if sched.interval_s > 0:
+                    threading.Thread(
+                        target=sched.run, name="accord-compaction", daemon=True
+                    ).start()
+                    atexit.register(sched.stop.set)
+            _server = server
+    return _server

accordsync_django-0.3.0/src/accordsync_django/management/commands/accord_compact.py

@@ -0,0 +1,16 @@
+import json
+from typing import Any
+
+from accordsync_server import compact, create_pool
+from django.core.management.base import BaseCommand
+
+from ...conf import database_url, load_definition
+
+
+class Command(BaseCommand):
+    help = "Runs Accord log compaction once (schedule it with cron for multi-process deployments)."
+
+    def handle(self, *args: Any, **options: Any) -> None:
+        definition = load_definition()
+        with create_pool(database_url(), size=2) as pool:
+            self.stdout.write(json.dumps(compact(pool, definition)))

accordsync_django-0.3.0/src/accordsync_django/management/commands/accord_migrate.py

@@ -0,0 +1,16 @@
+from typing import Any
+
+from accordsync_server import migrate
+from django.core.management.base import BaseCommand
+
+from ...conf import database_url
+
+
+class Command(BaseCommand):
+    help = "Applies the Accord migrations to the sync database (shared ledger with every server)."
+
+    def handle(self, *args: Any, **options: Any) -> None:
+        ran = migrate(database_url())
+        self.stdout.write(
+            f"applied {len(ran)} migration(s): {', '.join(ran)}" if ran else "up to date"
+        )

accordsync_django-0.3.0/src/accordsync_django/urls.py

@@ -0,0 +1,12 @@
+"""`path("", include("accordsync_django.urls"))` serves /v1/push, /v1/pull and /health."""
+
+from django.urls import path
+
+from . import views
+
+app_name = "accordsync"
+urlpatterns = [
+    path("v1/push", views.push, name="push"),
+    path("v1/pull", views.pull, name="pull"),
+    path("health", views.health, name="health"),
+]

accordsync_django-0.3.0/src/accordsync_django/views.py

@@ -0,0 +1,48 @@
+"""The three endpoints: each passes the raw request to `AccordServer.handle()` (ADR-Y07)."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+
+from django.db import transaction
+from django.http import HttpRequest, HttpResponse
+from django.views.decorators.csrf import csrf_exempt
+
+from .conf import get_server
+
+
+def _view(path: str) -> Callable[[HttpRequest], HttpResponse]:
+    @csrf_exempt
+    @transaction.non_atomic_requests
+    def view(request: HttpRequest) -> HttpResponse:
+        server = get_server()
+        length = request.META.get("CONTENT_LENGTH") or "0"
+        try:
+            n = int(length)
+        except ValueError:
+            n = 0
+        # Read the stream directly (not request.body: DATA_UPLOAD_MAX_MEMORY_SIZE must not apply),
+        # at most one byte past the limit: a larger body gets 413 without being buffered.
+        body = request.read(min(n, server.max_body_bytes + 1)) if n > 0 else b""
+        res = server.handle(
+            request.method or "GET",
+            path,
+            request.META.get("QUERY_STRING", ""),
+            dict(request.headers.items()),
+            body,
+        )
+        out = HttpResponse(res.body, status=res.status)
+        merged: dict[str, list[str]] = {}
+        for name, value in res.headers:
+            merged.setdefault(name, []).append(value)
+        for name, values in merged.items():
+            out[name] = ", ".join(values)
+        return out
+
+    view.__name__ = "accord_" + path.strip("/").replace("/", "_")
+    return view
+
+
+push = _view("/v1/push")
+pull = _view("/v1/pull")
+health = _view("/health")

accordsync_django-0.3.0/tests/accordsync_django_testdef.py

@@ -0,0 +1,11 @@
+from accordsync_core import define_schema, lww
+from accordsync_server import Access, Auth, Limits, define_server
+
+definition = define_server(
+    schema=define_schema({"note": {"title": lww()}}),
+    scopes={"note": lambda r: ["all"]},
+    access=lambda c: Access(read=["all"], write=["all"]),
+    auth=Auth.hs256("x" * 32),
+    limits=Limits(max_body_bytes=100),
+)
+not_a_definition = 42

accordsync_django-0.3.0/tests/conftest.py

@@ -0,0 +1,18 @@
+import sys
+from pathlib import Path
+
+import django
+from django.conf import settings
+
+sys.path.insert(0, str(Path(__file__).parent))
+
+if not settings.configured:
+    settings.configure(
+        INSTALLED_APPS=["accordsync_django"],
+        ROOT_URLCONF="accordsync_django.urls",
+        ALLOWED_HOSTS=["testserver"],
+        DATABASES={},
+        MIDDLEWARE=["django.middleware.csrf.CsrfViewMiddleware"],
+        ACCORD_SERVER="accordsync_django_testdef:definition",
+    )
+    django.setup()

accordsync_django-0.3.0/tests/test_django.py

@@ -0,0 +1,130 @@
+"""Wiring tests: settings, the system check, commands and views passing requests through."""
+
+from __future__ import annotations
+
+import os
+from collections.abc import Mapping
+from typing import Any
+
+import pytest
+from accordsync_django import PROTOCOL_VERSION, conf, views
+from accordsync_django.checks import check_accord
+from accordsync_server import AccordServer, Response
+from django.core.exceptions import ImproperlyConfigured
+from django.core.management import call_command, get_commands
+from django.test import Client, override_settings
+
+
+class DeadPool:
+    def connection(self, **_: Any) -> Any:
+        raise RuntimeError("no database")
+
+
+class StubServer(AccordServer):
+    def __init__(self) -> None:
+        super().__init__(conf.load_definition(), DeadPool())  # type: ignore[arg-type]
+        self.calls: list[tuple[str, str, Any, dict[str, str], bytes]] = []
+
+    def handle(
+        self, method: str, path: str, query: Any, headers: Mapping[str, str], body: bytes = b""
+    ) -> Response:
+        self.calls.append((method, path, query, dict(headers), body))
+        return Response(418, [("Content-Type", "text/plain"), ("Vary", "A"), ("Vary", "B")], b"s")
+
+
+@pytest.fixture
+def stub(monkeypatch: pytest.MonkeyPatch) -> StubServer:
+    server = StubServer()
+    monkeypatch.setattr(views, "get_server", lambda: server)
+    return server
+
+
+def test_speaks_protocol_version_1() -> None:
+    assert PROTOCOL_VERSION == 1
+
+
+def test_passes_raw_request_and_response_through(stub: StubServer) -> None:
+    res = Client().post(
+        "/v1/push?a=1&a=2",
+        data=b'{"ops": []}',
+        content_type="application/json",
+        headers={"Accord-Device": "d1"},
+    )
+    assert res.status_code == 418
+    assert res.content == b"s"
+    assert res["Vary"] == "A, B"
+    method, path, query, headers, body = stub.calls[0]
+    assert (method, path, query, body) == ("POST", "/v1/push", "a=1&a=2", b'{"ops": []}')
+    assert headers["Accord-Device"] == "d1"
+
+
+@pytest.mark.parametrize(("url", "path"), [("/v1/pull", "/v1/pull"), ("/health", "/health")])
+@pytest.mark.parametrize("method", ["get", "head", "options", "delete"])
+def test_every_method_reaches_handle(stub: StubServer, url: str, path: str, method: str) -> None:
+    assert getattr(Client(), method)(url).status_code == 418
+    assert stub.calls[0][:2] == (method.upper(), path)
+
+
+def test_body_is_cut_one_byte_past_the_limit(stub: StubServer) -> None:
+    Client().post("/v1/push", data=b"x" * 10_000, content_type="application/json")
+    assert stub.calls[0][4] == b"x" * 101
+
+
+def test_views_are_csrf_exempt_and_not_atomic(stub: StubServer) -> None:
+    for view in (views.push, views.pull, views.health):
+        assert getattr(view, "csrf_exempt", False)
+        assert getattr(view, "_non_atomic_requests", None)
+    assert Client(enforce_csrf_checks=True).post("/v1/push").status_code == 418
+
+
+def test_check_passes() -> None:
+    with override_settings(ACCORD_DATABASE_URL="postgresql://h/db"):
+        assert check_accord() == []
+
+
+@pytest.mark.parametrize(
+    ("spec", "message"),
+    [
+        (None, "must be set"),
+        ("nope_module:x", "cannot be imported"),
+        ("accordsync_django_testdef:not_a_definition", "not a ServerDefinition"),
+    ],
+)
+def test_check_reports_bad_definition(spec: str | None, message: str) -> None:
+    with override_settings(ACCORD_SERVER=spec, ACCORD_DATABASE_URL="postgresql://h/db"):
+        errors = check_accord()
+    assert [e.id for e in errors] == ["accordsync.E001"]
+    assert message in errors[0].msg
+
+
+def test_database_url_from_django_settings(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.delenv("ACCORD_DATABASE_URL", raising=False)
+    db = {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": "app",
+        "USER": "me",
+        "PASSWORD": "p@ss",
+        "HOST": "db",
+        "PORT": "5433",
+    }
+    with override_settings(DATABASES={"default": db}):
+        assert conf.database_url() == "postgresql://me:p%40ss@db:5433/app"
+    with override_settings(DATABASES={"default": {"ENGINE": "django.db.backends.sqlite3"}}):
+        with pytest.raises(ImproperlyConfigured):
+            conf.database_url()
+        assert [e.id for e in check_accord()] == ["accordsync.E002"]
+
+
+def test_commands_registered() -> None:
+    commands = get_commands()
+    assert commands["accord_migrate"] == "accordsync_django"
+    assert commands["accord_compact"] == "accordsync_django"
+
+
+def test_migrate_command_against_postgres() -> None:
+    url = os.environ.get("ACCORD_TEST_DATABASE_URL")
+    if not url:
+        pytest.skip("ACCORD_TEST_DATABASE_URL is not set")
+    with override_settings(ACCORD_DATABASE_URL=url):
+        call_command("accord_migrate")
+        call_command("accord_compact")