Skip to content

Commit c6062c6

Browse files
cristalolegcristaloleg
authored
!refactor: rename GetSharesByNamespace to GetNamespaceData (#3902)
1 parent 1fbb040 commit c6062c6

File tree

17 files changed

+74
-58
lines changed

17 files changed

+74
-58
lines changed

Diff for: ‎api/gateway/share.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ func (h *Handler) getShares(
9393
height uint64,
9494
namespace libshare.Namespace,
9595
) ([]libshare.Share, error) {
96-
shares, err := h.share.GetSharesByNamespace(ctx, height, namespace)
96+
shares, err := h.share.GetNamespaceData(ctx, height, namespace)
9797
if err != nil {
9898
return nil, err
9999
}

Diff for: ‎blob/service.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ func (s *Service) retrieve(
368368
getCtx, getSharesSpan := tracer.Start(ctx, "get-shares-by-namespace")
369369

370370
// collect shares for the requested namespace
371-
namespacedShares, err := s.shareGetter.GetSharesByNamespace(getCtx, header, namespace)
371+
namespacedShares, err := s.shareGetter.GetNamespaceData(getCtx, header, namespace)
372372
if err != nil {
373373
if errors.Is(err, shwap.ErrNotFound) {
374374
err = ErrBlobNotFound

Diff for: ‎blob/service_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -412,15 +412,15 @@ func TestBlobService_Get(t *testing.T) {
412412
innerGetter := service.shareGetter
413413
getterWrapper := mock.NewMockGetter(ctrl)
414414
getterWrapper.EXPECT().
415-
GetSharesByNamespace(gomock.Any(), gomock.Any(), gomock.Any()).
415+
GetNamespaceData(gomock.Any(), gomock.Any(), gomock.Any()).
416416
DoAndReturn(
417417
func(
418418
ctx context.Context, h *header.ExtendedHeader, ns libshare.Namespace,
419419
) (shwap.NamespaceData, error) {
420420
if ns.Equals(blobsWithDiffNamespaces[0].Namespace()) {
421421
return nil, errors.New("internal error")
422422
}
423-
return innerGetter.GetSharesByNamespace(ctx, h, ns)
423+
return innerGetter.GetNamespaceData(ctx, h, ns)
424424
}).AnyTimes()
425425

426426
service.shareGetter = getterWrapper
@@ -876,7 +876,7 @@ func createServiceWithSub(ctx context.Context, t testing.TB, blobs []*Blob) *Ser
876876
ctrl := gomock.NewController(t)
877877
shareGetter := mock.NewMockGetter(ctrl)
878878

879-
shareGetter.EXPECT().GetSharesByNamespace(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().
879+
shareGetter.EXPECT().GetNamespaceData(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().
880880
DoAndReturn(func(ctx context.Context, h *header.ExtendedHeader, ns libshare.Namespace) (shwap.NamespaceData, error) {
881881
idx := int(h.Height()) - 1
882882
accessor := &eds.Rsmt2D{ExtendedDataSquare: edsses[idx]}
@@ -897,7 +897,7 @@ func createService(ctx context.Context, t testing.TB, shares []libshare.Share) *
897897
accessor := &eds.Rsmt2D{ExtendedDataSquare: square}
898898
ctrl := gomock.NewController(t)
899899
shareGetter := mock.NewMockGetter(ctrl)
900-
shareGetter.EXPECT().GetSharesByNamespace(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().
900+
shareGetter.EXPECT().GetNamespaceData(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().
901901
DoAndReturn(func(ctx context.Context, h *header.ExtendedHeader, ns libshare.Namespace) (shwap.NamespaceData, error) {
902902
nd, err := eds.NamespaceData(ctx, accessor, ns)
903903
return nd, err

Diff for: ‎nodebuilder/da/mocks/api.go

+18-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎nodebuilder/share/cmd/share.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ var getSharesByNamespaceCmd = &cobra.Command{
8585
return err
8686
}
8787

88-
shares, err := client.Share.GetSharesByNamespace(cmd.Context(), height, ns)
88+
shares, err := client.Share.GetNamespaceData(cmd.Context(), height, ns)
8989
return cmdnode.PrintOutput(shares, err, nil)
9090
},
9191
}

Diff for: ‎nodebuilder/share/share.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ type Module interface {
4747
GetShare(ctx context.Context, height uint64, row, col int) (libshare.Share, error)
4848
// GetEDS gets the full EDS identified by the given extended header.
4949
GetEDS(ctx context.Context, height uint64) (*rsmt2d.ExtendedDataSquare, error)
50-
// GetSharesByNamespace gets all shares from an EDS within the given namespace.
50+
// GetNamespaceData gets all shares from an EDS within the given namespace.
5151
// Shares are returned in a row-by-row order if the namespace spans multiple rows.
52-
GetSharesByNamespace(
52+
GetNamespaceData(
5353
ctx context.Context, height uint64, namespace libshare.Namespace,
5454
) (shwap.NamespaceData, error)
5555
// GetRange gets a list of shares and their corresponding proof.
@@ -69,7 +69,7 @@ type API struct {
6969
ctx context.Context,
7070
height uint64,
7171
) (*rsmt2d.ExtendedDataSquare, error) `perm:"read"`
72-
GetSharesByNamespace func(
72+
GetNamespaceData func(
7373
ctx context.Context,
7474
height uint64,
7575
namespace libshare.Namespace,
@@ -98,12 +98,12 @@ func (api *API) GetRange(ctx context.Context, height uint64, start, end int) (*G
9898
return api.Internal.GetRange(ctx, height, start, end)
9999
}
100100

101-
func (api *API) GetSharesByNamespace(
101+
func (api *API) GetNamespaceData(
102102
ctx context.Context,
103103
height uint64,
104104
namespace libshare.Namespace,
105105
) (shwap.NamespaceData, error) {
106-
return api.Internal.GetSharesByNamespace(ctx, height, namespace)
106+
return api.Internal.GetNamespaceData(ctx, height, namespace)
107107
}
108108

109109
type module struct {
@@ -157,7 +157,7 @@ func (m module) GetRange(ctx context.Context, height uint64, start, end int) (*G
157157
}, nil
158158
}
159159

160-
func (m module) GetSharesByNamespace(
160+
func (m module) GetNamespaceData(
161161
ctx context.Context,
162162
height uint64,
163163
namespace libshare.Namespace,
@@ -166,5 +166,5 @@ func (m module) GetSharesByNamespace(
166166
if err != nil {
167167
return nil, err
168168
}
169-
return m.getter.GetSharesByNamespace(ctx, header, namespace)
169+
return m.getter.GetNamespaceData(ctx, header, namespace)
170170
}

Diff for: ‎nodebuilder/tests/nd_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ func TestShrexNDFromLights(t *testing.T) {
7373
require.NoError(t, err)
7474

7575
height := h.Height()
76-
expected, err := bridgeClient.Share.GetSharesByNamespace(reqCtx, height, ns)
76+
expected, err := bridgeClient.Share.GetNamespaceData(reqCtx, height, ns)
7777
require.NoError(t, err)
78-
got, err := lightClient.Share.GetSharesByNamespace(reqCtx, height, ns)
78+
got, err := lightClient.Share.GetNamespaceData(reqCtx, height, ns)
7979
require.NoError(t, err)
8080

8181
require.True(t, len(got[0].Shares) > 0)
@@ -149,18 +149,18 @@ func TestShrexNDFromLightsWithBadFulls(t *testing.T) {
149149
height := h.Height()
150150
ns, err := libshare.NewNamespaceFromBytes(namespace)
151151
require.NoError(t, err)
152-
expected, err := bridgeClient.Share.GetSharesByNamespace(reqCtx, height, ns)
152+
expected, err := bridgeClient.Share.GetNamespaceData(reqCtx, height, ns)
153153
require.NoError(t, err)
154154
require.True(t, len(expected[0].Shares) > 0)
155155

156156
// choose a random full to test
157157
fN := fulls[len(fulls)/2]
158158
fnClient := getAdminClient(ctx, fN, t)
159-
gotFull, err := fnClient.Share.GetSharesByNamespace(reqCtx, height, ns)
159+
gotFull, err := fnClient.Share.GetNamespaceData(reqCtx, height, ns)
160160
require.NoError(t, err)
161161
require.True(t, len(gotFull[0].Shares) > 0)
162162

163-
gotLight, err := lightClient.Share.GetSharesByNamespace(reqCtx, height, ns)
163+
gotLight, err := lightClient.Share.GetNamespaceData(reqCtx, height, ns)
164164
require.NoError(t, err)
165165
require.True(t, len(gotLight[0].Shares) > 0)
166166

Diff for: ‎share/availability/light/availability_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ func (g onceGetter) GetEDS(_ context.Context, _ *header.ExtendedHeader) (*rsmt2d
271271
panic("not implemented")
272272
}
273273

274-
func (g onceGetter) GetSharesByNamespace(
274+
func (g onceGetter) GetNamespaceData(
275275
_ context.Context,
276276
_ *header.ExtendedHeader,
277277
_ libshare.Namespace,

Diff for: ‎share/shwap/getter.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ type Getter interface {
3535
// GetEDS gets the full EDS identified by the given extended header.
3636
GetEDS(context.Context, *header.ExtendedHeader) (*rsmt2d.ExtendedDataSquare, error)
3737

38-
// GetSharesByNamespace gets all shares from an EDS within the given namespace.
38+
// GetNamespaceData gets all shares from an EDS within the given namespace.
3939
// Shares are returned in a row-by-row order if the namespace spans multiple rows.
4040
// Inclusion of returned data could be verified using Verify method on NamespacedShares.
4141
// If no shares are found for target namespace non-inclusion could be also verified by calling
4242
// Verify method.
43-
GetSharesByNamespace(context.Context, *header.ExtendedHeader, libshare.Namespace) (NamespaceData, error)
43+
GetNamespaceData(context.Context, *header.ExtendedHeader, libshare.Namespace) (NamespaceData, error)
4444
}

Diff for: ‎share/shwap/getters/cascade.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ func (cg *CascadeGetter) GetEDS(
7878
return cascadeGetters(ctx, cg.getters, get)
7979
}
8080

81-
// GetSharesByNamespace gets NamespacedShares from any of registered shwap.Getters in cascading
81+
// GetNamespaceData gets NamespacedShares from any of registered shwap.Getters in cascading
8282
// order.
83-
func (cg *CascadeGetter) GetSharesByNamespace(
83+
func (cg *CascadeGetter) GetNamespaceData(
8484
ctx context.Context,
8585
header *header.ExtendedHeader,
8686
namespace libshare.Namespace,
@@ -91,7 +91,7 @@ func (cg *CascadeGetter) GetSharesByNamespace(
9191
defer span.End()
9292

9393
get := func(ctx context.Context, get shwap.Getter) (shwap.NamespaceData, error) {
94-
return get.GetSharesByNamespace(ctx, header, namespace)
94+
return get.GetNamespaceData(ctx, header, namespace)
9595
}
9696

9797
return cascadeGetters(ctx, cg.getters, get)

Diff for: ‎share/shwap/getters/mock/getter.go

+14-14
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎share/shwap/getters/testing.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func TestGetter(t *testing.T) (shwap.Getter, *header.ExtendedHeader) {
3030
}
3131

3232
// SingleEDSGetter contains a single EDS where data is retrieved from.
33-
// Its primary use is testing, and GetSharesByNamespace is not supported.
33+
// Its primary use is testing, and GetNamespaceData is not supported.
3434
type SingleEDSGetter struct {
3535
EDS *rsmt2d.ExtendedDataSquare
3636
}
@@ -65,10 +65,10 @@ func (seg *SingleEDSGetter) GetEDS(
6565
return seg.EDS, nil
6666
}
6767

68-
// GetSharesByNamespace returns NamespacedShares from a kept EDS if the correct root is given.
69-
func (seg *SingleEDSGetter) GetSharesByNamespace(context.Context, *header.ExtendedHeader, libshare.Namespace,
68+
// GetNamespaceData returns NamespacedShares from a kept EDS if the correct root is given.
69+
func (seg *SingleEDSGetter) GetNamespaceData(context.Context, *header.ExtendedHeader, libshare.Namespace,
7070
) (shwap.NamespaceData, error) {
71-
panic("SingleEDSGetter: GetSharesByNamespace is not implemented")
71+
panic("SingleEDSGetter: GetNamespaceData is not implemented")
7272
}
7373

7474
func (seg *SingleEDSGetter) checkRoots(roots *share.AxisRoots) error {

Diff for: ‎share/shwap/p2p/bitswap/getter.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,10 @@ func (g *Getter) GetEDS(
179179
return square, nil
180180
}
181181

182-
// GetSharesByNamespace uses [RowNamespaceDataBlock] and [Fetch] to get all the data
182+
// GetNamespaceData uses [RowNamespaceDataBlock] and [Fetch] to get all the data
183183
// by the given namespace. If data spans over multiple rows, the request is split into
184184
// parallel RowNamespaceDataID requests per each row and then assembled back into NamespaceData.
185-
func (g *Getter) GetSharesByNamespace(
185+
func (g *Getter) GetNamespaceData(
186186
ctx context.Context,
187187
hdr *header.ExtendedHeader,
188188
ns libshare.Namespace,

Diff for: ‎share/shwap/p2p/shrex/shrex_getter/shrex.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ func (sg *Getter) GetEDS(ctx context.Context, header *header.ExtendedHeader) (*r
214214
}
215215
}
216216

217-
func (sg *Getter) GetSharesByNamespace(
217+
func (sg *Getter) GetNamespaceData(
218218
ctx context.Context,
219219
header *header.ExtendedHeader,
220220
namespace libshare.Namespace,

Diff for: ‎share/shwap/p2p/shrex/shrex_getter/shrex_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ func TestShrexGetter(t *testing.T) {
8282
Height: height,
8383
})
8484

85-
got, err := getter.GetSharesByNamespace(ctx, eh, namespace)
85+
got, err := getter.GetNamespaceData(ctx, eh, namespace)
8686
require.NoError(t, err)
8787
require.NoError(t, got.Verify(roots, namespace))
8888
})
@@ -102,7 +102,7 @@ func TestShrexGetter(t *testing.T) {
102102
Height: height,
103103
})
104104

105-
_, err := getter.GetSharesByNamespace(ctx, eh, namespace)
105+
_, err := getter.GetNamespaceData(ctx, eh, namespace)
106106
require.ErrorIs(t, err, shwap.ErrNotFound)
107107
})
108108

@@ -131,7 +131,7 @@ func TestShrexGetter(t *testing.T) {
131131
require.NoError(t, err)
132132
require.Len(t, rows, 1)
133133

134-
emptyShares, err := getter.GetSharesByNamespace(ctx, eh, nID)
134+
emptyShares, err := getter.GetNamespaceData(ctx, eh, nID)
135135
require.NoError(t, err)
136136
// no shares should be returned
137137
require.Nil(t, emptyShares.Flatten())
@@ -145,7 +145,7 @@ func TestShrexGetter(t *testing.T) {
145145
require.NoError(t, err)
146146
require.Len(t, rows, 0)
147147

148-
emptyShares, err = getter.GetSharesByNamespace(ctx, eh, nID)
148+
emptyShares, err = getter.GetNamespaceData(ctx, eh, nID)
149149
require.NoError(t, err)
150150
// no shares should be returned
151151
require.Nil(t, emptyShares.Flatten())
@@ -176,7 +176,7 @@ func TestShrexGetter(t *testing.T) {
176176
require.NoError(t, err)
177177
require.Len(t, rows, 0)
178178

179-
emptyShares, err := getter.GetSharesByNamespace(ctx, eh, namespace)
179+
emptyShares, err := getter.GetNamespaceData(ctx, eh, namespace)
180180
require.NoError(t, err)
181181
// no shares should be returned
182182
require.Empty(t, emptyShares.Flatten())

Diff for: ‎store/getter.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func (g *Getter) GetEDS(ctx context.Context, h *header.ExtendedHeader) (*rsmt2d.
6868
return rsmt2d.ExtendedDataSquare, nil
6969
}
7070

71-
func (g *Getter) GetSharesByNamespace(
71+
func (g *Getter) GetNamespaceData(
7272
ctx context.Context,
7373
h *header.ExtendedHeader,
7474
ns libshare.Namespace,

0 commit comments

Comments
 (0)