Merge pull request #39 from supabase/readme-chores

Update README & other chores

Author: laktek

README.md

@@ -1,13 +1,13 @@
-# Edge Runtime
+# Supabase Edge Runtime
 
 A web server based on [Deno](https://deno.land) runtime, capable of running JavaScript, TypeScript, and WASM services.
 
-### Why are we building this?
+You can use it to:
 
-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).
+* Locally test and self-host Supabase's Edge Functions (or any Deno Edge Function)
+* As a programmable HTTP Proxy: You can intercept / route HTTP requests
 
-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).
-Also, this enables portability of edge functions to those users who want to self-host them outside of Deno Deploy.
+** WARNING: Beta Software. There will be breaking changes to APIs / Configuration Options **
 
 ## How to run locally
 
@@ -22,24 +22,6 @@ docker build -t edge-runtime .
 docker run -it --rm -p 9000:9000 -v /path/to/supabase/functions:/usr/services supabase/edge-runtime start --main-service /usr/services
 ```
 
-## TODO
-
-* Expose Deno.errors
-* Performance.now() precision tuning
-* Disable SharedArrayBuffers
-* better error messages for incorrect module loading paths
-* better error messages for invalid import map paths
-* Support snapshotting the runtime
-* Support for private modules (DENO_AUTH_TOKENS)
-* HTTP/2 support (need the host to support SSL)
-* Add tests
-* Add a benchmarking suite
-
-## How to update to a Deno version
-
-* Select the Deno version to upgrade and visit its tag on GitHub (eg: https://github.com/denoland/deno/blob/v1.30.3/Cargo.toml)
-* Open the `Cargo.toml` at the root of of this repo and modify all `deno_*` modules to match to the selected tag of Deno.
-
 ## How to run tests
 
 make sure the docker daemon is running and create a docker image:
@@ -60,3 +42,16 @@ run tests:
 ```bash
 npm run test
 ```
+
+## How to update to a newer Deno version
+
+* Select the Deno version to upgrade and visit its tag on GitHub (eg: https://github.com/denoland/deno/blob/v1.30.3/Cargo.toml)
+* Open the `Cargo.toml` at the root of of this repo and modify all `deno_*` modules to match to the selected tag of Deno.
+
+## Contributions
+
+We welcome contributions to Supabase Edge Runtime!
+
+To get started either open an issue on [GitHub](https://github.com/supabase/edge-runtime/issues) or drop us a message on [Discord](https://discord.com/invite/R7bSpeBSJE)
+
+Edge Runtime follows Supabase's [Code of Conduct](https://github.com/supabase/.github/blob/main/CODE_OF_CONDUCT.md).

crates/base/Cargo.toml

@@ -2,7 +2,6 @@
 name = "base"
 version = "0.1.0"
 edition = "2021"
-build = "build.rs"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

crates/base/build.rs

@@ -1,7 +1,6 @@
 use crate::utils::units::{bytes_to_display, human_elapsed, mib_to_bytes};
 
-use anyhow::{anyhow, bail, Error};
-use deno_core::located_script_name;
+use anyhow::{bail, Error};
 use deno_core::url::Url;
 use deno_core::JsRuntime;
 use deno_core::ModuleSpecifier;

crates/base/src/js_worker.rs

@@ -1,4 +1,4 @@
-use anyhow::{anyhow, bail, Error};
+use anyhow::{bail, Error};
 use deno_ast::EmitOptions;
 use deno_ast::MediaType;
 use deno_core::error::AnyError;
@@ -10,8 +10,6 @@ use deno_core::ModuleSpecifier;
 use deno_core::ModuleType;
 use deno_core::ResolutionKind;
 use import_map::ImportMap;
-use module_fetcher::cache;
-use module_fetcher::cache::cache_db::CacheDB;
 use module_fetcher::cache::{
     caches, DenoDir, EmitCache, FastInsecureHasher, HttpCache, ParsedSourceCache,
 };

crates/base/src/js_worker/module_loader.rs

@@ -1,7 +1,7 @@
 use crate::worker_ctx::{WorkerContext, WorkerPool};
 use anyhow::Error;
 use hyper::{server::conn::Http, service::Service, Body, Request, Response};
-use log::{debug, error, info};
+use log::{error, info};
 use std::future::Future;
 use std::net::IpAddr;
 use std::net::Ipv4Addr;

crates/base/src/server.rs

@@ -2,15 +2,14 @@ use crate::js_worker::{MainWorker, UserWorker};
 
 use anyhow::{bail, Error};
 use hyper::{Body, Request, Response};
-use log::{debug, error};
+use log::error;
 use sb_worker_context::essentials::{CreateUserWorkerResult, UserWorkerMsgs, UserWorkerOptions};
 use std::collections::HashMap;
 use std::path::Path;
 use std::path::PathBuf;
 use std::sync::Arc;
 use std::thread;
 use tokio::net::UnixStream;
-use tokio::sync::oneshot::Receiver;
 use tokio::sync::RwLock;
 use tokio::sync::{mpsc, oneshot};
 use uuid::Uuid;
@@ -34,8 +33,8 @@ impl WorkerContext {
         let import_map_path = options.import_map_path;
         let user_worker_msgs_tx = options.user_worker_msgs_tx;
 
-        if (!service_path.exists()) {
-            return bail!("main function does not exist {:?}", &service_path);
+        if !service_path.exists() {
+            bail!("main function does not exist {:?}", &service_path)
         }
 
         // create a unix socket pair
@@ -90,8 +89,8 @@ impl WorkerContext {
         let import_map_path = options.import_map_path;
         let env_vars = options.env_vars;
 
-        if (!service_path.exists()) {
-            return bail!("user function does not exist {:?}", &service_path);
+        if !service_path.exists() {
+            bail!("user function does not exist {:?}", &service_path)
         }
 
         // create a unix socket pair
@@ -197,7 +196,7 @@ impl WorkerPool {
                         let mut worker = worker.write().await;
                         // TODO: Json format
                         // TODO: Ability to attach hook
-                        let res = worker.send_request(req).await.unwrap_or_else(|e| Response::builder().status(408).body(Body::from(deno_core::serde_json::json!({
+                        let res = worker.send_request(req).await.unwrap_or_else(|_e| Response::builder().status(408).body(Body::from(deno_core::serde_json::json!({
                             "msg": "Request could not be processed by the server because it timed out or an error was thrown."
                         }).to_string())).unwrap());
 

crates/base/src/worker_ctx.rs

@@ -3,7 +3,7 @@ mod logger;
 use anyhow::Error;
 use base::commands::start_server;
 use clap::builder::FalseyValueParser;
-use clap::{arg, value_parser, ArgAction, ArgMatches, Command};
+use clap::{arg, value_parser, ArgAction, Command};
 fn cli() -> Command {
     Command::new("edge-runtime")
         .about("A server based on Deno runtime, capable of running JavaScript, TypeScript, and WASM services")
@@ -36,15 +36,15 @@ fn cli() -> Command {
         )
 }
 
-async fn exit_with_code(result: Result<(), Error>) {
-    match result {
-        Ok(()) => std::process::exit(0),
-        Err(error) => {
-            eprintln!("{:?}", error);
-            std::process::exit(1)
-        }
-    }
-}
+//async fn exit_with_code(result: Result<(), Error>) {
+//    match result {
+//        Ok(()) => std::process::exit(0),
+//        Err(error) => {
+//            eprintln!("{:?}", error);
+//            std::process::exit(1)
+//        }
+//    }
+//}
 
 fn main() -> Result<(), anyhow::Error> {
     let runtime = tokio::runtime::Builder::new_current_thread()

crates/cli/src/main.rs

@@ -17,7 +17,6 @@ use deno_core::serde_json::json;
 use deno_core::serde_json::Value;
 use deno_core::ModuleSpecifier;
 use indexmap::IndexMap;
-use std::borrow::Cow;
 use std::collections::BTreeMap;
 use std::collections::HashMap;
 use std::collections::HashSet;
@@ -488,13 +487,13 @@ pub struct ConfigFile {
 }
 
 impl ConfigFile {
-    pub fn discover(flags: &Flags, cwd: &Path) -> Result<Option<ConfigFile>, AnyError> {
+    pub fn discover(_flags: &Flags, _cwd: &Path) -> Result<Option<ConfigFile>, AnyError> {
         Ok(None)
     }
 
     pub fn discover_from(
-        start: &Path,
-        checked: &mut HashSet<PathBuf>,
+        _start: &Path,
+        _checked: &mut HashSet<PathBuf>,
     ) -> Result<Option<ConfigFile>, AnyError> {
         // No config file found.
         Ok(None)

crates/module_fetcher/src/args/config_file.rs

@@ -1,8 +1,7 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 use deno_core::error::AnyError;
-use std::path::PathBuf;
 
-use crate::args::config_file::{ConfigFile, LockConfig};
+use crate::args::config_file::ConfigFile;
 use crate::npm::NpmResolutionPackage;
 
 use crate::args::flags::Flags;
@@ -12,8 +11,8 @@ use deno_lockfile::NpmPackageDependencyLockfileInfo;
 use deno_lockfile::NpmPackageLockfileInfo;
 
 pub fn discover(
-    flags: &Flags,
-    maybe_config_file: Option<&ConfigFile>,
+    _flags: &Flags,
+    _maybe_config_file: Option<&ConfigFile>,
 ) -> Result<Option<Lockfile>, AnyError> {
     // if flags.no_lock
     //   || matches!(