Custom drivers failed on build

[tchiotludo]

Environment

---

• Operating System: Linux
• Node Version: v18.13.0
• Nuxt Version: 3.5.2
• Nitro Version: 2.4.1
• Package Manager: [email protected]
• Builder: vite
• User Config: modules, app, css, content, router, devServer, vue, gtag, runtimeConfig, nitro, routeRules, build, multiCache
• Runtime Modules: @nuxt/[email protected], @nuxt/[email protected], [email protected], [email protected], [email protected]
• Build Modules: -

---

Reproduction

The full source is here

Describe the bug

Hey,

I've an issue, I'm trying to implement a custom drivers.
Everything work fine on development but npm run build failed this error:

Cannot read properties of undefined (reading 'getKeys')

diging the stacktrace, here is the orginal error from here

require() of ES Module /home/ludo/Web/kestra/kestra.io/drivers/apidocs/driver.mjs not supported.                         
Instead change the require of /home/ludo/Web/kestra/kestra.io/drivers/apidocs/driver.mjs to a dynamic import() which is available in all CommonJS modules.

Additional context

No response

Logs

No response

[SwenVogel]

I have the same problem with a custom driver:

` ERROR Couldn't load driver /Users/vogel/Entwicklung/Workspace/ypsystems/brock/rcp-ui-web/src/drivers/payload/driver.mjs 12:08:44

ERROR Cannot read properties of undefined (reading 'getKeys') `

and using the following nuxt.config:

`
...

sources: [
"content",
{
driver: resolve("src", "drivers", "payload", "driver.mjs"),
name: "payload",
prefix: "/payload",
....
`

Does anybody know to resolve this issue?

[shareable-vision]

I am getting the same error while building with custom webdav driver:

Couldn't load driver .../web.nuxt/server/drivers/webdav.mjs

[shareable-vision]

We need to modify the getMountDriver() in utils.ts.

export function getMountDriver (mount: MountOptions) {
  const dirverName = mount.driver as keyof typeof unstorageDrivers
  if (unstorageDrivers[dirverName]) {
    return unstorageDrivers[dirverName](mount as any)
  }

  try {
    // eslint-disable-next-line @typescript-eslint/no-var-requires
    return require(mount.driver).default(mount as any)
  } catch (e) {
    // eslint-disable-next-line no-console
    console.error("Couldn't load driver", mount.driver)
  }
}

We need to make getMountDriver() async and "change the require of . . . to a dynamic import()":

async function getMountDriver(mount) {
  const dirverName = mount.driver;
  if (unstorageDrivers[dirverName]) {
    return unstorageDrivers[dirverName](mount);
  }
  try {
    return (await import(mount.driver)).default(mount) //require(mount.driver).default(mount);
  } catch (e) {
    console.error("Couldn't load driver", mount.driver);
  }
}

And await the function at this block of the async setup():

 for (const [key, source] of Object.entries(sources)) {
    storage.mount(key, await getMountDriver(source));
 }

[shareable-vision]

Also it appears to be necessary to add to tsconfig.json:

"compilerOptions": {
  "lib": [ "es2015" ]
},

to avoid Typescript error An async function or method in ES5/ES3 requires the 'Promise' constructor. Make sure you have a declaration for the 'Promise' constructor or include 'ES2015' in your --lib option.

[shareable-vision]

Submitted PR to resolve issue.