Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(v2-sdk): separate esm / cjs builds #222

Closed
wants to merge 2 commits into from

Conversation

just-toby
Copy link
Collaborator

@just-toby just-toby commented Dec 16, 2024

PR Scope

breaking change to build structure for v2-sdk

Description

updates the build setup for v2-sdk to manually and explicitly create separate cjs and esm builds (plus a types-only version)

How Has This Been Tested?

built the sdk locally, then installed the local build result in another project (universe/apps/web) and verified that it properly resolved the esm version instead of the cjs version

Are there any breaking changes?

there shouldn't be, but technically if an end user is importing incorrectly (by directly referencing any build artifact files) then they'll need to update

(Optional) Follow Ups

PRs to follow will do this for many other SDKs

Copy link
Collaborator Author

just-toby commented Dec 16, 2024

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@just-toby just-toby requested a review from adjkant December 16, 2024 18:33
@just-toby just-toby marked this pull request as ready for review December 16, 2024 18:33
@just-toby just-toby requested review from jsy1218 and a team as code owners December 16, 2024 18:33
Copy link

socket-security bot commented Dec 16, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@typescript-eslint/[email protected] Transitive: environment, filesystem, unsafe +18 4.97 MB bradzacher, jameshenry
npm/[email protected] Transitive: environment, filesystem, unsafe +11 4.15 MB lydell
npm/[email protected] Transitive: environment, eval, filesystem, shell, unsafe +72 3.13 MB simenb
npm/[email protected] None 0 7.83 MB prettier-bot
npm/[email protected] environment, filesystem, unsafe Transitive: eval, shell +23 2.41 MB kul

🚮 Removed packages: npm/[email protected]

View full report↗︎

Copy link

socket-security bot commented Dec 16, 2024

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSourceCI
Filesystem access npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Filesystem access npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/@pkgr/[email protected] ⚠︎
Filesystem access npm/[email protected] ⚠︎
Filesystem access npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Shell access npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎
Dynamic require npm/[email protected] ⚠︎

View full report↗︎

Next steps

What is filesystem access?

Accesses the file system, and could potentially read sensitive data.

If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

What is dynamic require?

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Packages should avoid dynamic imports when possible. Audit the use of dynamic require to ensure it is not executing malicious or vulnerable code.

What is shell access?

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

@just-toby just-toby force-pushed the feat/v2-sdk-build branch 2 times, most recently from 0087b48 to fcdbbde Compare December 16, 2024 18:56
@just-toby just-toby changed the base branch from feat/universal-router-sdk-esm-build to feat/router-sdk-build December 16, 2024 20:08
@just-toby just-toby force-pushed the feat/router-sdk-build branch from c6c87a9 to 9f045cc Compare December 16, 2024 20:15
@just-toby just-toby closed this Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant