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

[READY FOR MERGE] - implement full jmespath support in codegen for downstream AWS SDK v2 #523

Merged
merged 3 commits into from
Jul 17, 2024

Conversation

lucix-aws
Copy link
Contributor

@lucix-aws lucix-aws commented Jul 10, 2024

  • Builds out support for additional jmespath expressions required by AWS SDK v2.
    • The traversal pattern was beefed up in general - a Variable is now the input and output of a traversed expression, as well as the result of each intermediate phase.
  • Consumes jmespath codegen in waiters integration.

This implementation was verified by re-generating the public SDKs and ensuring that they compiled.

This PR should not be merged as-is. It was submitted in this state such that the diff for the waiters integration was most easily read. We intend to do a trial rollout of the new waiter implementation downstream for the EC2 service. Before merging this PR we must do the following:

  • copy over the entire new waiters logic to a new Waiters2 etc. implementation
  • restore the old implementation

Closes #238

@lucix-aws lucix-aws requested review from a team as code owners July 10, 2024 14:12
Copy link
Contributor

@Madrigal Madrigal left a comment

Choose a reason for hiding this comment

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

General comment/clarification

  1. This is so we can get rid of the jmespath dependency. This is currently not required for Smithy support, since that only has a subset of jmespath, right?
  2. Does this aim to be comprehensive of all jmespath specification?

}

private Result visit(JmespathExpression expr, Shape current) {
private Variable visit(JmespathExpression expr, Variable current) {
if (expr instanceof FunctionExpression tExpr) {
Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] now that we have like 10 if-else it would really be nice to enable pattern matching https://www.baeldung.com/java-switch-pattern-matching

However I don't think we need to prioritize it, would just be cool

private Variable visitFilterProjection(FilterProjectionExpression expr, Variable current) {
var unfiltered = visitProjection(new ProjectionExpression(expr.getLeft(), expr.getRight()), current);
if (!(unfiltered.shape instanceof CollectionShape unfilteredCol)) {
throw new CodegenException("projection did not create a list");
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add expr to the Codegen exception so we know which projection failed to create a list?

private Variable visitLiteral(LiteralExpression expr) {
var ident = nextIdent();
if (expr.isNumberValue()) {
// FUTURE: recognize floating-point, for now we just use int
Copy link
Contributor

Choose a reason for hiding this comment

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

is it safe to leave this as future?

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 -- would fail at compile time in the result.


// inner HAS to be a list by spec, otherwise something is wrong
if (!(inner.shape instanceof CollectionShape innerList)) {
throw new CodegenException("left side of projection did not create a list");
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add the expression to the exception message that failed to create a list?

++idIndex;
var ident = nextIdent();
// projections implicitly filter out nil evaluations of RHS
var needsDeref = isPointable(lookahead.type);
Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] can we move this closer to where it's used?

for _, v := range v1 {
v3 := v.Key
if v3 != nil {
v2 = append(v2, *v3)
Copy link
Contributor

Choose a reason for hiding this comment

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

are these string guaranteed to be string pointers all the time?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No -- the projection routine checks for that and generates the check accordingly (it's the needsDeref thing).

}

@Test
public void testComparatorStringLHSNil() {
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't follow how LHS is nil here here :(

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Shapes are nilable by default for cross-language compatibility - so since output.nested.nestedField is just a plain String shape, we generate it as nilable.

v2 := input.Nested
v3 := v2.NestedField
var v4 bool
if v3 != nil {
Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] is the extra space expected

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 -- side effect of the template being $L $L $L where some of the format args can be empty (in this case, only both operands being nilable will result in all three being set). gofmt gets rid of it.


@Test
public void testNot() {
var expr = "objectList[?!(length(innerObjectList) > `0`)]";
Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] I'd prefer to use a value that is not 0, since this could hide any bug we may introduce later on by just using int defaults

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed one of them to 99. Note we do have a test in here somewhere that basically checks 0 < x <= 10, so it was covering the nondefault case.

@lucix-aws
Copy link
Contributor Author

lucix-aws commented Jul 15, 2024

This is so we can get rid of the jmespath dependency. This is currently not required for Smithy support, since that only has a subset of jmespath, right?

I don't think there are any restrictions on the jmespath syntax used in waiters. Docs do not seem to convey any.

Does this aim to be comprehensive of all jmespath specification?

No -- there are still unhandled expressions. Those would be caught at codegen time.

@lucix-aws lucix-aws changed the title [DO NOT MERGE] - implement full jmespath support in codegen for downstream AWS SDK v2 [READY FOR MERGE] - implement full jmespath support in codegen for downstream AWS SDK v2 Jul 16, 2024
@@ -0,0 +1,763 @@
/*
* Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copy link
Contributor

Choose a reason for hiding this comment

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

String waiterName
) {
waiterName = StringUtils.capitalize(waiterName);
return String.format("%sWaiterOptions", waiterName);
Copy link
Contributor

Choose a reason for hiding this comment

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

[tiny nit] Java can be simpler and just do return waiterName + "WaiterOptions"

@lucix-aws lucix-aws merged commit 3cc78c0 into main Jul 17, 2024
11 checks passed
@lucix-aws lucix-aws deleted the feat-jmespath2 branch July 17, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

refactor smithy-waiters to remove jmespath dependency at runtime
3 participants