reaper: Require setting OVERRIDE_BASE_URL

Author: chromy

reaper/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to reaper will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+- Require `com.emergetools.OVERRIDE_BASE_URL` to be set. [#610](https://github.com/EmergeTools/emerge-android/pull/610)
+
 ## 1.0.1 - 2025-03-05
 
 - Add `Reaper.fuseOff()`. [#491](https://github.com/EmergeTools/emerge-android/pull/491)

reaper/reaper/src/main/kotlin/com/emergetools/reaper/Manifest.kt

@@ -4,6 +4,9 @@ import android.os.Bundle
 
 private const val MANIFEST_TAG_INSTRUMENTED = "com.emergetools.reaper.REAPER_INSTRUMENTED"
 private const val MANIFEST_TAG_PUBLISHABLE_API_KEY = "com.emergetools.reaper.PUBLISHABLE_API_KEY"
+
+// Override is a misnomer now as this is required and there is no base endpoint however
+// don't want to rename this and create more confusion.
 private const val MANIFEST_TAG_OVERRIDE_BASE_URL = "com.emergetools.OVERRIDE_BASE_URL"
 private const val MANIFEST_TAG_DEBUG = "com.emergetools.reaper.DEBUG"
 
@@ -16,7 +19,12 @@ internal fun getApiKey(metadata: Bundle): String {
 }
 
 internal fun getBaseUrl(metadata: Bundle): String {
-  return metadata.getString(MANIFEST_TAG_OVERRIDE_BASE_URL, ReaperConfig.EMERGE_BASE_URL)
+  val baseUrl = metadata.getString(MANIFEST_TAG_OVERRIDE_BASE_URL, "")
+  check(baseUrl != "") {
+    "com.emergetools.OVERRIDE_BASE_URL must be set to a URL. " +
+      "See https://docs.emergetools.com/docs/reaper-setup-android#setting-baseurl"
+  }
+  return baseUrl
 }
 
 internal fun isDebug(metadata: Bundle): Boolean {

reaper/sample/app/src/main/AndroidManifest.xml

@@ -21,6 +21,19 @@
     </activity>
     <activity android:name="androidx.activity.ComponentActivity" />
 
+    <!-- The Reaper library sends data to two endpoints:
+      - $baseUrl/report
+      - $baseUrl/reaper/error
+      So if baseUrl is set to https://example.com/foo as
+      below Reaper reports will be sent to:
+      - https://example.com/foo/report
+      and errors will be sent to:
+      - https://example.com/foo/reaper/error
+      -->
+    <meta-data
+      android:name="com.emergetools.OVERRIDE_BASE_URL"
+      android:value="https://example.com/foo" />
+
   </application>
 
 </manifest>

reaper/sample/stress/src/main/AndroidManifest.xml

@@ -13,6 +13,20 @@
         <category android:name="android.intent.category.LAUNCHER" />
       </intent-filter>
     </activity>
+
+    <!-- The Reaper library sends data to two endpoints:
+      - $baseUrl/report
+      - $baseUrl/reaper/error
+      So if baseUrl is set to https://example.com/foo as
+      below Reaper reports will be sent to:
+      - https://example.com/foo/report
+      and errors will be sent to:
+      - https://example.com/foo/reaper/error
+      -->
+    <meta-data
+      android:name="com.emergetools.OVERRIDE_BASE_URL"
+      android:value="https://example.com/foo" />
+
   </application>
 
 </manifest>