Feat/tr/pagination #123

theodorehreuter · 2025-01-03T20:19:32Z

Related Issue(s):

#Pagination support #93

Proposed Changes:

Adding pagination for 4 endpoints:

GET /orders
GET /products
GET /orders/{order_id}/statuses
POST /products/{product_id}/opportunities

We are using token based approach to pagination.

BREAKING CHANGES:

Moving OrderCollection construction to root_router.py instead of root_backend.py
Pagination support on the backend methods has changed returned types in root_backend.py and product_backend.py to tuples, to include returning a new pagination token.

PR Checklist:

I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

…agination tests: creating incomplete test to start testing pagination

… desired way

… feat: replacing token in url if new token is provided tests: continue to updae test to validate additional pieces of the limit/token expected functionality, still breaking on limit check feat: removing use or Orders type and going with tuple instead

… object if we are returned a token. tests: created simple test implementation to abstract out token handling and generation

…t: use include_query_params instead of parsing query param string ourselves

…r bad token tests: reworking pagination tests tests: adding handle to max limit in test implemented backend

tests/application.py

tests/test_order.py

src/stapi_fastapi/routers/root_router.py

tests/test_order.py

…getting records until no more are available ftests: added separate test to get 404 back with no orders and using a token

…y features after token lookup tests: separating empty orders check to separate test

…re not being torn down for every test

… issue with in memory DB by adding missing __init__ to class. tests: added multiple orders to create_order fixture and passed this fixture to other tests using previously existing create_order_allowed_paylaods tests: added setup_pagination fixture that is now necessary again after fixing the in memory db init issue

…ing pagination token return Maybe[str] instead of usng empty strings feat: tweaking logic path in endpoint functions to make a single return point tests: updating tests as necessary to accomodating changes

… where next token and search params are not their own separat key value pairs but in the same body

src/stapi_fastapi/backends/root_backend.py

src/stapi_fastapi/routers/product_router.py

src/stapi_fastapi/routers/root_router.py

src/stapi_fastapi/routers/product_router.py

philvarner · 2025-01-27T16:23:04Z

src/stapi_fastapi/routers/root_router.py

-            products=[pr.get_product(request) for pr in self.product_routers.values()],
-            links=[
+    def get_products(
+        self, request: Request, next: str | None = None, limit: int = 10


next would be better as Maybe[str] instead of Optional[str]

per async convo will leave as is for now, pydantic + fastapi dont like Maybe[str] as an arg type.

src/stapi_fastapi/routers/root_router.py

tests/conftest.py

tests/test_opportunity.py

philvarner · 2025-01-27T17:18:36Z

Done leaving comments.

…ethods to clean up endpoint business logic. tests: small tweaks to test based on PR feedback

theodorehreuter added 3 commits January 2, 2025 14:56

feat: adding input parameters to endpoint functions for /orders for p…

152a227

…agination tests: creating incomplete test to start testing pagination

feat: applying new Orders class and test is breaking in the expected,…

0dcf05b

… desired way

theodorehreuter requested a review from jkeifer January 3, 2025 20:19

theodorehreuter temporarily deployed to pypi January 3, 2025 20:19 — with GitHub Actions Inactive

feat: tighened up logic in root_router.py to only add pagination link…

16f4dc2

… object if we are returned a token. tests: created simple test implementation to abstract out token handling and generation

theodorehreuter temporarily deployed to pypi January 3, 2025 20:24 — with GitHub Actions Inactive

poetry.lock

e0fa4e7

theodorehreuter temporarily deployed to pypi January 3, 2025 20:45 — with GitHub Actions Inactive

theodorehreuter added 2 commits January 3, 2025 15:48

feat: updating lock file header fix: fix previous commit message

90d0ebd

feat: rework test backend to make code smoother feat: use default fea…

53afb66

…t: use include_query_params instead of parsing query param string ourselves

theodorehreuter temporarily deployed to pypi January 7, 2025 03:08 — with GitHub Actions Inactive

feat: update Failure logic in root_router get_orders to return 404 fo…

723e645

…r bad token tests: reworking pagination tests tests: adding handle to max limit in test implemented backend

theodorehreuter commented Jan 8, 2025

View reviewed changes

tests/application.py Outdated Show resolved Hide resolved

theodorehreuter commented Jan 8, 2025

View reviewed changes

tests/application.py Outdated Show resolved Hide resolved

theodorehreuter commented Jan 8, 2025

View reviewed changes

tests/application.py Outdated Show resolved Hide resolved

theodorehreuter commented Jan 8, 2025

View reviewed changes

tests/test_order.py Outdated Show resolved Hide resolved

theodorehreuter commented Jan 8, 2025

View reviewed changes

tests/test_order.py Outdated Show resolved Hide resolved

theodorehreuter commented Jan 8, 2025

View reviewed changes

tests/test_order.py Outdated Show resolved Hide resolved

theodorehreuter commented Jan 8, 2025

View reviewed changes

tests/test_order.py Outdated Show resolved Hide resolved

tests: tweak test name

7b3453e

theodorehreuter commented Jan 8, 2025

View reviewed changes

src/stapi_fastapi/routers/root_router.py Outdated Show resolved Hide resolved

jkeifer reviewed Jan 8, 2025

View reviewed changes

tests/test_order.py Outdated Show resolved Hide resolved

theodorehreuter added 3 commits January 8, 2025 16:53

tests: reworked pagination test to iterate using next tokens to keep …

5db53c1

…getting records until no more are available ftests: added separate test to get 404 back with no orders and using a token

feat: tweaking mock backend to use list index look up and return empt…

b690cf1

…y features after token lookup tests: separating empty orders check to separate test

Merge branch 'main' into feat/tr/pagination

068e4b2

theodorehreuter temporarily deployed to pypi January 9, 2025 16:32 — with GitHub Actions Inactive

tests: moving tests around to work around issue of stapi_client fixtu…

55e1c60

…re not being torn down for every test

theodorehreuter temporarily deployed to pypi January 9, 2025 16:40 — with GitHub Actions Inactive

feat: creating methods to make Links to improve readability feat: mak…

9cfd146

…ing pagination token return Maybe[str] instead of usng empty strings feat: tweaking logic path in endpoint functions to make a single return point tests: updating tests as necessary to accomodating changes

theodorehreuter temporarily deployed to pypi January 24, 2025 02:39 — with GitHub Actions Inactive

calculate limit override more cleanly)

35c8f53

theodorehreuter temporarily deployed to pypi January 24, 2025 02:41 — with GitHub Actions Inactive

feat: slightly tweaking the body that is returned by the post request…

c148b7d

… where next token and search params are not their own separat key value pairs but in the same body

theodorehreuter temporarily deployed to pypi January 24, 2025 21:25 — with GitHub Actions Inactive

theodorehreuter requested a review from philvarner January 24, 2025 21:27