[MOB-17072] Adopt changes for Core 2.0 part 1 by kevinlind · Pull Request #2 · adobe/aepsdk-edge-android

kevinlind · 2022-11-23T00:53:12Z

Description

Part 1 of adoption of changes for Core 2.0

Updates .gradle files to use Core 2.0 from jitpack
Sets extension version to 2.0.0
Updates Edge public APIs for Core 2.0
Use new shared state api in EdgeExtension, EdgeState, EdgeHitProcessor
Implements EdgeExtension.onRegistered and registers listeners. Removes older Listener class
Implements EdgeExtension.readyForEvent which calls EdgeState.bootupIfNeeded and checks shared state dependencies for specific events.
Updates EdgeState and EdgeProperties for Core 2.0 changes.
Switch to new Log class only for the class touched by the changes above.
Set permission for .githooks/pre-commit for execution

Out of scope for this PR:

Switch to use public EventType and EventSource in all places
Switch to use new Log class in all places
Updates to hit queue, EdgeNetworkService, and NetworkResponseHandler except to get code to compile
Unit and functional tests do not compile or run

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.

… apis

….0.0

kevinlind · 2022-11-23T00:55:49Z

code/edge/src/main/java/com/adobe/marketing/mobile/Edge.java

 @SuppressWarnings("unused")
 public class Edge {

+	private static final String LOG_SOURCE = "Edge";


As the name of this class is the same as the extension, should the source remain as "Edge" or something else like "PublicAPIs"?

Other core extensions also use the same source name the extension name, I think we can leave it as Edge to make it consistent.

kevinlind · 2022-11-23T01:07:16Z

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeHitProcessor.java

+		SharedStateResult assuranceStateResult = sharedStateCallback.getSharedState(
 			EdgeConstants.SharedState.ASSURANCE,
 			null
 		);
-		final String assuranceIntegrationId = EventUtils.getAssuranceIntegrationId(assuranceSharedState);

-		if (!Utils.isNullOrEmpty(assuranceIntegrationId)) {
+		if (assuranceStateResult == null || assuranceStateResult.getStatus() != SharedStateStatus.SET) {
+			return requestHeaders;
+		}
+
+		final String assuranceIntegrationId = DataReader.optString(
+			assuranceStateResult.getValue(),
+			EdgeConstants.SharedState.Assurance.INTEGRATION_ID,
+			null
+		);
+
+		if (!StringUtils.isNullOrEmpty(assuranceIntegrationId)) {


I've only updated EdgeHitProcessor to fix uses of getSharedState and to use the new DataReader in this getRequestHeader function. The reset of this class will be updated in another PR.

kevinlind · 2022-11-23T01:08:07Z

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeNetworkService.java

 			return httpConnecting[0];
 		} catch (final InterruptedException | IllegalArgumentException e) {
-			Log.warning(LOG_TAG, "Connection failure for url (%s), error: (%s)", url, e);
+			Log.warning(LOG_TAG, LOG_SOURCE, "Connection failure for url (%s), error: (%s)", url, e);


I've only updated the EdgeNetworkService to fix this one instance of Log to get the code to compile. The reset of the class will be updated in another PR.

kevinlind · 2022-11-23T01:14:36Z

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeEndpoint.java


 package com.adobe.marketing.mobile;

+import com.adobe.marketing.mobile.util.StringUtils;


This line was the only needed change. Please review entire class.

kevinlind · 2022-11-23T01:23:59Z

code/edge/src/main/java/com/adobe/marketing/mobile/NetworkResponseHandler.java

 */
 class NetworkResponseHandler {

+	private static final String LOG_SOURCE = "NetworkResponseHandler";


I've only updated NetworkResponseHandler to fix the cases of Log which were failing to compile. The rest of this class will be updated in another PR.

kevinlind · 2022-11-23T01:25:24Z

code/edge/src/test/java/com/adobe/marketing/mobile/EdgeStateTests.java

 			new EdgeSharedStateCallback() {
 				@Override
-				public Map<String, Object> getSharedState(final String stateOwner, final Event event) {
+				public SharedStateResult getSharedState(final String stateOwner, final Event event) {


The changes in EdgeStateTests were done automatically when I made the API changes. The test classes will be updated in another PR.

kevinlind · 2022-11-23T01:28:13Z

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeConstants.java


 	static final String EDGE_DATA_STORAGE = "EdgeDataStorage";
-	static final String EXTENSION_VERSION = "1.4.0";
+	static final String EXTENSION_VERSION = "2.0.0";


As this PR is just part 1 of the changes to adopt Core 2.0, I'm not able to remove any unneeded constants, such as the EdgeType and EdgeSource constants.

cacheung · 2022-11-24T03:03:58Z

code/edge/src/main/java/com/adobe/marketing/mobile/Edge.java

 @SuppressWarnings("unused")
 public class Edge {

+	private static final String LOG_SOURCE = "Edge";


Other core extensions also use the same source name the extension name, I think we can leave it as Edge to make it consistent.

code/edge/src/main/java/com/adobe/marketing/mobile/Edge.java

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeExtension.java

code/edge/src/main/java/com/adobe/marketing/mobile/Edge.java

prudrabhat · 2022-12-01T23:30:15Z

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeState.java

+
+		// Get Hub's shared state needed to check if Identity and Consent are registered
+		// If not set, return false and attempt bootup at next event
+		final SharedStateResult eventHubStateResult = sharedStateCallback.getSharedState(


Does the actual check on whether Consent and Identity are registered happen elsewhere?

I'm not sure why I said Identity here. The hub's state is needed to build ImplementationDetails using the Core version and wrapper type, and setting the default Consent if Consent is not registered. Both of those a checked in the synchronized block, in ImplementationDetails.fromEventHubState and updateCollectConsentIfNotRegistered.
I'll update the comment to make it more clear.

code/edge/src/main/java/com/adobe/marketing/mobile/Edge.java

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeExtension.java

code/edge/src/main/java/com/adobe/marketing/mobile/EventUtils.java

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeExtension.java

…states

…Type/EventSource

emdobrin

Changes look good to me with couple small follow-ups

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeConstants.java

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeExtension.java

kevinlind added 19 commits November 17, 2022 15:55

Update Gradle settings for :edge module to use Core 2.0

909f2e5

First pass at updating EdgeExtension for 2.0

f255660

Remove class EdgeExtensionListener

e479e51

Update EdgeState for Core 2.0

142d370

Add readForEvent and remove event queue in EdgeExtension

ea7e642

Update Edge public APIs to Core 2.0

ec91b17

Remove unused EventUtils methods

65a03fd

Set execute permission to pre-commit Git Hook

77f131e

Apply format fixes

3227e77

Update EdgeProperties for Core 2.0

e418472

Fix log message

7176a60

Fix uses of Log and StringUtils to get code to compile

a26fbb8

Fix retrieval of assurance id to use new shared state and data reader…

76b316b

… apis

Simplify EventUtils.getEdgeConfiguration

8f7eaf0

Update version to 2.0.0 and dependent Core and Identity versions to 2…

6e22d72

….0.0

Add javadoc for onRegistered

bf2b75e

Update :app build.gradle for core 2.0

205502f

Update JavaDoc comments for EdgeSharedStateCallback

763a423

Update ImplementationDetails for Core 2.0

fe4fe50

kevinlind commented Nov 23, 2022

View reviewed changes

kevinlind requested review from cacheung, emdobrin, prudrabhat and timkimadobe November 23, 2022 01:29

cacheung reviewed Nov 28, 2022

View reviewed changes

cacheung reviewed Nov 29, 2022

View reviewed changes

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeExtension.java Show resolved Hide resolved

Move public variables above private variables

a88ba87

cacheung reviewed Dec 1, 2022

View reviewed changes

code/edge/src/main/java/com/adobe/marketing/mobile/Edge.java Outdated Show resolved Hide resolved

Set public API timeout to 5 sec to match existing 1.0 timeout

712224e

cacheung approved these changes Dec 1, 2022

View reviewed changes

prudrabhat reviewed Dec 1, 2022

View reviewed changes

emdobrin reviewed Dec 2, 2022

View reviewed changes

kevinlind added 7 commits December 1, 2022 20:37

Clarify comment in bootupIfNeeded on use of Hub shared state

85b17e3

Move API timeout variable to constants class

b2e3546

Fix wording in sendEvent log messages

d426306

Use public EventSource instead of constant

00eadb5

Rename EdgeSharedStateCallback setSharedState to createSharedState

d5871cc

Cleanup functions used to retrieve configuration and identity shared …

eb735bc

…states

Cleanup EventUtils by using NonNull annotation and using public Event…

3ac8cf5

…Type/EventSource

emdobrin reviewed Dec 2, 2022

View reviewed changes

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeConstants.java Show resolved Hide resolved

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeExtension.java Outdated Show resolved Hide resolved

Rename EdgeExtension method to processAndQueueEvent

261abe2

emdobrin approved these changes Dec 2, 2022

View reviewed changes

code/edge/src/main/java/com/adobe/marketing/mobile/EdgeExtension.java Outdated Show resolved Hide resolved

Fix wording in comment

6980d4c

kevinlind changed the base branch from dev to dev-v2.0.0 December 3, 2022 01:31

kevinlind merged commit 596e1c3 into adobe:dev-v2.0.0 Dec 3, 2022

kevinlind deleted the mob-17072-core2 branch December 3, 2022 01:32


		package com.adobe.marketing.mobile;

		import com.adobe.marketing.mobile.util.StringUtils;

Conversation

kevinlind commented Nov 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emdobrin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kevinlind commented Nov 23, 2022 •

edited

Loading