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

Fix ordering of script argument interpolation #112

Merged
merged 4 commits into from
Jun 3, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions nri-redis/src/Redis/Script.hs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ module Redis.Script
Tokens (..),
ScriptParam (..),
HasScriptParam (..),
printScript,
)
where

Expand Down Expand Up @@ -201,8 +200,8 @@ scriptFromEvaluatedTokens quasiQuotedString' evaluatedTokens =
in Script
{ luaScript = buffer script',
quasiQuotedString = quasiQuotedString',
keys = keyList script',
arguments = Log.mkSecret (argList script')
keys = List.reverse (keyList script'),
arguments = Log.mkSecret (List.reverse (argList script'))
}

-----------------------------
Expand Down Expand Up @@ -275,12 +274,3 @@ toHex bytes =
|> List.map (Text.Printf.printf "%02x")
|> List.concat
|> Text.fromList

---------------------------------------------
-- Helper functions for testing
---------------------------------------------

printScript :: Script a -> Text
printScript Script {luaScript, quasiQuotedString, keys, arguments} =
let listStr l = List.map (\s -> "\"" ++ s ++ "\"") l |> Text.join ", "
in "Script { luaScript = \"" ++ luaScript ++ "\", quasiQuotedString = \"" ++ quasiQuotedString ++ "\", keys = [" ++ listStr keys ++ "], arguments = [" ++ listStr (Log.unSecret arguments) ++ "] }"
6 changes: 4 additions & 2 deletions nri-redis/test/Spec/Redis.hs
Original file line number Diff line number Diff line change
Expand Up @@ -400,9 +400,11 @@ queryTests redisHandler =
[Redis.script|
local a = ${Redis.Key 2}
local b = ${Redis.Literal 3}
return b|]
local c = ${Redis.Literal 4}
local d = ${Redis.Literal 5}
return {b, c, d}|]
result <- Redis.eval testNS script |> Expect.succeeds
Expect.equal result 3,
Expect.equal result [3, 4, 5],
Test.test "eval with arguments namespaces key" <| \() -> do
let script = [Redis.script|return ${Redis.Key "hi"}|]
(result :: Text) <- Redis.eval testNS script |> Expect.succeeds
Expand Down
50 changes: 46 additions & 4 deletions nri-redis/test/Spec/Redis/Script.hs
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,54 @@ thTests :: List Test.Test
thTests =
[ Test.test "just text" <| \_ ->
[script|some text|]
|> printScript
|> Expect.equal "Script { luaScript = \"some text\", quasiQuotedString = \"some text\", keys = [], arguments = [] }",
|> Expect.equal
( Script
{ luaScript = "some text",
quasiQuotedString = "some text",
keys = [],
arguments = Log.mkSecret []
}
),
Test.test "one key argument" <| \_ ->
[script|${Key "hi"}|]
|> printScript
|> Expect.equal "Script { luaScript = \"KEYS[1]\", quasiQuotedString = \"${Key \"hi\"}\", keys = [\"hi\"], arguments = [] }",
|> Expect.equal
( Script
{ luaScript = "KEYS[1]",
quasiQuotedString = "${Key \"hi\"}",
keys = ["hi"],
arguments = Log.mkSecret []
}
),
Test.test "one literal argument" <| \_ ->
[script|${Literal "hi"}|]
|> Expect.equal
( Script
{ luaScript = "ARGV[1]",
quasiQuotedString = "${Literal \"hi\"}",
keys = [],
arguments = Log.mkSecret ["hi"]
}
),
Test.test "one key one literal argument" <| \_ ->
[script|${Key "a key"} ${Literal "a literal"}|]
|> Expect.equal
( Script
{ luaScript = "KEYS[1] ARGV[1]",
quasiQuotedString = "${Key \"a key\"} ${Literal \"a literal\"}",
keys = ["a key"],
arguments = Log.mkSecret ["a literal"]
}
),
Test.test "multiple keys and literals" <| \_ ->
[script|${Key "key1"} ${Key "key2"} ${Key "key3"} ${Literal "literal1"} ${Literal "literal2"} ${Literal "literal3"}|]
|> Expect.equal
( Script
{ luaScript = "KEYS[1] KEYS[2] KEYS[3] ARGV[1] ARGV[2] ARGV[3]",
quasiQuotedString = "${Key \"key1\"} ${Key \"key2\"} ${Key \"key3\"} ${Literal \"literal1\"} ${Literal \"literal2\"} ${Literal \"literal3\"}",
keys = ["key1", "key2", "key3"],
arguments = Log.mkSecret ["literal1", "literal2", "literal3"]
}
),
Test.test "fails on type-checking when not given Key or Literal" <| \_ ->
[script|${False}|]
|> arguments
Expand Down
Loading