Webhook handlers as FastAPI APIRoutes to allow for Depends injection,… #13

pkucmus · 2021-12-12T22:51:02Z

… refactor

update deps
remove the need for the framework to have the apps Settings
deatach Manifest from settings
deatach development http/https handling from the debug setting (for unambiguity)
create APIRoutes for every webhook handler
introduce the Simple Saleor Client (potentially will land in a separate package in the future)
add url_for resololution in Manifest URLs
describe different verions of webhook payloads (with meta)

Add experimental SQS support, imporved resiency, add test coverage

add SQS targetUrl handling on installation
add the ability to not provide any handlers
stop using FastAPI app.extra
add lazy url loading on manifest definition
hide potentially sensitive logs to debug level
add dynamic webhook handler model definition (for easier maintenence)
add EXPERIMENTAL SQS worker (untested)

… refactor - update deps - remove the need for the framework to have the apps Settings - deatach Manifest from settings - deatach development http/https handling from the debug setting (for unambiguity) - create APIRoutes for every webhook handler - introduce the Simple Saleor Client (potentially will land in a separate package in the future) - add url_for resololution in Manifest URLs - describe different verions of webhook payloads (with meta)

CLAassistant · 2021-12-12T22:51:06Z

All committers have signed the CLA.

samples/simple_app/app.py

src/saleor_app/app.py

src/saleor_app/endpoints.py

src/saleor_app/errors.py

src/saleor_app/http.py

src/saleor_app/schemas/webhook.py

src/saleor_app/install.py

- add SQS targetUrl handling on installation - add the ability to not provide any handlers - stop using FastAPI app.extra - add lazy url loading on manifest definition - hide potentially sensitive logs to debug level - add dynamic webhook handler model definition (for easier maintenence) - add EXPERIMENTAL SQS worker (untested)

docs/index.md

docs/event_handlers/http.md

src/saleor_app/saleor/utils.py

korycins · 2022-01-17T07:51:40Z

src/saleor_app/tests/test_endpoints.py


+# app.dependency_overrides[verify_saleor_domain] = lambda: True


Should be removed, right?

src/saleor_app/workers/base.py

src/saleor_app/workers/sqs.py

docs/event_handlers/http.md

samples/simple_app/app.py

src/saleor_app/deps.py

src/saleor_app/endpoints.py

src/saleor_app/tests/test_deps.py

src/saleor_app/app.py

…pos and review coments

korycins · 2022-01-18T06:41:57Z

samples/complex_app/app.py

@@ -39,7 +39,7 @@ async def get_webhook_details(domain_name: DomainName) -> WebhookData:
 app = SaleorApp(
    validate_domain=validate_domain,
    save_app_data=store_app_data,
-    webhook_handlers=webhook_handlers,
+    http_webhook_handlers=webhook_handlers,


It is not needed anymore, right?

korycins · 2022-01-18T06:42:27Z

samples/complex_app/webhooks.py

@@ -17,7 +17,7 @@ async def product_deleted(payload: Payload, saleor_domain: DomainName):
    print(payload)


-webhook_handlers = WebhookHandlers(
+http_webhook_handlers = WebhookHandlers(


I believe, everything with WebhookHandlers can be removed, right?

src/saleor_app/install.py

src/saleor_app/endpoints.py

korycins · 2022-01-18T06:51:12Z

src/saleor_app/install.py

-            "Unable to finish installation of app for %s. Received error: %s",
-            domain,
-            webhook_error,
+        logger.error("Unable to finish installation of app for %s.", saleor_domain)


We should figure out how to treat an installation when some of the requests will pass successfully and the rest fail. But I don't think this is a scope of this PR, I just raise it to keep in mind

src/saleor_app/webhook.py