Skip to content

refactor: [SDK-5538] add SdkOperation names for init-gated entry points #2800

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

Draft
abdulraqeeb33 wants to merge 1 commit into
base: feat/never-crash
Choose a base branch
from
Draft

refactor: [SDK-5538] add SdkOperation names for init-gated entry points #2800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/InputGuard.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.onesignal.common

import com.onesignal.debug.internal.logging.Logging
import com.onesignal.internal.SdkOperation

internal fun hasNullByte(value: String?): Boolean = value != null && '\u0000' in value

Expand All @@ -22,6 +23,12 @@ fun isMissing(
return error != null
}

internal fun isMissing(
value: String?,
operation: SdkOperation,
parameter: String,
): Boolean = isMissing(value, "$operation: $parameter")

/**
* Returns true when any of [values] is missing, per [isMissing].
*/
Expand Down
24 changes: 24 additions & 0 deletions OneSignalSDK/onesignal/core/src/main/java/com/onesignal/internal/SdkOperation.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package com.onesignal.internal

// Public entry points that wait for or require init. [label] is the API name the app called.
internal enum class SdkOperation(val label: String) {
INIT_WITH_CONTEXT("initWithContext"),
SESSION("Session"),
NOTIFICATIONS("Notifications"),
LOCATION("Location"),
IN_APP_MESSAGES("InAppMessages"),
USER("User"),
LOGIN("login"),
LOGOUT("logout"),
UPDATE_USER_JWT("updateUserJwt"),
JWT_LISTENERS("OneSignal"),
GET_CONSENT_REQUIRED("getConsentRequired"),
SET_CONSENT_REQUIRED("setConsentRequired"),
GET_CONSENT_GIVEN("getConsentGiven"),
SET_CONSENT_GIVEN("setConsentGiven"),
GET_DISABLE_GMS_MISSING_PROMPT("getDisableGMSMissingPrompt"),
SET_DISABLE_GMS_MISSING_PROMPT("setDisableGMSMissingPrompt"),
;

override fun toString() = label
}
8 changes: 8 additions & 0 deletions OneSignalSDK/onesignal/core/src/test/java/com/onesignal/common/InputGuardTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package com.onesignal.common

import com.onesignal.debug.LogLevel
import com.onesignal.debug.internal.logging.Logging
import com.onesignal.internal.SdkOperation
import io.kotest.core.spec.style.FunSpec
import io.kotest.matchers.shouldBe

Expand All @@ -24,4 +25,11 @@ class InputGuardTests : FunSpec({
isMissing("abc\u0000", "addAlias: id") shouldBe true
hasMissingEntries(mapOf("external_id" to "\u0000: 1"), "addAliases", allowEmptyValue = false) shouldBe true
}

test("the operation overload applies the same checks and logs the public API name") {
isMissing(null, SdkOperation.LOGIN, "externalId") shouldBe true
isMissing("\u0000", SdkOperation.LOGIN, "externalId") shouldBe true
isMissing("user-1", SdkOperation.LOGIN, "externalId") shouldBe false
"${SdkOperation.LOGIN}: externalId" shouldBe "login: externalId"
}
})
Loading