Address data races in AEPTestUtil classes#1103
Merged
timkimadobe merged 1 commit intoadobe:dev-testutilsfrom Dec 4, 2024
Merged
Address data races in AEPTestUtil classes#1103timkimadobe merged 1 commit intoadobe:dev-testutilsfrom
timkimadobe merged 1 commit intoadobe:dev-testutilsfrom
Conversation
addb
approved these changes
Dec 4, 2024
This was referenced Dec 4, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
The changes in this PR should not affect the signature of any existing public APIs, so the patch version will be increased from:
testutils-5.2.2->testutils-5.2.3Description
This PR addresses data race issues with public test classes available in AEPTestUtils by protecting access to shared access public vars in a sync queue:
InstrumentedExtensionextensionVersionexpectedEventsreceivedEventsMockExtensionextensionVersionregistrationClosureunregistrationClosureeventReceivedClosureMockDataStoredictThis implementation tested via:
MockExtension
InstrumentedExtension
MockDataStore
Related Issue
Motivation and Context
Data race caught by thread sanitizer:
Test Case '-[FunctionalTests.NetworkResponseHandlerFunctionalTests testProcessResponseOnSuccess_afterPersistedResetEvent_savesStorePayloads]' passed (1.246 seconds).
Test Case '-[FunctionalTests.NetworkResponseHandlerFunctionalTests testProcessResponseOnSuccess_afterPersistedResetEvent_updatesLocationHint]' started.
AEPTestUtils/AEPCore/Mocks/PublicTestUtils/InstrumentedExtension.swift:115 Data race in static AEPTestUtils.InstrumentedExtension.reset() -> () at static AEPTestUtils.InstrumentedExtension.receivedEvents : AEPServices.ThreadSafeDictionary<AEPTestUtils.EventSpec, Swift.Array<AEPCore.Event>>
'static AEPTestUtils.InstrumentedExtension.receivedEvents : AEPServices.ThreadSafeDictionary<AEPTestUtils.EventSpec, Swift.Array<AEPCore.Event>>' is a global variable (0x110038f38)
Test Case '-[FunctionalTests.NetworkResponseHandlerFunctionalTests testProcessResponseOnSuccess_afterPersistedResetEvent_updatesLocationHint]' passed (3.407 seconds).
Test Case '-[FunctionalTests.NetworkResponseHandlerFunctionalTests testProcessResponseOnSuccess_afterResetEvent_savesStorePayloads]' started.
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: