Skip to content

Merge to Main for v1.5.0 release#292

Merged
kevinlind merged 39 commits intomainfrom
staging
Oct 19, 2022
Merged

Merge to Main for v1.5.0 release#292
kevinlind merged 39 commits intomainfrom
staging

Conversation

@kevinlind
Copy link
Copy Markdown
Contributor

Merge to Main for v1.5.0 release.

Description

  • Adds new APIs, getLocationHint() and setLocationHint()
  • Handles Edge Network response locationHint:result allowing network requests to "stick" to a specific network cluster which allows for user profiles to remain in sync during a session.
  • Adds path overwrite for Edge Network requests which require custom paths. Required by the Media for Edge Network extension.
  • Includes tutorial documentation which walks through the processes of configuring, installing, and debugging the Edge extension and sendEvent() calls.

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.

emdobrin and others added 30 commits June 2, 2022 19:03
Downmerge main -> dev after v1.4.1 release
…t for similar requests in future. Added validation to drop paths with invalid cahracters.
…anged unitTest and functionTest schemes settings to build when run.
[MOB-16479] Allow path overwrite for Media Edge requests
update CI Xcode
* Add region id parameter to EdgeEndpoint

* Read and write location hint to requests

* Move location hint code to EdgeState while passing get/set function handlers to EdgeHitProcessor and NetworkResponseHandler.
This makes the EdgeState the holder of the location hint while other classes must call it to get or update the location hint.

* Set shared state when the location hint is updated

* Add function to clear location hint.

* Add EdgeHitProcessor unit tests

* Add NetworkResponseHandler functional tests

* Add EdgeProperties to store and manage persisted fields

* Add EdgeState unit tests

* Add location hint functional tests in AEPEdgeFunctionalTests

* Update expected number of events in functional tests as Edge now dispatches a shared state

* Add coverage capture to AEPEdge scheme

* Update comment when creating shared state in bootupIfNeeded

* Rename EdgeEndpoint property from 'regionId' to 'locationHint'

* update CircleCI macos xcode to 13.4.0

* Fix a few SwiftLint warnings

* Move Event Handler Type constants under their own enum

* Refactor handleLocationHintHandle loop to break on failure

* Persist EdgeProperties to data store automatically from get/clear locationHint

* Guard access to current consent status in EdgeState

* Add unit tests for Edge endpoint with path overwrite and location hint.

* SwiftLint autocorrect
* Add getLocationHint and setLocationHint APIs

* Add buttons to get and set Location Hint

* Update AEPCore pod to 'dev' branch to pull in new EventSource values.

* Move existing EdgePublicAPITests under UnitTests.

* Add unit and functional tests

* Add picker to select location hints in test app UI

* Use nil-coalescing operator instead of explicit nil check

* Extract location hint 'or2' to constant for test cases.

* Update labels to setLocationHint
* Migration of Edge tutorial to Edge repo

* Refactoring file structure

* Update steps for Edge, add sections for various AEP extensions

* Update file structure to place tutorials in documentation in line with other repos

* Remove duplicated tutorial and update assurance window step

* Update edge example with one using XDM object

* Update tutorial for edge

* Step updates

* Update AEP setup heading level

* Reset app to start state

* Update section numbering

* Update git repo link to point to tutorial branch

* Update repo setup instructions to point to tutorial project

* Update podfile instructions

* Remove unneeded pod update step
Clarify click and drag step

* Update click and drag with image
Update wording for datastream description

* Update click and drag with step numbers

* Update property extension installation to include assurance
Update publishing steps
update env id saving

* Remove trigger consequence button

* Flesh out rule creation steps

* Add Analytics service to datastream steps

* Update assurance validation to include analytics mapping and event transactions

* Update tutorial app to starting state

* Update pod instructions since opening for the first time has invalid Pod target
Allow alternative route using SPM if no admin access

* Update top level diagram

* Create final state for edge tutorial app

* Update copyright to match standard license header

* Update final app copyright license headers

* Remove org info from assets
Update wording for "we"

* Update start app project to EdgeTutorialApp

* Updates based on feedback

* Create TOC under Tutorials directory

* Remove branch from repo link

* Remove initial pod update

* Update related projects and point to it from tutorial

* Update assurance step header and toc

* Update app name usages

Co-authored-by: Emilia Dobrin <33132425+emdobrin@users.noreply.github.com>
* Add Documentation folder and api-reference

* Add getting-started

* A few format fixes and changes from code review

* Update comment for setLocationHint in api doc

* Add instructions to download using SPM

* Add README to Documentation folder with contents

* Include Core and Identity in SPM instructions.

Co-authored-by: Emilia Dobrin <33132425+emdobrin@users.noreply.github.com>
kevinlind and others added 8 commits October 6, 2022 18:42
* Fix broken link documentation table of contents

* Fix names of documentation in table of contents
Merge to Staging for v1.5.0 release
* Migration of Edge tutorial to Edge repo

* Refactoring file structure

* Update steps for Edge, add sections for various AEP extensions

* Update file structure to place tutorials in documentation in line with other repos

* Remove duplicated tutorial and update assurance window step

* Update edge example with one using XDM object

* Update tutorial for edge

* Step updates

* Update AEP setup heading level

* Reset app to start state

* Update section numbering

* Update git repo link to point to tutorial branch

* Update repo setup instructions to point to tutorial project

* Update podfile instructions

* Remove unneeded pod update step
Clarify click and drag step

* Update click and drag with image
Update wording for datastream description

* Update click and drag with step numbers

* Update property extension installation to include assurance
Update publishing steps
update env id saving

* Remove trigger consequence button

* Flesh out rule creation steps

* Add Analytics service to datastream steps

* Update assurance validation to include analytics mapping and event transactions

* Update tutorial app to starting state

* Update pod instructions since opening for the first time has invalid Pod target
Allow alternative route using SPM if no admin access

* Update top level diagram

* Create final state for edge tutorial app

* Update copyright to match standard license header

* Update final app copyright license headers

* Remove org info from assets
Update wording for "we"

* Update start app project to EdgeTutorialApp

* Updates based on feedback

* Create TOC under Tutorials directory

* Remove branch from repo link

* Remove initial pod update

* Update related projects and point to it from tutorial

* Update assurance step header and toc

* Update app name usages

* Refactor assets to categorize by tutorial section
remove unneeded assets

* update asset references

* update assurance validation step formatting

* fix image formatting in deeplink instructions

* remove unused assets

Co-authored-by: Emilia Dobrin <33132425+emdobrin@users.noreply.github.com>
Update docs for staging 1.5.0
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 19, 2022

Codecov Report

Merging #292 (42fc356) into main (11f5431) will increase coverage by 0.91%.
The diff coverage is 98.45%.

@@            Coverage Diff             @@
##             main     #292      +/-   ##
==========================================
+ Coverage   94.59%   95.50%   +0.91%     
==========================================
  Files          27       28       +1     
  Lines         998     1045      +47     
==========================================
+ Hits          944      998      +54     
+ Misses         54       47       -7     

@kevinlind kevinlind merged commit 23e2484 into main Oct 19, 2022
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.

5 participants