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.

Sign up for GitHub

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

[Backport 1.19] fix: List functions handle invalid zero position #973

Merged
merged 2 commits into from
Jan 21, 2025
Merged

[Backport 1.19] fix: List functions handle invalid zero position #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68dbd9e
test: Verify list functions with zero position
saig0 Jan 16, 2025
9a079f9
fix: List functions handle invalid position
saig0 Jan 16, 2025
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
50 changes: 31 additions & 19 deletions src/main/scala/org/camunda/feel/impl/builtin/ListBuiltinFunctions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,20 +275,26 @@ class ListBuiltinFunctions(private val valueMapper: ValueMapper) {
private def sublistFunction =
builtinFunction(
params = List("list", "start"),
invoke = { case List(ValList(list), ValNumber(start)) =>
ValList(list.slice(listIndex(list, start.intValue), list.length))
invoke = {
case List(ValList(_), ValNumber(start)) if start == 0 =>
ValError("start position must be a non-zero number")
case List(ValList(list), ValNumber(start)) =>
ValList(list.slice(listIndex(list, start.intValue), list.length))
}
)

private def sublistFunction3 = builtinFunction(
params = List("list", "start", "length"),
invoke = { case List(ValList(list), ValNumber(start), ValNumber(length)) =>
ValList(
list.slice(
listIndex(list, start.intValue),
listIndex(list, start.intValue) + length.intValue
invoke = {
case List(ValList(_), ValNumber(start), ValNumber(_)) if start == 0 =>
ValError("start position must be a non-zero number")
case List(ValList(list), ValNumber(start), ValNumber(length)) =>
ValList(
list.slice(
listIndex(list, start.intValue),
listIndex(list, start.intValue) + length.intValue
)
)
)
}
)

Expand Down Expand Up @@ -325,23 +331,29 @@ class ListBuiltinFunctions(private val valueMapper: ValueMapper) {

private def insertBeforeFunction = builtinFunction(
params = List("list", "position", "newItem"),
invoke = { case List(ValList(list), ValNumber(position), newItem: Val) =>
ValList(
list
.take(listIndex(list, position.intValue)) ++ (newItem :: Nil) ++ list
.drop(listIndex(list, position.intValue))
)
invoke = {
case List(ValList(_), ValNumber(position), _) if position == 0 =>
ValError("position must be a non-zero number")
case List(ValList(list), ValNumber(position), newItem: Val) =>
ValList(
list
.take(listIndex(list, position.intValue)) ++ (newItem :: Nil) ++ list
.drop(listIndex(list, position.intValue))
)
}
)

private def removeFunction = builtinFunction(
params = List("list", "position"),
invoke = { case List(ValList(list), ValNumber(position)) =>
ValList(
list.take(listIndex(list, position.intValue)) ++ list.drop(
listIndex(list, position.intValue + 1)
invoke = {
case List(ValList(_), ValNumber(position)) if position == 0 =>
ValError("position must be a non-zero number")
case List(ValList(list), ValNumber(position)) =>
ValList(
list.take(listIndex(list, position.intValue)) ++ list.drop(
listIndex(list, position.intValue + 1)
)
)
)
}
)

Expand Down
37 changes: 33 additions & 4 deletions src/test/scala/org/camunda/feel/impl/builtin/BuiltinListFunctionsTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,10 @@ package org.camunda.feel.impl.builtin

import org.scalatest.matchers.should.Matchers
import org.scalatest.flatspec.AnyFlatSpec
import org.camunda.feel._
import org.camunda.feel.api.EvaluationFailureType.FUNCTION_INVOCATION_FAILURE
import org.camunda.feel.impl.{EvaluationResultMatchers, FeelEngineTest, FeelIntegrationTest}
import org.camunda.feel.syntaxtree._
import org.camunda.feel.impl.{EvaluationResultMatchers, FeelEngineTest}

import java.time.LocalDate
import scala.math.BigDecimal.int2bigDecimal

/** @author
* Philipp
Expand Down Expand Up @@ -257,6 +254,21 @@ class BuiltinListFunctionsTest
evaluateExpression(" sublist([1,2,3], 1, 2) ") should returnResult(List(1, 2))
}

it should "return null if the start position is 0" in {

evaluateExpression(" sublist([1,2,3], 0) ") should (returnNull() and reportFailure(
failureType = FUNCTION_INVOCATION_FAILURE,
failureMessage =
"Failed to invoke function 'sublist': start position must be a non-zero number"
))

evaluateExpression(" sublist([1,2,3], 0, 2) ") should (returnNull() and reportFailure(
failureType = FUNCTION_INVOCATION_FAILURE,
failureMessage =
"Failed to invoke function 'sublist': start position must be a non-zero number"
))
}

"A append() function" should "return list with item appended" in {

evaluateExpression(" append([1,2], 3) ") should returnResult(List(1, 2, 3))
Expand All @@ -274,11 +286,28 @@ class BuiltinListFunctionsTest
evaluateExpression(" insert before([1,3],2,2) ") should returnResult(List(1, 2, 3))
}

it should "return null if the position is 0" in {

evaluateExpression(" insert before([1,3],0,2) ") should (returnNull() and reportFailure(
failureType = FUNCTION_INVOCATION_FAILURE,
failureMessage =
"Failed to invoke function 'insert before': position must be a non-zero number"
))
}

"A remove() function" should "return list with item at _ removed" in {

evaluateExpression(" remove([1,1,3],2) ") should returnResult(List(1, 3))
}

it should "return null if the position is 0" in {

evaluateExpression(" remove([1,2,3], 0) ") should (returnNull() and reportFailure(
failureType = FUNCTION_INVOCATION_FAILURE,
failureMessage = "Failed to invoke function 'remove': position must be a non-zero number"
))
}

"A reverse() function" should "reverse the list" in {

evaluateExpression(" reverse([1,2,3]) ") should returnResult(List(3, 2, 1))
Expand Down
Loading