Introduce separate entry point for worker environments #1660
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anniel-stripe
force-pushed
the
anniel-conditional-exports
branch
from
6c260e6 to
e520500
Compare
anniel-stripe
commented
Jan 17, 2023
anniel-stripe
commented
Jan 17, 2023
anniel-stripe
commented
Jan 17, 2023
anniel-stripe
commented
Jan 17, 2023
anniel-stripe
commented
Jan 17, 2023
|
Why is node 12 on fire? Is it because it's getting the wrong HTTP client? |
pakrym-stripe
requested changes
Jan 17, 2023
Create a test project similar to ones we have and invoke the cloudflare build CLI on it from tests. |
pakrym-stripe
requested changes
Jan 18, 2023
…reviewer comments
anniel-stripe
force-pushed
the
anniel-conditional-exports
branch
from
b3a8791 to
94369db
Compare
gurus00
pushed a commit
to gurus00/stripe-node
that referenced
this pull request
Feb 11, 2025
* Separate stripe into worker and default entrypoints, needs tests for worker * Fix test, remove unused import * Actually require child_process * build * Convert tests to TypeScript, add browser field * Move more utils functions to nodeUtils * Use _utils defined on Stripe object * Add error messages to createNodeHttpClient and createNodeCryptoProvider * Move platform-specific utils to new PlatformFunctions classes, add tests * Abstract getUname to platform functions, set _platformFunctions on Webhooks * Make generic createCryptoProvider in Webhooks * Revert "Make generic createCryptoProvider in Webhooks" This reverts commit c8af4d5. * Remove stale file in lib * Create generic createHttpClient that creates FetchHttpClient by default in workers * Move getUname to PlatformFunctions (now returns a promise), and misc reviewer comments * Make generic createCryptoProvider in Webhooks * Removing this alias * Fix DefaultPlatformFunctions getUname, fix test * Add getMockPlatformFunctions test util, prefix _createCryptoProvider
gurus00
pushed a commit
to gurus00/stripe-node
that referenced
this pull request
Feb 11, 2025
* Separate stripe into worker and default entrypoints, needs tests for worker * Fix test, remove unused import * Actually require child_process * build * Convert tests to TypeScript, add browser field * Move more utils functions to nodeUtils * Use _utils defined on Stripe object * Add error messages to createNodeHttpClient and createNodeCryptoProvider * Move platform-specific utils to new PlatformFunctions classes, add tests * Abstract getUname to platform functions, set _platformFunctions on Webhooks * Make generic createCryptoProvider in Webhooks * Revert "Make generic createCryptoProvider in Webhooks" This reverts commit c8af4d5. * Remove stale file in lib * Create generic createHttpClient that creates FetchHttpClient by default in workers * Move getUname to PlatformFunctions (now returns a promise), and misc reviewer comments * Make generic createCryptoProvider in Webhooks * Removing this alias * Fix DefaultPlatformFunctions getUname, fix test * Add getMockPlatformFunctions test util, prefix _createCryptoProvider
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Introduces an exports field to the package.json that defines a separate entry point for environments where Node.js built-in modules are not supported.
Major changes in this PR:
stripe.tsandstripe.worker.ts, move common code intostripe.common.tsutils.tsthat depend on Node.js built-ins to theplatformdirectory in aNodePlatformFunctionsclass that inherits fromDefaultPlatformFunctions_platformFunctionsproperty onto Stripe object. Use this to override functions that depend on Node-specific modules instripe.node.tsStripe.createNodeHttpClientandStripe.createNodeCryptoProviderto throw errors and override them instripe.node.ts(won't be available for workers)Stripe.createHttpClientthat defaults toStripe.createNodeHttpClientnormally, andStripe.createFetchHttpClientin workersTesting
I wasn't sure of a good way to add an automated test that mimics a worker environment. I tested this locally, and validated that the expected build errors have been resolved (see next section 'Remaining Work' for remaining errors).
The original build errors:
Now:
Remaining Work
Stripe._emitterandutils.checkForStreamto not useEventEmitterfor worker environments