[feat] Import examples from aws-samples/aws-lambda-powertools-examples by scottgerring · Pull Request #1051 · aws-powertools/powertools-lambda-java

scottgerring · 2023-02-15T12:48:01Z

Issue #, if available:
#1050

Description of changes:

Moving the samples from https://github.com/aws-samples/aws-lambda-powertools-examples into the repository. This will help make the samples more discoverable, allow us to keep them up-to-date with the powertools themselves, and follow the pattern established by the python powertools.

Checklist

Meet tenets criteria
Update tests
Update docs
PR title follows conventional commit semantics

Detailed Description

The code is lifted verbatim from the old repository. I've tied it all together into one big maven build tree, and introduced an intermediate pom in the examples project. This has included some effort to restructure the examples themselves so they match the general maven project structure.

Breaking change checklist

RFC issue #:

Migration process documented
Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

scottgerring · 2023-02-15T12:50:03Z

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>


Introducing an intermediate parent pom to aggregate the samples together

scottgerring · 2023-02-15T12:50:29Z

@@ -0,0 +1,138 @@
+# CoreUtilities


These and the rest of the concrete samples have simply been lifted from main from the linked samples repository.

https://github.com/aws-samples/aws-lambda-powertools-examples

scottgerring · 2023-02-15T12:54:10Z

        <module>powertools-cloudformation</module>
-        <module>powertools-idempotency</module>
+        <module>powertools-idempotency</module> 
+        <module>examples</module>


Discussion point: do we want the samples to be build as part of the main project reactor here?
It makes the build easier, and we can simply choose not to release the examples project.

What's the build time? Does it have any side effects?
If there are no issues with mentioned above questions, I believe that it's good to have it built as a part of build process to have quick feedback when some changes are done in the project (version of PowerTools used in examples might be an issue here...)

Build time: +approx 45s, 3:30 up from 2:44

The only other side-effect I can see is that changes to the powertools that break the examples will have to fix the examples, but I'd say that is desirable!

Yes, that would be desirable, we'd have a mechanism to keep the samples up to date.

scottgerring · 2023-02-15T12:54:50Z

        <Class name="software.amazon.lambda.powertools.logging.internal.LambdaLoggingAspect"/>
        <Method name="setLogLevelBasedOnSamplingRate"/>
    </Match>
+    <Match>


Spotbugs wasn't run on the examples previously. This lint comes from the original projects and I have not yet corrected it.

scottgerring · 2023-02-16T09:22:54Z

            <id>build-with-spotbugs</id>
            <activation>
-                <activeByDefault>true</activeByDefault>
+                <activeByDefault>false</activeByDefault>


I've turned this off by default, as it 1/ helps with the SAM tooling for the examples and 2/ speeds up local builds that haven't opted into it.

The github workflows explicitly activate and de-activate these using the profiles, so it has no impact on CI.

jeromevdl

Should the example poms have the examples/pom.xml as parent or the lambda-powertools root pom?

(See my other comments)

scottgerring · 2023-02-20T17:03:49Z

Should the example poms have the examples/pom.xml as parent or the lambda-powertools root pom?

(See my other comments)

yes - silly mistake - some were, some weren't. fixed.

kozub · 2023-02-21T10:26:51Z

Looks good to me.

One minor suggestion:

I think that we might change names of 2 examples packages in theirs pom.xml to have it more consistent.

Right now when we run all tests it produces logs (please ignore info about failing test):

[INFO] Reactor Summary for AWS Lambda Powertools for Java library Parent 1.14.0:
[INFO]
[INFO] AWS Lambda Powertools for Java library Parent ...... SUCCESS [  0.311 s]
[INFO] AWS Lambda Powertools for Java library Core ........ SUCCESS [  2.522 s]
[INFO] AWS Lambda Powertools for Java library Serialization Utilities SUCCESS [  2.596 s]
[INFO] AWS Lambda Powertools for Java library Logging ..... SUCCESS [  3.538 s]
[INFO] AWS Lambda Powertools for Java library Tracing ..... SUCCESS [  2.695 s]
[INFO] AWS Lambda Powertools for Java library SQS ......... SUCCESS [  2.864 s]
[INFO] AWS Lambda Powertools for Java library Metrics ..... SUCCESS [  2.440 s]
[INFO] AWS Lambda Powertools for Java library Parameters .. SUCCESS [  3.165 s]
[INFO] AWS Lambda Powertools for Java validation library .. SUCCESS [  3.167 s]
[INFO] AWS Lambda Powertools for Java library Test Suite .. SUCCESS [  2.547 s]
[INFO] AWS Lambda Powertools for Java library Cloudformation SUCCESS [  2.086 s]
[INFO] AWS Lambda Powertools for Java library Idempotency . SUCCESS [  4.064 s]
[INFO] AWS Lambda Powertools for Java library Examples .... SUCCESS [  0.004 s]
[INFO] A sample Hello World created for SAM CLI using powertools core utilities SUCCESS [  3.381 s]
[INFO] A sample Hello World using powertools idempotency .. FAILURE [  8.181 s]
[INFO] Sample app demoing parameters utility of Powertools. SKIPPED
[INFO] Sample app demoing serialization utility of Powertools. SKIPPED
[INFO] Sample app demoing SQS Batch Processing utility of Powertools. SKIPPED
[INFO] Sample app demoing validation utility of Powertools. SKIPPED

scottgerring · 2023-02-21T11:49:21Z

Looks good to me.

One minor suggestion:

I think that we might change names of 2 examples packages in theirs pom.xml to have it more consistent.

Right now when we run all tests it produces logs (please ignore info about failing test):

[INFO] Reactor Summary for AWS Lambda Powertools for Java library Parent 1.14.0:
[INFO]
[INFO] AWS Lambda Powertools for Java library Parent ...... SUCCESS [  0.311 s]
[INFO] AWS Lambda Powertools for Java library Core ........ SUCCESS [  2.522 s]
[INFO] AWS Lambda Powertools for Java library Serialization Utilities SUCCESS [  2.596 s]
[INFO] AWS Lambda Powertools for Java library Logging ..... SUCCESS [  3.538 s]
[INFO] AWS Lambda Powertools for Java library Tracing ..... SUCCESS [  2.695 s]
[INFO] AWS Lambda Powertools for Java library SQS ......... SUCCESS [  2.864 s]
[INFO] AWS Lambda Powertools for Java library Metrics ..... SUCCESS [  2.440 s]
[INFO] AWS Lambda Powertools for Java library Parameters .. SUCCESS [  3.165 s]
[INFO] AWS Lambda Powertools for Java validation library .. SUCCESS [  3.167 s]
[INFO] AWS Lambda Powertools for Java library Test Suite .. SUCCESS [  2.547 s]
[INFO] AWS Lambda Powertools for Java library Cloudformation SUCCESS [  2.086 s]
[INFO] AWS Lambda Powertools for Java library Idempotency . SUCCESS [  4.064 s]
[INFO] AWS Lambda Powertools for Java library Examples .... SUCCESS [  0.004 s]
[INFO] A sample Hello World created for SAM CLI using powertools core utilities SUCCESS [  3.381 s]
[INFO] A sample Hello World using powertools idempotency .. FAILURE [  8.181 s]
[INFO] Sample app demoing parameters utility of Powertools. SKIPPED
[INFO] Sample app demoing serialization utility of Powertools. SKIPPED
[INFO] Sample app demoing SQS Batch Processing utility of Powertools. SKIPPED
[INFO] Sample app demoing validation utility of Powertools. SKIPPED

I've changed the example project names to match the general format, and i've put a publish exclusion on them so they don't end up in maven central.

scottgerring · 2023-02-22T06:52:58Z

Created change in aws-samples/aws-lambda-powertools-examples/pull/296 to forward viewers onto the samples here.

jeromevdl

Good for me

scottgerring added 14 commits February 15, 2023 11:07

Pull in examples code

fa45f7f

Add actions for examples build

c1f6af1

Fix action name

ee0abc7

Enable builds temporarily for import-examples branch

a23389a

Put workflow where it belongs

e118ca1

Rename examples projects to reflect java module names

7113ce2

Incorporate examples into mvn hierarchy

54a6fd6

Turn on builds temporarily for this branch

557fc13

Remove build overrides in examples

0d9d1f1

Rebuild on examples

f7c34e2

Add validation back and remove redundant groupId from examples poms

b46d862

Test - is it only java 8 versions?

677fce3

Fix pom mistake

b106353

Add missing pom to rebuild triggers

4fe275c

pull-request-size Bot added the size/XXL label Feb 15, 2023

scottgerring commented Feb 15, 2023

View reviewed changes

Comment thread README.md Outdated

Remove redundant manifest

d344225

scottgerring commented Feb 15, 2023

View reviewed changes

Comment thread .github/workflows/build.yml

scottgerring commented Feb 15, 2023

View reviewed changes

stevehouel reviewed Feb 15, 2023

View reviewed changes

Comment thread examples/powertools-examples-sqs/src/main/java/org/demo/sqs/SqsMessageSender.java Outdated

Comment thread examples/powertools-examples-sqs/src/main/java/org/demo/sqs/SqsPoller.java Outdated

scottgerring added 6 commits February 15, 2023 14:19

Java-8ify serialization example

0dc2c3e

Another back-to-java-8 change

d985bc3

Fix syntax error

a24d00b

Fix type error

455df76

Downgrade mocks in examples so they'll run on Java 1.8

1c9b791

Fix SAM builds

3062dbb

scottgerring commented Feb 16, 2023

View reviewed changes