Feature/pimob 4287 add subdomain prefix by zane-smith-cko · Pull Request #302 · checkout/frames-android

zane-smith-cko · 2026-03-06T17:38:48Z

Issue

Issue ticket number and link.

Proposed changes

Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.

Test Steps

If there's any functionality change, please list a step by step guide of how to verify the changes, and/or upload a screen recording for any visible changes.

For instance:

Go to the main screen

Tap on primary button

Verify the image is shown on the screen

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

Reviewers assigned
I have performed a self-review of my code and manual testing
Lint and unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if applicable)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you choose the solution you did and what alternatives you considered, etc...

…onfig, add updated public keys

…efix, add validator extension function

Copilot

Pull request overview

Adds support for an optional subdomain/base-URL prefix so tokenization requests can be routed via a regional/merchant-specific subdomain, and wires this through Frames + CVV flows with updated samples and tests.

Changes:

Introduces baseUrlPrefix in Frames configuration/DI and propagates it down to CheckoutApiServiceFactory.
Adds Environment.toBaseUrl(...) URL building with prefix validation and corresponding unit tests.
Updates example apps and unit tests to pass the new prefix argument(s).

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
frames/src/test/java/com/checkout/frames/screen/paymentform/PaymentFormViewModelTest.kt	Updates test setup to include `baseUrlPrefix` when constructing the VM factory.
frames/src/test/java/com/checkout/frames/screen/paymentform/PaymentFormConfigTest.kt	Extends config test coverage to include `baseUrlPrefix`.
frames/src/test/java/com/checkout/frames/mock/PaymentFormConfigTestData.kt	Adds test data constant for `baseUrlPrefix`.
frames/src/test/java/com/checkout/frames/cvvinputfield/InternalCVVComponentApiTest.kt	Updates CVV API test to include `baseUrlPrefix`.
frames/src/test/java/com/checkout/frames/cvvinputfield/CVVComponentApiFactoryTest.kt	Updates factory test for new `create(...)` signature.
frames/src/main/java/com/checkout/frames/screen/paymentform/model/PaymentFormConfig.kt	Adds public config field `baseUrlPrefix`.
frames/src/main/java/com/checkout/frames/screen/paymentform/PaymentFormViewModel.kt	Threads `baseUrlPrefix` into injector creation.
frames/src/main/java/com/checkout/frames/screen/paymentform/PaymentFormScreen.kt	Passes config `baseUrlPrefix` into VM factory.
frames/src/main/java/com/checkout/frames/di/injector/FramesInjector.kt	Threads `baseUrlPrefix` into `CheckoutApiServiceFactory.create(...)` and DI builder.
frames/src/main/java/com/checkout/frames/di/component/FramesDIComponent.kt	Adds `@BindsInstance baseUrlPrefix` to Dagger builder.
frames/src/main/java/com/checkout/frames/cvvinputfield/api/InternalCVVComponentApi.kt	Threads `baseUrlPrefix` into `CheckoutApiServiceFactory.create(...)` for CVV tokenization.
frames/src/main/java/com/checkout/frames/cvvinputfield/CVVComponentApiFactory.kt	Extends CVV factory API to accept `baseUrlPrefix`.
example_app_frames/src/main/java/com/checkout/example/frames/ui/utils/Constants.kt	Adds demo constant for regional subdomain and updates demo keys.
example_app_frames/src/main/java/com/checkout/example/frames/ui/screen/MainActivity.kt	Passes regional subdomain into `PaymentFormConfig`.
example_app_frames/src/main/java/com/checkout/example/frames/ui/screen/HomeScreen.kt	Passes regional subdomain into `CheckoutApiServiceFactory.create(...)`.
example_app_frames/src/main/java/com/checkout/example/frames/ui/screen/CVVTokenizationScreen.kt	Passes regional subdomain into `CVVComponentApiFactory.create(...)`.
checkout/src/test/java/com/checkout/EnvironmentExtensionTest.kt	Adds unit tests for `Environment.toBaseUrl(...)` behavior.
checkout/src/test/java/com/checkout/CheckoutApiServiceFactoryTest.kt	Updates factory test for new signature.
checkout/src/main/java/com/checkout/logging/utils/EnvironmentExtension.kt	Adds `Environment.toBaseUrl(...)` and prefix validation helper.
checkout/src/main/java/com/checkout/base/model/Environment.kt	Refactors `Environment` enum to remove `url` field.
checkout/src/main/java/com/checkout/CheckoutApiServiceFactory.kt	Adds `baseUrlPrefix` parameter and uses `Environment.toBaseUrl(...)` for tokenization base URL.
app/src/main/java/checkout/checkout_android/DemoActivity.java	Updates demo to pass regional subdomain into `PaymentFormConfig`.
app/src/main/java/checkout/checkout_android/Constants.java	Adds regional subdomain constant and updates demo keys.
app/src/main/java/checkout/checkout_android/CVVTokenizationActivity.java	Updates demo to pass regional subdomain into `CVVComponentApiFactory.create(...)`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-06T17:45:52Z

checkout/src/test/java/com/checkout/EnvironmentExtensionTest.kt

+        assertEquals("https://api.checkout.com/tokens", result)
+    }
+
+    fun `toBaseUrl PRODUCTION returns default URL for any non-alphanumeric prefix`() {


This function is missing the @Test annotation, so the invalid-prefix cases won’t run and regressions could slip through. Add @Test (and consider adding the equivalent invalid-prefix coverage for SANDBOX as well).

Copilot · 2026-03-06T17:45:52Z

checkout/src/test/java/com/checkout/EnvironmentExtensionTest.kt

+        invalidPrefixList.map { invalidPrefix ->
+            val result = Environment.PRODUCTION.toBaseUrl(invalidPrefix)
+            assertEquals(
+                result,
+                PRODUCTION_SERVER_URL,


Using map { ... } here is for side-effects only and the result is ignored. Prefer forEach (or a parameterized test) and use assertEquals(expected, actual) ordering to improve failure messages (assertEquals(PRODUCTION_SERVER_URL, result)).

Suggested change

invalidPrefixList.map { invalidPrefix ->

val result = Environment.PRODUCTION.toBaseUrl(invalidPrefix)

assertEquals(

result,

PRODUCTION_SERVER_URL,

invalidPrefixList.forEach { invalidPrefix ->

val result = Environment.PRODUCTION.toBaseUrl(invalidPrefix)

assertEquals(

PRODUCTION_SERVER_URL,

result,

Copilot · 2026-03-06T17:45:52Z

checkout/src/main/java/com/checkout/logging/utils/EnvironmentExtension.kt

+import com.checkout.base.util.EnvironmentConstants.SANDBOX_SERVER_URL

+
+internal fun Environment.toBaseUrl(baseUrlPrefix: String? = null) = when(this) {


when(this) is inconsistent with Kotlin official formatting (and with when (this) used later in this same file) and may be flagged by ktlint. Use when (this) to match the repo’s enforced Kotlin style.

Suggested change

internal fun Environment.toBaseUrl(baseUrlPrefix: String? = null) = when(this) {

internal fun Environment.toBaseUrl(baseUrlPrefix: String? = null) = when (this) {

Copilot · 2026-03-06T17:45:53Z

app/src/main/java/checkout/checkout_android/Constants.java

 	 * Replace with Secret key from Hub in Sandbox Environment
 	 */
-	public static final String SECRET_KEY = "sk_test_568e6077-a08f-4692-9237-cc6c48dcf6aa";
+	public static final String SECRET_KEY = "sk_sbox_cqc26o3haljkwuns6xcfcmf2vmu";


A (sandbox) secret key is committed into source control via SECRET_KEY. Even sandbox secret keys should not be checked in; replace this with a placeholder and load it from a secure local/developer-only mechanism (e.g., gradle properties/env var), and rotate/revoke the exposed key.

Suggested change

public static final String SECRET_KEY = "sk_sbox_cqc26o3haljkwuns6xcfcmf2vmu";

private static String loadSecretKey() {

String secretKey = System.getenv("CHECKOUT_SECRET_KEY");

if (secretKey == null || secretKey.isEmpty()) {

throw new IllegalStateException("Environment variable CHECKOUT_SECRET_KEY must be set with a valid secret key.");

}

return secretKey;

}

public static final String SECRET_KEY = loadSecretKey();

Copilot · 2026-03-06T17:45:53Z

checkout/src/main/java/com/checkout/CheckoutApiServiceFactory.kt

-        riskSdkUseCase = RiskSdkUseCase(environment, context, publicKey, riskSDKFramesOptions, RiskInstanceProvider),
-    )
+        baseUrlPrefix: String?
+    ): TokenRepository  {


There are two spaces before { in the return type declaration (): TokenRepository {), which may be flagged by ktlint. Remove the extra whitespace to match the repo’s enforced Kotlin formatting.

Suggested change

): TokenRepository {

): TokenRepository {

Copilot · 2026-03-06T17:45:53Z

checkout/src/main/java/com/checkout/CheckoutApiServiceFactory.kt

+        baseUrlPrefix: String?
    ): CheckoutApiService {


CheckoutApiServiceFactory.create is a public API and baseUrlPrefix is currently a required parameter, which is a source/binary breaking change and also causes internal call sites to stop compiling (e.g., frames/src/androidTest/.../InternalCVVComponentMediatorUITest.kt still calls create(...) without this argument). Make baseUrlPrefix optional (default null) and/or provide an overload to preserve the previous signature for Kotlin/Java callers.

Suggested change

baseUrlPrefix: String?

): CheckoutApiService {

): CheckoutApiService {

return create(publicKey, environment, context, null)

}

@JvmStatic

public fun create(

publicKey: String,

environment: Environment,

context: Context,

baseUrlPrefix: String? = null,

): CheckoutApiService {

Copilot · 2026-03-06T17:45:53Z

frames/src/main/java/com/checkout/frames/cvvinputfield/CVVComponentApiFactory.kt

    public fun create(
        publicKey: String,
        environment: Environment,
        context: Context,
+        baseUrlPrefix: String?,


CVVComponentApiFactory.create is public and now requires baseUrlPrefix, which breaks existing Kotlin/Java call sites. Consider making it optional (default null) and adding an overload (e.g., via @JvmOverloads) so existing callers can continue using the 3-argument form.

Copilot · 2026-03-06T17:45:54Z

frames/src/main/java/com/checkout/frames/cvvinputfield/CVVComponentApiFactory.kt

    public fun create(
        publicKey: String,
        environment: Environment,
        context: Context,
+        baseUrlPrefix: String?,


The KDoc for CVVComponentApiFactory.create doesn’t document the new baseUrlPrefix parameter. Please add an @param baseUrlPrefix entry describing its purpose/constraints so the generated docs stay accurate.

Copilot · 2026-03-06T17:45:54Z

checkout/src/main/java/com/checkout/base/model/Environment.kt

-    SANDBOX(EnvironmentConstants.SANDBOX_SERVER_URL),
+public enum class Environment {
+    PRODUCTION,
+    SANDBOX


Removing the public url property from Environment is a breaking API change for SDK consumers that may rely on Environment.url. Consider keeping a (possibly deprecated) url property (backed by the current default tokenization URL) or exposing a public replacement for retrieving the base URL.

Suggested change

SANDBOX

SANDBOX;

@Deprecated(

message = "Environment.url is deprecated. Use the appropriate configuration or tokenization URL accessor instead."

)

public val url: String

get() = when (this) {

PRODUCTION -> PRODUCTION_URL

SANDBOX -> SANDBOX_URL

}

private companion object {

private const val PRODUCTION_URL: String = "https://api.checkout.com/tokens"

private const val SANDBOX_URL: String = "https://api.sandbox.checkout.com/tokens"

}

zane-smith-cko added 6 commits March 3, 2026 14:52

PIMOB-4287: add subdomain prefix to base url for multi region support

ed27d58

PIMOB-4287: rename base url prefix var, include global subdomain in c…

8c5b4c9

…onfig, add updated public keys

PIMOB-4287: update kdoc

80963da

PIMOB-4287: add & fix unit tests, rename variable name for baseurl pr…

2861377

…efix, add validator extension function

PIMOB-4287: lint format check

0a5ee24

PIMOB-4287: remove unused secret key

57e489a

zane-smith-cko self-assigned this Mar 6, 2026

zane-smith-cko requested a review from Copilot March 6, 2026 17:39

Copilot started reviewing on behalf of zane-smith-cko March 6, 2026 17:39 View session

Copilot AI reviewed Mar 6, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/pimob 4287 add subdomain prefix#302

Feature/pimob 4287 add subdomain prefix#302
zane-smith-cko wants to merge 6 commits intomasterfrom
feature/PIMOB-4287_add_subdomain_prefix

zane-smith-cko commented Mar 6, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Copilot AI Mar 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

		import com.checkout.base.util.EnvironmentConstants.SANDBOX_SERVER_URL


		internal fun Environment.toBaseUrl(baseUrlPrefix: String? = null) = when(this) {

-	public static final String SECRET_KEY = "sk_sbox_cqc26o3haljkwuns6xcfcmf2vmu";
+	private static String loadSecretKey() {
+		String secretKey = System.getenv("CHECKOUT_SECRET_KEY");
+		if (secretKey == null || secretKey.isEmpty()) {
+			throw new IllegalStateException("Environment variable CHECKOUT_SECRET_KEY must be set with a valid secret key.");
+		}
+		return secretKey;
+	}
+	public static final String SECRET_KEY = loadSecretKey();

-    SANDBOX
+    SANDBOX;
+    @Deprecated(
+        message = "Environment.url is deprecated. Use the appropriate configuration or tokenization URL accessor instead."
+    )
+    public val url: String
+        get() = when (this) {
+            PRODUCTION -> PRODUCTION_URL
+            SANDBOX -> SANDBOX_URL
+        }
+    private companion object {
+        private const val PRODUCTION_URL: String = "https://api.checkout.com/tokens"
+        private const val SANDBOX_URL: String = "https://api.sandbox.checkout.com/tokens"
+    }

Conversation

zane-smith-cko commented Mar 6, 2026

Issue

Proposed changes

Test Steps

Checklist

Further comments

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants