Create secondary indices based on table bean annotations (#3923)

[breader124]

Allow creation of secondary indices based on annotations put on beans

Motivation and Context

This changes solves the problem described in the #3923

Modifications

I've implemented the mechanism that inside the createTable() method of the DefaultDynamoDbTable class takes the tableSchema field and uses it to come up with the list of LSIs and GSIs in the table's schema. They are distinguished based on the fact that primary partition key of the table should be the same attribute as the partition key of the LSI. If that's the true, then index is being mapped to LSI. Otherwise, it's treated as GSI and and will be mapped accordingly.

During the mapping there are no information about projections and provisioned throughput available (only applicable to GSIs). I believe that it should be the scope of another bunch of work to make it possible on the bean level to specify projections and desired provisioned throughput and that's why I tried to come up with some sensible defaults for now:

• for projections I used ProjectionType.ALL, it may incur some additional cost for people that wouldn't need it, but after all it'll allow to use the index for all imaginable cases
• for provisioned throughput I used the defaults of 20 RCUs and 20 WCUs

Testing

I've implemented additional tests in DefaultDynamoDbTableTest class to make sure that bugfix actually works. All tests executed while running ./mvnw package passed.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Checklist

• I have read the CONTRIBUTING document
• Local run of mvn install succeeds
• My code follows the code style of this project
• My change requires a change to the Javadoc documentation
• I have updated the Javadoc documentation accordingly
• I have added tests to cover my changes
• All new and existing tests passed
• I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
• My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

• I confirm that this pull request can be released under the Apache 2 license

[breader124]

I see you've been assigned as a reviewer @dagnir, would you find some time to give this PR a look, please?

[hamburml]

I need this :)

[L-Applin]

Some unit test are failing due to the createTable() method. Particularly, the BasicCrudTest class.

com.amazonaws.services.dynamodbv2.exceptions.DynamoDBLocalServiceException: GSI list is empty/invalid

Looking...

[L-Applin]

It seems that when no secondary indexes are specified, the create-request made is incorrect and includes empty list for secondary indexes:

@DynamoDbBean
public class Simple {

    private UUID id;
    private String status;
    private String type;

    @DynamoDbPartitionKey
    public UUID getId() {
        return id;
    }
    // other getters-setters ...
}

Also when the TableSchema is created statically like in the failing test case:

        docMappedtable = enhancedClient.table(tableName,
                                              TableSchema.documentSchemaBuilder()
                                                         .addIndexPartitionKey(TableMetadata.primaryIndexName(),
                                                                               "id",
                                                                               AttributeValueType.S)
                                                         .addIndexSortKey(TableMetadata.primaryIndexName(), "sort", AttributeValueType.S)
                                                         .attributeConverterProviders(defaultProvider())
                                                         .build());
        docMappedtable.createTable();

This should be fixed before merging, thanks.

[breader124]

I just fixed it. All unit tests for the services-custom/dynamodb-enhanced submodule are now passing

[L-Applin]

I just fixed it. All unit tests for the services-custom/dynamodb-enhanced submodule are now passing

Awesome, I'm re-running test now!

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

97.9% Coverage
0.0% Duplication

[L-Applin]

all checks passes, approved!

[debora-ito]

@all-contributors please add @breader124 for code.

[allcontributors]

@debora-ito

I've put up a pull request to add @breader124! 🎉