refactor: wait for the crypto key provider service to load before con…

saranyailla commented 1 year ago

…figuring the client

Issue #, if available:

Description of changes:

Wait for the crypto key provider service to be available before configuring the client by retrying for 3 times. If the service is still not available, then throw an exception.
The data plane client is removed when the any of the device config changes. So that getter on data plane client re-configures it waiting for the crypto key provider service to load. If the client already exists, we return the same in the getter without reconfiguring.
With this an exception called IoTDataPlaneClientCreationException (newly added with this PR) will be thrown when the client is not properly configured.
Any cloud request that throws IoTDataPlaneClientCreationException will be retried as the client is not configured.

Why is this change necessary: If the data plane client is configured before the crypto key provider service (such as pkcs provider component) is loaded, then data plane client will not be mTLS configured. This will make the requests using SDK throw SDKClientException due to SSLHandShakeException. These requests are always skipped and never retried.

How was this change tested:

Any additional information or context required to review the change:

Checklist:

[ ] Updated the README if applicable
[ ] Updated or added new unit tests
[ ] Updated or added new integration tests
[ ] If your code makes a remote network call, it was tested with a proxy

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

github-actions[bot] commented 1 year ago

Unit Tests Coverage Report

File	Coverage	Lines	Branches
All files	`85%`	`91%`	`80%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.LocalUpdateSyncRequest	`84%`	`88%`	`80%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.Direction	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.LocalDeleteSyncRequest	`99%`	`98%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.FullShadowSyncRequest	`84%`	`98%`	`71%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.CloudDeleteSyncRequest	`80%`	`78%`	`83%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.OverwriteCloudShadowRequest	`98%`	`95%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.BaseSyncRequest	`83%`	`93%`	`73%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.OverwriteLocalShadowRequest	`98%`	`95%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.CloudUpdateSyncRequest	`74%`	`76%`	`71%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.model.Operation	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.model.PubSubRequest	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.PeriodicSyncStrategy	`63%`	`77%`	`50%`	:x:
com.aws.greengrass.shadowmanager.sync.strategy.SyncStrategyFactory	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.BaseSyncStrategy	`87%`	`90%`	`85%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.RealTimeSyncStrategy	`93%`	`86%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.IotDataPlaneClientFactory	`55%`	`85%`	`25%`	:x:
com.aws.greengrass.shadowmanager.sync.RequestBlockingQueue	`96%`	`99%`	`93%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.SyncHandler	`71%`	`89%`	`53%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.IotDataPlaneClientWrapper	`91%`	`91%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.RequestMerger	`78%`	`76%`	`81%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.CloudDataClient	`74%`	`72%`	`77%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.configuration.ShadowSyncConfiguration	`87%`	`93%`	`82%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.configuration.ThingShadowSyncConfiguration	`76%`	`78%`	`75%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ShadowManagerDatabase	`0%`	`0%`	`0%`	:x:
com.aws.greengrass.shadowmanager.ShadowManager	`78%`	`84%`	`71%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ShadowManagerDAOImpl	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.AuthorizationHandlerWrapper	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.PubSubIntegrator	`89%`	`93%`	`86%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ShadowManager$1	`43%`	`43%`	`0%`	:x:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractDeleteThingShadowOperationHandler	`67%`	`67%`	`0%`	:white_check_mark:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractListNamedShadowsForThingOperationHandler	`67%`	`67%`	`0%`	:white_check_mark:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractUpdateThingShadowOperationHandler	`67%`	`67%`	`0%`	:white_check_mark:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractGetThingShadowOperationHandler	`67%`	`67%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.model.StrategyType	`86%`	`92%`	`80%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.model.Strategy	`90%`	`100%`	`80%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.JsonMerger	`94%`	`100%`	`89%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.SyncNodeMerger	`91%`	`98%`	`84%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.DataOwner	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.ShadowWriteSynchronizeHelper	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.Validator	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.JsonUtil	`95%`	`100%`	`90%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ResponseMessageBuilder	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowDocument	`81%`	`89%`	`73%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowStateMetadata	`93%`	`98%`	`89%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ErrorMessage	`75%`	`100%`	`50%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowRequest	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowState	`84%`	`87%`	`81%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.LogEvents	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.BaseRequestHandler	`77%`	`77%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.GetThingShadowRequestHandler	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.IpcRateLimiter	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.PubSubClientWrapper	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.UpdateThingShadowIPCHandler	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.InboundRateLimiter	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.InboundRateLimiter$1	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.DeleteThingShadowRequestHandler	`99%`	`99%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.UpdateThingShadowRequestHandler	`92%`	`95%`	`89%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.DeleteThingShadowIPCHandler	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.GetThingShadowIPCHandler	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.ListNamedShadowsForThingIPCHandler	`100%`	`100%`	`100%`	:white_check_mark:

Minimum allowed coverage is 65%

Generated by :monkey: cobertura-action against c1df956523479ea3c3c55552a483ffadb475a6f8

github-actions[bot] commented 1 year ago

Integration Tests Coverage Report

File	Coverage	Lines	Branches
All files	`63%`	`69%`	`57%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.LocalUpdateSyncRequest	`34%`	`47%`	`20%`	:x:
com.aws.greengrass.shadowmanager.sync.model.Direction	`83%`	`91%`	`75%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.LocalDeleteSyncRequest	`55%`	`59%`	`50%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.FullShadowSyncRequest	`49%`	`56%`	`41%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.CloudDeleteSyncRequest	`53%`	`55%`	`50%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.OverwriteCloudShadowRequest	`76%`	`76%`	`75%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.model.BaseSyncRequest	`43%`	`50%`	`36%`	:x:
com.aws.greengrass.shadowmanager.sync.model.OverwriteLocalShadowRequest	`33%`	`33%`	`0%`	:x:
com.aws.greengrass.shadowmanager.sync.model.CloudUpdateSyncRequest	`51%`	`51%`	`50%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.model.Operation	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.model.PubSubRequest	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.PeriodicSyncStrategy	`71%`	`92%`	`50%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.SyncStrategyFactory	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.BaseSyncStrategy	`75%`	`77%`	`73%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.RealTimeSyncStrategy	`83%`	`90%`	`75%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.IotDataPlaneClientFactory	`41%`	`33%`	`50%`	:x:
com.aws.greengrass.shadowmanager.sync.RequestBlockingQueue	`59%`	`69%`	`50%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.SyncHandler	`82%`	`94%`	`71%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.IotDataPlaneClientWrapper	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.RequestMerger	`24%`	`33%`	`16%`	:x:
com.aws.greengrass.shadowmanager.sync.CloudDataClient	`49%`	`45%`	`53%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.configuration.ShadowSyncConfiguration	`70%`	`79%`	`61%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.configuration.ThingShadowSyncConfiguration	`76%`	`78%`	`75%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ShadowManagerDatabase	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ShadowManager	`87%`	`89%`	`85%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ShadowManagerDAOImpl	`84%`	`90%`	`77%`	:white_check_mark:
com.aws.greengrass.shadowmanager.AuthorizationHandlerWrapper	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.PubSubIntegrator	`22%`	`22%`	`21%`	:x:
com.aws.greengrass.shadowmanager.ShadowManager$1	`14%`	`14%`	`0%`	:x:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractDeleteThingShadowOperationHandler	`100%`	`100%`	`0%`	:white_check_mark:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractListNamedShadowsForThingOperationHandler	`100%`	`100%`	`0%`	:white_check_mark:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractUpdateThingShadowOperationHandler	`100%`	`100%`	`0%`	:white_check_mark:
software.amazon.awssdk.aws.greengrass.GeneratedAbstractGetThingShadowOperationHandler	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.model.StrategyType	`55%`	`69%`	`40%`	:white_check_mark:
com.aws.greengrass.shadowmanager.sync.strategy.model.Strategy	`90%`	`100%`	`80%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.JsonMerger	`34%`	`38%`	`31%`	:x:
com.aws.greengrass.shadowmanager.util.SyncNodeMerger	`0%`	`0%`	`0%`	:x:
com.aws.greengrass.shadowmanager.util.DataOwner	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.ShadowWriteSynchronizeHelper	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.Validator	`64%`	`65%`	`63%`	:white_check_mark:
com.aws.greengrass.shadowmanager.util.JsonUtil	`80%`	`87%`	`73%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ResponseMessageBuilder	`91%`	`91%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowDocument	`81%`	`89%`	`73%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowStateMetadata	`81%`	`86%`	`77%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ErrorMessage	`97%`	`94%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowRequest	`88%`	`77%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.ShadowState	`94%`	`98%`	`91%`	:white_check_mark:
com.aws.greengrass.shadowmanager.model.LogEvents	`100%`	`100%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.BaseRequestHandler	`77%`	`77%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.GetThingShadowRequestHandler	`87%`	`74%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.IpcRateLimiter	`100%`	`100%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.PubSubClientWrapper	`82%`	`82%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.UpdateThingShadowIPCHandler	`55%`	`55%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.InboundRateLimiter	`94%`	`100%`	`88%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.InboundRateLimiter$1	`75%`	`100%`	`50%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.DeleteThingShadowRequestHandler	`86%`	`72%`	`100%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.UpdateThingShadowRequestHandler	`74%`	`76%`	`72%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.DeleteThingShadowIPCHandler	`53%`	`53%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.GetThingShadowIPCHandler	`95%`	`95%`	`0%`	:white_check_mark:
com.aws.greengrass.shadowmanager.ipc.ListNamedShadowsForThingIPCHandler	`61%`	`55%`	`67%`	:white_check_mark:

Minimum allowed coverage is 45%

Generated by :monkey: cobertura-action against c1df956523479ea3c3c55552a483ffadb475a6f8

aws-greengrass / aws-greengrass-shadow-manager

refactor: wait for the crypto key provider service to load before con… #135