fix: avoid node-based sdk-utils in default export for package #125
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.
@percy/agent is sometimes imported like this in our SDKs:
At which point the default export is imported. This export is intended to run in a browser and everything in the
src/percy-agent-client
directory is built to expect this.As we've built out our SDKs we found that @percy/agent is also quite useful for centralizing SDK utility functions. We previously had been distributing these util functions through the default export, so you can go:
The problem with that is the util code would import other libraries, such as Winston, which are entirely designed to run on Node and not in a browser.
This PR simply removes the node-specific code from our default export, but as a result we've had to update our SDKs to reach inside @percy/agent and require these utils instead.
Those PRs are here:
Related issue: