[PIMOB-4287]: adding base url prefix to Frames SDK for multi-region #302
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,6 @@ | ||
| package com.checkout.base.model | ||
|
|
||
| public enum class Environment { | ||
| PRODUCTION, | ||
| SANDBOX, | ||
| } |
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
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
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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -1,13 +1,32 @@ | ||||||||
| package com.checkout.logging.utils | ||||||||
|
|
||||||||
| import com.checkout.base.model.Environment | ||||||||
| import com.checkout.base.util.EnvironmentConstants.PRODUCTION_LOGGING | ||||||||
| import com.checkout.base.util.EnvironmentConstants.PRODUCTION_SERVER_URL | ||||||||
| import com.checkout.base.util.EnvironmentConstants.SANDBOX_LOGGING | ||||||||
| import com.checkout.base.util.EnvironmentConstants.SANDBOX_SERVER_URL | ||||||||
| import com.checkout.base.util.HTTPS_PROTOCOL | ||||||||
|
|
||||||||
| internal fun Environment.toBaseUrl(baseUrlPrefix: String? = null) = when (this) { | ||||||||
| Environment.PRODUCTION -> PRODUCTION_SERVER_URL.applyPrefix(baseUrlPrefix) | ||||||||
| Environment.SANDBOX -> SANDBOX_SERVER_URL.applyPrefix(baseUrlPrefix) | ||||||||
| } | ||||||||
|
Contributor
There was a problem hiding this comment. Minor nit for formatting consistency between functions' spacing
Suggested change
|
||||||||
| internal fun Environment.toLoggingEnvironment() = when (this) { | ||||||||
| Environment.PRODUCTION -> com.checkout.eventlogger.Environment.PRODUCTION | ||||||||
| Environment.SANDBOX -> com.checkout.eventlogger.Environment.SANDBOX | ||||||||
| } | ||||||||
|
|
||||||||
| internal fun Environment.toLoggingName() = when (this) { | ||||||||
| Environment.PRODUCTION -> PRODUCTION_LOGGING | ||||||||
| Environment.SANDBOX -> SANDBOX_LOGGING | ||||||||
| } | ||||||||
|
|
||||||||
| private fun String.applyPrefix(prefix: String?): String { | ||||||||
| val validatedPrefix = prefix?.baseUrlPrefixValidator() ?: return this | ||||||||
| return this.replace(HTTPS_PROTOCOL, "$HTTPS_PROTOCOL$validatedPrefix.") | ||||||||
| } | ||||||||
|
|
||||||||
| private fun String?.baseUrlPrefixValidator() = this | ||||||||
|
Contributor
There was a problem hiding this comment. The function is declared as an extension on String?, but it's always called via the safe-call operator |
||||||||
| ?.takeIf { prefix -> | ||||||||
| prefix.all { char -> char in 'a'..'z' || char in 'A'..'Z' || char in '0'..'9' } && prefix.isNotEmpty() | ||||||||
|
Contributor
There was a problem hiding this comment. Reorder the isNotEmpty() check to come first. In the validator, prefix.all { ... } returns true for an empty string (vacuous truth in Kotlin). The logic is correct because
Contributor
There was a problem hiding this comment. The validator only allows [a-zA-Z0-9]. Per RFC 1123, valid subdomain labels can also contain hyphens (-), e.g., my-subdomain. If this restriction is intentional, it might be worth a brief comment explaining why hyphens are excluded. If not, the range check should include char == '-'. |
||||||||
| } | ||||||||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| package com.checkout | ||
|
|
||
| import com.checkout.base.model.Environment | ||
| import com.checkout.base.util.EnvironmentConstants | ||
| import com.checkout.base.util.EnvironmentConstants.PRODUCTION_SERVER_URL | ||
| import com.checkout.logging.utils.toBaseUrl | ||
| import org.junit.Assert.assertEquals | ||
| import org.junit.Test | ||
|
|
||
| internal class EnvironmentExtensionTest { | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl PRODUCTION with null subDomainPrefix returns production server URL`() { | ||
| val result = Environment.PRODUCTION.toBaseUrl(null) | ||
| assertEquals(EnvironmentConstants.PRODUCTION_SERVER_URL, result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl PRODUCTION with no subDomainPrefix argument returns production server URL`() { | ||
| val result = Environment.PRODUCTION.toBaseUrl() | ||
| assertEquals(EnvironmentConstants.PRODUCTION_SERVER_URL, result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl PRODUCTION with subDomainPrefix returns custom production URL`() { | ||
| val result = Environment.PRODUCTION.toBaseUrl("custom") | ||
| assertEquals("https://custom.api.checkout.com/tokens", result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl PRODUCTION with alphanumeric subDomainPrefix returns custom production URL`() { | ||
| val result = Environment.PRODUCTION.toBaseUrl("mySubdomain123") | ||
| assertEquals("https://mySubdomain123.api.checkout.com/tokens", result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl SANDBOX with null subDomainPrefix returns sandbox server URL`() { | ||
| val result = Environment.SANDBOX.toBaseUrl(null) | ||
| assertEquals(EnvironmentConstants.SANDBOX_SERVER_URL, result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl SANDBOX with no subDomainPrefix argument returns sandbox server URL`() { | ||
| val result = Environment.SANDBOX.toBaseUrl() | ||
| assertEquals(EnvironmentConstants.SANDBOX_SERVER_URL, result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl SANDBOX with subDomainPrefix returns custom sandbox URL`() { | ||
| val result = Environment.SANDBOX.toBaseUrl("custom") | ||
| assertEquals("https://custom.api.sandbox.checkout.com/tokens", result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl SANDBOX with alphanumeric subDomainPrefix returns custom sandbox URL`() { | ||
| val result = Environment.SANDBOX.toBaseUrl("test99") | ||
| assertEquals("https://test99.api.sandbox.checkout.com/tokens", result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when toBaseUrl with empty string subDomainPrefix uses default URL for production`() { | ||
| val result = Environment.PRODUCTION.toBaseUrl("") | ||
| assertEquals("https://api.checkout.com/tokens", result) | ||
| } | ||
|
|
||
| @Test | ||
| fun `toBaseUrl PRODUCTION returns default URL for any non-alphanumeric prefix`() { | ||
zane-smith-cko marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| val invalidPrefixList = listOf( | ||
| "invalid_prefix", | ||
| "invalid-prefix", | ||
| "invalid.prefix", | ||
|
There was a problem hiding this comment. the top 3 look like they could be valid prefixes - worth checking |
||
| "invalid@prefix", | ||
| "invalid!prefix", | ||
| "invalid#prefix", | ||
| "invalid\$prefix", | ||
| "invalid%prefix", | ||
| "invalid^prefix", | ||
| "invalid&prefix", | ||
| "invalid*prefix", | ||
| "invalid(prefix", | ||
| "invalid)prefix", | ||
| "invalid prefix", | ||
| ) | ||
|
|
||
| invalidPrefixList.forEach { invalidPrefix -> | ||
| val result = Environment.PRODUCTION.toBaseUrl(invalidPrefix) | ||
| assertEquals( | ||
| PRODUCTION_SERVER_URL, | ||
| result, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.