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

coerce nil numbers to 0 in jmespath codegen #565

Merged
merged 3 commits into from
Jan 23, 2025
Merged

coerce nil numbers to 0 in jmespath codegen #565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4344f6
coerce nil numbers to 0 in jmespath codegen
lucix-aws Jan 22, 2025
1357344
only order cmp
lucix-aws Jan 23, 2025
1e4fa56
sigh
lucix-aws Jan 23, 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
52 changes: 50 additions & 2 deletions ...odegen/src/main/java/software/amazon/smithy/go/codegen/GoJmespathExpressionGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

package software.amazon.smithy.go.codegen;

import static software.amazon.smithy.go.codegen.GoWriter.emptyGoTemplate;
import static software.amazon.smithy.go.codegen.GoWriter.goTemplate;
import static software.amazon.smithy.go.codegen.SymbolUtils.isNilable;
import static software.amazon.smithy.go.codegen.SymbolUtils.isPointable;
Expand Down Expand Up @@ -407,11 +408,48 @@ private GoWriter.Writable compareVariables(String ident, Variable left, Variable
return goTemplate("$1L := $5L($2L) $4L $5L($3L)", ident, left.ident, right.ident, cmp, cast);
}

// undocumented jmespath behavior: null in numeric _ordering_ comparisons coerces to 0
// this means the subsequent nil checks for numerics are moot, but it's either this or branch the codegen even
// further for questionable benefit
var nilCoerceLeft = emptyGoTemplate();
var nilCoerceRight = emptyGoTemplate();
if (isOrderComparator(cmp)) {
if (isLPtr && left.shape instanceof NumberShape) {
nilCoerceLeft = goTemplate("""
if ($1L == nil) {
$1L = new($2T)
*$1L = 0
}""", left.ident, left.type);
}
if (isRPtr && right.shape instanceof NumberShape) {
nilCoerceRight = goTemplate("""
if ($1L == nil) {
$1L = new($2T)
*$1L = 0
}""", right.ident, right.type);
}
}

// also, if they're both pointers, and it's (in)equality, there's an additional true case where both are nil,
// or both are different
var elseCheckPtrs = emptyGoTemplate();
if (isLPtr && isRPtr) {
if (cmp == ComparatorType.EQUAL) {
elseCheckPtrs = goTemplate("else { $L = $L == nil && $L == nil }",
ident, left.ident, right.ident);
} else if (cmp == ComparatorType.NOT_EQUAL) {
elseCheckPtrs = goTemplate("else { $1L = ($2L == nil && $3L != nil) || ($2L != nil && $3L == nil) }",
ident, left.ident, right.ident);
}
}

return goTemplate("""
var $ident:L bool
$nilCoerceLeft:W
$nilCoerceRight:W
if $lif:L $amp:L $rif:L {
$ident:L = $cast:L($lhs:L) $cmp:L $cast:L($rhs:L)
}""",
}$elseCheckPtrs:W""",
Map.of(
"ident", ident,
"lif", isLPtr ? left.ident + " != nil" : "",
Expand All @@ -420,10 +458,20 @@ private GoWriter.Writable compareVariables(String ident, Variable left, Variable
"cmp", cmp,
"lhs", isLPtr ? "*" + left.ident : left.ident,
"rhs", isRPtr ? "*" + right.ident : right.ident,
"cast", cast
"cast", cast,
"nilCoerceLeft", nilCoerceLeft,
"nilCoerceRight", nilCoerceRight
),
Map.of(
"elseCheckPtrs", elseCheckPtrs
));
}

private static boolean isOrderComparator(ComparatorType cmp) {
Copy link
Contributor

Choose a reason for hiding this comment

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

rant (?), non-blocking: I wouldn't know how to name this function so I would get "comparisons excluding direct equality check" without reading inside it. TIL they are technically called "inequalities"link but I'd definitely be thinking != with that name.

(order comparator is fine BTW)

return cmp == ComparatorType.GREATER_THAN || cmp == ComparatorType.LESS_THAN
|| cmp == ComparatorType.GREATER_THAN_EQUAL || cmp == ComparatorType.LESS_THAN_EQUAL;
}

/**
* Represents a variable (input, intermediate, or final output) of a JMESPath traversal.
* @param shape The underlying shape referenced by this variable. For certain jmespath expressions (e.g.
Expand Down
110 changes: 109 additions & 1 deletion ...en/src/test/java/software/amazon/smithy/go/codegen/GoJmespathExpressionGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ public class GoJmespathExpressionGeneratorTest {
objectList: ObjectList
objectMap: ObjectMap
nested: NestedStruct
nullableIntegerA: Integer
nullableIntegerB: Integer
}

structure Object {
Expand Down Expand Up @@ -318,6 +320,7 @@ public void testComparatorStringLHSNil() {
}
v4 := "foo"
var v5 bool

if v2 != nil {
v5 = string(*v2) == string(v4)
}
Expand Down Expand Up @@ -345,6 +348,7 @@ public void testComparatorStringRHSNil() {
v3 = v4
}
var v5 bool

if v3 != nil {
v5 = string(v1) == string(*v3)
}
Expand Down Expand Up @@ -372,9 +376,10 @@ public void testComparatorStringBothNil() {
}
v4 := input.SimpleShape
var v5 bool

if v2 != nil && v4 != nil {
v5 = string(*v2) == string(*v4)
}
}else { v5 = v2 == nil && v4 == nil }
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, gofmt will handle this.

"""));
}

Expand Down Expand Up @@ -546,4 +551,107 @@ public void testMultiSelectFlatten() {
}
"""));
}

@Test
public void testOrderComparatorNumberCoercesLeftNullable() {
var expr = "nullableIntegerA > `9`";

var writer = testWriter();
var generator = new GoJmespathExpressionGenerator(testContext(), writer);
var actual = generator.generate(JmespathExpression.parse(expr), new GoJmespathExpressionGenerator.Variable(
TEST_MODEL.expectShape(ShapeId.from("smithy.go.test#Struct")),
"input"
));
assertThat(actual.shape().toShapeId().toString(), Matchers.equalTo("smithy.api#PrimitiveBoolean"));
assertThat(actual.ident(), Matchers.equalTo("v3"));
assertThat(writer.toString(), Matchers.containsString("""
v1 := input.NullableIntegerA
v2 := 9
var v3 bool
if (v1 == nil) {
v1 = new(int32)
*v1 = 0
}

if v1 != nil {
v3 = int64(*v1) > int64(v2)
}
"""));
}

@Test
public void testOrderComparatorNumberCoercesBothNullable() {
var expr = "nullableIntegerA > nullableIntegerB";

var writer = testWriter();
var generator = new GoJmespathExpressionGenerator(testContext(), writer);
var actual = generator.generate(JmespathExpression.parse(expr), new GoJmespathExpressionGenerator.Variable(
TEST_MODEL.expectShape(ShapeId.from("smithy.go.test#Struct")),
"input"
));
assertThat(actual.shape().toShapeId().toString(), Matchers.equalTo("smithy.api#PrimitiveBoolean"));
assertThat(actual.ident(), Matchers.equalTo("v3"));
assertThat(writer.toString(), Matchers.containsString("""
v1 := input.NullableIntegerA
v2 := input.NullableIntegerB
var v3 bool
if (v1 == nil) {
v1 = new(int32)
*v1 = 0
}
if (v2 == nil) {
v2 = new(int32)
*v2 = 0
}
if v1 != nil && v2 != nil {
v3 = int64(*v1) > int64(*v2)
}
"""));
}

@Test
public void testEqualBothNullable() {
var expr = "nullableIntegerA == nullableIntegerB";

var writer = testWriter();
var generator = new GoJmespathExpressionGenerator(testContext(), writer);
var actual = generator.generate(JmespathExpression.parse(expr), new GoJmespathExpressionGenerator.Variable(
TEST_MODEL.expectShape(ShapeId.from("smithy.go.test#Struct")),
"input"
));
assertThat(actual.shape().toShapeId().toString(), Matchers.equalTo("smithy.api#PrimitiveBoolean"));
assertThat(actual.ident(), Matchers.equalTo("v3"));
assertThat(writer.toString(), Matchers.containsString("""
v1 := input.NullableIntegerA
v2 := input.NullableIntegerB
var v3 bool

if v1 != nil && v2 != nil {
v3 = int64(*v1) == int64(*v2)
}else { v3 = v1 == nil && v2 == nil }
"""));
}

@Test
public void testNotEqualBothNullable() {
var expr = "nullableIntegerA != nullableIntegerB";

var writer = testWriter();
var generator = new GoJmespathExpressionGenerator(testContext(), writer);
var actual = generator.generate(JmespathExpression.parse(expr), new GoJmespathExpressionGenerator.Variable(
TEST_MODEL.expectShape(ShapeId.from("smithy.go.test#Struct")),
"input"
));
assertThat(actual.shape().toShapeId().toString(), Matchers.equalTo("smithy.api#PrimitiveBoolean"));
assertThat(actual.ident(), Matchers.equalTo("v3"));
assertThat(writer.toString(), Matchers.containsString("""
v1 := input.NullableIntegerA
v2 := input.NullableIntegerB
var v3 bool

if v1 != nil && v2 != nil {
v3 = int64(*v1) != int64(*v2)
}else { v3 = (v1 == nil && v2 != nil) || (v1 != nil && v2 == nil) }
"""));
}
}
Loading