Release v200.7.0 (#340)

Co-authored-by: Trevor Draeseke <[email protected]>
Co-authored-by: TADraeseke <[email protected]>
Co-authored-by: Alan Lucas <[email protected]>
Co-authored-by: hud10837 <[email protected]>
Co-authored-by: Oliver Smith <[email protected]>
Co-authored-by: Darryl Lynch <[email protected]>
Co-authored-by: Erick Lopez Solis <[email protected]>
Co-authored-by: Shelly Gill <[email protected]>

Author: 8 people

.gitignore

@@ -15,6 +15,7 @@ build/
 *.classpath
 .settings/
 .vscode
+*.salive
 
 # OS generated files #
 .DS_Store

README.md

@@ -11,7 +11,7 @@
 
 ## Overview
 
-ArcGIS Maps SDK for Kotlin v200.6.0 samples.  The `main` branch of this repository contains sample app modules for the latest available version of the [ArcGIS Maps Kotlin SDK](https://developers.arcgis.com/kotlin/). Samples released under older versions can be found through the [git tags](https://github.com/Esri/arcgis-maps-sdk-kotlin-samples/tags).  Please read our [wiki](https://github.com/Esri/arcgis-maps-sdk-kotlin-samples/wiki) for help with working with this repository.
+ArcGIS Maps SDK for Kotlin v200.7.0 samples.  The `main` branch of this repository contains sample app modules for the latest available version of the [ArcGIS Maps Kotlin SDK](https://developers.arcgis.com/kotlin/). Samples released under older versions can be found through the [git tags](https://github.com/Esri/arcgis-maps-sdk-kotlin-samples/tags).  Please read our [wiki](https://github.com/Esri/arcgis-maps-sdk-kotlin-samples/wiki) for help with working with this repository.
 
 ## Prerequisites
 

app/build.gradle.kts

@@ -7,12 +7,10 @@ plugins {
     alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.gradle.secrets)
     alias(libs.plugins.sample.files.copy)
-    alias(libs.plugins.screenshots.copy)
     alias(libs.plugins.ksp)
 }
 
 tasks.named("preBuild").configure { dependsOn("copyCodeFiles") }
-tasks.named("preBuild").configure { dependsOn("copyScreenshots") }
 
 secrets {
     // this file doesn't contain secrets, it just provides defaults which can be committed into git.
@@ -28,7 +26,7 @@ android {
     }
 
     // Optional input to apply the external signing configuration for the sample viewer
-    // Example: ./gradlew assembleRelease -PsigningPropsFilePath=absolute-file-path/signing.properties -D build=200.6.0
+    // Example: ./gradlew assembleRelease -PsigningPropsFilePath=absolute-file-path/signing.properties -D build=200.7.0
     val signingPropsFilePath = project.findProperty("signingPropsFilePath").toString()
     val signingPropsFile = rootProject.file(signingPropsFilePath)
 
@@ -71,7 +69,9 @@ android {
 
 dependencies {
     for (sampleFile in file("../samples").listFiles()!!) {
-        if (sampleFile.isDirectory) {
+        if (sampleFile.isDirectory &&
+            sampleFile.listFiles()?.find { it.name.equals("build.gradle.kts") } != null
+        ) {
             implementation(project(":samples:" + sampleFile.name))
         }
     }

app/src/main/AndroidManifest.xml

@@ -16,14 +16,18 @@
         android:theme="@style/AppTheme"
         tools:targetApi="31">
         <activity
-            android:name=".MainActivity"
+            android:name=".SampleViewerLauncherActivity"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
 
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
+        <activity
+            android:name=".MainActivity"
+            android:exported="true">
+        </activity>
     </application>
 
 </manifest>

app/src/main/java/com/esri/arcgismaps/kotlin/sampleviewer/MainActivity.kt

@@ -22,22 +22,47 @@ import androidx.activity.compose.setContent
 import androidx.activity.enableEdgeToEdge
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.Surface
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
 import com.esri.arcgismaps.kotlin.sampleviewer.navigation.NavGraph
+import com.esri.arcgismaps.sample.sampleslib.components.MessageDialog
 import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
 
 class MainActivity : ComponentActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         enableEdgeToEdge()
         setContent {
-            setContent {
-
-                SampleAppTheme {
-                    Surface(color = MaterialTheme.colorScheme.background) {
-                        NavGraph()
-                    }
+            SampleAppTheme {
+                Surface(color = MaterialTheme.colorScheme.background) {
+                    NavGraph()
+                    HandleExceptions()
                 }
             }
         }
     }
+
+    /**
+     * Responsible for managing incoming exceptions and displaying it as a dialog in the UI.
+     */
+    @Composable
+    fun HandleExceptions() {
+        var sampleViewerException by remember { 
+            mutableStateOf(
+                intent.extras?.let {
+                    it.getStringArray("SampleViewerException") ?: arrayOf()
+                } ?: arrayOf<String>()
+            ) 
+        }
+        if (sampleViewerException.isNotEmpty()) {
+            MessageDialog(
+                onDismissRequest = { sampleViewerException = arrayOf() },
+                title = sampleViewerException[0],
+                description = sampleViewerException[1]
+            )
+        }
+    }
 }

app/src/main/java/com/esri/arcgismaps/kotlin/sampleviewer/SampleViewerApplication.kt

@@ -1,3 +1,19 @@
+/* Copyright 2024 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 package com.esri.arcgismaps.kotlin.sampleviewer
 
 import android.app.Application

app/src/main/java/com/esri/arcgismaps/kotlin/sampleviewer/SampleViewerLauncherActivity.kt

@@ -0,0 +1,87 @@
+/* Copyright 2024 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.esri.arcgismaps.kotlin.sampleviewer
+
+import android.content.Intent
+import android.os.Bundle
+import android.os.Handler
+import android.os.Looper
+import android.util.Log
+import androidx.activity.ComponentActivity
+
+class SampleViewerLauncherActivity : ComponentActivity(), ExceptionListener {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setupExceptionHandler()
+        startMainActivity(null)
+    }
+
+    /**
+     *  Prepares extras for the intent with error information if a [throwable] is provided.
+     *  It then starts the [MainActivity] by creating an intent with necessary flag and extras.
+     */
+    private fun startMainActivity(throwable: Throwable?) {
+        val extras = Bundle()
+        if (throwable != null) {
+            extras.putStringArray(
+                /* key = */     "SampleViewerException",
+                /* value = */   arrayOf(throwable.message.toString(), throwable.cause.toString())
+            )
+        }
+
+        startActivity(Intent(this, MainActivity::class.java).apply {
+            addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP)
+            addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK)
+            addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+            putExtras(extras)
+        })
+    }
+
+    /**
+     * Overrides [ExceptionListener] to capture the [throwable]
+     * and starts the [MainActivity] with the exception details.
+     */
+    override fun uncaughtException(throwable: Throwable) {
+        Log.e("SampleViewerException", throwable.message.toString(), throwable)
+        startMainActivity(throwable)
+    }
+
+    /**
+     * Posts a task to the main [Looper] to handle uncaught exceptions.
+     */
+    private fun setupExceptionHandler() {
+        Handler(Looper.getMainLooper()).post {
+            while (true) {
+                try {
+                    Looper.loop()
+                } catch (e: Throwable) {
+                    uncaughtException(e)
+                }
+            }
+        }
+        Thread.setDefaultUncaughtExceptionHandler { _, e ->
+            uncaughtException(e)
+        }
+    }
+}
+
+/**
+ * This interface defines a method [uncaughtException] to handle uncaught exceptions.
+ */
+interface ExceptionListener {
+    fun uncaughtException(throwable: Throwable)
+}

app/src/main/java/com/esri/arcgismaps/kotlin/sampleviewer/model/DefaultSampleInfoRepository.kt

@@ -19,17 +19,22 @@ package com.esri.arcgismaps.kotlin.sampleviewer.model
 import android.content.Context
 import android.util.Log
 import com.esri.arcgismaps.kotlin.sampleviewer.model.Sample.Companion.loadActivityPath
+import com.esri.arcgismaps.kotlin.sampleviewer.model.Sample.Companion.loadCodeFiles
 import com.esri.arcgismaps.kotlin.sampleviewer.model.Sample.Companion.loadReadMe
 import com.esri.arcgismaps.kotlin.sampleviewer.model.Sample.Companion.loadScreenshot
 import com.esri.arcgismaps.kotlin.sampleviewer.model.room.AppDatabase
 import com.esri.arcgismaps.kotlin.sampleviewer.model.room.Converters
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.withContext
 import kotlinx.serialization.json.Json
 import java.util.concurrent.atomic.AtomicBoolean
 
 /**
- * The single source of truth for app wide data. It reads the sample metadata to create as list of
+ * The single source of truth for app wide data. It reads the sample metadata to create a list of
  * [Sample] objects and populates the database used for search.
  * It also provides functions to get samples by category, name, or all samples.
  */
@@ -39,55 +44,59 @@ object DefaultSampleInfoRepository : SampleInfoRepository {
 
     private val json = Json { ignoreUnknownKeys = true }
 
-    private val sampleList = mutableListOf<Sample>()
+    private val _sampleData = MutableStateFlow<List<Sample>>(emptyList())
+    private val sampleData = _sampleData.asStateFlow()
 
     /**
-     * Load the sample metadata from the metadata folder in the assets directory and updates sampleList
+     * Load the sample metadata from 'samples.json' in the assets directory and updates sampleList
      * of [Sample] objects.
      */
     suspend fun load(context: Context) {
         if (isInitialized.compareAndSet(false, true)) {
-            // Iterate through the metadata folder for all metadata files
+            // List that will be populated with samples
+            val sampleList = mutableListOf<Sample>()
 
-            context.assets.list("samples")?.forEach { samplePath ->
-                // Get this metadata files as a string
-                context.assets.open("samples/$samplePath/README.metadata.json").use { inputStream ->
-                    val metadataJsonString = inputStream.bufferedReader().use { it.readText() }
-                    try {
-                        val metadata = json.decodeFromString<SampleMetadata>(metadataJsonString)
+            // Read the entire 'samples.json' from build/sampleAssets/samples/
+            val samplesJsonString = context.assets.open("samples/samples.json").use { stream ->
+                stream.bufferedReader().use { it.readText() }
+            }
+
+            // Parse it into a map of: sampleFolderName -> mapOf( filename -> fileContent )
+            val allSamplesData = json.decodeFromString<Map<String, Map<String, String>>>(samplesJsonString)
+
+            // Build each Sample using the metadata from "README.metadata.json"
+            allSamplesData.forEach { (sampleFolderName, fileMap) ->
+                val metadataJsonString = fileMap["README.metadata.json"]
+                    ?: throw Exception("README.metadata.json not found in sample: $sampleFolderName")
+                try {
+                    val metadata = json.decodeFromString<SampleMetadata>(metadataJsonString)
 
-                        // Create and add a new sample metadata data class object to the list
-                        val sample = Sample(
-                            name = metadata.title,
-                            codeFiles = Sample.loadCodeFiles(
-                                context = context,
-                                sampleName = metadata.title
-                            ),
-                            url = "https://developers.arcgis.com/kotlin/sample-code/" +
-                                    metadata.title.replace(" ", "-").lowercase(),
-                            readMe = loadReadMe(
-                                context = context,
-                                sampleName = samplePath
-                            ),
-                            screenshotURL = loadScreenshot(
-                                sampleName = metadata.title,
-                                imageArray = metadata.imagePaths
-                            ),
-                            mainActivity = loadActivityPath(
-                                codePaths = metadata.codePaths
-                            ),
-                            metadata = metadata,
-                        )
-                        // Add the new sample to the list
-                        sampleList.add(sample)
-                    } catch (e: Exception) {
-                        Log.e(
-                            DefaultSampleInfoRepository::class.simpleName,
-                            "Exception at $samplePath: " + e.printStackTrace()
-                        )
-                    }
+                    // Create and add a new sample metadata data class object to the list
+                    val sample = Sample(
+                        name = metadata.title,
+                        codeFiles = loadCodeFiles(fileMap),
+                        url = "https://developers.arcgis.com/kotlin/sample-code/" +
+                                metadata.title.replace(" ", "-").lowercase(),
+                        readMe = loadReadMe(fileMap),
+                        screenshotURL = loadScreenshot(
+                            sampleName = metadata.title,
+                            imageArray = metadata.imagePaths
+                        ),
+                        mainActivity = loadActivityPath(
+                            codePaths = metadata.codePaths
+                        ),
+                        metadata = metadata
+                    )
+                    // Add the new sample to the list
+                    sampleList.add(sample)
+                } catch (e: Exception) {
+                    Log.e(
+                        DefaultSampleInfoRepository::class.simpleName,
+                        "Exception at $sampleFolderName: ${e.stackTraceToString()}"
+                    )
                 }
             }
+            _sampleData.value = sampleList
             withContext(Dispatchers.IO) {
                 // Populates the Room SQL database
                 populateDatabase(context)
@@ -99,22 +108,22 @@ object DefaultSampleInfoRepository : SampleInfoRepository {
      * Populates the Room SQL database with all samples and sample info
      */
     private suspend fun populateDatabase(context: Context) {
-        val sampleEntities = sampleList.map { Converters().convertToEntity(sample = it) }
+        val sampleEntities = sampleData.value.map { Converters().convertToEntity(sample = it) }
         AppDatabase.getDatabase(context).clearAllTables()
         AppDatabase.getDatabase(context).sampleDao().insertAll(samples = sampleEntities)
     }
 
     /**
      * Get a sample by its name. Either the formal name or title.
      */
-    override fun getSampleByName(sampleName: String): Sample {
-        return sampleList.first { it.metadata.formalName == sampleName || it.metadata.title == sampleName }
+    override fun getSampleByName(sampleName: String): Flow<Sample> {
+        return sampleData.map { it.first { sample -> sample.metadata.formalName == sampleName || sample.metadata.title == sampleName } }
     }
 
     /**
      * Get a list of samples for the given [SampleCategory].
      */
-    override fun getSamplesInCategory(sampleCategory: SampleCategory): List<Sample> {
-        return sampleList.filter { it.metadata.sampleCategory == sampleCategory }
+    override fun getSamplesInCategory(sampleCategory: SampleCategory): Flow<List<Sample>> {
+        return sampleData.map { it.filter { sample -> sample.metadata.sampleCategory == sampleCategory } }
     }
 }