Skip to content

Add script function flags in the module API#2836

Merged
rjd15372 merged 2 commits into
valkey-io:unstablefrom
rjd15372:script-flags
Nov 20, 2025
Merged

Add script function flags in the module API#2836
rjd15372 merged 2 commits into
valkey-io:unstablefrom
rjd15372:script-flags

Conversation

@rjd15372

@rjd15372 rjd15372 commented Nov 13, 2025

Copy link
Copy Markdown
Member

This commit adds script function flags to the module API, which allows function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags from the code and set the flags on the compiled function objects.

@rjd15372
Add script function flags in the module API
303fcb9 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
@rjd15372 rjd15372 requested a review from zuiderkwast November 13, 2025 17:17
@rjd15372 rjd15372 self-assigned this Nov 13, 2025
@codecov

codecov Bot commented Nov 13, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.42%. Comparing base (01a7657) to head (a85185c).
⚠️ Report is 13 commits behind head on unstable.

Additional details and impacted files 
@@             Coverage Diff              @@
##           unstable    #2836      +/-   ##
============================================
- Coverage     72.46%   72.42%   -0.04%     
============================================
  Files           128      128              
  Lines         70364    70371       +7     
============================================
- Hits          50986    50965      -21     
- Misses        19378    19406      +28
Files with missing lines Coverage Δ
src/script.c 80.13% <ø> (+0.91%) ⬆️

... and 17 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

zuiderkwast
zuiderkwast reviewed Nov 17, 2025
View reviewed changes

@zuiderkwast zuiderkwast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine, but why do scripts need to be able to declare per these flags per function? Do you have a real use case?

Comment thread src/script.c Outdated
@rjd15372

rjd15372 commented Nov 18, 2025

Copy link
Copy Markdown
Member Author

Looks fine, but why do scripts need to be able to declare per these flags per function? Do you have a real use case?

These are only used for FUNCTION LOAD scripts, where script functions are declared dynamically using the scripting server API. For EVAL scripts, these flags are parsed from the shebang header.

@rjd15372
rename types and variables to original names
a85185c 
Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
@zuiderkwast

zuiderkwast commented Nov 18, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

These are only used for FUNCTION LOAD scripts, where script functions are declared dynamically using the scripting server API. For EVAL scripts, these flags are parsed from the shebang header.

In the FUNCTION LOAD docs, the shebang is used too:

FUNCTION LOAD "#!lua name=mylib \n server.register_function('myfunc', function(keys, args) return args[1] end)"

What am I missing?

@rjd15372

rjd15372 commented Nov 18, 2025

Copy link
Copy Markdown
Member Author

What am I missing?

See "Function Flags" section in https://valkey.io/topics/functions-intro/

Example:

server.register_function('my_hset', my_hset)
server.register_function{
  function_name='my_hgetall',
  callback=my_hgetall,
  flags={ 'no-writes' }
}
server.register_function{
  function_name='my_hlastmodified',
  callback=my_hlastmodified,
  flags={ 'no-writes' }
}

@zuiderkwast

zuiderkwast commented Nov 18, 2025

Copy link
Copy Markdown
Contributor

Thank you! Now I understand.

The page has this disclaimer:

This page is under review. The page is likely incorrect, contains invalid links, and/or needs technical review. In the future it may change substantially or be removed entirely.

If you have read this page and found nothing wrong, let's remove the disclaimer?

@rjd15372

rjd15372 commented Nov 18, 2025

Copy link
Copy Markdown
Member Author

If you have read this page and found nothing wrong, let's remove the disclaimer?

Sure, I can proof read it and then remove the disclaimer.

@rjd15372

rjd15372 commented Nov 19, 2025

Copy link
Copy Markdown
Member Author

@zuiderkwast is anything still missing or can this PR be approved?

zuiderkwast
zuiderkwast approved these changes Nov 19, 2025
View reviewed changes

@zuiderkwast zuiderkwast left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is anything still missing or can this PR be approved?

Only that I need to take the time to review it. :)

@rjd15372 rjd15372 mentioned this pull request Nov 20, 2025
Merged
@rjd15372 rjd15372 merged commit 05540af into valkey-io:unstable Nov 20, 2025
55 checks passed
zhijun42 pushed a commit to zhijun42/valkey that referenced this pull request Nov 28, 2025
@rjd15372 @zhijun42
Add script function flags in the module API (valkey-io#2836)
f3843b6 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
zhijun42 pushed a commit to zhijun42/valkey that referenced this pull request Nov 28, 2025
@rjd15372 @zhijun42
Add script function flags in the module API (valkey-io#2836)
5496965 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
zhijun42 pushed a commit to zhijun42/valkey that referenced this pull request Nov 28, 2025
@rjd15372 @zhijun42
Add script function flags in the module API (valkey-io#2836)
8c69f96 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
aradz44 pushed a commit to aradz44/valkey that referenced this pull request Dec 23, 2025
@rjd15372 @aradz44
Add script function flags in the module API (valkey-io#2836)
7128af6 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
jjuleslasarte pushed a commit to jjuleslasarte/valkey that referenced this pull request Jan 6, 2026
@rjd15372 @jjuleslasarte
Add script function flags in the module API (valkey-io#2836)
a1395bf 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
Signed-off-by: jjuleslasarte <jules.lasarte@gmail.com>
jjuleslasarte pushed a commit to jjuleslasarte/valkey that referenced this pull request Jan 6, 2026
@rjd15372 @jjuleslasarte
Add script function flags in the module API (valkey-io#2836)
dd39ab5 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
Signed-off-by: jjuleslasarte <jules.lasarte@gmail.com>
jjuleslasarte pushed a commit to jjuleslasarte/valkey that referenced this pull request Jan 6, 2026
@rjd15372 @jjuleslasarte
Add script function flags in the module API (valkey-io#2836)
da8abb5 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
Signed-off-by: jjuleslasarte <jules.lasarte@gmail.com>
jjuleslasarte pushed a commit to jjuleslasarte/valkey that referenced this pull request Jan 6, 2026
@rjd15372 @jjuleslasarte
Add script function flags in the module API (valkey-io#2836)
5678130 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
Signed-off-by: jjuleslasarte <jules.lasarte@gmail.com>
jdheyburn pushed a commit to jdheyburn/valkey that referenced this pull request Jan 8, 2026
@rjd15372 @jdheyburn
Add script function flags in the module API (valkey-io#2836)
a49fca6 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
hpatro pushed a commit to hpatro/valkey that referenced this pull request Mar 5, 2026
@rjd15372 @hpatro
Add script function flags in the module API (valkey-io#2836)
1ede7e3 
This commit adds script function flags to the module API, which allows
function scripts to specify the function flags programmatically.

When the scripting engine compiles the script code can extract the flags
from the code and set the flags on the compiled function objects.

---------

Signed-off-by: Ricardo Dias <ricardo.dias@percona.com>
Signed-off-by: Harkrishn Patro <bunty.hari@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zuiderkwast zuiderkwast zuiderkwast approved these changes

Assignees

@rjd15372 rjd15372

Labels

None yet

Projects

Valkey 9.1
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rjd15372 @zuiderkwast