-
Notifications
You must be signed in to change notification settings - Fork 89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release/2.1.0 #111
Merged
Merged
Release/2.1.0 #111
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
b17f399
Version up to 2.1.0-rc1
Sergey-Makarov bf3d4b0
Jitpack fix: change JDK version 11 -> 17
Sergey-Makarov f807c6d
Version up to 2.1.0-rc2
Sergey-Makarov 67212ef
Fix instrumented tests build
Sergey-Makarov 187dc1a
Remove nested safe calls with timeouts, since it makes the code less …
Sergey-Makarov cff1d7f
Make safeWithTimeoutContextFlagUnset test more explicit & fix it on C…
Sergey-Makarov bb46a59
Make SafeTests instrumented
Sergey-Makarov 9fba647
CI fix: increase timeout for mediaDrmId retrieval
Sergey-Makarov 900efb0
Dummy results: replace zeros with empty string
Sergey-Makarov b3e9bde
Long timeout for applications list. Just as a precaution
Sergey-Makarov dd670d3
Merge pull request #109 from fingerprintjs/fix/remove-nested-safe-wit…
Sergey-Makarov b175fbc
Version up to 2.1.0-rc3
Sergey-Makarov 00b66b8
Version up to 2.1.0
Sergey-Makarov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <manifest xmlns:tools="http://schemas.android.com/tools"> | ||
| <uses-sdk tools:overrideLibrary="io.mockk, io.mockk.proxy.android"/> | ||
| </manifest> |
This file contains 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
253 changes: 253 additions & 0 deletions
253
fingerprint/src/androidTest/java/com/fingerprintjs/android/fingerprint/SafeTests.kt
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,253 @@ | ||
| package com.fingerprintjs.android.fingerprint | ||
|
|
||
| import android.content.Context | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4 | ||
| import androidx.test.platform.app.InstrumentationRegistry | ||
| import com.fingerprintjs.android.fingerprint.signal_providers.StabilityLevel | ||
| import com.fingerprintjs.android.fingerprint.tools.threading.createSharedExecutor | ||
| import com.fingerprintjs.android.fingerprint.tools.threading.runOnAnotherThread | ||
| import com.fingerprintjs.android.fingerprint.tools.threading.safe.ExecutionTimeoutException | ||
| import com.fingerprintjs.android.fingerprint.tools.threading.safe.Safe | ||
| import com.fingerprintjs.android.fingerprint.tools.threading.safe.safeWithTimeout | ||
| import com.fingerprintjs.android.fingerprint.tools.threading.sharedExecutor | ||
| import com.fingerprintjs.android.fingerprint.utils.callbackToSync | ||
| import com.fingerprintjs.android.fingerprint.utils.mockkObjectSupported | ||
| import io.mockk.every | ||
| import io.mockk.mockkObject | ||
| import io.mockk.unmockkObject | ||
| import io.mockk.verify | ||
| import io.mockk.verifyOrder | ||
| import junit.framework.TestCase | ||
| import org.junit.After | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import java.util.concurrent.CountDownLatch | ||
| import java.util.concurrent.ExecutionException | ||
|
|
||
| @RunWith(AndroidJUnit4::class) | ||
| class SafeTests { | ||
|
|
||
| private val context: Context | ||
| get() = InstrumentationRegistry.getInstrumentation().targetContext | ||
|
|
||
| @After | ||
| fun recreateExecutor() { | ||
| sharedExecutor = createSharedExecutor() | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutValueReturned() { | ||
| val v = safeWithTimeout { 0 } | ||
| TestCase.assertEquals(v.getOrNull(), 0) | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutErrorRetrievable() { | ||
| val errorId = "Hello" | ||
| val v = safeWithTimeout { throw Exception(errorId) } | ||
| val err = v.exceptionOrNull() as ExecutionException | ||
| val errCause = err.cause!! | ||
| TestCase.assertTrue(errCause is Exception && errCause.message == errorId) | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutExecutionNeverStuck() { | ||
| val elapsedTime = elapsedTimeMs { | ||
| safeWithTimeout(timeoutMs = TimeConstants.t1) { Thread.sleep(TimeConstants.t4) } | ||
| } | ||
| TestCase.assertTrue(elapsedTime - TimeConstants.t1 < TimeConstants.epsilon) | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutExecutionStuckThreadStackTraceReturned() { | ||
| val res = safeWithTimeout(timeoutMs = TimeConstants.t1) { Thread.sleep(TimeConstants.t4) } | ||
| val err = res.exceptionOrNull()!! | ||
| TestCase.assertTrue( | ||
| err is ExecutionTimeoutException | ||
| && err.executionThreadStackTrace != null | ||
| && err.executionThreadStackTrace.any { it.className == "java.lang.Thread" && it.methodName == "sleep" } | ||
|
Check warning Code scanning / detekt Line detected that is longer than the defined maximum line length in the code style. Warning
Line detected that is longer than the defined maximum line length in the code style.
|
||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutFromMultipleThreadsIsNotBlocked() { | ||
| val countDownLatch = CountDownLatch(2) | ||
| val elapsedTime = elapsedTimeMs { | ||
| runOnAnotherThread { safeWithTimeout { Thread.sleep(TimeConstants.t1); countDownLatch.countDown() } } | ||
| runOnAnotherThread { safeWithTimeout { Thread.sleep(TimeConstants.t1); countDownLatch.countDown() } } | ||
| countDownLatch.await() | ||
| } | ||
| TestCase.assertTrue(elapsedTime - TimeConstants.t1 < TimeConstants.epsilon) | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutThreadsAreReused() { | ||
| for (i in 0 until 4) { | ||
| safeWithTimeout { } | ||
| TestCase.assertEquals(1, sharedExecutor.poolSize) | ||
| Thread.sleep(TimeConstants.epsilon) | ||
| } | ||
| } | ||
|
|
||
| // this is a sad fact but we will leave it as it is | ||
| @Test | ||
| fun safeWithTimeoutThreadCountGrowsIfThreadsCantInterrupt() { | ||
| for (i in 1 until 5) { | ||
| safeWithTimeout(timeoutMs = TimeConstants.epsilon) { neverReturn() } | ||
| TestCase.assertEquals(i, sharedExecutor.poolSize) | ||
| Thread.sleep(TimeConstants.epsilon) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutOuterTimeoutDominatesOverInner() { | ||
| val elapsedTime = elapsedTimeMs { | ||
| safeWithTimeout(timeoutMs = TimeConstants.t1) { | ||
| safeWithTimeout(timeoutMs = TimeConstants.t2) { | ||
| Thread.sleep(TimeConstants.t3) | ||
| } | ||
| } | ||
| } | ||
| TestCase.assertTrue(elapsedTime - TimeConstants.t1 < TimeConstants.epsilon) | ||
| } | ||
|
|
||
| /** | ||
| * This test illustrates the behaviour when using one safe call inside the another. | ||
| * Such usage is prohibited, but we'd rather know the what-ifs. | ||
| */ | ||
| @Test | ||
| fun safeWithTimeoutNestedSafeInterruptedBehaviour() { | ||
| if (!mockkObjectSupported()) return | ||
| val errLvl1: Throwable? | ||
| var errLvl2: Throwable? = null | ||
| var errLvl3: Throwable? = null | ||
| val countDownLatch = CountDownLatch(2) | ||
| mockkObject(Safe) | ||
| every { Safe.logIllegalSafeWithTimeoutUsage() } answers {} | ||
|
|
||
| errLvl1 = safeWithTimeout(timeoutMs = TimeConstants.t1) { | ||
| errLvl2 = safeWithTimeout(timeoutMs = TimeConstants.t2) { | ||
| try { | ||
| Thread.sleep(TimeConstants.t3) | ||
| } catch (t: Throwable) { | ||
| errLvl3 = t | ||
| countDownLatch.countDown() | ||
| } | ||
| }.exceptionOrNull() | ||
| countDownLatch.countDown() | ||
| }.exceptionOrNull() | ||
| countDownLatch.await() | ||
|
|
||
| unmockkObject(Safe) | ||
| TestCase.assertTrue(errLvl1 is ExecutionTimeoutException) | ||
| TestCase.assertTrue(errLvl2 is InterruptedException) | ||
| TestCase.assertTrue(errLvl3 is InterruptedException) | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Same motivation for the test as for the above. | ||
| */ | ||
| @Test | ||
| fun safeWithTimeoutNestedValueReturned() { | ||
| if (!mockkObjectSupported()) return | ||
| mockkObject(Safe) | ||
| every { Safe.logIllegalSafeWithTimeoutUsage() } answers { } | ||
|
|
||
| val v = safeWithTimeout { safeWithTimeout { 0 } } | ||
|
|
||
| unmockkObject(Safe) | ||
| TestCase.assertEquals(v.getOrNull()!!.getOrNull(), 0) | ||
| } | ||
|
|
||
| @Test | ||
| fun safeContextFlagUnsetWhenSafeBlockReturns() = | ||
| safeWithTimeoutContextFlagUnset(whenBlockThrows = false) | ||
|
|
||
| @Test | ||
| fun safeContextFlagUnsetWhenSafeBlockThrows() = | ||
| safeWithTimeoutContextFlagUnset(whenBlockThrows = true) | ||
|
|
||
| private fun safeWithTimeoutContextFlagUnset(whenBlockThrows: Boolean) { | ||
| if (!mockkObjectSupported()) return | ||
| mockkObject(Safe) | ||
| var clearThreadId: Long? = null | ||
| every { Safe.clearInsideSafeWithTimeout() } answers { | ||
| callOriginal().also { clearThreadId = Thread.currentThread().id } | ||
| } | ||
| var markThreadId: Long? = null | ||
| every { Safe.markInsideSafeWithTimeout() } answers { | ||
| callOriginal().also { markThreadId = Thread.currentThread().id } | ||
| } | ||
|
|
||
| safeWithTimeout { | ||
| if (whenBlockThrows) | ||
| throw Exception() | ||
|
Check warning Code scanning / detekt Thrown exception is too generic. Prefer throwing project specific exceptions to handle error cases. Warning
Exception is a too generic Exception. Prefer throwing specific exceptions that indicate a specific error case.
|
||
| } | ||
|
|
||
| verify(exactly = 1) { | ||
| Safe.markInsideSafeWithTimeout() | ||
| Safe.clearInsideSafeWithTimeout() | ||
| } | ||
| verifyOrder { | ||
| Safe.markInsideSafeWithTimeout() | ||
| Safe.clearInsideSafeWithTimeout() | ||
| } | ||
|
|
||
| TestCase.assertEquals(markThreadId, clearThreadId) | ||
| unmockkObject(Safe) | ||
| } | ||
|
|
||
| @Test | ||
| fun safeWithTimeoutNestedUsageReported() { | ||
| if (!mockkObjectSupported()) return | ||
| var logCalled = false | ||
| mockkObject(Safe) | ||
| every { Safe.logIllegalSafeWithTimeoutUsage() } answers { logCalled = true } | ||
|
|
||
| safeWithTimeout { safeWithTimeout {} } | ||
|
|
||
| unmockkObject(Safe) | ||
| TestCase.assertEquals(true, logCalled) | ||
| } | ||
|
|
||
|
|
||
| @Test | ||
| fun nestedSafeCallNeverHappens() { | ||
| if (!mockkObjectSupported()) return | ||
|
|
||
| var logCalled = false | ||
| mockkObject(Safe) | ||
| every { Safe.logIllegalSafeWithTimeoutUsage() } answers { logCalled = true } | ||
|
|
||
| Fingerprinter.Version.values().forEach { version -> | ||
| val fingerprinter = FingerprinterFactory.create(context) | ||
| val deviceId = callbackToSync { fingerprinter.getDeviceId(version = version) { emit(it) } } | ||
| StabilityLevel.values().forEach { stabilityLevel -> | ||
| val fingerprint = callbackToSync { fingerprinter.getFingerprint(version, stabilityLevel) { emit(it) } } | ||
| } | ||
| val fingerprintingSignalsProvider = fingerprinter.getFingerprintingSignalsProvider()!! | ||
| } | ||
|
|
||
| TestCase.assertEquals(false, logCalled) | ||
| } | ||
| } | ||
|
|
||
| private object TimeConstants { | ||
| const val epsilon = 200L | ||
| const val t1 = epsilon * 3 | ||
| const val t2 = t1 * 2 | ||
| const val t3 = t1 * 3 | ||
| const val t4 = t1 * 4 | ||
| } | ||
|
|
||
| private inline fun elapsedTimeMs(block: () -> Unit): Long { | ||
| val currentTime = System.currentTimeMillis() | ||
| block() | ||
| return System.currentTimeMillis() - currentTime | ||
| } | ||
|
|
||
| @Suppress("ControlFlowWithEmptyBody") | ||
| private fun neverReturn() { | ||
| while (true); | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Check warning
Code scanning / detekt
Thrown exception is too generic. Prefer throwing project specific exceptions to handle error cases. Warning