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

all: remove gob and SSE rpc endpoints #758

Merged
merged 2 commits into from
Apr 19, 2024
Merged

Conversation

keegancsmith
Copy link
Member

We now only consume zoekt via gRPC at Sourcegraph and I doubt anyone uses the old endpoints. We still support the classic rest like API at /api/ which is used by neogrok.

This will have one required update in sourcegraph, and that is to use SenderFunc from the main zoekt package rather than from the now deleted stream package.

Test Plan: go test

We now only consume zoekt via gRPC at Sourcegraph and I doubt anyone
uses the old endpoints.

This will have one required update in sourcegraph, and that is to use
SenderFunc from the main zoekt package rather than from the now deleted
stream package.

Test Plan: go test
@keegancsmith keegancsmith requested a review from a team April 18, 2024 13:33
@cla-bot cla-bot bot added the cla-signed label Apr 18, 2024
@keegancsmith
Copy link
Member Author

@dgruzd @DylanGriffith which API endpoints do you use in zoekt-webserver? Safe to remove these?

@dgruzd
Copy link
Contributor

dgruzd commented Apr 18, 2024

@dgruzd @DylanGriffith which API endpoints do you use in zoekt-webserver? Safe to remove these?

@keegancsmith We use the /api/search endpoint at the moment. We might eventually switch to gRPC.

Edit: I've also tested it locally with this branch. Everything seems to be ok. Thank you!

web/e2e_test.go Outdated
@@ -964,6 +962,8 @@ func TestHealthz(t *testing.T) {
}

func TestRPC(t *testing.T) {
t.Skip("TODO grpc and jsonrpc")
Copy link
Member

Choose a reason for hiding this comment

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

Are you planning to update this test before merging?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, I can just remove the test but was hoping to stumble on this in the future and then improve it.

Copy link
Member

Choose a reason for hiding this comment

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

Let's remove it if we think it's not critical and have decent coverage elsewhere!

Copy link
Member

@jtibshirani jtibshirani left a comment

Choose a reason for hiding this comment

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

This makes sense to me, it seems like a nice clean-up and I don't see problems removing it.

Aside: it's interesting we don't have Zoekt releases, which is the standard way to document + communicate API breaks. But it doesn't feel like we have enough changes and consumers right now that it'd be worth it.

@keegancsmith
Copy link
Member Author

Aside: it's interesting we don't have Zoekt releases, which is the standard way to document + communicate API breaks. But it doesn't feel like we have enough changes and consumers right now that it'd be worth it.

Yeah right now I am just ccing on PRs the two main downstream consumers. I think its unusual for us to make a few breaking changes so close together. I think we can introduce something more formal if we or others start feeling pain.

@keegancsmith keegancsmith merged commit a0f051e into main Apr 19, 2024
8 checks passed
@keegancsmith keegancsmith deleted the k/rm-gob-and-stream-client branch April 19, 2024 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants