build: introduce a multi-platform project to host the new Compose UI #4115

Tbaile · 2025-01-19T23:04:00Z

Introducing new project that tries to give Alchemist a UI that is completely multi-platform across desktop apps and web.
This is an introductory pull requests that adds the project and the initial dependencies.

codecov · 2025-01-19T23:34:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (124d522) to head (3d8fb39).
Report is 1 commits behind head on master.

Additional details and impacted files

@@          Coverage Diff           @@
##           master   #4115   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files           2       2           
  Lines          90      90           
  Branches        3       3           
======================================
  Misses         90      90

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

DanySK

let's make sure the build is clean

DanySK · 2025-01-21T09:43:28Z

alchemist-composeui/build.gradle.kts

+    id("kotlin-multiplatform-convention") apply false
+    kotlin("multiplatform")


Suggested change

id("kotlin-multiplatform-convention") apply false

kotlin("multiplatform")

id("kotlin-multiplatform-convention")

If there are changes required to the convention, then we apply them to the convention

While the convention is fine as is, it requires the js target which is not available in this package. A possible solution is to being able to customize the convention, this needs then enough defaults so that the convention does not break everything and can be customized when needed. If that works for you I'll look into that.

By changing the section from the kotlin-multiplatform-convention plugin from this:

js { browser() nodejs() }

to this:

// adding js only when directory `jsMain` exists if (projectDir.resolve("src/jsMain").exists()) { js { browser() nodejs() } }

It's possible to achieve this behavior, not sure it's most optimal one (but might be effective in the long run, just checking for the target to build before importing the target)

Wait, why don't we have js? Isn't Compose supposed to run also in browser? This is also our main goal: an in-browser interface

It runs on web, but not using the js target, instead using the wasmJs one. This is the only way to use the cross-platform interface: https://kotlinlang.org/docs/wasm-overview.html

Oh, I see. I'd proceed as follows:

create withJS() extension method in the convention, running js { browser() nodejs() }

create withWasmJS() extension method in the convention, running js { browser() nodejs() }

enable only JVM inside the convention

update all other modules using the convention to call withJS()

I would avoid fancy autodetection of folders. It can get very surprising, and the logics is reversed (if I have JS, then I may have the folder, not vice versa). I could (and I do) generate js for purely kotlin subprojects

alchemist-composeui/build.gradle.kts

DanySK · 2025-01-24T13:35:39Z

alchemist-composeui/build.gradle.kts

+    fun PatternFilterable.excludeGenerated() = exclude { "build${separator}generated" in it.file.absolutePath }
+    withType<Detekt>().configureEach { excludeGenerated() }
+    ktlint { filter { excludeGenerated() } }


I think this can be moved in the convention

DanySK · 2025-01-24T13:36:56Z

alchemist-composeui/src/wasmJsMain/kotlin/it/unibo/alchemist/boundary/composeui/Main.kt

+ */
+@OptIn(ExperimentalComposeUiApi::class)
+fun main() {
+    ComposeViewport(document.body!!) {


Suggested change

ComposeViewport(document.body!!) {

ComposeViewport(checkNotNull(document.body) { "Reasonable error message" }) {

DanySK · 2025-01-24T13:37:50Z

gradle/libs.versions.toml

@@ -122,6 +124,7 @@ spotbugs-annotations = "com.github.spotbugs:spotbugs-annotations:4.9.0"
 redux-kotlin-threadsafe = "org.reduxkotlin:redux-kotlin-threadsafe:0.6.1"
 svgsalamander = "guru.nidi.com.kitfox:svgSalamander:1.1.3"
 trove4j = "net.sf.trove4j:trove4j:3.0.3"
+androidx-lifecycle-runtime-compose = { group = "org.jetbrains.androidx.lifecycle", name = "lifecycle-runtime-compose", version.ref = "androidx-lifecycle" }


please use lexicographic ordering

DanySK · 2025-01-24T13:38:01Z

gradle/libs.versions.toml

@@ -167,3 +170,5 @@ scalafmt = "cz.alenkacz.gradle.scalafmt:1.16.2"
 shadowJar = "com.github.johnrengelman.shadow:8.1.1"
 taskTree = "com.dorongold.task-tree:4.0.0"
 jpackage = "org.panteleyev.jpackageplugin:1.6.0"
+compose-multiplatform = { id = "org.jetbrains.compose", version.ref = "compose-multiplatform" }
+compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }


lexicographic ordering

DanySK · 2025-01-24T13:38:13Z

settings.gradle.kts

@@ -40,6 +40,7 @@ include(
    "alchemist-ui-tooling",
    "alchemist-swingui",
    "alchemist-web-renderer",
+    "alchemist-composeui",


lexicographic order

mergify · 2025-01-24T14:00:31Z

Hi @Tbaile! 👋
This pull request has conflicts 😖
Could you fix it? 🔧
Thank you! 🙏

sonarqubecloud · 2025-01-24T14:19:55Z

Please retry analysis of this Pull-Request directly on SonarQube Cloud

DanySK requested a review from AngeloFilaseta January 20, 2025 10:42

DanySK added the auto-update-rebase label Jan 20, 2025

DanySK force-pushed the master branch 6 times, most recently from 9889fc0 to aeead57 Compare January 20, 2025 14:08

DanySK requested changes Jan 21, 2025

View reviewed changes

DanySK force-pushed the master branch 20 times, most recently from 34fa775 to 3d8fb39 Compare January 24, 2025 10:49

DanySK force-pushed the master branch 2 times, most recently from 2092f41 to dbdaf5a Compare January 24, 2025 13:06

DanySK reviewed Jan 24, 2025

View reviewed changes

Tbaile and others added 5 commits January 24, 2025 13:57

feat(composeui): added compose ui initial build (WIP)

5426f19

fix(build): this could be posted on r/blackmagicfuckery (#3)

f5a4680

style: formatted docblocks

073363d

feat: removed default build in favor of Monitor implementation

e28024a

build: renamed gradle deps

4e01de4

DanySK force-pushed the master branch from dbdaf5a to 4e01de4 Compare January 24, 2025 13:57

chore(build): update the javadoc.io cache

c07eddb

chore(build): actualize the yarn.lock file

a1e0522

DanySK changed the title ~~feat: introducing multi-platform UI with Compose~~ build: introduce a multi-platform project to host the new Compose UI Jan 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build: introduce a multi-platform project to host the new Compose UI #4115

build: introduce a multi-platform project to host the new Compose UI #4115

Tbaile commented Jan 19, 2025

codecov bot commented Jan 19, 2025 •

edited

Loading

DanySK left a comment

DanySK Jan 21, 2025

Tbaile Jan 22, 2025

Tbaile Jan 22, 2025 •

edited

Loading

DanySK Jan 23, 2025

Tbaile Jan 23, 2025

DanySK Jan 24, 2025

DanySK Jan 24, 2025

DanySK Jan 24, 2025

DanySK Jan 24, 2025

DanySK Jan 24, 2025

DanySK Jan 24, 2025

mergify bot commented Jan 24, 2025

sonarqubecloud bot commented Jan 24, 2025

		id("kotlin-multiplatform-convention") apply false
		kotlin("multiplatform")

	id("kotlin-multiplatform-convention") apply false
	kotlin("multiplatform")
	id("kotlin-multiplatform-convention")

	ComposeViewport(document.body!!) {
	ComposeViewport(checkNotNull(document.body) { "Reasonable error message" }) {

build: introduce a multi-platform project to host the new Compose UI #4115

Are you sure you want to change the base?

build: introduce a multi-platform project to host the new Compose UI #4115

Conversation

Tbaile commented Jan 19, 2025

codecov bot commented Jan 19, 2025 • edited Loading

Codecov Report

DanySK left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tbaile Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mergify bot commented Jan 24, 2025

sonarqubecloud bot commented Jan 24, 2025

codecov bot commented Jan 19, 2025 •

edited

Loading

Tbaile Jan 22, 2025 •

edited

Loading