feat(udf): introduce async and batched JavaScript UDF #20403

fuyufjh · 2025-02-06T08:54:45Z

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

This PR adds support for async and batched JavaScript UDF as well as fetch() API. Resolves #20391.

Syntax:

create function my_udf(s varchar) returns decimal language javascript async as $$
export async function my_udf(s) {
    ... // able to call async functions such as `await fetch()` here
}
$$ WITH (
   async = [true|false],
   batch = [true|false],
)

Notice that UDAF is not supported in this PR. You can confirm this by checking the code of frontend handle_create_aggregate() doesn't support the new syntax. However, the internal implementation is mostly ready except here.

Checklist

I have written necessary rustdoc comments.
I have added necessary unit tests and integration tests.
I have added test labels as necessary.
I have added fuzzing tests or opened an issue to track them.
My PR contains breaking changes.
My PR changes performance-critical code, so I will run (micro) benchmarks and present the results.
My PR contains critical fixes that are necessary to be merged into the latest release.

Documentation

My PR needs documentation updates.

Release note

fuyufjh · 2025-02-06T08:55:11Z

Cargo.toml

@@ -164,7 +164,7 @@ iceberg-catalog-glue = { git = "https://github.com/risingwavelabs/iceberg-rust.g
 opendal = "0.49"
 # used only by arrow-udf-flight
 arrow-flight = "53"
-arrow-udf-js = "0.5"
+arrow-udf-js = { git = "https://github.com/arrow-udf/arrow-udf.git", rev = "4562678944210da2b3a094a6383f7b9ebe6cc54c" }


Wait for the release of arrow-udf-js before this PR merges.

stdrc · 2025-02-10T07:12:45Z

src/expr/core/src/aggregate/user_defined.rs

-        let state = self.runtime.call_agg_create_state()?;
-        Ok(AggregateState::Any(Box::new(State(state))))
+        // FIXME(eric): This is bad. Let's make `create_state` async later
+        futures::executor::block_on(async {
+            let state = self.runtime.call_agg_create_state().await?;
+            Ok(AggregateState::Any(Box::new(State(state))))
+      
8000
  })


Since we don't support async function create_state for now, what about using now_or_never instead of block_on here?

src/expr/core/src/sig/udf.rs

src/expr/impl/src/udf/quickjs.rs

Signed-off-by: Richard Chien <stdrc@outlook.com>

BugenZhao · 2025-03-03T08:13:13Z

ci/scripts/common.sh

-  risedev --allow-private link-all-in-one-binaries
+  risedev link-all-in-one-binaries


Will this work?

This is to avoid a warning complaining duplicated --allow-private, because risedev already mean cargo make --allow-private

BugenZhao · 2025-03-03T08:48:41Z

src/sqlparser/src/ast/mod.rs

+        if let Some(v) = self.always_retry_on_network_error {
+            options.push(format!("always_retry_on_network_error = {}", v));
+        }


@xiangjinwu This unparsing bug will finally be addressed. 😄

BugenZhao · 2025-03-03T08:50:15Z

src/sqlparser/src/ast/mod.rs

+                        SqlOptionValue::Value(Value::Boolean(true))
+                    ))
+                }
+                "batch" => {


Shall we name it batched instead? 🤔

We also use batch=True in external python udf

github-actions · 2025-03-03T15:26:49Z

Hi, there.

📝 Telemetry Reminder:
If you're implementing this feature, please consider adding telemetry metrics to track its usage. This helps us understand how the feature is being used and improve it further.
You can find the function report_event of telemetry reporting in the following files. Feel free to ask questions if you need any guidance!

src/frontend/src/telemetry.rs
src/meta/src/telemetry.rs
src/stream/src/telemetry.rs
src/storage/compactor/src/telemetry.rs
Or calling report_event_common (src/common/telemetry_event/src/lib.rs) as if finding it hard to implement.
✨ Thank you for your contribution to RisingWave! ✨

This is an automated comment created by the peaceiris/actions-label-commenter. Responding to the bot or mentioning it won't have any effect.

Signed-off-by: Richard Chien <stdrc@outlook.com> Co-authored-by: Richard Chien <stdrc@outlook.com> Co-authored-by: Noel Kwan <noelkwan1998@gmail.com>

…0403) to 2.3 (#20702) Signed-off-by: Richard Chien <stdrc@outlook.com> Co-authored-by: Eric Fu <eric@risingwave-labs.com> Co-authored-by: Noel Kwan <noelkwan1998@gmail.com>

Eric Fu added 6 commits February 5, 2025 16:32

code

2a0d444

update UTs

c4ec1b8

bugfix

c9c4402

introduce new arrow-udf-js

0b8a705

support udf language javascript_async

f5655f3

fmt

7566c71

fuyufjh requested a review from a team as a code owner February 6, 2025 08:54

fuyufjh requested review from xiangjinwu and removed request for a team February 6, 2025 08:54

fuyufjh commented Feb 6, 2025

View reviewed changes

fuyufjh requested review from MrCroxx, BugenZhao and stdrc February 7, 2025 06:37

adapt to newer version of arrow-udf-js

4c27276

stdrc reviewed Feb 10, 2025

View reviewed changes

Eric Fu added 2 commits February 10, 2025 20:30

refactor: use WITH to pass/store async & batched

3dd2363

update deps

6a705fa

fuyufjh marked this pull request as draft February 10, 2025 12:46

github-actions bot added type/feature Type: New feature. ci/run-e2e-single-node-tests ci/run-e2e-test-other-backends labels Feb 10, 2025

Base automatically changed from eric/js_function_def to main February 10, 2025 13:28

Eric Fu added 3 commits February 11, 2025 14:29

update deps before merge main

02dc527

Merge remote-tracking branch 'origin/main' into eric/async_js_udf

bb8d6c3

fix bugs

6c1b0ef

fuyufjh mentioned this pull request Feb 11, 2025

add: RisingWave RAG Demo risingwavelabs/awesome-stream-processing#32

Merged

Eric Fu added 3 commits February 11, 2025 18:37

Cargo.lock

7d75ecb

make memory_usage non-async

dfd20c6

fix cargo clippy

e046647

fuyufjh marked this pull request as ready for review February 12, 2025 07:06

Eric Fu and others added 5 commits February 25, 2025 12:38

bump udf-js to release ver

b028a7d

fix function options display

af75b51

Signed-off-by: Richard Chien <stdrc@outlook.com>

minor

8b3c4be

Signed-off-by: Richard Chien <stdrc@outlook.com>

try

133f41b

Signed-off-by: Richard Chien <stdrc@outlook.com>

Merge branch 'main' into eric/async_js_udf

0f417d9

stdrc force-pushed the eric/async_js_udf branch from ba07063 to 0f417d9 Compare February 28, 2025 08:56

stdrc added 2 commits March 3, 2025 13:48

fix backward comp

64c3b59

Signed-off-by: Richard Chien <stdrc@outlook.com>

8000

Merge branch 'main' into eric/async_js_udf

1ddd077

stdrc requested a review from MrCroxx March 3, 2025 05:50

stdrc added 2 commits March 3, 2025 14:44

fix backward comp 2

6536b96

Signed-off-by: Richard Chien <stdrc@outlook.com>

fix

dc8171e

Signed-off-by: Richard Chien <stdrc@outlook.com>

BugenZhao reviewed Mar 3, 2025

View reviewed changes

BugenZhao approved these changes Mar 3, 2025

View reviewed changes

Merge branch 'main' into eric/async_js_udf

d9b0677

stdrc enabled auto-merge March 3, 2025 15:26

stdrc added the user-facing-changes Contains changes that are visible to users label Mar 3, 2025

kwannoel and others added 3 commits March 4, 2025 09:41

fix

44e9b47

fix format

1ac15e5

skip non madsim labels

faacf05

kwannoel force-pushed the eric/async_js_udf branch from c9d97c7 to faacf05 Compare March 4, 2025 04:22

stdrc added this pull request to the merge queue Mar 4, 2025

Merged via the queue into main with commit 0cc54b3 Mar 4, 2025
33 of 35 checks passed

stdrc deleted the eric/async_js_udf branch March 4, 2025 05:03

neverchanje mentioned this pull request Mar 4, 2025

Document: feat(udf): introduce async and batched JavaScript UDF risingwavelabs/risingwave-docs#272

Closed

stdrc added a commit that referenced this pull request Mar 4, 2025

feat(udf): introduce async and batched JavaScript UDF (#20403)

14e5e7e

Signed-off-by: Richard Chien <stdrc@outlook.com> Co-authored-by: Richard Chien <stdrc@outlook.com> Co-authored-by: Noel Kwan <noelkwan1998@gmail.com>

stdrc mentioned this pull request Mar 4, 2025

cherry-pick feat(udf): introduce async and batched JavaScript UDF (#20403) to 2.3 #20702

Merged

WanYixian mentioned this pull request Mar 31, 2025

Document: async and batched JavaScript UDF risingwavelabs/risingwave-docs#362

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(udf): introduce async and batched JavaScript UDF #20403

feat(udf): introduce async and batched JavaScript UDF #20403

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

		risedev --allow-private link-all-in-one-binaries
		risedev link-all-in-one-binaries

feat(udf): introduce async and batched JavaScript UDF #20403

feat(udf): introduce async and batched JavaScript UDF #20403

Uh oh!

Conversation

Uh oh!

What's changed and what's your intention?

Checklist

Documentation

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!