From befe24bae58fb6c8eeb2a24b0bd6da6f6149e3fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Wed, 20 Aug 2025 14:02:31 +0900 Subject: [PATCH 01/27] feat: release deno 2.1 compatible version (#592) From 6084d3b81e9b1e6cf6d31821492256deab46252a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Wed, 20 Aug 2025 14:28:41 +0900 Subject: [PATCH 02/27] fix: semantic release version conflict (#593) --- .github/workflows/release.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8315ff3ed..9d76dfb6c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -18,6 +18,9 @@ jobs: version: ${{ steps.semantic.outputs.new_release_version }} steps: - uses: actions/checkout@v3 + with: + fetch-depth: 0 + fetch-tags: true - name: Semantic Release id: semantic From d3b9cee495a39f255cf5120f99bd35317d19b031 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Tue, 26 Aug 2025 15:13:37 +0900 Subject: [PATCH 03/27] fix: remove another bottleneck that causes boot time spike (#596) * fix: remove another bottleneck that causes boot time spike * chore: add integration test --- crates/base/src/utils/test_utils.rs | 1 + crates/base/src/worker/worker_inner.rs | 59 +++++++++++------ .../issue-func-284/baseline/index.ts | 3 + .../test_cases/issue-func-284/noisy/index.ts | 19 ++++++ crates/base/tests/integration_tests.rs | 65 +++++++++++++++++++ 5 files changed, 126 insertions(+), 21 deletions(-) create mode 100644 crates/base/test_cases/issue-func-284/baseline/index.ts create mode 100644 crates/base/test_cases/issue-func-284/noisy/index.ts diff --git a/crates/base/src/utils/test_utils.rs b/crates/base/src/utils/test_utils.rs index b6ce1aa58..499a85fee 100644 --- a/crates/base/src/utils/test_utils.rs +++ b/crates/base/src/utils/test_utils.rs @@ -271,6 +271,7 @@ impl TestBedBuilder { } } +#[derive(Clone)] pub struct TestBed { pool_termination_token: TerminationToken, main_termination_token: TerminationToken, diff --git a/crates/base/src/worker/worker_inner.rs b/crates/base/src/worker/worker_inner.rs index e4f22274b..a63450c5b 100644 --- a/crates/base/src/worker/worker_inner.rs +++ b/crates/base/src/worker/worker_inner.rs @@ -273,6 +273,12 @@ impl Worker { let _ = booter_signal.send(Ok((metric_src, new_runtime.drop_token.clone()))); + + let span = debug_span!( + "poll", + thread = ?std::thread::current().id(), + ); + let supervise_fut = match imp.clone().supervise(&mut new_runtime) { Some(v) => v.boxed(), None if worker_kind.is_user_worker() => return None, @@ -290,28 +296,41 @@ impl Worker { } }); - let result = imp.on_created(&mut new_runtime).await; - let maybe_uncaught_exception_event = match result.as_ref() { - Ok(WorkerEvents::UncaughtException(ev)) => Some(ev.clone()), - Err(err) => Some(UncaughtExceptionEvent { - cpu_time_used: 0, - exception: err.to_string(), - }), + let worker_poll_fut = async move { + let result = imp.on_created(&mut new_runtime).await; + let maybe_uncaught_exception_event = match result.as_ref() { + Ok(WorkerEvents::UncaughtException(ev)) => Some(ev.clone()), + Err(err) => Some(UncaughtExceptionEvent { + cpu_time_used: 0, + exception: err.to_string(), + }), - _ => None, - }; + _ => None, + }; - if let Some(ev) = maybe_uncaught_exception_event { - exit.set(WorkerExitStatus::WithUncaughtException(ev)).await; - } + if let Some(ev) = maybe_uncaught_exception_event { + exit.set(WorkerExitStatus::WithUncaughtException(ev)).await; + } - drop(new_runtime); - let _ = supervise_fut.await; + drop(new_runtime); + let _ = supervise_fut.await; - Some(result) + result + } + .instrument(span); + + Some( + rt.spawn_pinned({ + let fut = unsafe { MaskFutureAsSend::new(worker_poll_fut) }; + move || tokio::task::spawn_local(fut) + }) + .await + .map_err(anyhow::Error::from) + .and_then(|it| it.map_err(anyhow::Error::from)) + .and_then(|it| it.into_inner()), + ) }; - - let worker_fut = { + let worker_result_fut = { let event_metadata = event_metadata.clone(); async move { let Some(result) = worker_fut.await else { @@ -349,13 +368,11 @@ impl Worker { "worker", id = worker_name.as_str(), kind = %worker_kind, - thread = ?std::thread::current().id(), metadata = ?event_metadata )); - drop(rt.spawn_pinned({ - let worker_fut = unsafe { MaskFutureAsSend::new(worker_fut) }; - move || tokio::task::spawn_local(worker_fut) + drop(tokio::spawn(unsafe { + MaskFutureAsSend::new(worker_result_fut) })); } } diff --git a/crates/base/test_cases/issue-func-284/baseline/index.ts b/crates/base/test_cases/issue-func-284/baseline/index.ts new file mode 100644 index 000000000..320bacd09 --- /dev/null +++ b/crates/base/test_cases/issue-func-284/baseline/index.ts @@ -0,0 +1,3 @@ +Deno.serve(() => { + return new Response("meow"); +}); diff --git a/crates/base/test_cases/issue-func-284/noisy/index.ts b/crates/base/test_cases/issue-func-284/noisy/index.ts new file mode 100644 index 000000000..3e04f3457 --- /dev/null +++ b/crates/base/test_cases/issue-func-284/noisy/index.ts @@ -0,0 +1,19 @@ +function mySlowFunction(baseNumber) { + console.time("mySlowFunction"); + let now = Date.now(); + let result = 0; + for (var i = Math.pow(baseNumber, 7); i >= 0; i--) { + result += Math.atan(i) * Math.tan(i); + } + let duration = Date.now() - now; + console.timeEnd("mySlowFunction"); + return { result: result, duration: duration }; +} + +Deno.serve(async () => { + let count = 0; + while (++count != 300) { + mySlowFunction(8); + } + return new Response("meow"); +}); diff --git a/crates/base/tests/integration_tests.rs b/crates/base/tests/integration_tests.rs index fc461f708..2178d84cb 100644 --- a/crates/base/tests/integration_tests.rs +++ b/crates/base/tests/integration_tests.rs @@ -44,6 +44,7 @@ use deno_facade::EszipPayloadKind; use deno_facade::Metadata; use ext_event_worker::events::LogLevel; use ext_event_worker::events::ShutdownReason; +use ext_event_worker::events::WorkerEventWithMetadata; use ext_event_worker::events::WorkerEvents; use ext_runtime::SharedMetricSource; use ext_workers::context::MainWorkerRuntimeOpts; @@ -2606,6 +2607,70 @@ async fn test_issue_func_280() { run("mem", ShutdownReason::Memory).await; } +#[tokio::test] +#[serial] +async fn test_issue_func_284() { + async fn find_boot_event( + rx: &mut mpsc::UnboundedReceiver, + ) -> Option { + while let Some(ev) = rx.recv().await { + match ev.event { + WorkerEvents::Boot(ev) => return Some(ev.boot_time), + _ => continue, + } + } + + None + } + + let (tx, mut rx) = mpsc::unbounded_channel(); + let tb = TestBedBuilder::new("./test_cases/main") + .with_per_worker_policy(None) + .with_worker_event_sender(Some(tx)) + .build() + .await; + + tokio::spawn({ + let tb = tb.clone(); + async move { + tb.request(|b| { + b.uri("/meow") + .header("x-service-path", "issue-func-284/noisy") + .body(Body::empty()) + .context("can't make request") + }) + .await + .unwrap(); + } + }); + + timeout(Duration::from_secs(1), find_boot_event(&mut rx)) + .await + .unwrap() + .unwrap(); + + tokio::spawn({ + let tb = tb.clone(); + async move { + tb.request(|b| { + b.uri("/meow") + .header("x-service-path", "issue-func-284/baseline") + .body(Body::empty()) + .context("can't make request") + }) + .await + .unwrap(); + } + }); + + let boot_time = timeout(Duration::from_secs(1), find_boot_event(&mut rx)) + .await + .unwrap() + .unwrap(); + + assert!(boot_time < 1000); +} + #[tokio::test] #[serial] async fn test_should_render_detailed_failed_to_create_graph_error() { From 1dd58170e20982237d2be2061bf057f38afd6b9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Thu, 28 Aug 2025 09:22:51 +0900 Subject: [PATCH 04/27] fix(ext): handle log level correctly (#599) --- ext/event_worker/events.rs | 20 +++++++++++++++++++- ext/event_worker/js_interceptors.rs | 7 ++----- ext/runtime/js/bootstrap.js | 2 +- 3 files changed, 22 insertions(+), 7 deletions(-) diff --git a/ext/event_worker/events.rs b/ext/event_worker/events.rs index 70a5c25b2..b6f3e6b99 100644 --- a/ext/event_worker/events.rs +++ b/ext/event_worker/events.rs @@ -1,3 +1,5 @@ +use std::convert::Infallible; + use base_mem_check::MemCheckState; use enum_as_inner::EnumAsInner; use serde::Deserialize; @@ -50,14 +52,30 @@ pub struct LogEvent { pub level: LogLevel, } -#[derive(Serialize, Deserialize, Debug, PartialEq, Eq)] +#[derive(Serialize, Deserialize, Debug, Default, PartialEq, Eq)] +#[repr(u8)] pub enum LogLevel { + #[default] Debug, Info, Warning, Error, } +impl TryFrom for LogLevel { + type Error = Infallible; + + fn try_from(value: u8) -> Result { + match value { + 0 => Ok(Self::Debug), + 1 => Ok(Self::Info), + 2 => Ok(Self::Warning), + 3 => Ok(Self::Error), + _ => Ok(Self::Debug), + } + } +} + #[derive(Serialize, Deserialize, Debug, EnumAsInner)] pub enum WorkerEvents { Boot(BootEvent), diff --git a/ext/event_worker/js_interceptors.rs b/ext/event_worker/js_interceptors.rs index 9a967a06c..bdc66b3d6 100644 --- a/ext/event_worker/js_interceptors.rs +++ b/ext/event_worker/js_interceptors.rs @@ -12,14 +12,11 @@ use tokio::sync::mpsc; fn op_user_worker_log( state: &mut OpState, #[string] msg: &str, - is_err: bool, + #[smi] level: i32, ) -> Result<(), AnyError> { let maybe_tx = state.try_borrow::>(); - let mut level = LogLevel::Info; - if is_err { - level = LogLevel::Error; - } + let level = LogLevel::try_from(level as u8).unwrap_or_default(); if let Some(tx) = maybe_tx { let event_metadata = state diff --git a/ext/runtime/js/bootstrap.js b/ext/runtime/js/bootstrap.js index 5dc96bc3d..398854105 100644 --- a/ext/runtime/js/bootstrap.js +++ b/ext/runtime/js/bootstrap.js @@ -595,7 +595,7 @@ globalThis.bootstrapSBEdge = (opts, ctx) => { ObjectDefineProperties(globalThis, { console: nonEnumerable( new console.Console((msg, level) => { - return ops.op_user_worker_log(msg, level > 1); + return ops.op_user_worker_log(msg, level); }), ), }); From 173cad4dc67e332bf3c6b74954c1730af923c034 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Thu, 28 Aug 2025 14:30:15 +0900 Subject: [PATCH 05/27] fix(deno_facade): don't randomly place contents when bundling (#600) --- crates/deno_facade/eszip/mod.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/crates/deno_facade/eszip/mod.rs b/crates/deno_facade/eszip/mod.rs index 134830aa6..fc9066851 100644 --- a/crates/deno_facade/eszip/mod.rs +++ b/crates/deno_facade/eszip/mod.rs @@ -52,6 +52,7 @@ use futures::AsyncReadExt; use futures::AsyncSeekExt; use futures::FutureExt; use glob::glob; +use indexmap::IndexMap; use once_cell::sync::Lazy; use regex::Regex; use scopeguard::ScopeGuard; @@ -773,7 +774,7 @@ pub async fn generate_binary_eszip( let root_dir_url = EszipRelativeFileBaseUrl::new(&root_dir_url); let root_path = root_dir_url.inner().to_file_path().unwrap(); - let mut contents = HashMap::new(); + let mut contents = IndexMap::new(); let mut vfs_count = 0; let mut vfs_content_callback_fn = |_path: &_, _key: &_, content: Vec| { let key = format!("vfs://{}", vfs_count); From 8590136dc694a59cbf2f1c90916ade5c75a15f6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Fri, 29 Aug 2025 14:54:33 +0900 Subject: [PATCH 06/27] chore(cpu_timer): cleanup code and place cfg attr correctly (#595) --- crates/cpu_timer/src/lib.rs | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/crates/cpu_timer/src/lib.rs b/crates/cpu_timer/src/lib.rs index 0be14d5e5..7762362e7 100644 --- a/crates/cpu_timer/src/lib.rs +++ b/crates/cpu_timer/src/lib.rs @@ -42,6 +42,7 @@ mod linux { #[repr(C)] #[derive(Clone, Default)] pub struct CPUAlarmVal { + #[cfg(target_os = "linux")] pub cpu_alarms_tx: Arc>>>, } @@ -131,9 +132,12 @@ impl CPUTimer { pub async fn set_channel(&self) -> mpsc::UnboundedReceiver<()> { let (tx, rx) = mpsc::unbounded_channel(); - let mut val = self.cpu_alarm_val.cpu_alarms_tx.lock().await; + #[cfg(target_os = "linux")] + { + let mut val = self.cpu_alarm_val.cpu_alarms_tx.lock().await; + *val = Some(tx); + } - *val = Some(tx); rx } @@ -176,11 +180,6 @@ impl CPUTimer { log::error!("CPU timer: not enabled (need Linux)"); Ok(Self {}) } - - #[cfg(not(target_os = "linux"))] - pub fn reset(&self) -> Result<(), Error> { - Ok(()) - } } pub fn get_thread_time() -> Result { From 73628eb16e2df98724c65d02ecebdf7ce11e96b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Mon, 1 Sep 2025 11:02:54 +0900 Subject: [PATCH 07/27] fix(byonm): Deno.readFile* fails to recognize paths correctly when called from a node package (#601) --- crates/base/src/runtime/mod.rs | 5 +++++ crates/fs/impl/static_fs.rs | 21 ++++++++++++++++++++- deno/standalone/binary.rs | 2 +- 3 files changed, 26 insertions(+), 2 deletions(-) diff --git a/crates/base/src/runtime/mod.rs b/crates/base/src/runtime/mod.rs index 0f3f4fdfc..1dd97f740 100644 --- a/crates/base/src/runtime/mod.rs +++ b/crates/base/src/runtime/mod.rs @@ -658,6 +658,10 @@ where base_url, } = rt_provider; + let node_modules = metadata + .node_modules() + .ok() + .flatten(); let entrypoint = metadata.entrypoint.clone(); let main_module_url = match entrypoint.as_ref() { Some(Entrypoint::Key(key)) => base_url.join(key)?, @@ -717,6 +721,7 @@ where let (fs, s3_fs) = build_file_system_fn(if is_user_worker { Arc::new(StaticFs::new( + node_modules, static_files, if matches!(entrypoint, Some(Entrypoint::ModuleCode(_)) | None) && is_some_entry_point diff --git a/crates/fs/impl/static_fs.rs b/crates/fs/impl/static_fs.rs index ccbaad997..0580ca61d 100644 --- a/crates/fs/impl/static_fs.rs +++ b/crates/fs/impl/static_fs.rs @@ -6,6 +6,7 @@ use std::path::PathBuf; use std::rc::Rc; use std::sync::Arc; +use deno::standalone::binary::NodeModules; use deno_core::normalize_path; use deno_fs::AccessCheckCb; use deno_fs::FsDirEntry; @@ -26,22 +27,34 @@ pub struct StaticFs { static_files: EszipStaticFiles, base_dir_path: PathBuf, vfs_path: PathBuf, + byonm_node_modules_path: Option, snapshot: Option, vfs: Arc, } impl StaticFs { pub fn new( + node_modules: Option, static_files: EszipStaticFiles, base_dir_path: PathBuf, vfs_path: PathBuf, vfs: Arc, snapshot: Option, ) -> Self { + let byonm_node_modules_path = if let Some(NodeModules::Byonm { + root_node_modules_dir: Some(path), + }) = node_modules + { + Some(vfs_path.join(path)) + } else { + None + }; + Self { vfs, static_files, base_dir_path, + byonm_node_modules_path, vfs_path, snapshot, } @@ -375,7 +388,13 @@ impl deno_fs::FileSystem for StaticFs { _access_check: Option, ) -> FsResult> { let is_npm = self.is_valid_npm_package(path); - if is_npm { + let is_byonm_path = self + .byonm_node_modules_path + .as_ref() + .map(|it| path.starts_with(it)) + .unwrap_or_default(); + + if is_npm || is_byonm_path { let options = OpenOptions::read(); let file = self.open_sync(path, options, None)?; let buf = file.read_all_sync()?; diff --git a/deno/standalone/binary.rs b/deno/standalone/binary.rs index a18be402b..b0e41f748 100644 --- a/deno/standalone/binary.rs +++ b/deno/standalone/binary.rs @@ -9,7 +9,7 @@ use indexmap::IndexMap; use serde::Deserialize; use serde::Serialize; -#[derive(Deserialize, Serialize)] +#[derive(Debug, Clone, Deserialize, Serialize)] pub enum NodeModules { Managed { /// Relative path for the node_modules directory in the vfs. From 917a3b8966f83baff998342671f1f59bc0d967d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Tue, 2 Sep 2025 13:11:24 +0900 Subject: [PATCH 08/27] fix: add `otel_attributes` to event metadata (#602) --- crates/base/src/runtime/mod.rs | 38 +++++++++------------------------ crates/base/src/worker/utils.rs | 32 +++++++++++++++++++++++---- ext/event_worker/events.rs | 2 ++ 3 files changed, 40 insertions(+), 32 deletions(-) diff --git a/crates/base/src/runtime/mod.rs b/crates/base/src/runtime/mod.rs index 1dd97f740..3d41c7235 100644 --- a/crates/base/src/runtime/mod.rs +++ b/crates/base/src/runtime/mod.rs @@ -55,7 +55,6 @@ use deno_cache::SqliteBackedCache; use deno_core::error::AnyError; use deno_core::error::JsError; use deno_core::serde_json; -use deno_core::serde_json::Value; use deno_core::url::Url; use deno_core::v8; use deno_core::v8::GCCallbackFlags; @@ -80,7 +79,6 @@ use deno_facade::EmitterFactory; use deno_facade::EszipPayloadKind; use deno_facade::Metadata; use either::Either; -use ext_event_worker::events::EventMetadata; use ext_event_worker::events::WorkerEventWithMetadata; use ext_runtime::cert::ValueRootCertStoreProvider; use ext_runtime::external_memory::CustomAllocator; @@ -462,6 +460,7 @@ where pub(crate) async fn new(mut worker: Worker) -> Result { let init_opts = worker.init_opts.take(); let flags = worker.flags.clone(); + let event_metadata = worker.event_metadata.clone(); debug_assert!(init_opts.is_some(), "init_opts must not be None"); @@ -1111,7 +1110,6 @@ where s3_fs, beforeunload_cpu_threshold, beforeunload_mem_threshold, - context, .. } = match bootstrap_ret { Ok(Ok(v)) => v, @@ -1123,7 +1121,7 @@ where } }; - let context = context.unwrap_or_default(); + let otel_attributes = event_metadata.otel_attributes.clone(); let span = Span::current(); let post_task_ret = unsafe { spawn_blocking_non_send(|| { @@ -1151,13 +1149,6 @@ where op_state.put::>(HashMap::new()); } - let mut otel_attributes = HashMap::new(); - - otel_attributes.insert( - "edge_runtime.worker.kind".into(), - conf.to_worker_kind().to_string().into(), - ); - if conf.is_user_worker() { let conf = conf.as_user_worker().unwrap(); let key = conf.key.map_or("".to_string(), |k| k.to_string()); @@ -1165,32 +1156,23 @@ where // set execution id for user workers env_vars.insert("SB_EXECUTION_ID".to_string(), key.clone()); - if let Some(Value::Object(attributes)) = context.get("otel") { - for (k, v) in attributes { - otel_attributes.insert( - k.to_string().into(), - match v { - Value::String(str) => str.to_string().into(), - others => others.to_string().into(), - }, - ); - } - } - if let Some(events_msg_tx) = conf.events_msg_tx.clone() { op_state.put::>( events_msg_tx, ); - op_state.put::(EventMetadata { - service_path: conf.service_path.clone(), - execution_id: conf.key, - }); + op_state.put(event_metadata); } } op_state.put(ext_env::EnvVars(env_vars)); op_state.put(DenoRuntimeDropToken(DropToken(drop_token.clone()))); - op_state.put(RuntimeOtelExtraAttributes(otel_attributes)); + op_state.put(RuntimeOtelExtraAttributes( + otel_attributes + .unwrap_or_default() + .into_iter() + .map(|(k, v)| (k.into(), v.into())) + .collect(), + )); } if is_user_worker { diff --git a/crates/base/src/worker/utils.rs b/crates/base/src/worker/utils.rs index 20aba4b67..714119963 100644 --- a/crates/base/src/worker/utils.rs +++ b/crates/base/src/worker/utils.rs @@ -1,5 +1,8 @@ +use std::collections::HashMap; + use anyhow::anyhow; use anyhow::bail; +use deno_core::serde_json::Value; use ext_event_worker::events::EventMetadata; use ext_event_worker::events::WorkerEventWithMetadata; use ext_event_worker::events::WorkerEvents; @@ -15,18 +18,39 @@ use tokio::sync::oneshot; use tokio_util::sync::CancellationToken; pub fn get_event_metadata(conf: &WorkerRuntimeOpts) -> EventMetadata { + let mut otel_attributes = HashMap::new(); let mut event_metadata = EventMetadata { service_path: None, execution_id: None, + otel_attributes: None, }; + + otel_attributes.insert( + "edge_runtime.worker.kind".to_string(), + conf.to_worker_kind().to_string(), + ); + if conf.is_user_worker() { let conf = conf.as_user_worker().unwrap(); - event_metadata = EventMetadata { - service_path: conf.service_path.clone(), - execution_id: conf.key, - }; + let context = conf.context.clone().unwrap_or_default(); + + event_metadata.service_path = conf.service_path.clone(); + event_metadata.execution_id = conf.key; + + if let Some(Value::Object(attributes)) = context.get("otel") { + for (k, v) in attributes { + otel_attributes.insert( + k.to_string(), + match v { + Value::String(str) => str.to_string(), + others => others.to_string(), + }, + ); + } + } } + event_metadata.otel_attributes = Some(otel_attributes); event_metadata } diff --git a/ext/event_worker/events.rs b/ext/event_worker/events.rs index b6f3e6b99..9706aef04 100644 --- a/ext/event_worker/events.rs +++ b/ext/event_worker/events.rs @@ -1,3 +1,4 @@ +use std::collections::HashMap; use std::convert::Infallible; use base_mem_check::MemCheckState; @@ -106,6 +107,7 @@ impl WorkerEvents { pub struct EventMetadata { pub service_path: Option, pub execution_id: Option, + pub otel_attributes: Option>, } #[derive(Serialize, Deserialize, Debug)] From e29bd1282d06b3e29465e6588a02e0c0c4013916 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Fri, 5 Sep 2025 07:44:24 +0900 Subject: [PATCH 09/27] fix(cli): introduce timeout flag for the bundle command (#603) --- cli/src/flags.rs | 5 +++++ cli/src/main.rs | 22 +++++++++++++++++++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/cli/src/flags.rs b/cli/src/flags.rs index 334a37ec6..0a85f32cd 100644 --- a/cli/src/flags.rs +++ b/cli/src/flags.rs @@ -364,6 +364,11 @@ fn get_bundle_command() -> Command { .default_value("false") .value_parser(FalseyValueParser::new()), ) + .arg( + arg!(--"timeout" ) + .help("Maximum time in seconds that can be waited for the bundle to complete.") + .value_parser(value_parser!(u64).range(..u64::MAX)) + ) } fn get_unbundle_command() -> Command { diff --git a/cli/src/main.rs b/cli/src/main.rs index 4976c1654..82dcccca0 100644 --- a/cli/src/main.rs +++ b/cli/src/main.rs @@ -6,6 +6,7 @@ use std::path::PathBuf; use std::process::ExitCode; use std::str::FromStr; use std::sync::Arc; +use std::time::Duration; use anyhow::bail; use anyhow::Context; @@ -34,6 +35,7 @@ use flags::EszipV2ChecksumKind; use flags::OtelConsoleConfig; use flags::OtelKind; use log::warn; +use tokio::time::timeout; mod env; mod flags; @@ -319,6 +321,10 @@ fn main() -> Result { } else { vec![] }; + let timeout_dur = sub_matches + .get_one::("timeout") + .cloned() + .map(Duration::from_secs); if import_map_path.is_some() { warn!(concat!( @@ -382,14 +388,24 @@ fn main() -> Result { emitter_factory.set_deno_options(builder.build()?); let mut metadata = Metadata::default(); - let eszip = generate_binary_eszip( + let eszip_fut = generate_binary_eszip( &mut metadata, Arc::new(emitter_factory), None, maybe_checksum_kind, Some(static_patterns), - ) - .await?; + ); + + let eszip = if let Some(dur) = timeout_dur { + match timeout(dur, eszip_fut).await { + Ok(eszip) => eszip, + Err(_) => { + bail!("Failed to complete the bundle within the given time.") + } + } + } else { + eszip_fut.await + }?; let bin = eszip.into_bytes(); From 8fd73e62bffc45d4aff50a6387de9ef76fd586dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Fri, 5 Sep 2025 11:44:52 +0900 Subject: [PATCH 10/27] fix(fs): allow Deno.makeTempFile[Sync] (#604) --- crates/base/test_cases/user-worker-san-check/.blocklisted | 2 -- crates/base/test_cases/user-worker-san-check/.whitelisted | 1 + ext/runtime/js/bootstrap.js | 2 ++ 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/crates/base/test_cases/user-worker-san-check/.blocklisted b/crates/base/test_cases/user-worker-san-check/.blocklisted index 398109c64..7aa5c3a90 100644 --- a/crates/base/test_cases/user-worker-san-check/.blocklisted +++ b/crates/base/test_cases/user-worker-san-check/.blocklisted @@ -21,8 +21,6 @@ futime futimeSync link linkSync -makeTempFile -makeTempFileSync readLink readLinkSync rename diff --git a/crates/base/test_cases/user-worker-san-check/.whitelisted b/crates/base/test_cases/user-worker-san-check/.whitelisted index a3a8afc60..299dd96f0 100644 --- a/crates/base/test_cases/user-worker-san-check/.whitelisted +++ b/crates/base/test_cases/user-worker-san-check/.whitelisted @@ -8,3 +8,4 @@ writeTextFileSync readTextFileSync readFileSync makeTempDirSync +makeTempFileSync diff --git a/ext/runtime/js/bootstrap.js b/ext/runtime/js/bootstrap.js index 398854105..a4f6adcdd 100644 --- a/ext/runtime/js/bootstrap.js +++ b/ext/runtime/js/bootstrap.js @@ -680,6 +680,7 @@ globalThis.bootstrapSBEdge = (opts, ctx) => { "readTextFile": true, "mkdir": true, "makeTempDir": true, + "makeTempFile": true, "readDir": true, "kill": "mock", @@ -696,6 +697,7 @@ globalThis.bootstrapSBEdge = (opts, ctx) => { "readTextFileSync": "allowIfRuntimeIsInInit", "mkdirSync": "allowIfRuntimeIsInInit", "makeTempDirSync": "allowIfRuntimeIsInInit", + "makeTempFileSync": "allowIfRuntimeIsInInit", "readDirSync": "allowIfRuntimeIsInInit", // TODO: use a non-hardcoded path From 7c9d8dafe3400d03c75b1a10c1d9cd343c193524 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Tue, 9 Sep 2025 12:27:22 +0900 Subject: [PATCH 11/27] chore(ci/stale): add an missing permission (#606) --- .github/workflows/stale.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index e111eef2a..6a2dbf8d4 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -6,6 +6,7 @@ on: workflow_dispatch: permissions: + actions: write issues: write pull-requests: write From 159fc1db5d7eba48121e902d95ab94a841a8e5cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=83=A5=EB=83=90=EC=B1=A0?= Date: Thu, 11 Sep 2025 19:43:04 +0900 Subject: [PATCH 12/27] fix(supervisor): do not try to divide 0 by 2 (#607) --- crates/base/src/worker/supervisor/strategy_per_worker.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/base/src/worker/supervisor/strategy_per_worker.rs b/crates/base/src/worker/supervisor/strategy_per_worker.rs index c952e4ecc..516e1882e 100644 --- a/crates/base/src/worker/supervisor/strategy_per_worker.rs +++ b/crates/base/src/worker/supervisor/strategy_per_worker.rs @@ -188,7 +188,7 @@ pub async fn supervise(args: Arguments) -> (ShutdownReason, i64) { worker_timeout_ms }; - let wall_clock_duration = Duration::from_millis(worker_timeout_ms); + let wall_clock_duration = Duration::from_millis(wall_clock_limit_ms); // Split wall clock duration into 2 intervals. // At the first interval, we will send a msg to retire the worker. From 7b23fd9a258133f07c9100f32ff7cee4fb8977df Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Wed, 21 May 2025 12:11:32 +0100 Subject: [PATCH 13/27] stamp: starting with `ai` docs - to rebase later --- ext/ai/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 ext/ai/README.md diff --git a/ext/ai/README.md b/ext/ai/README.md new file mode 100644 index 000000000..d4627b347 --- /dev/null +++ b/ext/ai/README.md @@ -0,0 +1,25 @@ +# Supabase AI module + +This crate is part of the Supabase Edge Runtime stack and implements AI related +features for the `Supabase.ai` namespace. + +## Model Execution Engine + +`Supabase.ai` uses [onnxruntime](https://onnxruntime.ai/) as internal model +execution engine, backend by [ort pyke](https://ort.pyke.io/) rust bindings. + +TODO: add photo + +Following there's specific documentation for both "lands": + +
+ Javascript/Frontend +
+ +
+ Rust/Backend +
+ +onnxruntime: + +the Session class: From 46977c69ed3583557752b68924240f0d28c6ae61 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Wed, 21 May 2025 15:00:03 +0100 Subject: [PATCH 14/27] stamp: trying with assets rebase later --- assets/docs/ai/onnx-backend-dark.svg | 4 ++++ assets/docs/ai/onnx-backend.svg | 4 ++++ ext/ai/README.md | 8 +++++++- 3 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 assets/docs/ai/onnx-backend-dark.svg create mode 100644 assets/docs/ai/onnx-backend.svg diff --git a/assets/docs/ai/onnx-backend-dark.svg b/assets/docs/ai/onnx-backend-dark.svg new file mode 100644 index 000000000..146c97388 --- /dev/null +++ b/assets/docs/ai/onnx-backend-dark.svg @@ -0,0 +1,4 @@ + + +Onnx Backend(nlp tasks + ort rust)Shipped AssetsModel loadingDownload and cacheorShared instanceWorker 1Warm- Model InferenceInit- Model Lazy LoadingWorker 2Warm- Model InferenceInit- Model Lazy LoadingExecution time:- 1º request: 1s / 5s- 2º request: 400ms Execution time:- 1º request: 400ms- 2º request: 400ms /api/api \ No newline at end of file diff --git a/assets/docs/ai/onnx-backend.svg b/assets/docs/ai/onnx-backend.svg new file mode 100644 index 000000000..9a2397d4d --- /dev/null +++ b/assets/docs/ai/onnx-backend.svg @@ -0,0 +1,4 @@ + + +Onnx Backend(nlp tasks + ort rust)Shipped AssetsModel loadingDownload and cacheorShared instanceWorker 1Warm- Model InferenceInit- Model Lazy LoadingWorker 2Warm- Model InferenceInit- Model Lazy LoadingExecution time:- 1º request: 1s / 5s- 2º request: 400ms Execution time:- 1º request: 400ms- 2º request: 400ms /api/api \ No newline at end of file diff --git a/ext/ai/README.md b/ext/ai/README.md index d4627b347..4e7bc5bdf 100644 --- a/ext/ai/README.md +++ b/ext/ai/README.md @@ -8,7 +8,13 @@ features for the `Supabase.ai` namespace. `Supabase.ai` uses [onnxruntime](https://onnxruntime.ai/) as internal model execution engine, backend by [ort pyke](https://ort.pyke.io/) rust bindings. -TODO: add photo +

+ + + + ONNX Backend illustration + +

Following there's specific documentation for both "lands": From e6c9ac02cd5d182064c5ff1c2028718fb94b14e2 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Wed, 21 May 2025 16:08:08 +0100 Subject: [PATCH 15/27] add: onnxruntime instructions --- ext/ai/README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 56 insertions(+), 3 deletions(-) diff --git a/ext/ai/README.md b/ext/ai/README.md index 4e7bc5bdf..dac405e5b 100644 --- a/ext/ai/README.md +++ b/ext/ai/README.md @@ -5,9 +5,6 @@ features for the `Supabase.ai` namespace. ## Model Execution Engine -`Supabase.ai` uses [onnxruntime](https://onnxruntime.ai/) as internal model -execution engine, backend by [ort pyke](https://ort.pyke.io/) rust bindings. -

@@ -16,10 +13,66 @@ execution engine, backend by [ort pyke](https://ort.pyke.io/) rust bindings.

+`Supabase.ai` uses [onnxruntime](https://onnxruntime.ai/) as internal model +execution engine, backend by [ort pyke](https://ort.pyke.io/) rust bindings. + Following there's specific documentation for both "lands":
Javascript/Frontend + +The **onnxruntime** API is available from `globalThis` and shares similar specs of [onnxruntime-common](https://github.com/microsoft/onnxruntime/tree/main/js/common). + +The available items are: + +- `Tensor`: represent a basic tensor with specified dimensions and data type. -- "The AI input/output" +- `InferenceSession`: represent the inner model session. -- "The AI model itself" + +### Usage + +It can be used from the exported `globalThis[Symbol.for("onnxruntime")]` -- +but manipulating it directly is not trivial, so in the future you may use the [Inference API #501](https://github.com/supabase/edge-runtime/pull/501) for a more user friendly API. + +```typescript +const { InferenceSession, Tensor } = globalThis[Symbol.for("onnxruntime")]; + +// 'create()' supports an url string buffer or the binary data +const modelUrlBuffer = new TextEncoder().encode("https://huggingface.co/Supabase/gte-small/resolve/main/onnx/model_quantized.onnx"); +const session = await InferenceSession.create(modelUrlBuffer); + +// Example only, in real 'feature-extraction' tensors must be created from the tokenizer step. +const inputs = { + input_ids: new Tensor('float32', [1, 2, 3...], [1, 384]), + attention_mask: new Tensor('float32', [...], [1, 384]), + token_types_ids: new Tensor('float32', [...], [1, 384]) +}; + +const { last_hidden_state } = await session.run(inputs); +console.log(last_hidden_state); +``` + +### Third party libs + +Originaly this backend was created to implicit integrate with [transformers.js](https://github.com/huggingface/transformers.js/). This way users can still consuming a high-level lib at same time they benefits of all Supabase's Model Execution Engine features, like model optimization and caching. For further information pleas check the [PR #436](https://github.com/supabase/edge-runtime/pull/436) + +> [!WARNING] +> At this moment users need to explicit target `device: 'auto'` to enable the platform compatibility. + +```typescript +import { env, pipeline } from 'https://cdn.jsdelivr.net/npm/@huggingface/transformers@3.0.1'; + +// Broswer cache is now supported for `onnx` models +env.useBrowserCache = true; +env.allowLocalModels = false; + +const pipe = await pipeline('feature-extraction', 'supabase/gte-small', { device: 'auto' }); + +const output = await pipe("This embed will be generated from rust land", { + pooling: 'mean', + normalize: true +}); +``` +
From b46df4cea3f0459ee86177fc03995276e312e567 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Wed, 21 May 2025 16:19:12 +0100 Subject: [PATCH 16/27] stamp: self-hosting onnxruntime instructions --- ext/ai/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/ext/ai/README.md b/ext/ai/README.md index dac405e5b..f93915f29 100644 --- a/ext/ai/README.md +++ b/ext/ai/README.md @@ -73,6 +73,29 @@ const output = await pipe("This embed will be generated from rust land", { }); ``` +### Self-Hosting + +**Caching filepath**: +The `EXT_AI_CACHE_DIR` environment variable can be use to set a custom cache path + +**Memory clean up**: +For Self-Hosting users an extra method is available for `main/index.ts` scope and should be used to clean up unused sessions, consider adding it into your main entrypoint file: + +```typescript +// cleanup unused sessions every 30s +setInterval(async () => { + try { + const cleanupCount = await EdgeRuntime.ai.tryCleanupUnusedSession(); + if (cleanupCount == 0) { + return; + } + console.log('EdgeRuntime.ai.tryCleanupUnusedSession', cleanupCount); + } catch (e) { + console.error(e.toString()); + } +}, 30 * 1000); +``` +
From 3a4f8bf87960ac952fd4933849b40b288ba30991 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Fri, 23 May 2025 20:46:48 +0100 Subject: [PATCH 17/27] stamp: adding `Session` information --- ext/ai/README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/ext/ai/README.md b/ext/ai/README.md index f93915f29..d3e6acf85 100644 --- a/ext/ai/README.md +++ b/ext/ai/README.md @@ -16,17 +16,15 @@ features for the `Supabase.ai` namespace. `Supabase.ai` uses [onnxruntime](https://onnxruntime.ai/) as internal model execution engine, backend by [ort pyke](https://ort.pyke.io/) rust bindings. -Following there's specific documentation for both "lands": -
- Javascript/Frontend + Javascript docs The **onnxruntime** API is available from `globalThis` and shares similar specs of [onnxruntime-common](https://github.com/microsoft/onnxruntime/tree/main/js/common). The available items are: -- `Tensor`: represent a basic tensor with specified dimensions and data type. -- "The AI input/output" -- `InferenceSession`: represent the inner model session. -- "The AI model itself" +- `Tensor`: Represent a basic tensor with specified dimensions and data type. -- "The AI input/output" +- `InferenceSession`: Represent the inner model session. -- "The AI model itself" ### Usage @@ -53,7 +51,7 @@ console.log(last_hidden_state); ### Third party libs -Originaly this backend was created to implicit integrate with [transformers.js](https://github.com/huggingface/transformers.js/). This way users can still consuming a high-level lib at same time they benefits of all Supabase's Model Execution Engine features, like model optimization and caching. For further information pleas check the [PR #436](https://github.com/supabase/edge-runtime/pull/436) +Originaly this backend was created to implicit integrate with [transformers.js](https://github.com/huggingface/transformers.js/). This way users can still consuming a high-level lib at same time they benefits of all Supabase's Model Execution Engine features, like model optimization and caching. For further information please check the [PR #436](https://github.com/supabase/edge-runtime/pull/436) > [!WARNING] > At this moment users need to explicit target `device: 'auto'` to enable the platform compatibility. @@ -98,10 +96,11 @@ setInterval(async () => {
-
- Rust/Backend -
+## The `Session` class -onnxruntime: +Prior versions has [introduced](https://supabase.com/blog/ai-inference-now-available-in-supabase-edge-functions) the `Session` class as alternative to `transformers.js` for *gte-small* model and then was used to provide a [LLM interface](https://supabase.com/docs/guides/functions/ai-models?queryGroups=platform&platform=ollama#using-large-language-models-llm) for Ollama and some other providers. -the Session class: +Since the **Model Execution Engine** was created the `Session` class now can focus on LLM interface while the `Session('gte-small')` is for compatibility purposes only. + +> [!WARNING] +> Docs for Session class will end here - There's a open [PR #539](https://github.com/supabase/edge-runtime/pull/539) that may change a lot of things for it. From f050201e1d4ddb204495d9db91052d32f2919bc8 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Fri, 23 May 2025 21:11:52 +0100 Subject: [PATCH 18/27] stamp: adding useful links to main Readme --- README.md | 11 +++++++++++ crates/base/README.md | 0 ext/node/README.md | 10 +++++++++- ext/node/polyfills/README.md | 7 ++++--- 4 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 crates/base/README.md diff --git a/README.md b/README.md index 412c0ac73..3c0b9e14c 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,17 @@ The edge runtime can be divided into two runtimes with different purposes. - Limits are required to be set such as: Memory and Timeouts. - Has access to environment variables explictly allowed by the main runtime. +### Edge Runtime in Deep + +#### Conceptual + +- [EdgeRuntime Base](/crates/base/README.md): Overalls about how EdgeRuntime is based on Deno. + +#### Extension Modules + +- [AI](/ext/ai/README.md): Implements AI related features. +- [NodeJs](/ext/node/README.md) & [NodeJs Polyfills](/ext/node/polyfills/README.md): Implements the NodeJs compatibility layer. + ## Developers To learn how to build / test Edge Runtime, visit [DEVELOPERS.md](DEVELOPERS.md) diff --git a/crates/base/README.md b/crates/base/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/ext/node/README.md b/ext/node/README.md index d154d8cb6..87d08a664 100644 --- a/ext/node/README.md +++ b/ext/node/README.md @@ -1,3 +1,11 @@ -# deno_node +# Supabase Node module + +This crate is part of the Supabase Edge Runtime stack and implements NodeJs +related features. + +To see all compatible features, please check the +[NodeJs Polyfills](/ext/node/polyfills/README.md) section. + +## deno_node `require` and other node related functionality for Deno. diff --git a/ext/node/polyfills/README.md b/ext/node/polyfills/README.md index 26527278e..1e6e82bdc 100644 --- a/ext/node/polyfills/README.md +++ b/ext/node/polyfills/README.md @@ -1,6 +1,7 @@ -# Deno Node.js compatibility +# Supabase Node.js compatibility module -This module is meant to have a compatibility layer for the +This crate is part of the Supabase Edge Runtime stack and implements a +compatibility layer for the [Node.js standard library](https://nodejs.org/docs/latest/api/). **Warning**: Any function of this module should not be referred anywhere in the @@ -59,7 +60,7 @@ Deno standard library as it's a compatibility module. - [x] worker_threads - [ ] zlib -* [x] node globals _partly_ +- [x] node globals _partly_ ### Deprecated From 50248184e485762b6b4b1814af8141369e037e9e Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Fri, 23 May 2025 21:20:06 +0100 Subject: [PATCH 19/27] stamp: improving --- ext/ai/README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/ext/ai/README.md b/ext/ai/README.md index d3e6acf85..aece5d0a4 100644 --- a/ext/ai/README.md +++ b/ext/ai/README.md @@ -16,19 +16,17 @@ features for the `Supabase.ai` namespace. `Supabase.ai` uses [onnxruntime](https://onnxruntime.ai/) as internal model execution engine, backend by [ort pyke](https://ort.pyke.io/) rust bindings. -
- Javascript docs - The **onnxruntime** API is available from `globalThis` and shares similar specs of [onnxruntime-common](https://github.com/microsoft/onnxruntime/tree/main/js/common). The available items are: -- `Tensor`: Represent a basic tensor with specified dimensions and data type. -- "The AI input/output" -- `InferenceSession`: Represent the inner model session. -- "The AI model itself" +- `Tensor`: Represent a basic tensor with specified dimensions and data type. - "The AI input/output" +- `InferenceSession`: Represent the inner model session. - "The AI model itself" -### Usage +
+Usage -It can be used from the exported `globalThis[Symbol.for("onnxruntime")]` -- +It can be used from the exported `globalThis[Symbol.for("onnxruntime")]` - but manipulating it directly is not trivial, so in the future you may use the [Inference API #501](https://github.com/supabase/edge-runtime/pull/501) for a more user friendly API. ```typescript @@ -49,6 +47,8 @@ const { last_hidden_state } = await session.run(inputs); console.log(last_hidden_state); ``` +
+ ### Third party libs Originaly this backend was created to implicit integrate with [transformers.js](https://github.com/huggingface/transformers.js/). This way users can still consuming a high-level lib at same time they benefits of all Supabase's Model Execution Engine features, like model optimization and caching. For further information please check the [PR #436](https://github.com/supabase/edge-runtime/pull/436) @@ -94,8 +94,6 @@ setInterval(async () => { }, 30 * 1000); ``` -
- ## The `Session` class Prior versions has [introduced](https://supabase.com/blog/ai-inference-now-available-in-supabase-edge-functions) the `Session` class as alternative to `transformers.js` for *gte-small* model and then was used to provide a [LLM interface](https://supabase.com/docs/guides/functions/ai-models?queryGroups=platform&platform=ollama#using-large-language-models-llm) for Ollama and some other providers. From ffc69bd535174789475cd67e976894f657dd4f4f Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Fri, 23 May 2025 21:27:09 +0100 Subject: [PATCH 20/27] stamp(ai): adding reference to tests folder --- ext/ai/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ext/ai/README.md b/ext/ai/README.md index aece5d0a4..7633f327e 100644 --- a/ext/ai/README.md +++ b/ext/ai/README.md @@ -51,7 +51,8 @@ console.log(last_hidden_state); ### Third party libs -Originaly this backend was created to implicit integrate with [transformers.js](https://github.com/huggingface/transformers.js/). This way users can still consuming a high-level lib at same time they benefits of all Supabase's Model Execution Engine features, like model optimization and caching. For further information please check the [PR #436](https://github.com/supabase/edge-runtime/pull/436) +Originaly this backend was created to implicit integrate with [transformers.js](https://github.com/huggingface/transformers.js/). This way users can still consuming a high-level lib at same time they benefits of all Supabase's Model Execution Engine features, like model optimization and caching. +For further information please check the [PR #436](https://github.com/supabase/edge-runtime/pull/436) as well the [tests folder](/crates/base/test_cases/ai-ort-rust-backend/transformers-js) > [!WARNING] > At this moment users need to explicit target `device: 'auto'` to enable the platform compatibility. From bdc5d34dcd86714b82c9404c13fb560edbd3b3ab Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Mon, 26 May 2025 11:27:16 +0100 Subject: [PATCH 21/27] stamp: improving edge-runtime diagram --- README.md | 8 +++++++- assets/edge-runtime-diagram-dark.svg | 4 ++++ assets/edge-runtime-diagram.svg | 25 ++++--------------------- 3 files changed, 15 insertions(+), 22 deletions(-) create mode 100644 assets/edge-runtime-diagram-dark.svg diff --git a/README.md b/README.md index 3c0b9e14c..41a5bec8f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,13 @@ Options** ## Architecture -![Sequence diagram of Edge Runtime request flow](assets/edge-runtime-diagram.svg?raw=true) +

+ + + + Sequence diagram of Edge Runtime request flow + +

The edge runtime can be divided into two runtimes with different purposes. diff --git a/assets/edge-runtime-diagram-dark.svg b/assets/edge-runtime-diagram-dark.svg new file mode 100644 index 000000000..e440ef85c --- /dev/null +++ b/assets/edge-runtime-diagram-dark.svg @@ -0,0 +1,4 @@ + + +Incomming http reqSb. Worker IsolateMain WorkerSb extensionsUser Worker/endpoint-AUser Worker/endpoint-B Deno CoreSb. InterceptorsHyperOutcome http resEdge Runtime \ No newline at end of file diff --git a/assets/edge-runtime-diagram.svg b/assets/edge-runtime-diagram.svg index 63cfa5ffe..73a032d70 100644 --- a/assets/edge-runtime-diagram.svg +++ b/assets/edge-runtime-diagram.svg @@ -1,21 +1,4 @@ - - - - - - - - - - - - - - - - - - - - - + + +Incomming http reqSb. Worker IsolateMain WorkerSb extensionsUser Worker/endpoint-AUser Worker/endpoint-B Deno CoreSb. InterceptorsHyperOutcome http resEdge Runtime \ No newline at end of file From 85438077d377fbb2eaf92f1b1bbfdebd132e1052 Mon Sep 17 00:00:00 2001 From: Kalleby Santos <105971119+kallebysantos@users.noreply.github.com> Date: Mon, 26 May 2025 11:28:01 +0100 Subject: [PATCH 22/27] fix: diagram width --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 41a5bec8f..86ea30b97 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Options** - Sequence diagram of Edge Runtime request flow + Sequence diagram of Edge Runtime request flow

From 4fc0a1eeb1ddbb6b49e6351e803f0460de6db470 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Mon, 26 May 2025 11:31:47 +0100 Subject: [PATCH 23/27] stamp: add diagram caption --- assets/edge-runtime-diagram-dark.svg | 4 ++-- assets/edge-runtime-diagram.svg | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/assets/edge-runtime-diagram-dark.svg b/assets/edge-runtime-diagram-dark.svg index e440ef85c..f19e8b5d2 100644 --- a/assets/edge-runtime-diagram-dark.svg +++ b/assets/edge-runtime-diagram-dark.svg @@ -1,4 +1,4 @@ -Incomming http reqSb. Worker IsolateMain WorkerSb extensionsUser Worker/endpoint-AUser Worker/endpoint-B Deno CoreSb. InterceptorsHyperOutcome http resEdge Runtime \ No newline at end of file +Incomming http reqSb. Worker IsolateMain WorkerSb extensionsUser Worker/endpoint-AUser Worker/endpoint-B Deno CoreSb. InterceptorsHyperOutcome http resEdge Runtimerusttypescript / javascript \ No newline at end of file diff --git a/assets/edge-runtime-diagram.svg b/assets/edge-runtime-diagram.svg index 73a032d70..bc4036c70 100644 --- a/assets/edge-runtime-diagram.svg +++ b/assets/edge-runtime-diagram.svg @@ -1,4 +1,4 @@ -Incomming http reqSb. Worker IsolateMain WorkerSb extensionsUser Worker/endpoint-AUser Worker/endpoint-B Deno CoreSb. InterceptorsHyperOutcome http resEdge Runtime \ No newline at end of file +Incomming http reqSb. Worker IsolateMain WorkerSb extensionsUser Worker/endpoint-AUser Worker/endpoint-B Deno CoreSb. InterceptorsHyperOutcome http resEdge Runtimerusttypescript / javascript \ No newline at end of file From d6725f7cd4b7322900f73224b3648a82c0f6fbe0 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Mon, 18 Aug 2025 12:59:47 +0100 Subject: [PATCH 24/27] stamp: add base runtime diagram --- README.md | 2 +- crates/base/README.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 86ea30b97..0304d9f56 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The edge runtime can be divided into two runtimes with different purposes. - User runtime: - An instance for the _user runtime_ is responsible for executing users' code. - Limits are required to be set such as: Memory and Timeouts. - - Has access to environment variables explictly allowed by the main runtime. + - Has access to environment variables explicitly allowed by the main runtime. ### Edge Runtime in Deep diff --git a/crates/base/README.md b/crates/base/README.md index e69de29bb..a1374b042 100644 --- a/crates/base/README.md +++ b/crates/base/README.md @@ -0,0 +1,14 @@ +# Supabase EdgeRuntime base + +This crate is part of the Supabase Edge Runtime stack and implements the runtime +core features. + +## Architecture + +

+ + + + Sequence diagram of Edge Runtime request flow + +

From 4f2ac6b1e0632b35c817fafb3c975d33ba4eb58c Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Fri, 12 Sep 2025 16:12:14 +0100 Subject: [PATCH 25/27] feat: add usage section --- README.md | 4 +++ docs/usage.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 docs/usage.md diff --git a/README.md b/README.md index 0304d9f56..33d8aa532 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,10 @@ The edge runtime can be divided into two runtimes with different purposes. - Limits are required to be set such as: Memory and Timeouts. - Has access to environment variables explicitly allowed by the main runtime. +### Usage & Self-Hosting + +For completely usage and self-host details, visit [usage.md](/docs/usage.md) + ### Edge Runtime in Deep #### Conceptual diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 000000000..895f39d2a --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,74 @@ +# Usage & Self-Hosting + +## The edge-runtime CLI + +Edge runtime is based on [Deno](https://deno.land) and try to follows the same +concepts of it. One of them is the edge-runtime is primary a CLI based app and +have different commands as well parameters. + +The easiest way to use edge-runtime is by running it from docker: + +```bash +docker run --rm -it supabase/edge-runtime:v1.69.9 +``` + +> The version above may be outdated. + +
+ CLI output + +``` +A server based on Deno runtime, capable of running JavaScript, TypeScript, and WASM services + +Usage: edge-runtime [OPTIONS] [COMMAND] + +Commands: +start Start the server +bundle Creates an 'eszip' file that can be executed by the EdgeRuntime. Such file contains all the modules in contained in a single binary. +unbundle Unbundles an .eszip file into the specified directory +help Print this message or the help of the given subcommand(s) + +Options: +-v, --verbose Use verbose output +-q, --quiet Do not print any log messages + --log-source Include source file and line in log messages +-h, --help Print help +-V, --version Print version +``` + +
+ +### `start` command + +The start command allows you to run JavaScript/TypeScript code in a similar way of standard Deno. +But with the difference that it expects a main-service entrypoint with the given format: `path/index.ts` + +
+ Example + +```ts +// main.ts + +console.log('Hello from Edge Runtime!!'); +``` + +Running it from docker by using `--main-service` parameter: + +```bash +docker run --rm -it -v $(pwd)/main.ts:/home/deno/main/index.ts supabase/edge-runtime:v1.69.9 start --main-service /home/deno/main +``` + +In the command above we did first map our local `main.ts` script to an `index.ts` file located at `/home/deno/main` in the docker volume. +So that we only need to supply this path as "main-service" entrypoint. + +Edge runtime will then run the script and print the following output: + +``` +Hello from Edge Runtime!! +main worker has been destroyed +``` + +Notice that a *"main worker has been destroyed"* was printed out. +It means that our main service worker has nothing more to execute so the process will be finished. + +
From eaf2776f0411ff2049e5c56f6711de149839ec24 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Fri, 12 Sep 2025 18:50:00 +0100 Subject: [PATCH 26/27] stamp: improving usage docs - main service VS user worker --- docs/usage.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index 895f39d2a..9ee7a3754 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -72,3 +72,108 @@ Notice that a *"main worker has been destroyed"* was printed out. It means that our main service worker has nothing more to execute so the process will be finished.
+ +## Edge functions + +In the previous section we discussed in how `edge-runtime` cli can be used to run a JavaScript/TypeScript code. + +**But how about serving edge functions?** In order to achieve that we must first understand the edge-runtime execution flow. + +

+ + + + Sequence diagram of Edge Runtime request flow + +

+ +### Main Service + +The main service is the initial script supplied on `start` command and it's should acts as root level of edge functions. By intercepting the incomming http request and spawing an **User Worker** to handle it. + +All code execution here is more permisse, it means that main scope can access filesystem as well other privilegied APIs - like a `sudo` mode! + +> When using Supabase Hosting Platform you don't have access to **Main Service** since its implicit managed by Supabase team. + +### User Worker + +Here's where your edge functions will really be executed! + +The user worker is a more restricted and isolated environment, great to put user-specific code. + +> When using `supabase functions deploy`, in a Supabase Hosting Platform, all your function code will be executed inside an **User Worker**. + +### Self-Hosting + +To self-host edge-functions you should manage the main service as well the user worker spawn logic, like [main.ts template](https://github.com/supabase/supabase/blob/d91ea9d4e24c211f666e6e0ff01d290a9f3831cb/docker/volumes/functions/main/index.ts) + +The core idea is to have a root level `Deno.serve()` inside the main service and then foward the request to an user worker. + +
+ Example + +Creating a edge function to say hello! + +```ts +// functions/hello-world/index.ts + +Deno.serve(async (req: Request) => { + const { name } = await req.json(); + + const message = `Hello ${name} from foo!`; + + return Response.json({ message }); +}); +``` + +Handling http requests at main service level and passing it to a user worker: + +```ts +// main/index.ts + +import { exists } from 'jsr:@std/fs/exists'; + +Deno.serve(async (req: Request) => { + console.log('new request', req.url); // http:localhost:9000/hello-world + + const edgeFunctionName = new URL(req.url).pathname; // "hello-world" + + // path relative to docker volume + const edgeFunctionFilepath = `/home/deno/functions/${edgeFunctionName}`; + + // ensuring file exists + if (!await exists(edgeFunctionFilepath)) { + return new Response(null, { status: 404 }); + } + + try { + // spawning a user worker + const worker = await EdgeRuntime.userWorkers.create({ + servicePath: edgeFunctionFilepath, + memoryLimitMb: 150, + workerTimeoutMs: 1 * 60 * 1000, + }); + + // fowarding the request to user worker + return await worker.fetch(req); + } catch (error) { + return Response.json({ error }, { status: 500 }); + } +}); +``` + +Executing with docker + +```bash +docker run --rm -it -p 9000:9000 -v $(pwd):/home/deno supabase/edge-runtime:v1.69.9 start --main-service /home/deno/main +``` + +Calling the edge function + +```bash +$ curl localhost:9000/hello-world --data '{"name": "Kalleby Santos"}' + +{"message":"Hello Kalleby Santos from foo!"} +``` + +
From bef679bc600bec58e3c334b4faf15550848bc417 Mon Sep 17 00:00:00 2001 From: kallebysantos Date: Wed, 17 Sep 2025 19:34:37 +0100 Subject: [PATCH 27/27] stamp: creating api compatibility table - VALUES NOT VALIDATED --- docs/usage.md | 135 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index 9ee7a3754..aad38d922 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -103,6 +103,141 @@ The user worker is a more restricted and isolated environment, great to put user > When using `supabase functions deploy`, in a Supabase Hosting Platform, all your function code will be executed inside an **User Worker**. +### API Comparison + +
+ Deno APIs + + + +| API | Main Worker | User Worker | +|---|---|---| +| [`cloud`](https://docs.deno.com/api/deno/cloud) | ❌ | ❌ | +| [`fetch`](https://docs.deno.com/api/deno/fetch) | ✅ | ✅ | +| [`ffi`](https://docs.deno.com/api/deno/ffi) | ❌ | ❌ | +| [`file-system`](https://docs.deno.com/api/deno/file-system) | ✅ | ❌ | +| [`gpu`](https://docs.deno.com/api/deno/gpu) | ❌ | ❌ | +| [`http-server`](https://docs.deno.com/api/deno/http-server) | ✅ | ✅ | +| [`io`](https://docs.deno.com/api/deno/io) | ❌ | ❌ | +| [`jupyter`](https://docs.deno.com/api/deno/jupyter) | ❌ | ❌ | +| [`linter`](https://docs.deno.com/api/deno/linter) | ❌ | ❌ | +| [`network`](https://docs.deno.com/api/deno/network) | ✅ | ✅ | +| [`permissions`](https://docs.deno.com/api/deno/permissions) | ✅ | ✅ | +| [`runtime`](https://docs.deno.com/api/deno/runtime) | ⚠️ | ⚠️ | +| [`subprocess`](https://docs.deno.com/api/deno/subprocess) | ❌ | ❌ | +| [`telemetry`](https://docs.deno.com/api/deno/telemetry) | ✅ | ✅ | +| [`testing`](https://docs.deno.com/api/deno/testing) | ✅ | ✅ | +| [`websockets`](https://docs.deno.com/api/deno/websockets) | ✅ | ✅ | + +> ❌ Not supported +> ✅ Supported +> ⚠️Partial supported + +
+ +
+ Web APIs + + + +| API | Main Worker | User Worker | +|---|---|---| +| [`cache`](https://docs.deno.com/api/web/cache) | ❌ | ⚠️ **ai models** only | +| [`canvas`](https://docs.deno.com/api/web/canvas) | ❌ | ❌ | +| [`crypto`](https://docs.deno.com/api/web/crypto) | ✅ | ✅ | +| [`encoding`](https://docs.deno.com/api/web/encoding) | ✅ | ✅ | +| [`events`](https://docs.deno.com/api/web/events) | ✅ | ✅ | +| [`events`](https://docs.deno.com/api/web/events) | ✅ | ✅ | +| [`fetch`](https://docs.deno.com/api/web/fetch) | ✅ | ✅ | +| [`file`](https://docs.deno.com/api/web/file) | ✅ | ✅ | +| [`gpu`](https://docs.deno.com/api/web/gpu) | ❌ | ❌ | +| [`io`](https://docs.deno.com/api/web/io) | ✅ | ✅ | +| [`io`](https://docs.deno.com/api/web/io) | ✅ | ✅ | +| [`intl`](https://docs.deno.com/api/web/intl) | ✅ | ✅ | +| [`messaging`](https://docs.deno.com/api/web/messaging) | ✅ | ✅ | +| [`performance`](https://docs.deno.com/api/web/performance) | ✅ | ✅ | +| [`platform`](https://docs.deno.com/api/web/platform) | ❌ | ❌ | +| [`storage`](https://docs.deno.com/api/web/storage) | ❌ | ❌ | +| [`streams`](https://docs.deno.com/api/web/streams) | ✅ | ✅ | +| [`temporal`](https://docs.deno.com/api/web/temporal) | ✅ | ✅ | +| [`url`](https://docs.deno.com/api/web/url) | ✅ | ✅ | +| [`wasm`](https://docs.deno.com/api/web/wasm) | ✅ | ✅ | +| [`websockets`](https://docs.deno.com/api/web/websockets) | ✅ | ✅ | +| [`workers`](https://docs.deno.com/api/web/storage) | ❌ | ❌ | + +> ❌ Not supported +> ✅ Supported +> ⚠️Partial supported + +
+ +
+ Node APIs + + + +| API | Main Worker | User Worker | +|---|---|---| +| [`assert`](https://docs.deno.com/api/node/assert) | ✅ | ✅ | +| [`assert/strict`](https://docs.deno.com/api/node/assert/~/assert.strict) | ✅ | ✅ | +| [`assync_hooks`](https://docs.deno.com/api/node/assync_hooks) | ✅ | ✅ | +| [`buffer`](https://docs.deno.com/api/node/buffer) | ✅ | ✅ | +| [`child_process`](https://docs.deno.com/api/node/child_process) | ❌ | ❌ | +| [`cluster`](https://docs.deno.com/api/node/cluster) | ❌ | ❌ | +| [`console`](https://docs.deno.com/api/node/console) | ⚠️all outputs are trimmed out | ⚠️ same as *Main Worker* | +| [`crypto`](https://docs.deno.com/api/node/crypto) | ✅ | ✅ | +| [`dgram`](https://docs.deno.com/api/node/dgram) | ✅ | ✅ | +| [`diagnostics_channel`](https://docs.deno.com/api/node/diagnostics_channel) | ❌ | ❌ | +| [`dns`](https://docs.deno.com/api/node/dns) | ✅ | ✅ | +| [`dns/promisses`](https://docs.deno.com/api/node/dns/promisses) | ✅ | ✅ | +| [`domain`](https://docs.deno.com/api/node/domain) | ✅ | ✅ | +| [`events`](https://docs.deno.com/api/node/events) | ✅ | ✅ | +| [`fs`](https://docs.deno.com/api/node/fs) | ✅ | ❌ | +| [`fs/promisses`](https://docs.deno.com/api/node/fs/promisses) | ✅ | ❌ | +| [`http`](https://docs.deno.com/api/node/http) | ✅ | ✅ | +| [`http2`](https://docs.deno.com/api/node/http2) | ✅ | ✅ | +| [`https`](https://docs.deno.com/api/node/https) | ✅ | ✅ | +| [`inspector`](https://docs.deno.com/api/node/inspector) | ✅ | ✅ | +| [`inspector/promisses`](https://docs.deno.com/api/node/inspector/promisses) | ✅ | ✅ | +| [`module`](https://docs.deno.com/api/node/module) | ✅ | ✅ | +| [`net`](https://docs.deno.com/api/node/net) | ✅ | ✅ | +| [`os`](https://docs.deno.com/api/node/os) | ✅ | ✅ | +| [`path`](https://docs.deno.com/api/node/path) | ✅ | ✅ | +| [`perf_hooks`](https://docs.deno.com/api/node/perf_hooks) | ✅ | ✅ | +| [`process`](https://docs.deno.com/api/node/process) | ✅ | ✅ | +| [`querystring`](https://docs.deno.com/api/node/querystring) | ✅ | ✅ | +| [`readline`](https://docs.deno.com/api/node/readline) | ❌ | ❌ | +| [`readline/promisses`](https://docs.deno.com/api/node/readline/promisses) | ❌ | ❌ | +| [`repl`](https://docs.deno.com/api/node/repl) | ❌ | ❌ | +| [`sea`](https://docs.deno.com/api/node/sea) | ❌ | ❌ | +| [`sqlite`](https://docs.deno.com/api/node/sqlite) | ❌ | ❌ | +| [`stream`](https://docs.deno.com/api/node/stream) | ✅ | ✅ | +| [`stream/consumers`](https://docs.deno.com/api/node/stream/consumers) | ✅ | ✅ | +| [`stream/promisses`](https://docs.deno.com/api/node/stream/promisses) | ✅ | ✅ | +| [`stream/web`](https://docs.deno.com/api/node/stream/web) | ✅ | ✅ | +| [`string_decoder`](https://docs.deno.com/api/node/string_decoder) | ✅ | ✅ | +| [`test`](https://docs.deno.com/api/node/test) | ✅ | ✅ | +| [`test/reporters`](https://docs.deno.com/api/node/test/reporters) | ✅ | ✅ | +| [`timers`](https://docs.deno.com/api/node/timers) | ✅ | ✅ | +| [`timers/promisses`](https://docs.deno.com/api/node/timers/promisses) | ✅ | ✅ | +| [`tls`](https://docs.deno.com/api/node/tls) | ✅ | ✅ | +| [`trace_events`](https://docs.deno.com/api/node/trace_events) | ✅ | ✅ | +| [`tty`](https://docs.deno.com/api/node/tty) | ❌ | ❌ | +| [`url`](https://docs.deno.com/api/node/url) | ✅ | ✅ | +| [`util`](https://docs.deno.com/api/node/util) | ✅ | ✅ | +| [`util/types`](https://docs.deno.com/api/node/util/types) | ✅ | ✅ | +| [`v8`](https://docs.deno.com/api/node/v8) | ❌ | ❌ | +| [`vm`](https://docs.deno.com/api/node/vm) | ❌ | ❌ | +| [`wasi`](https://docs.deno.com/api/node/wasi) | ✅ | ✅ | +| [`worker_threads`](https://docs.deno.com/api/node/worker_threads) | ✅ | ✅ | +| [`zlib`](https://docs.deno.com/api/node/zlib) | ✅ | ✅ | + +> ❌ Not supported +> ✅ Supported +> ⚠️Partial supported + +
+ ### Self-Hosting To self-host edge-functions you should manage the main service as well the user worker spawn logic, like [main.ts template](https://github.com/supabase/supabase/blob/d91ea9d4e24c211f666e6e0ff01d290a9f3831cb/docker/volumes/functions/main/index.ts)