Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds endpoints to debug what has been persisted #291

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

skrawcz
Copy link
Contributor

@skrawcz skrawcz commented Jul 30, 2024

This I think will be useful for production debugging; what's in my state?

This assumes:

  1. You have the right dependencies with the server to load the right persister.
  2. Not all persisters load via the constructor, so you can use a classmethod to be called to instantiate it.
  3. Haven't exposed writing to state, but it's something we could do.

We'd probably want to couple this with a UI view.

Changes

  • server run.py with two endpoints
  • adds pydantic models returned

How I tested this

  • not extensively, but it seems to work.

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

This I think will be useful for production debugging; what's in my state?

This assumes:

1. You have the right dependencies with the server to load the right persister.
2. Not all persisters load via the constructor, so you can use a classmethod
to be called to instantiate it.
3. Haven't exposed writing to state, but it's something we could do.

We'd probably want to couple this with a UI view.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant