[feat]: compatibility with Cloudflare Workers

[emmanuelsw]

A clear and concise description of what the feature is

Hello! I'm trying to use this library in an Astro project that I deploy on Cloudflare Pages, but I haven't been able to make it work. I followed Cloudflare's documentation to add polyfills for some Node APIs that were generating the error, but the Worker still throws this error:

[ERROR] Error: No such module \"node:tty\".\n imported from \"chunks/strapi-client_R71o50vs.mjs

Is there any plans to support the Cloudflare Workers runtime in the future?

Why should this feature be included?

It would increase the number of users who could use this library, in different contexts.

Please provide an example for how this would work

No response

[nailchu]

It also occured on me.

I created a new Vue or React frontend project, added @strapi/client package, run build and It said I need 3 modules: os, util and tty. They are modules of Nodejs and not exist in browsers.
Build output :

[plugin vite:resolve] Module "tty" has been externalized for browser compatibility, imported by "/root/testtest/node_modules/.pnpm/@strapi+client@1.0.1/node_modules/@strapi/client/dist/bundle.mjs". See https://vite.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
[plugin vite:resolve] Module "util" has been externalized for browser compatibility, imported by "/root/testtest/node_modules/.pnpm/@strapi+client@1.0.1/node_modules/@strapi/client/dist/bundle.mjs". See https://vite.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
[plugin vite:resolve] Module "os" has been externalized for browser compatibility, imported by "/root/testtest/node_modules/.pnpm/@strapi+client@1.0.1/node_modules/@strapi/client/dist/bundle.mjs". See https://vite.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.

Browser console output:

I went to some LLM chatbots and this solution work:

• add 3 packages: tty-browserify,os-browserify,util
• add package vite-plugin-node-polyfills (I am using Vite)
• add configs below to vite.config.js

import { nodePolyfills } from 'vite-plugin-node-polyfills'
export default defineConfig({
  plugins: [
    nodePolyfills({
      include: ['os', 'util', 'tty'],
      globals: { Buffer: true}
    }),
  ],
  resolve: {
    alias: {
      'os': 'os-browserify/browser',
      'util': 'util',
      'tty': 'tty-browerify'
    },
  },
  optimizeDeps: {
    exclude: ['os-browserify', 'tty-browserify']
  }
})

Now there are no errors and everything work.

[nailchu]

Hey, @emmanuelsw
I did some futher study and this #62 might help you.
You can add "browser": { "@strapi/client": "./node_modules/@strapi/client/dist/new_esm_build.js"} to package.json if your build tool is not Vite.

[Convly]

Hey there, thanks for reporting this issue. We're going to work on both this and #62 as soon as we can.

[Convly]

We're going to work on both this and #62 as soon as we can.

Just giving a quick update on this, we're still working on our previous backlog and implementing other changes. I can't give an ETA for now, but it's definitely on the radar and something I'll pass as a priority whenever I can. Sorry for the inconvenience 🙏

[Convly]

Hey, I've created a PR that aims to fix this issue for all client-facing frameworks (react, angular, ...)
I've released an experimental version of the client to test in real-world conditions, would be awesome if you could test and tell me if it fixes the problem on your side

Version: 1.1.0-experimental.c93e62ec24034391f8af966bd99e4bf7edf5a125
You can install it by either modifying the version in your package.json or by running npm install @strapi/client@experimental

[emmanuelsw]

Thank you!
I'll be testing it on a new project this week.