SOLR-17658: Implement start screen (#3388)

* Add design for start screen

* Add connection logic with error handling

* Add SupervisorJob to component scopes

* Add component outputs for side effect navigation

* Add placeholder for authentication view

* Change the way coroutine scopes and context are passed down and initialized

* Add test cases for new components

* Add DefaultStartComponent integration tests

* Cleanup and add test cases

* Display loading indicator while connecting

* Add missing license headers

* Correctly propagate the connection URL to other components

* Update solr/ui/src/wasmJsMain/kotlin/org/apache/solr/ui/errors/parseError.kt

Co-authored-by: Eric Pugh <epugh@opensourceconnections.com>

* Use 127.0.0.1 instead of localhost

---------

Co-authored-by: Eric Pugh <epugh@opensourceconnections.com>

Author: malliaridis

gradle/libs.versions.toml

@@ -439,6 +439,7 @@ kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serializa
 ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
 ktor-client-contentNegotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" }
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
+ktor-client-mock = { module = "io.ktor:ktor-client-mock", version.ref = "ktor" }
 ktor-client-serialization-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
 langchain4j-cohere = { module = "dev.langchain4j:langchain4j-cohere", version.ref = "langchain4j" }
 langchain4j-core = { module = "dev.langchain4j:langchain4j-core", version.ref = "langchain4j" }

solr/ui/build.gradle.kts

@@ -107,6 +107,7 @@ kotlin {
                 implementation(libs.kotlinx.coroutines.test)
                 @OptIn(org.jetbrains.compose.ExperimentalComposeLibrary::class)
                 implementation(compose.uiTest)
+                implementation(libs.ktor.client.mock)
             }
         }
 

solr/ui/gradle.lockfile

@@ -66,6 +66,9 @@ io.ktor:ktor-client-content-negotiation:3.1.0=allSourceSetsCompileDependenciesMe
 io.ktor:ktor-client-core-jvm:3.1.0=desktopCompileClasspath,desktopRuntimeClasspath,desktopTestCompileClasspath,desktopTestRuntimeClasspath
 io.ktor:ktor-client-core-wasm-js:3.1.0=wasmJsCompileClasspath,wasmJsNpmAggregated,wasmJsRuntimeClasspath,wasmJsTestCompileClasspath,wasmJsTestNpmAggregated,wasmJsTestRuntimeClasspath
 io.ktor:ktor-client-core:3.1.0=allSourceSetsCompileDependenciesMetadata,allTestSourceSetsCompileDependenciesMetadata,commonMainApiDependenciesMetadata,commonMainCompileOnlyDependenciesMetadata,commonMainImplementationDependenciesMetadata,commonMainResolvableDependenciesMetadata,commonTestApiDependenciesMetadata,commonTestCompileOnlyDependenciesMetadata,commonTestImplementationDependenciesMetadata,commonTestResolvableDependenciesMetadata,desktopCompileClasspath,desktopMainApiDependenciesMetadata,desktopMainCompileOnlyDependenciesMetadata,desktopMainImplementationDependenciesMetadata,desktopMainResolvableDependenciesMetadata,desktopRuntimeClasspath,desktopTestApiDependenciesMetadata,desktopTestCompileClasspath,desktopTestCompileOnlyDependenciesMetadata,desktopTestImplementationDependenciesMetadata,desktopTestResolvableDependenciesMetadata,desktopTestRuntimeClasspath,metadataCommonMainCompileClasspath,metadataCompileClasspath,wasmJsCompileClasspath,wasmJsMainApiDependenciesMetadata,wasmJsMainCompileOnlyDependenciesMetadata,wasmJsMainImplementationDependenciesMetadata,wasmJsMainResolvableDependenciesMetadata,wasmJsNpmAggregated,wasmJsRuntimeClasspath,wasmJsTestApiDependenciesMetadata,wasmJsTestCompileClasspath,wasmJsTestCompileOnlyDependenciesMetadata,wasmJsTestImplementationDependenciesMetadata,wasmJsTestNpmAggregated,wasmJsTestResolvableDependenciesMetadata,wasmJsTestRuntimeClasspath
+io.ktor:ktor-client-mock-jvm:3.1.0=desktopTestCompileClasspath,desktopTestRuntimeClasspath
+io.ktor:ktor-client-mock-wasm-js:3.1.0=wasmJsTestCompileClasspath,wasmJsTestNpmAggregated,wasmJsTestRuntimeClasspath
+io.ktor:ktor-client-mock:3.1.0=allTestSourceSetsCompileDependenciesMetadata,commonTestApiDependenciesMetadata,commonTestCompileOnlyDependenciesMetadata,commonTestImplementationDependenciesMetadata,commonTestResolvableDependenciesMetadata,desktopTestApiDependenciesMetadata,desktopTestCompileClasspath,desktopTestCompileOnlyDependenciesMetadata,desktopTestImplementationDependenciesMetadata,desktopTestResolvableDependenciesMetadata,desktopTestRuntimeClasspath,wasmJsTestApiDependenciesMetadata,wasmJsTestCompileClasspath,wasmJsTestCompileOnlyDependenciesMetadata,wasmJsTestImplementationDependenciesMetadata,wasmJsTestNpmAggregated,wasmJsTestResolvableDependenciesMetadata,wasmJsTestRuntimeClasspath
 io.ktor:ktor-events-jvm:3.1.0=desktopCompileClasspath,desktopRuntimeClasspath,desktopTestCompileClasspath,desktopTestRuntimeClasspath
 io.ktor:ktor-events-wasm-js:3.1.0=wasmJsCompileClasspath,wasmJsNpmAggregated,wasmJsRuntimeClasspath,wasmJsTestCompileClasspath,wasmJsTestNpmAggregated,wasmJsTestRuntimeClasspath
 io.ktor:ktor-events:3.1.0=allSourceSetsCompileDependenciesMetadata,allTestSourceSetsCompileDependenciesMetadata,commonMainApiDependenciesMetadata,commonMainCompileOnlyDependenciesMetadata,commonMainImplementationDependenciesMetadata,commonMainResolvableDependenciesMetadata,commonTestApiDependenciesMetadata,commonTestCompileOnlyDependenciesMetadata,commonTestImplementationDependenciesMetadata,commonTestResolvableDependenciesMetadata,desktopCompileClasspath,desktopMainApiDependenciesMetadata,desktopMainCompileOnlyDependenciesMetadata,desktopMainImplementationDependenciesMetadata,desktopMainResolvableDependenciesMetadata,desktopRuntimeClasspath,desktopTestApiDependenciesMetadata,desktopTestCompileClasspath,desktopTestCompileOnlyDependenciesMetadata,desktopTestImplementationDependenciesMetadata,desktopTestResolvableDependenciesMetadata,desktopTestRuntimeClasspath,metadataCommonMainCompileClasspath,metadataCompileClasspath,wasmJsCompileClasspath,wasmJsMainApiDependenciesMetadata,wasmJsMainCompileOnlyDependenciesMetadata,wasmJsMainImplementationDependenciesMetadata,wasmJsMainResolvableDependenciesMetadata,wasmJsNpmAggregated,wasmJsRuntimeClasspath,wasmJsTestApiDependenciesMetadata,wasmJsTestCompileClasspath,wasmJsTestCompileOnlyDependenciesMetadata,wasmJsTestImplementationDependenciesMetadata,wasmJsTestNpmAggregated,wasmJsTestResolvableDependenciesMetadata,wasmJsTestRuntimeClasspath

solr/ui/src/commonMain/composeResources/drawable/solr-sun.svg

@@ -17,10 +17,22 @@
   -->
 
 <resources>
-  <!-- Content Descriptions (CD) -->
+  <!-- Actions (action) -->
+  <string name="action_connect">Connect</string>
+  <string name="action_logout">Logout</string>
+
+  <!-- Content Descriptions (cd) -->
   <string name="cd_solr_logo">Solr Logo</string>
 
-  <!-- Navigation (NAV) -->
+  <!-- Descriptions (desc) -->
+  <string name="desc_to_get_started">To get started, please provide a Solr host URL:</string>
+
+  <!-- Errors (error) -->
+  <string name="error_invalid_url">The provided URL is invalid.</string>
+  <string name="error_solr_host_not_found">Solr host could not be found.</string>
+  <string name="error_unknown">An unknown error occurred.</string>
+
+  <!-- Navigation (nav) -->
   <string name="nav_cluster">Cluster</string>
   <string name="nav_collections">Collections</string>
   <string name="nav_configsets">Configsets</string>
@@ -32,15 +44,21 @@
   <string name="nav_security">Security</string>
   <string name="nav_thread_dump">Thread Dump</string>
 
+  <!-- Placeholders (ph) -->
+  <string name="ph_solr_url">http://127.0.0.1:8983/</string>
+
+  <!-- Titles (title) -->
+  <string name="title_welcome_to_solr">Welcome to Solr Admin UI</string>
+
   <!-- General Text -->
   <string name="community">Community</string>
   <string name="documentation">Documentation</string>
   <string name="irc">IRC</string>
   <string name="issue_tracker">Issue Tracker</string>
-  <string name="logout">Logout</string>
   <string name="slack">Slack</string>
   <string name="solr_query_syntax">Solr Query Syntax</string>
   <string name="support">Support</string>
+  <string name="connecting">Connecting...</string>
 
   <!-- Uncategorized -->
 </resources>

solr/ui/src/commonMain/composeResources/values/strings.xml

@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.solr.ui.components.auth
+
+import io.ktor.http.Url
+
+interface UnauthenticatedComponent {
+
+    /**
+     * Aborts the authentication attempt.
+     */
+    fun onAbort()
+
+    sealed interface Output {
+
+        /**
+         * Emitted when the user successfully authenticated against
+         * the Solr instance.
+         *
+         * @property url The URL the connection was established with
+         */
+        data class OnConnected(val url: Url): Output
+
+        /**
+         * Emitted when the user aborts the authentication flow.
+         */
+        data object OnAbort: Output
+    }
+}

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/auth/UnauthenticatedComponent.kt

@@ -0,0 +1,35 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.solr.ui.components.auth.integration
+
+import com.arkivanov.mvikotlin.core.store.StoreFactory
+import io.ktor.client.HttpClient
+import org.apache.solr.ui.components.auth.UnauthenticatedComponent
+import org.apache.solr.ui.utils.AppComponentContext
+
+class DefaultUnauthenticatedComponent(
+    componentContext: AppComponentContext,
+    storeFactory: StoreFactory,
+    httpClient: HttpClient,
+    private val output: (UnauthenticatedComponent.Output) -> Unit
+) : UnauthenticatedComponent, AppComponentContext by componentContext {
+
+    // TODO Implement me
+
+    override fun onAbort() = output(UnauthenticatedComponent.Output.OnAbort)
+}

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/auth/integration/DefaultUnauthenticatedComponent.kt

@@ -22,6 +22,7 @@ import com.arkivanov.mvikotlin.core.store.StoreFactory
 import com.arkivanov.mvikotlin.extensions.coroutines.stateFlow
 import io.ktor.client.HttpClient
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.SupervisorJob
 import org.apache.solr.ui.components.environment.EnvironmentComponent
 import org.apache.solr.ui.components.environment.store.EnvironmentStoreProvider
 import org.apache.solr.ui.utils.AppComponentContext
@@ -37,13 +38,15 @@ class DefaultEnvironmentComponent(
     httpClient: HttpClient,
 ) : EnvironmentComponent, AppComponentContext by componentContext {
 
-    private val mainScope = coroutineScope(mainContext)
+    private val mainScope = coroutineScope(SupervisorJob() + mainContext)
+    private val ioScope = coroutineScope(SupervisorJob() + ioContext)
 
     private val store = instanceKeeper.getStore {
         EnvironmentStoreProvider(
             storeFactory = storeFactory,
             client = HttpEnvironmentStoreClient(httpClient),
-            ioContext = ioContext,
+            mainContext = mainScope.coroutineContext,
+            ioContext = ioScope.coroutineContext,
         ).provide()
     }
 

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/integration/DefaultEnvironmentComponent.kt

@@ -40,6 +40,7 @@ import org.apache.solr.ui.components.environment.store.EnvironmentStore.State
 internal class EnvironmentStoreProvider(
     private val storeFactory: StoreFactory,
     private val client: Client,
+    private val mainContext: CoroutineContext,
     private val ioContext: CoroutineContext,
 ) {
 
@@ -58,7 +59,7 @@ internal class EnvironmentStoreProvider(
         /**
          * Action used for initiating the initial fetch of environment data.
          */
-        data object FetchInitialSystemData: Action
+        data object FetchInitialSystemData : Action
     }
 
     private sealed interface Message {
@@ -78,9 +79,10 @@ internal class EnvironmentStoreProvider(
         data class JavaPropertiesUpdated(val properties: List<JavaProperty>) : Message
     }
 
-    private inner class ExecutorImpl : CoroutineExecutor<Intent, Action, State, Message, Nothing>() {
+    private inner class ExecutorImpl :
+        CoroutineExecutor<Intent, Action, State, Message, Nothing>(mainContext) {
 
-        override fun executeAction(action: Action) = when(action) {
+        override fun executeAction(action: Action) = when (action) {
             Action.FetchInitialSystemData -> {
                 fetchSystemData()
                 fetchJavaProperties()
@@ -145,6 +147,7 @@ internal class EnvironmentStoreProvider(
                 system = msg.data.system,
                 node = msg.data.node,
             )
+
             is Message.JavaPropertiesUpdated -> copy(
                 javaProperties = msg.properties,
             )

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/store/EnvironmentStoreProvider.kt

@@ -19,7 +19,9 @@ package org.apache.solr.ui.components.root
 
 import com.arkivanov.decompose.router.stack.ChildStack
 import com.arkivanov.decompose.value.Value
+import org.apache.solr.ui.components.auth.UnauthenticatedComponent
 import org.apache.solr.ui.components.main.MainComponent
+import org.apache.solr.ui.components.start.StartComponent
 
 /**
  * Root component used by each target as an entry point to the application.
@@ -33,9 +35,10 @@ interface RootComponent {
 
     sealed interface Child {
 
+        data class Start(val component: StartComponent): Child
+
         data class Main(val component: MainComponent): Child
 
-        // TODO Add child once authentication is checked
-        // data class Unauthenticated(val component: UnauthenticatedComponent): Child
+        data class Unauthenticated(val component: UnauthenticatedComponent): Child
     }
 }