Skip to content
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.

Sign up for GitHub

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

feat: Support direct URL routing #499

Merged
merged 19 commits into from
Aug 13, 2024
Merged

feat: Support direct URL routing #499

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
a82802d
Change on access utils function
Nov 6, 2023
84fc41c
feat: SQDSDKS-5914 - Pod redirection -2
Mansi-mParticle Jul 12, 2024
1952aee
fix unit test cases
Mansi-mParticle Jul 12, 2024
da0c856
remove test log
Mansi-mParticle Jul 15, 2024
a999215
Address review comments
Mansi-mParticle Jul 16, 2024
2b0d738
handle domain mapping
Mansi-mParticle Jul 24, 2024
5d7451a
address review comments
Mansi-mParticle Jul 24, 2024
434bd2f
remove test method,use method from the config class
Mansi-mParticle Jul 24, 2024
85b5f78
address review comment
Mansi-mParticle Aug 2, 2024
84ce09f
fix: Remove recursion from the method and add default URL generation.…
Mansi-mParticle Aug 7, 2024
acb223c
Address review comments, remove commented test case
Mansi-mParticle Aug 7, 2024
addeb2b
Resolve the merge conflict
Mansi-mParticle Aug 7, 2024
2c410eb
fix lint error
Mansi-mParticle Aug 7, 2024
7be9e19
Link to Jira ticket for detailed information.
Mansi-mParticle Aug 8, 2024
355d2d7
Remove extra space
Mansi-mParticle Aug 8, 2024
7cd4886
Correct reference link
Mansi-mParticle Aug 8, 2024
6cf1bef
address review comment
Mansi-mParticle Aug 8, 2024
c1ad77b
Refactor code for improved readability
Mansi-mParticle Aug 9, 2024
d1a9dce
Add a reference link for additional context
Mansi-mParticle Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
315 changes: 310 additions & 5 deletions android-core/src/androidTest/kotlin/com.mparticle/networking/MParticleBaseClientImplTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
package com.mparticle.networking

import android.net.Uri
import com.mparticle.BuildConfig
import com.mparticle.MParticle
import com.mparticle.MParticleOptions
import com.mparticle.internal.AccessUtils
import com.mparticle.internal.ConfigManager
import com.mparticle.testutils.BaseCleanInstallEachTest
import junit.framework.TestCase
import org.junit.Assert
import org.junit.Assert.assertEquals
import org.junit.Before
import org.junit.Test
import java.net.MalformedURLException
Expand All @@ -20,11 +23,170 @@ class MParticleBaseClientImplTest : BaseCleanInstallEachTest() {
startMParticle(MParticleOptions.builder(mContext).credentials(apiKey, "secret"))
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
for (endpoint in MParticleBaseClientImpl.Endpoint.values()) {
defaultUrls[endpoint] = baseClientImpl.getUrl(endpoint, endpoint.name)
defaultUrls[endpoint] = baseClientImpl.getUrl(endpoint, endpoint.name, false)
}
MParticle.setInstance(null)
}

@Test
fun testUrlPrefixWithPodRedirection() {
val prefix = "eu1"
val identityUrl = mRandomUtils.getAlphaString(20)
val configUrl = mRandomUtils.getAlphaString(20)
val audienceUrl = mRandomUtils.getAlphaString(20)
val eventsUrl = mRandomUtils.getAlphaString(20)
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.networkOptions(
NetworkOptions.builder()
.addDomainMapping(
DomainMapping.audienceMapping(audienceUrl)
.build()
)
.addDomainMapping(
DomainMapping.configMapping(configUrl)
.build()
)
.addDomainMapping(
DomainMapping.identityMapping(identityUrl)
.build()
)
.addDomainMapping(DomainMapping.eventsMapping(eventsUrl).build())
.build()
)
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val url =
baseClientImpl.getPodUrl(NetworkOptionsManager.MP_URL_PREFIX, prefix, true)
assertEquals("${NetworkOptionsManager.MP_URL_PREFIX}.$prefix.mparticle.com", url)
}

@Test
fun testUrlPrefixWithoutPodRedirection() {
val prefix = "eu1"
val identityUrl = mRandomUtils.getAlphaString(20)
val configUrl = mRandomUtils.getAlphaString(20)
val audienceUrl = mRandomUtils.getAlphaString(20)
val eventsUrl = mRandomUtils.getAlphaString(20)
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.networkOptions(
NetworkOptions.builder()
.addDomainMapping(
DomainMapping.audienceMapping(audienceUrl)
.build()
)
.addDomainMapping(
DomainMapping.configMapping(configUrl)
.build()
)
.addDomainMapping(
DomainMapping.identityMapping(identityUrl)
.build()
)
.addDomainMapping(DomainMapping.eventsMapping(eventsUrl).build())
.build()
)
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val url =
baseClientImpl.getPodUrl(NetworkOptionsManager.MP_URL_PREFIX, prefix, false)
assertEquals("${NetworkOptionsManager.MP_URL_PREFIX}.mparticle.com", url)
}

@Test
fun testAllPrefixes() {
val mConfigManager = ConfigManager(
mContext,
MParticle.Environment.Production,
"some api key",
"some api secret",
null,
null,
null,
null,
null,
null
)

// Following are the fake APIs for testing purposes.
val map = mapOf<String, String>(
Pair("us1-1vc4gbp24cdtx6e31s58icnymzy83f1uf", "us1"),
Mansi-mParticle marked this conversation as resolved.
Show resolved Hide resolved
Pair("us2-v2p8lr3w2g90vtpaumbq21zy05cl50qm3", "us2"),
Pair("eu1-bkabfno0b8zpv5bwi2zm2mfa1kfml19al", "eu1"),
Pair("au1-iermuj83dbeoshm0n32f10feotclq6i4a", "au1"),
Pair("st1-k77ivhkbbqf4ce0s3y12zpcthyn1ixfyu", "st1"),
Pair("us3-w1y2y8yj8q58d5bx9u2dvtxzl4cpa7cuf", "us3"),
Pair("kajsdhasdiuyaiudiashhadjhdasjk", "us1")
)
val identityUrl = mRandomUtils.getAlphaString(20)
val configUrl = mRandomUtils.getAlphaString(20)
val audienceUrl = mRandomUtils.getAlphaString(20)
val eventsUrl = mRandomUtils.getAlphaString(20)
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.networkOptions(
NetworkOptions.builder()
.addDomainMapping(
DomainMapping.audienceMapping(audienceUrl)
.build()
)
.addDomainMapping(
DomainMapping.configMapping(configUrl)
.build()
)
.addDomainMapping(
DomainMapping.identityMapping(identityUrl)
.build()
)
.addDomainMapping(DomainMapping.eventsMapping(eventsUrl).build())
.build()
)
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
map.forEach { key, value ->
mConfigManager?.setCredentials(key, value)
val prefix = mConfigManager?.podPrefix
assertEquals(value, prefix)
assertEquals(
"${NetworkOptionsManager.MP_URL_PREFIX}.$prefix.mparticle.com",
baseClientImpl.getPodUrl(
NetworkOptionsManager.MP_URL_PREFIX,
prefix,
true
)
)
assertEquals(
"${NetworkOptionsManager.MP_IDENTITY_URL_PREFIX}.$prefix.mparticle.com",
baseClientImpl.getPodUrl(
NetworkOptionsManager.MP_IDENTITY_URL_PREFIX,
prefix,
true
)
)

assertEquals(
"${NetworkOptionsManager.MP_URL_PREFIX}.mparticle.com",
baseClientImpl.getPodUrl(
NetworkOptionsManager.MP_URL_PREFIX,
prefix,
false
)
)
assertEquals(
"${NetworkOptionsManager.MP_IDENTITY_URL_PREFIX}.mparticle.com",
baseClientImpl.getPodUrl(
NetworkOptionsManager.MP_IDENTITY_URL_PREFIX,
prefix,
false
)
)
}
}

@Test
@Throws(MalformedURLException::class)
fun testGetUrlForceDefaultOption() {
Mansi-mParticle marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -56,17 +218,160 @@ class MParticleBaseClientImplTest : BaseCleanInstallEachTest() {
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
for (endpoint in MParticleBaseClientImpl.Endpoint.values()) {
val generatedUrl = baseClientImpl.getUrl(endpoint, endpoint.name, true)
Assert.assertEquals(defaultUrls[endpoint].toString(), generatedUrl.toString())
TestCase.assertTrue(generatedUrl === generatedUrl.defaultUrl)
assertEquals(defaultUrls[endpoint].toString(), generatedUrl.defaultUrl.toString())
}
for (endpoint in MParticleBaseClientImpl.Endpoint.values()) {
val generatedUrl = baseClientImpl.getUrl(endpoint, endpoint.name, false)
Assert.assertNotEquals(defaultUrls[endpoint].toString(), generatedUrl.toString())
Assert.assertFalse(generatedUrl === generatedUrl.defaultUrl)
Assert.assertEquals(
assertEquals(
einsteinx2 marked this conversation as resolved.
Show resolved Hide resolved
defaultUrls[endpoint].toString(),
generatedUrl.defaultUrl.toString()
)
}
}

@Test
@Throws(MalformedURLException::class)
fun testGenerateDefaultURL() {
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val subdirectory = "/v2/"
val uri = Uri.Builder()
.scheme(BuildConfig.SCHEME)
.encodedAuthority("nativesdks.us1.mparticle.com")
.path("$subdirectory us1-foo/events")
.build()
val result = baseClientImpl.generateDefaultURL(
false,
uri,
"nativesdks.mparticle.com",
"v2/us1-akshd324uajbhg123OIASI/events"
)
assertEquals("https://nativesdks.mparticle.com/v2/us1-akshd324uajbhg123OIASI/events", result.toString())
}

@Test
@Throws(MalformedURLException::class)
fun testGenerateDefaultURL_When_defaultDomain_IS_Empty() {
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val subdirectory = "/v2/"
val uri = Uri.Builder()
.scheme(BuildConfig.SCHEME)
.encodedAuthority("nativesdks.us1.mparticle.com")
.path("$subdirectory eu1-fooapi/events")
.build()
val result = baseClientImpl.generateDefaultURL(
false,
uri,
"",
"v2/us1-asjdjasdgjhasgdjhas/events"
)
assertEquals("https://nativesdks.us1.mparticle.com/v2/us1-asjdjasdgjhasgdjhas/events", result.toString())
}

@Test
@Throws(MalformedURLException::class)
fun testGenerateDefaultURL_When_defaultDomain_IS_NULL() {
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val subdirectory = "/v2/"
val uri = Uri.Builder()
.scheme(BuildConfig.SCHEME)
.encodedAuthority("nativesdks.us1.mparticle.com")
.path("$subdirectory us1-foo/events")
.build()
val result = baseClientImpl.generateDefaultURL(
false,
uri,
null,
"v2/us1-asjdjasdgjhasgdjhas/events"
)
assertEquals("https://nativesdks.us1.mparticle.com/v2/us1-asjdjasdgjhasgdjhas/events", result.toString())
}

@Test
@Throws(MalformedURLException::class)
fun testGenerateDefaultURL_When_URL_IS_NULL() {
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val result = baseClientImpl.generateDefaultURL(
false,
null,
"nativesdks.mparticle.com",
"v2/us1-bee5781b649a7a40a592c2000bc892d0/events"
)
assertEquals(null, result)
}

@Test
@Throws(MalformedURLException::class)
fun testGenerateDefaultURL_When_PATH_IS_NULL() {
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val subdirectory = "/v2/"
val uri = Uri.Builder()
.scheme(BuildConfig.SCHEME)
.encodedAuthority("nativesdks.us1.mparticle.com")
.path("$subdirectory us1-foo/events")
.build()
val result = baseClientImpl.generateDefaultURL(
false,
uri,
"nativesdks.mparticle.com",
null
)
assertEquals("https://nativesdks.mparticle.com/v2/%20us1-foo/events", result.toString())
}

@Test
@Throws(MalformedURLException::class)
fun testGenerateDefaultURL_When_defaultDomain_AND_URL_AND_PATH_ARE_NULL() {
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val result = baseClientImpl.generateDefaultURL(false, null, null, null)
assertEquals(null, result)
}

@Test
@Throws(MalformedURLException::class)
fun testGenerateDefaultURL_When_defaultDomain_FLAG_IS_TRUE() {
val options = MParticleOptions.builder(mContext)
.credentials(apiKey, "secret")
.build()
MParticle.start(options)
val baseClientImpl = AccessUtils.getApiClient() as MParticleBaseClientImpl
val subdirectory = "/v2/"
val uri = Uri.Builder()
.scheme(BuildConfig.SCHEME)
.encodedAuthority("nativesdks.us1.mparticle.com")
.path("$subdirectory us1-foo/events")
.build()
val result = baseClientImpl.generateDefaultURL(
true,
uri,
"nativesdks.mparticle.com",
"v2/us1-akshd324uajbhg123OIASI/events"
)
assertEquals(null, result)
}
}
Loading
Loading