Use import instead of require to fix ESM Remix apps

[TooTallNate]

This is a (partial) fix for #28.

You might want to just use it as inspiration since this won't work for the .cjs build of this package. Or maybe it's time to drop the .cjs build, considering the Remix templates are ESM at this point.

I also didn't try the dev mode, but I'm sure the purging of the require cache doesn't work correctly with this change. Not sure how to do that when using import (nodejs/node#49442).

[itsMapleLeaf]

So I eventually want to move to using remix vite, but I am interested in a short term fix for this before that happens (since it's not trivial, lol)

I think the approach I'd want to take is something like this:

try {
	await import(...)
} catch (importError) {
	try {
		require(...)
	} catch (requireError) {
		console.error("Failed to load build.", { importError, requireError })
	}
}

If you can update this PR and ensure it works for both CJS and ESM projects, I'd be happy to merge this and release!

[giuseppeg]

@itsMapleLeaf not sure we need the try/catch thing. Dynamic imports are allowed in CJS right?

import.meta won't be available in CJS but you can't try/catch that. I suggest that we remove this piece:

remix-electron/workspaces/remix-electron/src/index.mts

Lines 45 to 48 in 44d87c6

	const buildPath =
	typeof serverBuildOption === "string"
	? require.resolve(serverBuildOption)
	: undefined

Nonetheless I will try to scaffold a CJS app and test this version with imports.

I also didn't try the dev mode, but I'm sure the purging of the require cache doesn't work correctly with this change. Not sure how to do that when using import (nodejs/node#49442).

What we need is a timestamp on the statements to invalidate the cache. With that we can remove the purgeRequireCache helper.

Eg.

await import(`${buildPath}?${Date.now()}`);

Happy to make those changes if you agree (I have this in my fork and it works).

[itsMapleLeaf]

@itsMapleLeaf not sure we need the try/catch thing. Dynamic imports are allowed in CJS right?

import.meta won't be available in CJS but you can't try/catch that. I suggest that we remove this piece:

remix-electron/workspaces/remix-electron/src/index.mts

Lines 45 to 48 in 44d87c6

	const buildPath =
	typeof serverBuildOption === "string"
	? require.resolve(serverBuildOption)
	: undefined

Nonetheless I will try to scaffold a CJS app and test this version with imports.

I also didn't try the dev mode, but I'm sure the purging of the require cache doesn't work correctly with this change. Not sure how to do that when using import (nodejs/node#49442).

What we need is a timestamp on the statements to invalidate the cache. With that we can remove the purgeRequireCache helper.

Eg.

await import(`${buildPath}?${Date.now()}`);

Happy to make those changes if you agree (I have this in my fork and it works).

@giuseppeg Sure, sounds good to me. I'm not concerned about the implementation details, just that both CJS and ESM projects work 👍

[giuseppeg]

@itsMapleLeaf implemented all the changes in #33 I added a ESM test app too