ktor: MPP JS client: Can't resolve 'text-encoding'

Ktor Version

1.1.2

Ktor Engine Used(client or server and name)

Ktor client with default engine

JVM Version, Operating System and Relevant Context

JDK 1.8, Windows, Kotlin JS

Feedback

We are using the ktor client in a multiplatform project (android, iOS and web). Starting with version 1.1.0 the build of the JS client fails with the following message:

ERROR in ./kotlinx-io.js
Module not found: Error: Can't resolve 'text-encoding' in '<mypath>\kotlinmultiplatform\web\build\kotlin-js-min\main'
@ ./kotlinx-io.js 5309:21-45 5320:21-45
@ ./ktor-utils.js
@ ./web.js

If I manually add text-encoding as a npm-dependeny, it works.

If I list the npm dependency tree with the previous working ktor version 1.0.1 I get:

+-- kotlinx-io@0.1.4 -> <mypath>\kotlinmultiplatform\web\build\node_modules_imported\kotlinx-io extraneous
+-- kotlinx-io-js@0.1.1 -> <mypath>\kotlinmultiplatform\web\build\node_modules_imported\kotlinx-io-js
| +-- kotlin@1.3.10
| +-- kotlin-test@1.3.10
| | `-- kotlin@1.3.10 deduped
| +-- kotlinx-atomicfu@0.11.12 -> <mypath>\kotlinmultiplatform\web\build\node_modules_imported\kotlinx-atomicfu deduped
| `-- text-encoding@0.7.0

If I list the npm dependency tree with a ktor version >= 1.1.0 the kotlinx-io-js (and of course text-encoding) is missing

About this issue

Original URL
State: closed
Created 5 years ago
Reactions: 8
Comments: 21 (8 by maintainers)

Commits related to this issue

text-encoding added to npm install. workaround for https://github.com/ktorio/ktor/issues/961 — committed to thebehera/mqtt by thebehera 5 years ago

Most upvoted comments

To fix this, I’ve added the following dependencies to my Gradle build:

		api(npm("text-encoding"))
		api(npm("bufferutil"))
		api(npm("utf-8-validate"))
		api(npm("abort-controller"))
		api(npm("fs"))

This fixed the issue for me!

MrPowerGamerBR on May 19, 2020

see https://github.com/Kotlin/kotlinx-io/issues/57 for my current work around

dhakehurst on Nov 28, 2019

I’m also getting this error for 1.2.5 and 1.3.0-beta-1. Would really appreciate a fix as it’s holding up project development

JesseCorbett on Nov 8, 2019

I am getting the same error on Ktor 1.2.5 and 1.3.0-beta1:

> Task :drapi:jsNodeTest FAILED
Error: Cannot find module 'text-encoding'
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:582:15)
    at Function.Module._load (internal/modules/cjs/loader.js:508:25)
    at Module.require (internal/modules/cjs/loader.js:637:17)
    at require (internal/modules/cjs/helpers.js:22:18)
    at TextEncoderCtor (<path>/build/js/packages_imported/ktor-ktor-io/1.3.0-beta-1/ktor-ktor-io.js:20217:22)
    at encodeImpl (<path>/build/js/packages_imported/ktor-ktor-io/1.3.0-beta-1/ktor-ktor-io.js:18148:19)
    at encodeToByteArrayImpl1 (<path>/build/js/packages_imported/ktor-ktor-io/1.3.0-beta-1/ktor-ktor-io.js:6267:16)
    at encodeToByteArray (<path>/build/js/packages_imported/ktor-ktor-io/1.3.0-beta-1/ktor-ktor-io.js:18133:12)
    at <path>/build/js/packages_imported/ktor-ktor-http-cio/1.3.0-beta-1/ktor-ktor-http-cio.js:3120:10
    at <path>/build/js/packages_imported/ktor-ktor-http-cio/1.3.0-beta-1/ktor-ktor-http-cio.js:5:5

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':drapi:jsNodeTest'.
> command '<path>/.gradle/nodejs/node-v10.15.3-darwin-x64/bin/node' exited with errors (exit code: 1)

clhols on Oct 19, 2019

For everyone who is struggling with this issue I have another solution which suits my needs better than adding the dependencies to build.gradle.kts.

I have a full-stack multiplatform project, JVM and Browser targets for now. The dependency solution proposed by @MrPowerGamerBR worked for me as well, but that puts about 700 KB of code into my distribution output. That’s a lot.

So, I removed the dependencies and solved the problem by creating a “webpack.config.d” directory in my projet root and putting an “external.js” file into it with the following content.

This might not work for everyone as you might actually need text-encodings but for me they are mostly pointless as I use code points instead of UTF-8. A very good article about the difference: What every JavaScript developer should know about Unicode

config.externals = [
    'text-encoding',
    'utf-8-validate',
    'abort-controller',
    'bufferutil',
    'fs'
]

toth-istvan-zoltan on Jun 28, 2020

Now also getting this on 1.3.2:

(node:4637) UnhandledPromiseRejectionWarning: Error: Cannot find module 'abort-controller'
Require stack:
- /Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js
- /Users/clhols/dev/drchannels/build/js/packages/drchannels-drapi/kotlin/drchannels-drapi.js
- /Users/clhols/dev/drchannels/build/js/packages/drchannels-drapi-test/kotlin/drchannels-drapi-test.js
- /Users/clhols/dev/drchannels/build/js/packages/drchannels-drapi-test/adapter-nodejs.js
- /Users/clhols/dev/drchannels/build/js/node_modules/mocha/lib/mocha.js
- /Users/clhols/dev/drchannels/build/js/node_modules/mocha/lib/cli/one-and-dones.js
- /Users/clhols/dev/drchannels/build/js/node_modules/mocha/lib/cli/options.js
- /Users/clhols/dev/drchannels/build/js/node_modules/mocha/bin/mocha
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:797:15)
    at Function.Module._load (internal/modules/cjs/loader.js:690:27)
    at Module.require (internal/modules/cjs/loader.js:852:19)
    at require (internal/modules/cjs/helpers.js:74:18)
    at AbortController_0 (/Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:16787:24)
    at /Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:16722:20
    at /Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:16697:3
    at Coroutine$commonFetch.doResume (/Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:16752:116)
    at commonFetch (/Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:16780:23)
    at Coroutine$execute_dkgphz$.doResume (/Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:16129:25)
    at JsClientEngine.execute_dkgphz$ (/Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:16159:21)
    at Coroutine$HttpClientEngine$executeWithinCallContext$lambda.doResume (/Users/clhols/dev/drchannels/build/js/packages_imported/ktor-ktor-client-core/1.3.2/ktor-ktor-client-core.js:1473:58)
    at Coroutine$HttpClientEngine$executeWithinCallContext$lambda.CoroutineImpl.resumeWith_tl1gpc$ (/Users/clhols/dev/drchannels/build/js/packages_imported/kotlin/1.3.70/kotlin/coroutines/CoroutineImpl.kt:47:35)
    at DispatchedContinuation.DispatchedTask.run (/Users/clhols/dev/drchannels/build/js/packages_imported/kotlinx-coroutines-core/1.3.4/kotlinx-coroutines-core.js:32615:22)
    at SetTimeoutBasedDispatcher$ScheduledMessageQueue.MessageQueue.process (/Users/clhols/dev/drchannels/build/js/packages_imported/kotlinx-coroutines-core/1.3.4/kotlinx-coroutines-core.js:35929:15)
    at /Users/clhols/dev/drchannels/build/js/packages_imported/kotlinx-coroutines-core/1.3.4/kotlinx-coroutines-core.js:35745:30
    at processTicksAndRejections (internal/process/task_queues.js:75:11)
(node:4637) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:4637) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
23.44.41: Task execution finished 'jsNodeTest'.

clhols on Mar 16, 2020