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

Update README.md with @grpc/grpc-js #182

Merged
merged 2 commits into from
Jul 15, 2024
Merged

Conversation

Znarkus
Copy link
Contributor

@Znarkus Znarkus commented Feb 27, 2024

It looks like dgraph-js is using @grpc/grpc-js and not grpc. Using grpc in my project resulted in TS errors of type mismatch, changing to @grpc/grpc-js solved it. Updating the README to reflect this.

Copy link

This PR has been stale for 60 days and will be closed automatically in 7 days. Comment to keep it open.

@github-actions github-actions bot added the Stale label Jul 11, 2024
@Znarkus Znarkus requested a review from a team as a code owner July 13, 2024 17:44
@Znarkus
Copy link
Contributor Author

Znarkus commented Jul 13, 2024

Comment to keep open

@github-actions github-actions bot removed the Stale label Jul 14, 2024
Copy link
Contributor

@shivaji-kharse shivaji-kharse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR ! @Znarkus

@shivaji-kharse shivaji-kharse merged commit e439bcc into dgraph-io:master Jul 15, 2024
6 checks passed
shivaji-kharse pushed a commit that referenced this pull request Nov 5, 2024
Currently, the `grpc` dependency is causing the issue shown in issue
#231 due to an incompatibility with the most recent version of `grpc`
and any platform other than Linux based on our testing. We've also shown
reports that the prebuilt binaries downloaded by `gprc` are causing
massive bloat _**(nearly a 5x increase in size)**_ to our bundles that
are generated with the dependency included.

Upon investigation, we noticed that `grpc` isn't actually used by
anything in the library anymore, and was seemingly [added back by
mistake](#183) during the
most recent release, as `@grpc/grpc-js` is used in place of it.

Sources:
[Original PR](#125) to remove
`grpc`
[PR I made last year](#164),
where `grpc` was not in the list of dependencies at the time,
reinforcing the fact that it was added back by mistake
[The README of this very
repo](https://github.com/dgraph-io/dgraph-js?tab=readme-ov-file#install),
which has instructions to install `@grpc/grpc-js` and not `grpc`, and
[here is the PR](#182) where
that change was made

This PR is to remove the `grpc` dependency from the package to
accomplish the following:
- remedy the installation issue
- reduce install sizes
- get rid of an unused dependency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants