statepact 0.1.0__tar.gz

statepact-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+.venv/
+.hypothesis/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+coverage.xml
+.benchmarks/
+benchmarks/results/*.tmp.json
+.env
+.DS_Store
+Thumbs.db
+site/
+*.log

statepact-0.1.0/CHANGELOG.md

@@ -0,0 +1,121 @@
+# Changelog
+
+All notable changes to StatePact will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+* Renamed the project from **AgentCommit** to **StatePact** before the first
+  PyPI release, because `agentcommit` normalizes to the already-published
+  `agent-commit` distribution. The distribution is now `statepact`, the import
+  package is `statepact`, the CLI is `statepact`, and environment variables use
+  the `STATEPACT_` prefix. The GitHub repository is
+  [mithun-27/StatePact](https://github.com/mithun-27/StatePact). There was no
+  prior PyPI release under the old name.
+
+### Added
+
+### Changed
+
+### Fixed
+
+### Deprecated
+
+### Removed
+
+### Security
+
+### Dependencies
+
+## [0.1.0] - 2026-11-06
+
+### Added
+
+* Initial public release (alpha).
+* Full core transaction management with isolation modes:
+  * `none`, `snapshot`, `optimistic`, `serializable`, `pessimistic`
+* Three storage backends: `MemoryBackend`, `PostgresBackend`, `RedisBackend`
+* Leases with fencing tokens (`Lease`, `LeaseManager`)
+* Idempotent commits via `idempotency_key` and `IdempotentExecutor`
+* Retry coordination with exponential backoff (`RetryPolicy`, `run_with_retry`)
+* Wait‑for graph deadlock detection and `CAS` operations
+* Concurrency utilities (`run_concurrently`, `ConcurrencyLimiter`)
+* Observability stack (`EventBus`, `TransactionLog`, `Metrics`)
+* Optional OpenTelemetry bridge (`statepact.observability.otel`)
+* Framework adapters: LangGraph, CrewAI, AutoGen
+* Gradio playground (`demo/app.py`)
+* Static browser playground on Hugging Face Spaces (simulation of the isolation rules)
+* Benchmark runner with correctness invariants
+* Comprehensive test suite (121 unit/property/concurrency/failure-injection, 14 integration)
+* CLI (`statepact`)
+
+### Changed
+
+* Default isolation mode changed to `optimistic` (previously documented as default but not enforced).
+* `idempotency_fingerprint` defaults to value‑insensitive hash of `(agent_id, resource, key, op)`.
+* `LeaseLostError` is not retryable; callers must re‑acquire.
+* `TransactionManager.lease` auto‑registers the resource before acquisition.
+* Use `StrEnum` for enums and PEP 695 generics where applicable.
+* Failure‑injection/unknown commit exceptions are logged as `FAILED`; conflicts are logged by the backend.
+* `PostgresBackend` uses `asyncpg` directly with advisory transaction lock; global `pg_advisory_xact_lock` around commit validation/apply.
+* `RedisBackend` uses Lua for atomic commit validation/apply with prefix `statepact`.
+* Integrations are thin adapters with no framework imports at module load.
+* Benchmark runner namespaces all resources with `RUN_ID`; includes `baseline_none` and `hot_key_backoff`.
+
+### Fixed
+
+* README states PyPI 0.1.0 publication is pending (install from source) until Trusted Publishing succeeds.
+* README/docs must not claim an `statepact.observability.otel` bridge exists unless it is implemented.
+* `LeaseLostError` table in README incorrectly marked `retryable` as `yes*`.
+* Fixed docs inaccuracies:
+  * `docs/backends.md` mentioned "configured schema" for `clear()`.
+  * `docs/integrations.md` said callbacks "must not commit twice" though manager skips commit when already committed.
+  * `docs/isolation.md` listed `StaleSnapshotError` as raised though no backend raises it.
+* Removed "AMD EPYC-class" claim from README; actual env is AMD64 12-logical-CPU VM.
+* Fixed exception inheritance and retryable flags in `exceptions.py`.
+
+### Deprecated
+
+* `statepact.storage.memory.MemoryBackend.fault_injector` – legacy test utility; use property tests instead.
+* `statepact.observability.events.EventHook` – will be removed in favor of `Callable[[Event], Any]` in 1.0.0.
+
+### Removed
+
+* None.
+
+## [0.0.1] - Unpublished alpha
+
+### Added
+
+* Proof of concept for optimistic concurrency control.
+* Basic `MemoryBackend` implementation.
+* Early iteration of lease/fencing and idempotent commit logic.
+* Initial documentation draft.
+
+### Changed
+
+* Initial API design decisions.
+
+### Fixed
+
+* None.
+
+### Deprecated
+
+* None.
+
+### Removed
+
+* None.
+
+### Security
+
+* None.
+
+### Dependencies
+
+* None.

statepact-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,134 @@
+# Contributing to StatePact
+
+Thanks for taking the time to contribute. StatePact is correctness-first: a
+change that makes an isolation guarantee weaker, even if it is faster, is a
+regression.
+
+## Development setup
+
+Requirements: Python 3.12+, [uv](https://docs.astral.sh/uv/), and optionally
+Docker for the PostgreSQL and Redis services.
+
+```bash
+git clone https://github.com/mithun-27/StatePact
+cd StatePact
+uv sync --extra dev
+```
+
+Run the fast suite:
+
+```bash
+uv run pytest -q                 # unit, property, concurrency, failure injection
+uv run ruff check src tests demo benchmarks
+uv run mypy src
+```
+
+Run the integration suite against real services:
+
+```bash
+docker compose up -d postgres redis
+
+export STATEPACT_TEST_POSTGRES_URL='postgresql://statepact:statepact@localhost:5432/statepact'
+export STATEPACT_TEST_REDIS_URL='redis://localhost:6379/0'
+
+uv run pytest tests/integration -q
+```
+
+On PowerShell use `$env:NAME='value'` instead of `export`.
+
+The integration tests run the same behavioural contract
+(`tests/integration/backend_suite.py`) against PostgreSQL and Redis. If you add
+a backend, make it pass that suite before adding backend-specific tests.
+
+## What to work on
+
+* Bugs and design questions: open an issue first for anything larger than a
+  small fix, so the approach can be agreed before code is written.
+* Good first issues are labelled `good first issue`.
+* Security problems go to the address in [SECURITY.md](SECURITY.md), not the
+  public issue tracker.
+
+## Code style
+
+* Ruff enforces linting and formatting (`uv run ruff format --check ...`).
+* mypy runs in strict mode over `src/`. New public functions need annotations.
+* Keep the public API small. Internals live under `statepact.core`,
+  `statepact.concurrency`, `statepact.coordination` and
+  `statepact.storage`.
+* Framework adapters must not import their framework at module load. Keep the
+  adapter surface thin and test it without the framework installed.
+* Prefer explicit errors over silent fallbacks. Every failure path should answer:
+  did it commit, is retry safe, and which resource/key failed.
+* Add a docstring to every public class and function; the docs build reads them.
+
+## Tests that matter
+
+Beyond line coverage, these invariants are the contract:
+
+* `none` loses updates; `optimistic`/`serializable` do not.
+* `snapshot` permits write skew; `optimistic`/`serializable` reject one side.
+* `pessimistic` serialises writers and surfaces deadlock/timeout as retryable
+  conflicts.
+* A replayed idempotency key returns the stored result and does not reapply writes.
+* A stale fencing token is rejected with `LeaseLostError` (`retryable=False`).
+* An unknown commit failure is recorded as `FAILED`, never assumed committed.
+
+Property tests use Hypothesis; keep them deterministic with a fixed seed when
+reporting a failure. Concurrency tests should use `statepact.testing.run_concurrently`.
+
+## Commit messages
+
+```
+<type>(<scope>): <summary>
+
+Why the change is needed, and any trade-off.
+
+Refs: #123
+```
+
+`type` is one of `feat`, `fix`, `docs`, `test`, `refactor`, `perf`, `build`,
+`ci`, `chore`. Keep the summary imperative and under ~72 characters.
+
+## Pull request checklist
+
+- [ ] `uv run pytest -q` passes.
+- [ ] Integration tests pass if the change touches a backend.
+- [ ] `uv run ruff check src tests demo benchmarks` is clean.
+- [ ] `uv run mypy src` is clean.
+- [ ] New behaviour has tests, including a failure-path test.
+- [ ] Public API changes are documented in `docs/api.md` and `CHANGELOG.md`.
+- [ ] README/docs claims match the implementation (no aspirational features).
+- [ ] Benchmark invariants still hold if the change touches the commit path.
+
+## Documentation and benchmarks
+
+```bash
+uv sync --extra docs
+uv run mkdocs build --strict
+```
+
+To re-run the benchmark (takes a few minutes and needs Docker services):
+
+```bash
+uv run python benchmarks/run.py \
+  --backends memory,postgres,redis --agents 40 --ops 10 --trials 20
+```
+
+The runner writes a timestamped JSON artifact and `latest.json` under
+`benchmarks/results/`. Do not edit those files by hand; re-run the runner. When
+you cite numbers in docs, cite the artifact filename.
+
+## Releasing
+
+Release steps are maintainer-only and require PyPI Trusted Publishing:
+
+1. Update the version in `src/statepact/__about__.py` and `CHANGELOG.md`.
+2. `uv build` and `uvx twine check dist/*`.
+3. Tag `vX.Y.Z` and publish a GitHub release; the `publish.yml` workflow
+   publishes to PyPI through the `pypi` environment.
+4. Deploy the docs with the `Docs` workflow.
+
+## License
+
+By contributing you agree that your contribution is licensed under
+Apache-2.0, as described in [LICENSE](LICENSE).

statepact-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.