refactor index manager service

Signed-off-by: kpango <[email protected]>

Author: kpango

.golangci.yml

@@ -149,7 +149,14 @@ linters:
     - path: internal/errors/errors_benchmark_test\.go
       linters:
         - depguard
+<<<<<<< HEAD
     - path: internal/test/comparator/standard\.go
+=======
+    - path: internal/sync/alias\.go
+      linters:
+        - depguard
+    - path: hack/benchmark/src/singleflight/singleflight_bench_test\.go
+>>>>>>> refactor/manager-index/small-refactor
       linters:
         - depguard
 linters-settings:
@@ -169,6 +176,14 @@ linters-settings:
     rules:
       main:
         deny:
+          - pkg: "sync"
+            desc: "sync is allowed only by internal/sync"
+          - pkg: "golang.org/x/sync"
+            desc: "golang.org/x/sync is allowed only by internal/sync"
+          - pkg: "golang.org/x/sync/singleflight"
+            desc: "golang.org/x/sync/singleflight is allowed only by internal/sync/singleflight"
+          - pkg: "golang.org/x/sync/semaphore"
+            desc: "golang.org/x/sync/semaphore is allowed only by internal/sync/semaphore"
           - pkg: "errors"
             desc: "errors is allowed only by internal/errors"
           - pkg: "k8s.io/apimachinery/pkg/api/errors"

CHANGELOG.md

@@ -4750,7 +4750,7 @@
 - :white_check_mark: add internal/config/ngt test ([#554](https://github.com/vdaas/vald/pull/554))
 - :white_check_mark: internal/cache/cacher test ([#553](https://github.com/vdaas/vald/pull/553))
 - :white_check_mark: Add test case for `internal/file` ([#550](https://github.com/vdaas/vald/pull/550))
-- :white_check_mark: add internal/singleflight test ([#542](https://github.com/vdaas/vald/pull/542))
+- :white_check_mark: add internal/sync/singleflight test ([#542](https://github.com/vdaas/vald/pull/542))
 - not to force rebuild gotests ([#548](https://github.com/vdaas/vald/pull/548))
 - :pencil: Add use case document ([#482](https://github.com/vdaas/vald/pull/482))
 - :white_check_mark: add internal/log/mock/retry test ([#549](https://github.com/vdaas/vald/pull/549))
@@ -5272,7 +5272,7 @@
 - internal gRPC client for Vald
 - Cassandra NewConvictionPolicy
 - dicoverer now returns clone object
-- new internal/singleflight package
+- new internal/sync/singleflight package
 - new internal/net package
 - coding guideline
 

Makefile

@@ -361,7 +361,7 @@ clean:
 license:
 	GOPRIVATE=$(GOPRIVATE) \
 	MAINTAINER=$(MAINTAINER) \
-	go run -mod=readonly hack/license/gen/main.go ./
+	go run -mod=readonly hack/license/gen/main.go $(ROOTDIR)
 
 .PHONY: init
 ## initialize development environment

Makefile.d/proto.mk

@@ -138,6 +138,7 @@ $(PBGOS): \
 	find $(ROOTDIR)/apis/grpc/* -name '*.go' | xargs sed -i -E "s%google.golang.org/grpc/codes%github.com/vdaas/vald/internal/net/grpc/codes%g"
 	find $(ROOTDIR)/apis/grpc/* -name '*.go' | xargs sed -i -E "s%google.golang.org/grpc/status%github.com/vdaas/vald/internal/net/grpc/status%g"
 	find $(ROOTDIR)/apis/grpc/* -name '*.go' | xargs sed -i -E "s%\"io\"%\"github.com/vdaas/vald/internal/io\"%g"
+	find $(ROOTDIR)/apis/grpc/* -name '*.go' | xargs sed -i -E "s%\"sync\"%\"github.com/vdaas/vald/internal/sync\"%g"
 
 $(SWAGGERS): \
 	$(PROTOS) \

Makefile.d/test.mk

@@ -284,7 +284,7 @@ gotests/patch:
 	@$(call green, "apply patches to go test files...")
 	find $(ROOTDIR)/internal/k8s/* -name '*_test.go' | xargs sed -i -E "s%k8s.io/apimachinery/pkg/api/errors%github.com/vdaas/vald/internal/errors%g"
 	find $(ROOTDIR)/* -name '*_test.go' | xargs sed -i -E "s%cockroachdb/errors%vdaas/vald/internal/errors%g"
-	find $(ROOTDIR)/* -name '*_test.go' | xargs sed -i -E "s%golang.org/x/sync/errgroup%github.com/vdaas/vald/internal/errgroup%g"
+	find $(ROOTDIR)/* -name '*_test.go' | xargs sed -i -E "s%golang.org/x/sync/errgroup%github.com/vdaas/vald/internal/sync/errgroup%g"
 	find $(ROOTDIR)/* -name '*_test.go' | xargs sed -i -E "s%pkg/errors%vdaas/vald/internal/errors%g"
 	find $(ROOTDIR)/* -name '*_test.go' | xargs sed -i -E "s%go-errors/errors%vdaas/vald/internal/errors%g"
 	find $(ROOTDIR)/* -name '*_test.go' | xargs sed -i -E "s%go.uber.org/goleak%github.com/vdaas/vald/internal/test/goleak%g"

apis/docs/v1/docs.md

@@ -44,6 +44,8 @@ const _ = grpc.SupportPackageIsVersion7
 type IndexClient interface {
 	// Represent the RPC to get the index information.
 	IndexInfo(ctx context.Context, in *payload.Empty, opts ...grpc.CallOption) (*payload.Info_Index_Count, error)
+	// Represent the RPC to get the index information for each agents.
+	IndexDetail(ctx context.Context, in *payload.Empty, opts ...grpc.CallOption) (*payload.Info_Index_Detail, error)
 }
 
 type indexClient struct {
@@ -63,12 +65,23 @@ func (c *indexClient) IndexInfo(ctx context.Context, in *payload.Empty, opts ...
 	return out, nil
 }
 
+func (c *indexClient) IndexDetail(ctx context.Context, in *payload.Empty, opts ...grpc.CallOption) (*payload.Info_Index_Detail, error) {
+	out := new(payload.Info_Index_Detail)
+	err := c.cc.Invoke(ctx, "/manager.index.v1.Index/IndexDetail", in, out, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return out, nil
+}
+
 // IndexServer is the server API for Index service.
 // All implementations must embed UnimplementedIndexServer
 // for forward compatibility
 type IndexServer interface {
 	// Represent the RPC to get the index information.
 	IndexInfo(context.Context, *payload.Empty) (*payload.Info_Index_Count, error)
+	// Represent the RPC to get the index information for each agents.
+	IndexDetail(context.Context, *payload.Empty) (*payload.Info_Index_Detail, error)
 	mustEmbedUnimplementedIndexServer()
 }
 
@@ -79,6 +92,9 @@ type UnimplementedIndexServer struct {
 func (UnimplementedIndexServer) IndexInfo(context.Context, *payload.Empty) (*payload.Info_Index_Count, error) {
 	return nil, status.Errorf(codes.Unimplemented, "method IndexInfo not implemented")
 }
+func (UnimplementedIndexServer) IndexDetail(context.Context, *payload.Empty) (*payload.Info_Index_Detail, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method IndexDetail not implemented")
+}
 func (UnimplementedIndexServer) mustEmbedUnimplementedIndexServer() {}
 
 // UnsafeIndexServer may be embedded to opt out of forward compatibility for this service.
@@ -110,6 +126,24 @@ func _Index_IndexInfo_Handler(srv interface{}, ctx context.Context, dec func(int
 	return interceptor(ctx, in, info, handler)
 }
 
+func _Index_IndexDetail_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+	in := new(payload.Empty)
+	if err := dec(in); err != nil {
+		return nil, err
+	}
+	if interceptor == nil {
+		return srv.(IndexServer).IndexDetail(ctx, in)
+	}
+	info := &grpc.UnaryServerInfo{
+		Server:     srv,
+		FullMethod: "/manager.index.v1.Index/IndexDetail",
+	}
+	handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+		return srv.(IndexServer).IndexDetail(ctx, req.(*payload.Empty))
+	}
+	return interceptor(ctx, in, info, handler)
+}
+
 // Index_ServiceDesc is the grpc.ServiceDesc for Index service.
 // It's only intended for direct use with grpc.RegisterService,
 // and not to be introspected or modified (even as a copy)
@@ -121,6 +155,10 @@ var Index_ServiceDesc = grpc.ServiceDesc{
 			MethodName: "IndexInfo",
 			Handler:    _Index_IndexInfo_Handler,
 		},
+		{
+			MethodName: "IndexDetail",
+			Handler:    _Index_IndexDetail_Handler,
+		},
 	},
 	Streams:  []grpc.StreamDesc{},
 	Metadata: "apis/proto/v1/manager/index/index_manager.proto",