Skip to content

Clarify result lifetime and consumption contracts - #3

Merged
eosobande merged 2 commits into
mainfrom
docs/result-lifetime-and-consumer-proof
Oct 26, 2026
Merged

eosobande merged 2 commits into
mainfrom
docs/result-lifetime-and-consumer-proof

Conversation

@eosobande

@eosobande eosobande commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Clarify how applications use the existing result APIs. This is a documentation-only change: runtime behavior and public signatures are unchanged.

  • Explain that restoring navigation does not restore an in-memory pending result, and that the app chooses missing-result recovery before dependent work starts.
  • Show abandoned-request cleanup with the existing consume(key) overload, including nullable values, unrelated keys and late producer callbacks.
  • Clarify same-key publication inside a callback, including equal payloads and the lack of automatic redelivery.
  • Add a reading path through the existing API contracts.

The diff contains only README and KDoc changes in ResultStore, ResultConsumer and ResultEffect. Existing CI/CD, Gradle files and tests are unchanged. No Python tooling or publication-verification fixtures remain.

Validation: the existing 33 library and 4 sample Android JVM tests passed, with no failures or skips.

This PR remains a draft.

@eosobande eosobande changed the title Document result lifetimes and verify published consumers Clarify result lifetime and consumption contracts Oct 26, 2026
@eosobande
eosobande marked this pull request as ready for review October 26, 2026 21:09
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
🔒 Security Review 🔄 Running since 2026-10-26T21:09:22.107910Z 82ae769 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@eosobande eosobande self-assigned this Oct 26, 2026
@eosobande
eosobande requested a review from atunwo October 26, 2026 21:09
@eosobande eosobande added the documentation Improvements or additions to documentation label Oct 26, 2026

@atunwo atunwo Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This documentation-only change clarifies transient result lifetime, abandoned-request cleanup, callback republishing limitations, and the API reading path without changing runtime code or public signatures. No blocking issues found; the added guidance is consistent with the inspected store, consumer, effect, and state-helper implementations. Supplied CI reports all five checks successful. I did not independently run builds or tests, and callback republishing is not directly covered by the inspected test cases.

@eosobande
eosobande merged commit 27f6482 into main Oct 26, 2026
6 checks passed
@eosobande
eosobande deleted the docs/result-lifetime-and-consumer-proof branch October 26, 2026 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant