feat: add http-gateway library and cloudflare gateway example project #42
Conversation
| @@ -5,6 +5,7 @@ dist/ | |||
| pocket-ic | |||
| .env | |||
| Cargo.lock | |||
| .wrangler | |||
There was a problem hiding this comment.
This folder is generated by Cloudflare's wrangler CLI
README.md
Outdated
There was a problem hiding this comment.
Unrelated cleanup, removing deprecated projects and replacing with newer ones.
There was a problem hiding this comment.
The next few files belong to the Cloudflare worker example project that leverages the JS library to run an HTTP Gateway. Docs and implementation are still a little rough around the edges.
There was a problem hiding this comment.
This is the main logic for the Cloudlfare worker.
There was a problem hiding this comment.
The next few files belong to a library that exports a simple wrapper around an actor built with pre-generated types that correspond to the expected interface for a canister that the HTTP Gateway will interact with. There is also some simple mapping between more idiomatic TypeScript types and those generated by Candid.
packages/http-gateway-js/LICENSE
Outdated
There was a problem hiding this comment.
The next few files belong to the actual HTTP Gateway JavaScript library.
| @@ -0,0 +1,40 @@ | |||
| import { HttpGatewayClient } from '@dfinity/http-gateway'; | |||
| import { HttpAgent } from '@dfinity/agent'; | |||
| import RESPONSE_VERIFICATION_WASM from '@dfinity/response-verification/dist/web/web_bg.wasm'; | |||
There was a problem hiding this comment.
I had issues with loading the WASM when the HTTP Gateway library did it internally. This should work fine in other environments, but Cloudflare doesn't like it for some reason. Loading it explicitly inside the worker and passing it as a parameter works well, although I really don't like it.
packages/http-canister-client-js/src/http-canister/http-canister-client.spec.ts
Outdated
Show resolved
Hide resolved
packages/http-canister-client-js/src/http-canister/http-canister-client.spec.ts
Outdated
Show resolved
Hide resolved
nathanosdev
force-pushed
the
nathan/add-http-gateway-library
branch
from
57a261e to
4fcd03f
Compare
There was a problem hiding this comment.
Will the example be built/tested by CI? (sorry if this is a stupid question, I'm somewhat lost in the JS-code 😕 😉) If not, would it make sense to add some simple test, just to make sure that it is in a healthy state when e.g. some of the dependencies get upgraded?
There was a problem hiding this comment.
Is this file empty on purpose?
| @@ -0,0 +1,19 @@ | |||
| # Cloudflare Worker based ICP HTTP Gateway | |||
There was a problem hiding this comment.
nit: it seems to me "based" should be preceded with a hyphen, but am not sure whether it should be "Cloudflare-Worker-based" or "Cloudflare Worker-based" (and obviously I'm not a native speaker 😢 ). Maybe the best solution would be to reformulate to "An ICP HTTP Gateway based on a Cloudflare Worker"?
This PR includes a very minimal version of a JavaScript based HTTP Gateway library and an example project that shows how to use this library to run an HTTP Gateway on Cloudflare. This is still experimental and a PoC at this point.