Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Script::load function #603

Merged
merged 4 commits into from Jun 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
81 changes: 51 additions & 30 deletions src/script.rs
Expand Up @@ -4,6 +4,7 @@ use sha1_smol::Sha1;
use crate::cmd::cmd;
use crate::connection::ConnectionLike;
use crate::types::{ErrorKind, FromRedisValue, RedisResult, ToRedisArgs};
use crate::Cmd;

/// Represents a lua script.
#[derive(Debug, Clone)]
Expand Down Expand Up @@ -124,26 +125,15 @@ impl<'a> ScriptInvocation<'a> {
/// Invokes the script and returns the result.
#[inline]
pub fn invoke<T: FromRedisValue>(&self, con: &mut dyn ConnectionLike) -> RedisResult<T> {
loop {
match cmd("EVALSHA")
.arg(self.script.hash.as_bytes())
.arg(self.keys.len())
.arg(&*self.keys)
.arg(&*self.args)
.query(con)
{
Ok(val) => {
return Ok(val);
}
Err(err) => {
if err.kind() == ErrorKind::NoScriptError {
cmd("SCRIPT")
.arg("LOAD")
.arg(self.script.code.as_bytes())
.query(con)?;
} else {
fail!(err);
}
let eval_cmd = self.eval_cmd();
match eval_cmd.query(con) {
Ok(val) => Ok(val),
Err(err) => {
if err.kind() == ErrorKind::NoScriptError {
self.load_cmd().query(con)?;
eval_cmd.query(con)
} else {
Err(err)
}
}
}
Expand All @@ -157,15 +147,7 @@ impl<'a> ScriptInvocation<'a> {
C: crate::aio::ConnectionLike,
T: FromRedisValue,
{
let mut eval_cmd = cmd("EVALSHA");
eval_cmd
.arg(self.script.hash.as_bytes())
.arg(self.keys.len())
.arg(&*self.keys)
.arg(&*self.args);

let mut load_cmd = cmd("SCRIPT");
load_cmd.arg("LOAD").arg(self.script.code.as_bytes());
let eval_cmd = self.eval_cmd();
match eval_cmd.query_async(con).await {
Ok(val) => {
// Return the value from the script evaluation
Expand All @@ -174,12 +156,51 @@ impl<'a> ScriptInvocation<'a> {
Err(err) => {
// Load the script into Redis if the script hash wasn't there already
if err.kind() == ErrorKind::NoScriptError {
load_cmd.query_async(con).await?;
self.load_cmd().query_async(con).await?;
eval_cmd.query_async(con).await
} else {
Err(err)
}
}
}
}

/// Loads the script and returns the SHA1 of it.
#[inline]
pub fn load(&self, con: &mut dyn ConnectionLike) -> RedisResult<String> {
let hash: String = self.load_cmd().query(con)?;

debug_assert_eq!(hash, self.script.hash);

Ok(hash)
}

/// Asynchronously loads the script and returns the SHA1 of it.
#[inline]
#[cfg(feature = "aio")]
pub async fn load_async<C>(&self, con: &mut C) -> RedisResult<String>
where
C: crate::aio::ConnectionLike,
{
let hash: String = self.load_cmd().query_async(con).await?;

debug_assert_eq!(hash, self.script.hash);

Ok(hash)
}

fn load_cmd(&self) -> Cmd {
let mut cmd = cmd("SCRIPT");
djc marked this conversation as resolved.
Show resolved Hide resolved
cmd.arg("LOAD").arg(self.script.code.as_bytes());
cmd
}

fn eval_cmd(&self) -> Cmd {
let mut cmd = cmd("EVALSHA");
djc marked this conversation as resolved.
Show resolved Hide resolved
cmd.arg(self.script.hash.as_bytes())
.arg(self.keys.len())
.arg(&*self.keys)
.arg(&*self.args);
cmd
}
}
14 changes: 14 additions & 0 deletions tests/test_async.rs
Expand Up @@ -350,6 +350,20 @@ fn test_script() {
.unwrap();
}

#[test]
#[cfg(feature = "script")]
fn test_script_load() {
let ctx = TestContext::new();
let script = redis::Script::new("return 'Hello World'");

block_on_all(async move {
let mut con = ctx.multiplexed_async_connection().await.unwrap();

let hash = script.prepare_invoke().load_async(&mut con).await.unwrap();
assert_eq!(hash, script.get_hash().to_string());
});
}

#[test]
#[cfg(feature = "script")]
fn test_script_returning_complex_type() {
Expand Down
16 changes: 16 additions & 0 deletions tests/test_async_async_std.rs
Expand Up @@ -286,6 +286,22 @@ fn test_script() {
.unwrap();
}

#[test]
#[cfg(feature = "script")]
fn test_script_load() {
let ctx = TestContext::new();
let mut con = ctx.connection();

let script = redis::Script::new("return 'Hello World'");

block_on_all(async move {
let mut con = ctx.multiplexed_async_connection_async_std().await.unwrap();
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did you change these to unwrap()?

Copy link
Contributor Author

@zhiburt zhiburt May 12, 2022

Choose a reason for hiding this comment

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

To fix the build :) (I may mistaken but it was necessary to specify a Result::Err type)

Do you think it matters?


let hash = script.prepare_invoke().load_async(&mut con).await.unwrap();
assert_eq!(hash, script.get_hash().to_string());
});
}

#[test]
#[cfg(feature = "script")]
fn test_script_returning_complex_type() {
Expand Down
13 changes: 13 additions & 0 deletions tests/test_basic.rs
Expand Up @@ -677,6 +677,19 @@ fn test_script() {
assert_eq!(response, Ok(("foo".to_string(), 42)));
}

#[test]
#[cfg(feature = "script")]
fn test_script_load() {
let ctx = TestContext::new();
let mut con = ctx.connection();

let script = redis::Script::new("return 'Hello World'");

let hash = script.prepare_invoke().load(&mut con);

assert_eq!(hash, Ok(script.get_hash().to_string()));
}

#[test]
fn test_tuple_args() {
let ctx = TestContext::new();
Expand Down