Support wasmJs target #4965

IlyaGulya · 2024-01-16T09:39:33Z

What's impossible for now:

Commonization of WebWorkerDriver can't be done without support for Kotlin arrays interop with wasmJs: https://youtrack.jetbrains.com/issue/KT-57125/Add-interop-with-JavaScript-arrays-to-Kotlin-Wasm

Changes:

Enable wasmJs target in MultiplatformConventions and :driver-test.
Migrate to use kotlin multiplatform default hierarchy template.
Add jsCommon source set containing common code for js and wasmJs targets.
Added jsNativeCommon source set to :runtime module containing common code for native, js, and wasmJs targets.
Enable watchosDeviceArm64 and linuxArm64 because of failing tests.
Support WebWorkerDriver for wasmJs target. Fix all tests to be passing.

dellisd · 2024-01-31T01:33:22Z

Is the conversion to .gradle.kts required to enable the wasmJs target? If not, it would be best to leave that conversion for a different PR since this one has a lot of files that are just moved and it's more difficult to review the actual changes here.

IlyaGulya · 2024-01-31T07:19:56Z

Sure, I will revert this change

IlyaGulya · 2024-02-05T07:25:49Z

@dellisd Hi!
I've rebased on the latest master.
Here are changes since your comment:

Reverted the migration to .gradle.kts.
Made web-worker-driver tests for js and wasmJs common.
Made createWebWorkerDriver helper function which allows creating the default WebWorkerDriver in the jsCommon sourceSet.
Upgraded Kotlin to 2.0.0-Beta3 and KSP to 2.0.0-Beta3-1.0.17

IlyaGulya · 2024-02-18T13:54:06Z

@dellisd Hi!
I've rebased on latest master.
Here're changes since my previous comment:

Upgraded Kotlin to 2.0.0-Beta4 and KSP to 2.0.0-Beta4-1.0.17
Upgraded kotlinx.coroutines to 1.8.0 with wasmJs support
Temporarily added Sonatype repository containing Turbine 1.1.0-SNAPSHOT

IlyaGulya · 2024-02-19T15:15:21Z

I'm not sure why, but instrumentation tests are failing on CI.
They're passing locally on my M1 Max.
https://github.com/IlyaGulya/sqldelight/actions/runs/7957378205/job/21719986393

artemyto · 2024-03-06T17:59:53Z

Turbine 1.1.0 with wasmJs support is out

IlyaGulya · 2024-03-12T09:44:34Z

Replaced Turbine snapshot with 1.1.0

IlyaGulya · 2024-03-13T15:28:57Z

Currently trying to fix tests 🙂

IlyaGulya · 2024-03-25T18:58:08Z

@dellisd Hi!
All tests are passing. I was able to rollback the kotlin 2.0 upgrade, so I think it can be merged after the code review 🙂
Please take a look when you will have time.

dellisd

Overall this looks good, but there are some changes to the public API that I think we should make and I'm a little unclear on why certain parts of the Wasm implementation can't be shared with the Js implementation.

dellisd · 2024-05-24T19:29:41Z

drivers/driver-test/build.gradle

@@ -23,9 +26,11 @@ kotlin {
  watchosX64()
  watchosArm32()
  watchosArm64()
+  watchosDeviceArm64()


Because these aren't directly related to adding Wasm support, I think these would be better split out into their own PR to introduce support for these targets.

Done!
I don't really remember why I've added them. AFAIK, because of some tests failing, but I can't reproduce it now.

dellisd · 2024-05-25T17:13:14Z

drivers/web-worker-driver/build.gradle

      testTask {
        useKarma {
          useChromeHeadless()
        }
      }
    }
  }
+  applyDefaultHierarchyTemplate {
+    it.common {
+      it.group("jsCommon") {


Is there any need for this to be jsCommon instead of leaving it as the default common?

Yeah, you are right, it's unnecessary. My bad, I'll remove this group.

dellisd · 2024-05-25T17:17:46Z

...er-driver/src/jsCommonMain/kotlin/app/cash/sqldelight/driver/worker/CreateWebWorkerDriver.kt

+
+import app.cash.sqldelight.db.SqlDriver
+
+expect fun createWebWorkerDriver(): SqlDriver


The web worker driver is designed to support more than just one worker implementation, so this function should be able to accept a Worker parameter to allow a consumer to define which worker should be loaded.

It is still possible to create WebWorkerDriver with custom Worker.
I think we could just rename this method to createDefaultWebWorkerDriver() instead.

dellisd · 2024-05-25T17:19:44Z

...web-worker-driver/src/wasmJsMain/kotlin/app/cash/sqldelight/driver/worker/WebWorkerDriver.kt

+ * @property worker The Worker running a SQL implementation that this driver communicates with.
+ * @see [WebWorkerDriver.fromScriptUrl]
+ */
+class WebWorkerDriver(private val worker: Worker) : SqlDriver {


Which elements of this class (and its jsMain counterpart) can't be lifted into the commonMain implementation? Ideally I think we would have one common implementation of the worker driver, and then expect/actual the web API bits (i.e. Worker) as needed.

TBH, most of it 🙁
I have tried to make it as common as possible, but found out that currently there's no way to do it properly.

Most of JS APIs are not common between js and wasmJs.
Current wasmJs interop is quite limited.
It does not support: Array, dynamic in external types. Also, it does not allow arbitrary types which are not extending JsAny to be passed to external functions.
This means that we cannot share WorkerRequest, WorkerResult, WorkerResponse.
Also, we would need to expect/actual quite big portion of Worker API with custom wrappers all over the place.

I will try some more ways to commonise as much as possible and show you in a couple of days, maybe we will find a better solution.

@dellisd I've tried to commonize WebWorkerDriver as much as possible. Please take a look 🙂 ece537a

hfhbd · 2024-05-30T09:31:56Z

Do you need Kotlin 2.0 for this change too? I bumped it in this PR #5217, but I will break my PR into smaller ones.

IlyaGulya · 2024-05-30T13:06:45Z

Do you need Kotlin 2.0 for this change too? I bumped it in this PR #5217, but I will break my PR into smaller ones.

Not really.
But I will be happy to rebase on 2.0 once it's merged 🙂

tamimattafi · 2024-07-11T13:54:33Z

Any updates on this?

…her than 23 is required)

…available for androidNative

…eDefaultWebWorkerDriver()`. remove unnecessary `jsCommon` group from web-worker-driver.

…datetime to 0.6.0. remove expect/actual classes warning

…iver-test

dpnkrg · 2024-07-26T12:25:29Z

Any update on the same.

sunildhiman90 · 2024-07-27T14:19:11Z

Any update on this please?

petrstetka · 2024-07-30T08:22:42Z

I am also interested in wasm support, it would be very nice to have it ready.

ahna92 · 2024-08-10T03:21:42Z

can we get an alpha (early access) version with this change to try it out ? 🙏

ghasemdev · 2024-08-10T20:02:41Z

I was developing a multiplatform library and needed to implement a database. After adding SQLDelight, I realized that the plugin causes errors in the wasmjs module, essentially forcing me to remove this module because there's no way to ignore the error and use SQLDelight on other platforms while handling storage differently in wasm. Currently, libraries like Koin, Ktor, ViewModel, and Lifecycle support wasm, and the lack of SQLDelight support is noticeable.

dellisd self-assigned this Jan 17, 2024

IlyaGulya force-pushed the feature/wasmJs branch 6 times, most recently from 2c9fe7e to 5c2d9a3 Compare February 5, 2024 07:24

IlyaGulya force-pushed the feature/wasmJs branch from fadbd3e to 9c998de Compare February 18, 2024 13:50

IlyaGulya force-pushed the feature/wasmJs branch 2 times, most recently from 0f55176 to 8d53f00 Compare February 19, 2024 06:06

IlyaGulya force-pushed the feature/wasmJs branch from f5f4c46 to 8253cfb Compare March 12, 2024 09:50

IlyaGulya force-pushed the feature/wasmJs branch 6 times, most recently from 49e197c to 672ff65 Compare March 20, 2024 12:49

IlyaGulya force-pushed the feature/wasmJs branch from 5ba62bc to 7e91ea4 Compare March 25, 2024 13:43

IlyaGulya changed the title ~~[WIP] Support wasmJs target~~ Support wasmJs target Mar 25, 2024

IlyaGulya changed the title ~~Support wasmJs target~~ [WIP] Support wasmJs target Mar 25, 2024

IlyaGulya force-pushed the feature/wasmJs branch 2 times, most recently from 8838b26 to f3fbc73 Compare March 25, 2024 16:01

IlyaGulya changed the title ~~[WIP] Support wasmJs target~~ Support wasmJs target Mar 25, 2024

IlyaGulya force-pushed the feature/wasmJs branch from e6bc4cb to 73d0a59 Compare April 7, 2024 14:04

IlyaGulya force-pushed the feature/wasmJs branch from 73d0a59 to 20267be Compare April 22, 2024 07:46

dellisd mentioned this pull request Apr 25, 2024

Issues compiling JS target on KMP #5198

Closed

dellisd reviewed May 25, 2024

View reviewed changes

IlyaGulya force-pushed the feature/wasmJs branch from 20267be to 612f90b Compare May 26, 2024 17:04

phansier mentioned this pull request May 26, 2024

wasm support phansier/Coffeegram#146

Open

toasterofbread mentioned this pull request Jul 22, 2024

Support wasmJS target toasterofbread/spmp#345

Draft

IlyaGulya and others added 10 commits July 25, 2024 22:23

Support wasmJs target.

150aefb

migrate sample to use kotlinx.datetime

de36b97

make android integration tests run on latest emulators (targetSdk hig…

6fcdbf1

…her than 23 is required)

hide kotlin warning regarding expect/actual on classes

6ef184d

fix coroutines-extensions tests build failing because of SQLiter not …

fb94a83

…available for androidNative

cleanup

9435086

commonize WebWorkerDriver. rename createWebWorkerDriver() to `creat…

e65e162

…eDefaultWebWorkerDriver()`. remove unnecessary `jsCommon` group from web-worker-driver.

remove unnecessary jsCommon group from sample-web. upgrade kotlinx-…

1efc20b

…datetime to 0.6.0. remove expect/actual classes warning

remove watchosDeviceArm64 and linuxArm64 targets from :drivers:dr…

1bec3fa

…iver-test

fix spotless violations

bfe3d03

IlyaGulya force-pushed the feature/wasmJs branch from 824c9fc to bfe3d03 Compare July 25, 2024 17:24

fix spotless violations

d77a6e1

ghasemdev approved these changes Aug 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support wasmJs target #4965

Support wasmJs target #4965

IlyaGulya commented Jan 16, 2024 •

edited

Loading

dellisd commented Jan 31, 2024

IlyaGulya commented Jan 31, 2024

IlyaGulya commented Feb 5, 2024

IlyaGulya commented Feb 18, 2024 •

edited

Loading

IlyaGulya commented Feb 19, 2024

artemyto commented Mar 6, 2024

IlyaGulya commented Mar 12, 2024

IlyaGulya commented Mar 13, 2024

IlyaGulya commented Mar 25, 2024

dellisd left a comment

dellisd May 24, 2024

IlyaGulya May 26, 2024

dellisd May 25, 2024

IlyaGulya May 26, 2024 •

edited

Loading

dellisd May 25, 2024

IlyaGulya May 26, 2024

dellisd May 25, 2024

IlyaGulya May 26, 2024 •

edited

Loading

IlyaGulya May 26, 2024

hfhbd commented May 30, 2024

IlyaGulya commented May 30, 2024 •

edited

Loading

tamimattafi commented Jul 11, 2024

dpnkrg commented Jul 26, 2024

sunildhiman90 commented Jul 27, 2024

petrstetka commented Jul 30, 2024

ahna92 commented Aug 10, 2024

ghasemdev commented Aug 10, 2024


		import app.cash.sqldelight.db.SqlDriver

		expect fun createWebWorkerDriver(): SqlDriver

Support wasmJs target #4965

Are you sure you want to change the base?

Support wasmJs target #4965

Conversation

IlyaGulya commented Jan 16, 2024 • edited Loading

dellisd commented Jan 31, 2024

IlyaGulya commented Jan 31, 2024

IlyaGulya commented Feb 5, 2024

IlyaGulya commented Feb 18, 2024 • edited Loading

IlyaGulya commented Feb 19, 2024

artemyto commented Mar 6, 2024

IlyaGulya commented Mar 12, 2024

IlyaGulya commented Mar 13, 2024

IlyaGulya commented Mar 25, 2024

dellisd left a comment

Choose a reason for hiding this comment

dellisd May 24, 2024

Choose a reason for hiding this comment

IlyaGulya May 26, 2024

Choose a reason for hiding this comment

dellisd May 25, 2024

Choose a reason for hiding this comment

IlyaGulya May 26, 2024 • edited Loading

Choose a reason for hiding this comment

dellisd May 25, 2024

Choose a reason for hiding this comment

IlyaGulya May 26, 2024

Choose a reason for hiding this comment

dellisd May 25, 2024

Choose a reason for hiding this comment

IlyaGulya May 26, 2024 • edited Loading

Choose a reason for hiding this comment

IlyaGulya May 26, 2024

Choose a reason for hiding this comment

hfhbd commented May 30, 2024

IlyaGulya commented May 30, 2024 • edited Loading

tamimattafi commented Jul 11, 2024

dpnkrg commented Jul 26, 2024

sunildhiman90 commented Jul 27, 2024

petrstetka commented Jul 30, 2024

ahna92 commented Aug 10, 2024

ghasemdev commented Aug 10, 2024

IlyaGulya commented Jan 16, 2024 •

edited

Loading

IlyaGulya commented Feb 18, 2024 •

edited

Loading

IlyaGulya May 26, 2024 •

edited

Loading

IlyaGulya May 26, 2024 •

edited

Loading

IlyaGulya commented May 30, 2024 •

edited

Loading