Dispatch 'complete' event when streaming connection closed

[kevinlind]

Description

Dispatch a "complete" event when the streaming connection is closed, when requested. This event may be used by extensions who are not using the public API sendEvent but wish to know when all response handles are received for a given request event.

Allows callers to add a flag to the Edge request to signal a "complete" event should be dispatched when the streaming connection is closed. The flag sendCompletion is part of the request object, a sibling object to the data and xdm objects in the Edge Experience Event.

{
   "xdm": { ... },
   "request": { "sendCompletion" : true }
}

The presence of the sendCompletion flag in the request causes the Edge extension to dispatch a paired response event to signal to the caller that the connection is closed and no more streaming response handles will be dispatched. The response event is of type com.adobe.eventType.edge and source com.adobe.eventSource.contentComplete and contains data of just requestId for debugging. The parentId of the event will match the UUID of the original request event.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have signed the Adobe Open Source CLA.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[codecov]

Codecov Report

Merging #83 (ce87682) into dev-v2.2.1 (7689f2f) will increase coverage by 0.21%.
The diff coverage is 100.00%.

❗ Current head ce87682 differs from pull request most recent head f969ae3. Consider uploading reports for the commit f969ae3 to get more accurate results

@@               Coverage Diff                @@
##             dev-v2.2.1      #83      +/-   ##
================================================
+ Coverage         83.63%   83.84%   +0.21%     
- Complexity          380      385       +5     
================================================
  Files                29       29              
  Lines              1582     1578       -4     
  Branches            225      223       -2     
================================================
  Hits               1323     1323              
+ Misses              162      161       -1     
+ Partials             97       94       -3     

Flag	Coverage Δ
functional-tests	66.48% <92.31%> (+0.29%)	⬆️
unit-tests	79.78% <100.00%> (+0.14%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
...java/com/adobe/marketing/mobile/EdgeConstants.java	100.00% <ø> (ø)
...a/com/adobe/marketing/mobile/EdgeHitProcessor.java	87.22% <100.00%> (-0.37%)	⬇️
...adobe/marketing/mobile/NetworkResponseHandler.java	84.62% <100.00%> (+1.71%)	⬆️

[timkimadobe]

Looks great! Just had a question about the variable name for the new constants

[timkimadobe]

Looks great! Thank you Kevin

Do we also want to include the new flag in the event reference documentation (https://github.com/adobe/aepsdk-edge-ios/pull/383/files#diff-49f4dd7f8fd0c3aa77b7402714be2b63f2a34fbfbace7def48fc4a6de450a344)? Or is there a better location for that one

[kevinlind]

Looks great! Thank you Kevin

Do we also want to include the new flag in the event reference documentation (https://github.com/adobe/aepsdk-edge-ios/pull/383/files#diff-49f4dd7f8fd0c3aa77b7402714be2b63f2a34fbfbace7def48fc4a6de450a344)? Or is there a better location for that one

I'm not sure on the best place to include it. I've updated the event-reference to include the sendCompletion plus to clarify the response content event. Let me know what you think.

[timkimadobe]

small nit: what do you think of capital "Defined" instead of defined?