Skip to content

Commit

Permalink
Move several packages to internal/ (#901)
Browse files Browse the repository at this point in the history 
This PR moves the following packages to `internal` to avoid exposing them in the API:
* `ctags`
* `debugserver`
* `gitindex`
* `shards`
* `trace`
  • Loading branch information
@jtibshirani
jtibshirani authored Jan 28, 2025
1 parent e7f0a1a commit a634b6c
Show file tree
Hide file tree
Showing 65 changed files with 65 additions and 81 deletions.
3 changes: 1 addition & 2 deletions build/builder.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,8 @@ import (
"github.com/dustin/go-humanize"
"github.com/go-enry/go-enry/v2"
"github.com/rs/xid"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/internal/ctags"
)

var DefaultDir = filepath.Join(os.Getenv("HOME"), ".zoekt")
Expand Down
2 changes: 1 addition & 1 deletion build/ctags.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (
"time"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/internal/ctags"
)

// Make sure all names are lowercase here, since they are normalized
Expand Down
2 changes: 1 addition & 1 deletion build/ctags_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
"testing"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/internal/ctags"
)

func TestTagsToSections(t *testing.T) {
Expand Down
5 changes: 2 additions & 3 deletions build/e2e_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,12 @@ import (
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/grafana/regexp"
"github.com/stretchr/testify/require"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/internal/tenant"
"github.com/sourcegraph/zoekt/internal/tenant/tenanttest"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
"github.com/stretchr/testify/require"
)

func TestBasic(t *testing.T) {
Expand Down
4 changes: 2 additions & 2 deletions build/scoring_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (
"testing"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/internal/ctags"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
)

type scoreCase struct {
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-git-clone/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import (
"strconv"
"strings"

"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
)

func main() {
Expand Down
10 changes: 4 additions & 6 deletions cmd/zoekt-git-index/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,11 @@ import (
"strings"

"github.com/dustin/go-humanize"
"go.uber.org/automaxprocs/maxprocs"

"github.com/sourcegraph/zoekt/internal/profiler"

"github.com/sourcegraph/zoekt/cmd"
"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/ctags"
"github.com/sourcegraph/zoekt/internal/gitindex"
"github.com/sourcegraph/zoekt/internal/profiler"
"go.uber.org/automaxprocs/maxprocs"
)

func run() int {
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-indexserver/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import (
"time"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
)

const day = time.Hour * 24
Expand Down
5 changes: 2 additions & 3 deletions cmd/zoekt-merge-index/main_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ import (
"sort"
"testing"

"github.com/stretchr/testify/require"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
"github.com/stretchr/testify/require"
)

func TestMerge(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-mirror-bitbucket-server/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import (

bitbucketv1 "github.com/gfleury/go-bitbucket-v1"

"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-mirror-gerrit/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import (
gerrit "github.com/andygrunwald/go-gerrit"
git "github.com/go-git/go-git/v5"
"github.com/go-git/go-git/v5/config"
"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
)

type loggingRT struct {
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-mirror-gitea/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import (

"code.gitea.io/sdk/gitea"

"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
)

type topicsFlag []string
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-mirror-github/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import (
"github.com/google/go-github/v27/github"
"golang.org/x/oauth2"

"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
)

type topicsFlag []string
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-mirror-gitiles/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (
"os"
"path/filepath"

"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
)

type crawlTarget struct {
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-mirror-gitlab/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import (
"strings"
"time"

"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/internal/gitindex"
gitlab "github.com/xanzy/go-gitlab"
)

Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-repo-index/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ import (
"github.com/google/slothfs/manifest"
"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/gitindex"
"github.com/sourcegraph/zoekt/ignore"
"github.com/sourcegraph/zoekt/internal/gitindex"
"go.uber.org/automaxprocs/maxprocs"

git "github.com/go-git/go-git/v5"
Expand Down
3 changes: 1 addition & 2 deletions cmd/zoekt-sourcegraph-indexserver/index.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@ import (
"time"

sglog "github.com/sourcegraph/log"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/internal/ctags"
"github.com/sourcegraph/zoekt/internal/tenant"
)

Expand Down
12 changes: 5 additions & 7 deletions cmd/zoekt-sourcegraph-indexserver/index_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,17 @@ import (
"testing"
"time"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/sourcegraph/log/logtest"
proto "github.com/sourcegraph/zoekt/cmd/zoekt-sourcegraph-indexserver/protos/sourcegraph/zoekt/configuration/v1"
"github.com/sourcegraph/zoekt/internal/ctags"
"github.com/sourcegraph/zoekt/internal/tenant/tenanttest"
"github.com/stretchr/testify/require"
"google.golang.org/grpc"
"google.golang.org/protobuf/testing/protocmp"
"google.golang.org/protobuf/types/known/timestamppb"

proto "github.com/sourcegraph/zoekt/cmd/zoekt-sourcegraph-indexserver/protos/sourcegraph/zoekt/configuration/v1"
"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/internal/tenant/tenanttest"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"

"github.com/sourcegraph/zoekt"
)

Expand Down
17 changes: 8 additions & 9 deletions cmd/zoekt-sourcegraph-indexserver/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,21 @@ import (
"github.com/prometheus/client_golang/prometheus/promauto"
sglog "github.com/sourcegraph/log"
"github.com/sourcegraph/mountinfo"
"go.uber.org/automaxprocs/maxprocs"
"golang.org/x/net/trace"
"golang.org/x/sys/unix"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/metadata"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
proto "github.com/sourcegraph/zoekt/cmd/zoekt-sourcegraph-indexserver/protos/sourcegraph/zoekt/configuration/v1"
"github.com/sourcegraph/zoekt/debugserver"
"github.com/sourcegraph/zoekt/grpc/internalerrs"
"github.com/sourcegraph/zoekt/grpc/messagesize"
"github.com/sourcegraph/zoekt/internal/debugserver"
"github.com/sourcegraph/zoekt/internal/profiler"
"github.com/sourcegraph/zoekt/internal/tenant"
"go.uber.org/automaxprocs/maxprocs"
"golang.org/x/net/trace"
"golang.org/x/sys/unix"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/metadata"
)

var (
Expand Down
5 changes: 2 additions & 3 deletions cmd/zoekt-sourcegraph-indexserver/sg.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,11 @@ import (
"time"

"github.com/go-git/go-git/v5"
"github.com/sourcegraph/zoekt/internal/ctags"
"golang.org/x/net/trace"

proto "github.com/sourcegraph/zoekt/cmd/zoekt-sourcegraph-indexserver/protos/sourcegraph/zoekt/configuration/v1"
"github.com/sourcegraph/zoekt/ctags"

"github.com/sourcegraph/zoekt"
proto "github.com/sourcegraph/zoekt/cmd/zoekt-sourcegraph-indexserver/protos/sourcegraph/zoekt/configuration/v1"
)

// SourcegraphListResult is the return value of Sourcegraph.List. It is its
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt-test/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ import (

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
)

func readTree(dir string) (map[string][]byte, error) {
Expand Down
15 changes: 7 additions & 8 deletions cmd/zoekt-webserver/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,25 @@ import (

grpcprom "github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus"
"github.com/sourcegraph/mountinfo"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"golang.org/x/net/http2"
"golang.org/x/net/http2/h2c"
"google.golang.org/grpc"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
zoektgrpc "github.com/sourcegraph/zoekt/cmd/zoekt-webserver/grpc/server"
"github.com/sourcegraph/zoekt/debugserver"
"github.com/sourcegraph/zoekt/grpc/internalerrs"
"github.com/sourcegraph/zoekt/grpc/messagesize"
"github.com/sourcegraph/zoekt/grpc/propagator"
proto "github.com/sourcegraph/zoekt/grpc/protos/zoekt/webserver/v1"
"github.com/sourcegraph/zoekt/internal/debugserver"
"github.com/sourcegraph/zoekt/internal/profiler"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/internal/tenant"
"github.com/sourcegraph/zoekt/internal/trace"
"github.com/sourcegraph/zoekt/internal/tracer"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
"github.com/sourcegraph/zoekt/trace"
"github.com/sourcegraph/zoekt/web"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"golang.org/x/net/http2"
"golang.org/x/net/http2/h2c"
"google.golang.org/grpc"

"github.com/opentracing/opentracing-go"
"github.com/prometheus/client_golang/prometheus"
Expand Down
2 changes: 1 addition & 1 deletion cmd/zoekt/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ import (

"github.com/felixge/fgprof"
"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
)

func displayMatches(files []zoekt.FileMatch, pat string, withRepo bool, list bool) {
Expand Down
2 changes: 1 addition & 1 deletion contentprovider.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
"unicode"
"unicode/utf8"

"github.com/sourcegraph/zoekt/ctags"
"github.com/sourcegraph/zoekt/internal/ctags"
)

var _ = log.Println
Expand Down
2 changes: 1 addition & 1 deletion ignore/ignore.go
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// package ignore provides helpers to support ignore-files similar to .gitignore
// Package ignore provides helpers to support ignore-files similar to .gitignore
package ignore

import (
Expand Down
5 changes: 2 additions & 3 deletions internal/archive/e2e_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,11 @@ import (
"testing"
"time"

"github.com/stretchr/testify/require"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
"github.com/stretchr/testify/require"
)

func TestMain(m *testing.M) {
Expand Down
0 ctags/parser.go → internal/ctags/parser.go
View file
File renamed without changes.
0 ctags/parser_bins.go → internal/ctags/parser_bins.go
View file
File renamed without changes.
0 ctags/parser_test.go → internal/ctags/parser_test.go
View file
File renamed without changes.
0 ctags/symbol_kind.go → internal/ctags/symbol_kind.go
View file
File renamed without changes.
0 debugserver/debug.go → internal/debugserver/debug.go
View file
File renamed without changes.
0 debugserver/expvar.go → internal/debugserver/expvar.go
View file
File renamed without changes.
3 changes: 1 addition & 2 deletions internal/e2e/e2e_rank_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,11 @@ import (
"time"

"github.com/google/go-cmp/cmp"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/internal/archive"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
)

var update = flag.Bool("update", false, "update golden file")
Expand Down
0 gitindex/clone.go → internal/gitindex/clone.go
View file
File renamed without changes.
0 gitindex/clone_test.go → internal/gitindex/clone_test.go
View file
File renamed without changes.
0 gitindex/delete.go → internal/gitindex/delete.go
View file
File renamed without changes.
0 gitindex/delete_test.go → internal/gitindex/delete_test.go
View file
File renamed without changes.
0 gitindex/filter.go → internal/gitindex/filter.go
View file
File renamed without changes.
5 changes: 2 additions & 3 deletions gitindex/ignore_test.go → internal/gitindex/ignore_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@ import (
"reflect"
"testing"

"github.com/sourcegraph/zoekt/query"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/shards"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
)

func createSourcegraphignoreRepo(dir string) error {
Expand Down
0 gitindex/index.go → internal/gitindex/index.go
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion gitindex/index_test.go → internal/gitindex/index_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ import (
"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/ignore"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
)

func TestIndexEmptyRepo(t *testing.T) {
Expand Down
0 gitindex/repocache.go → internal/gitindex/repocache.go
View file
File renamed without changes.
0 gitindex/repocache_test.go → internal/gitindex/repocache_test.go
View file
File renamed without changes.
0 gitindex/submodule.go → internal/gitindex/submodule.go
View file
File renamed without changes.
0 gitindex/submodule_test.go → internal/gitindex/submodule_test.go
View file
File renamed without changes.
0 gitindex/tree.go → internal/gitindex/tree.go
View file
File renamed without changes.
5 changes: 2 additions & 3 deletions gitindex/tree_test.go → internal/gitindex/tree_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,11 @@ import (

"github.com/google/go-cmp/cmp"
"github.com/grafana/regexp"
"github.com/sourcegraph/zoekt/ignore"

"github.com/sourcegraph/zoekt"
"github.com/sourcegraph/zoekt/build"
"github.com/sourcegraph/zoekt/ignore"
"github.com/sourcegraph/zoekt/internal/shards"
"github.com/sourcegraph/zoekt/query"
"github.com/sourcegraph/zoekt/shards"
)

func createSubmoduleRepo(dir string) error {
Expand Down
0 json/json.go → internal/json/json.go
View file
File renamed without changes.
Loading

0 comments on commit a634b6c

Please sign in to comment.