Skip to content

Commit 3e61fdc

Browse files
committed
fix: Updated README & other cleanups
1 parent fabdf9f commit 3e61fdc

File tree

4 files changed

+7
-27
lines changed

4 files changed

+7
-27
lines changed

README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
A web server based on [Deno](https://deno.land) runtime, capable of running JavaScript, TypeScript, and WASM services.
44

5-
### Why are we building this?
5+
You can use it to:
66

7-
The primary goal of this project is to have a runtime environment that can simulate the capabilities and limitations of [Deno Deploy](https://deno.com/deploy).
7+
* Locally test and self-host Supabase's Edge Functions (or any Deno Edge Function)
8+
* As a programmable HTTP Proxy: You can intercept / route HTTP requests
89

9-
This enables Supabase users to test their Edge Functions locally while simulating the behavior at the edge (eg: runtime APIs like File I/O not available, memory and CPU time enforced).
10-
Also, this enables portability of edge functions to those users who want to self-host them outside of Deno Deploy.
10+
** WARNING: Beta Software. There will be breaking changes to APIs / Configuration Options **
1111

1212
## How to run locally
1313

@@ -22,20 +22,7 @@ docker build -t edge-runtime .
2222
docker run -it --rm -p 9000:9000 -v /path/to/supabase/functions:/usr/services supabase/edge-runtime start --main-service /usr/services
2323
```
2424

25-
## TODO
26-
27-
* Expose Deno.errors
28-
* Performance.now() precision tuning
29-
* Disable SharedArrayBuffers
30-
* better error messages for incorrect module loading paths
31-
* better error messages for invalid import map paths
32-
* Support snapshotting the runtime
33-
* Support for private modules (DENO_AUTH_TOKENS)
34-
* HTTP/2 support (need the host to support SSL)
35-
* Add tests
36-
* Add a benchmarking suite
37-
38-
## How to update to a Deno version
25+
## How to update to a newer Deno version
3926

4027
* Select the Deno version to upgrade and visit its tag on GitHub (eg: https://github.com/denoland/deno/blob/v1.30.3/Cargo.toml)
4128
* Open the `Cargo.toml` at the root of of this repo and modify all `deno_*` modules to match to the selected tag of Deno.

crates/base/Cargo.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
name = "base"
33
version = "0.1.0"
44
edition = "2021"
5-
build = "build.rs"
65

76
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
87

crates/base/build.rs

Lines changed: 0 additions & 7 deletions
This file was deleted.

examples/main/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ serve(async (req: Request) => {
2020
console.error(`serving the request with ${servicePath}`);
2121

2222
const memoryLimitMb = 150;
23-
const workerTimeoutMs = 5 * 60 * 1000;
23+
const workerTimeoutMs = 1 * 60 * 1000;
2424
const noModuleCache = false;
2525
const importMapPath = null;
2626
const envVarsObj = Deno.env.toObject();
@@ -36,6 +36,7 @@ serve(async (req: Request) => {
3636
});
3737
return worker.fetch(req);
3838
} catch (e) {
39+
console.error(e);
3940
const error = { msg: e.toString() }
4041
return new Response(
4142
JSON.stringify(error),

0 commit comments

Comments
 (0)