Skip to content

Commit 46bc0eb

Browse files
committed
add string-format rule for revive linter
1 parent 3498e8a commit 46bc0eb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+167
-142
lines changed

api/http/errors_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ func TestHandleErrOnDefault(t *testing.T) {
139139
t.Cleanup(CleanupEnv)
140140
env = "dev"
141141
f := func(rw http.ResponseWriter, req *http.Request) {
142-
handleErr(req.Context(), rw, errors.New("Unauthorized"), http.StatusUnauthorized)
142+
handleErr(req.Context(), rw, errors.New("unauthorized"), http.StatusUnauthorized)
143143
}
144144
req, err := http.NewRequest("GET", "/test", nil)
145145
if err != nil {
@@ -164,6 +164,6 @@ func TestHandleErrOnDefault(t *testing.T) {
164164

165165
assert.Equal(t, http.StatusUnauthorized, errResponse.Errors[0].Extensions.Status)
166166
assert.Equal(t, http.StatusText(http.StatusUnauthorized), errResponse.Errors[0].Extensions.HTTPError)
167-
assert.Equal(t, "Unauthorized", errResponse.Errors[0].Message)
168-
assert.Contains(t, errResponse.Errors[0].Extensions.Stack, "[DEV] Unauthorized")
167+
assert.Equal(t, "unauthorized", errResponse.Errors[0].Message)
168+
assert.Contains(t, errResponse.Errors[0].Extensions.Stack, "[DEV] unauthorized")
169169
}

client/dockey.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func NewDocKeyV0(dataCID cid.Cid) DocKey {
5656
func NewDocKeyFromString(key string) (DocKey, error) {
5757
parts := strings.SplitN(key, "-", 2)
5858
if len(parts) != 2 {
59-
return DocKey{}, errors.New("Malformed DocKey, missing either version or cid")
59+
return DocKey{}, errors.New("malformed DocKey, missing either version or cid")
6060
}
6161
versionStr := parts[0]
6262
_, data, err := mbase.Decode(versionStr)
@@ -69,7 +69,7 @@ func NewDocKeyFromString(key string) (DocKey, error) {
6969
return DocKey{}, err
7070
}
7171
if _, ok := ValidDocKeyVersions[uint16(version)]; !ok {
72-
return DocKey{}, errors.New("Invalid DocKey version")
72+
return DocKey{}, errors.New("invalid DocKey version")
7373
}
7474

7575
uuid, err := uuid.FromString(parts[1])

client/document.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ func NewDocFromMap(data map[string]any) (*Document, error) {
8989
delete(data, "_key") // remove the key so it isn't parsed further
9090
kstr, ok := k.(string)
9191
if !ok {
92-
return nil, errors.New("Provided _key in document must be a string type")
92+
return nil, errors.New("provided _key in document must be a string type")
9393
}
9494
if doc.key, err = NewDocKeyFromString(kstr); err != nil {
9595
return nil, err

client/errors.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ const (
2424
var (
2525
ErrFieldNotExist = errors.New(errFieldNotExist)
2626
ErrSelectOfNonGroupField = errors.New(errSelectOfNonGroupField)
27-
ErrFieldNotObject = errors.New("Trying to access field on a non object type")
28-
ErrValueTypeMismatch = errors.New("Value does not match indicated type")
29-
ErrIndexNotFound = errors.New("No index found for given ID")
30-
ErrDocumentNotFound = errors.New("No document for the given key exists")
31-
ErrInvalidUpdateTarget = errors.New("The target document to update is of invalid type")
32-
ErrInvalidUpdater = errors.New("The updater of a document is of invalid type")
33-
ErrInvalidDeleteTarget = errors.New("The target document to delete is of invalid type")
27+
ErrFieldNotObject = errors.New("trying to access field on a non object type")
28+
ErrValueTypeMismatch = errors.New("value does not match indicated type")
29+
ErrIndexNotFound = errors.New("no index found for given ID")
30+
ErrDocumentNotFound = errors.New("no document for the given key exists")
31+
ErrInvalidUpdateTarget = errors.New("the target document to update is of invalid type")
32+
ErrInvalidUpdater = errors.New("the updater of a document is of invalid type")
33+
ErrInvalidDeleteTarget = errors.New("the target document to delete is of invalid type")
3434
)
3535

3636
func NewErrFieldNotExist(name string) error {

core/crdt/composite.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ func (c CompositeDAG) DeltaDecode(node ipld.Node) (core.Delta, error) {
135135
delta := &CompositeDAGDelta{}
136136
pbNode, ok := node.(*dag.ProtoNode)
137137
if !ok {
138-
return nil, errors.New("Failed to cast ipld.Node to ProtoNode")
138+
return nil, errors.New("failed to cast ipld.Node to ProtoNode")
139139
}
140140
data := pbNode.Data()
141141
h := &codec.CborHandle{}

core/crdt/lwwreg.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ func (reg LWWRegister) Merge(ctx context.Context, delta core.Delta, id string) e
139139
func (reg LWWRegister) setValue(ctx context.Context, val []byte, priority uint64) error {
140140
curPrio, err := reg.getPriority(ctx, reg.key)
141141
if err != nil {
142-
return errors.Wrap("Failed to get priority for Set ", err)
142+
return errors.Wrap("failed to get priority for Set ", err)
143143
}
144144

145145
// if the current priority is higher ignore put
@@ -159,7 +159,7 @@ func (reg LWWRegister) setValue(ctx context.Context, val []byte, priority uint64
159159
buf := append([]byte{byte(client.LWW_REGISTER)}, val...)
160160
err = reg.store.Put(ctx, valueK.ToDS(), buf)
161161
if err != nil {
162-
return errors.Wrap("Failed to store new value ", err)
162+
return errors.Wrap("failed to store new value ", err)
163163
}
164164

165165
return reg.setPriority(ctx, reg.key, priority)
@@ -172,7 +172,7 @@ func (reg LWWRegister) DeltaDecode(node ipld.Node) (core.Delta, error) {
172172
delta := &LWWRegDelta{}
173173
pbNode, ok := node.(*dag.ProtoNode)
174174
if !ok {
175-
return nil, errors.New("Failed to cast ipld.Node to ProtoNode")
175+
return nil, errors.New("failed to cast ipld.Node to ProtoNode")
176176
}
177177
data := pbNode.Data()
178178
h := &codec.CborHandle{}

core/key.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ func (k DataStoreKey) PrefixEnd() DataStoreKey {
432432
func (k DataStoreKey) FieldID() (uint32, error) {
433433
fieldID, err := strconv.Atoi(k.FieldId)
434434
if err != nil {
435-
return 0, errors.Wrap("Failed to get FieldID of Key", err)
435+
return 0, errors.Wrap("failed to get FieldID of Key", err)
436436
}
437437
return uint32(fieldID), nil
438438
}

core/replicated.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121

2222
var (
2323
// ErrMismatchedMergeType - Tying to merge two ReplicatedData of different types
24-
ErrMismatchedMergeType = errors.New("Given type to merge does not match source")
24+
ErrMismatchedMergeType = errors.New("given type to merge does not match source")
2525
)
2626

2727
// ReplicatedData is a data type that allows concurrent writers

db/base/collection_keys.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func MakePrimaryIndexKeyForCRDT(
4646
fieldKey := getFieldKey(c, key, fieldName)
4747
return MakeCollectionKey(c).WithInstanceInfo(fieldKey), nil
4848
}
49-
return core.DataStoreKey{}, errors.New("Invalid CRDT type")
49+
return core.DataStoreKey{}, errors.New("invalid CRDT type")
5050
}
5151

5252
func getFieldKey(

db/collection.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ import (
3434
)
3535

3636
var (
37-
ErrDocumentAlreadyExists = errors.New("A document with the given dockey already exists")
38-
ErrUnknownCRDTArgument = errors.New("Invalid CRDT arguments")
37+
ErrDocumentAlreadyExists = errors.New("a document with the given dockey already exists")
38+
ErrUnknownCRDTArgument = errors.New("invalid CRDT arguments")
3939
ErrUnknownCRDT = errors.New("")
4040
)
4141

@@ -63,29 +63,29 @@ type collection struct {
6363
// NewCollection returns a pointer to a newly instanciated DB Collection
6464
func (db *db) newCollection(desc client.CollectionDescription) (*collection, error) {
6565
if desc.Name == "" {
66-
return nil, errors.New("Collection requires name to not be empty")
66+
return nil, errors.New("collection requires name to not be empty")
6767
}
6868

6969
if len(desc.Schema.Fields) == 0 {
70-
return nil, errors.New("Collection schema has no fields")
70+
return nil, errors.New("collection schema has no fields")
7171
}
7272

7373
docKeyField := desc.Schema.Fields[0]
7474
if docKeyField.Kind != client.FieldKind_DocKey || docKeyField.Name != "_key" {
75-
return nil, errors.New("Collection schema first field must be a DocKey")
75+
return nil, errors.New("collection schema first field must be a DocKey")
7676
}
7777

7878
desc.Schema.FieldIDs = make([]uint32, len(desc.Schema.Fields))
7979
for i, field := range desc.Schema.Fields {
8080
if field.Name == "" {
81-
return nil, errors.New("Collection schema field missing Name")
81+
return nil, errors.New("collection schema field missing Name")
8282
}
8383
if field.Kind == client.FieldKind_None {
84-
return nil, errors.New("Collection schema field missing FieldKind")
84+
return nil, errors.New("collection schema field missing FieldKind")
8585
}
8686
if (field.Kind != client.FieldKind_DocKey && !field.IsObject()) &&
8787
field.Typ == client.NONE_CRDT {
88-
return nil, errors.New("Collection schema field missing CRDT type")
88+
return nil, errors.New("collection schema field missing CRDT type")
8989
}
9090
desc.Schema.FieldIDs[i] = uint32(i)
9191
desc.Schema.Fields[i].ID = client.FieldID(i)
@@ -122,7 +122,7 @@ func (db *db) CreateCollection(
122122
return nil, err
123123
}
124124
if exists {
125-
return nil, errors.New("Collection already exists")
125+
return nil, errors.New("collection already exists")
126126
}
127127

128128
colSeq, err := db.getSequence(ctx, core.COLLECTION)
@@ -181,7 +181,7 @@ func (db *db) CreateCollection(
181181
// GetCollection returns an existing collection within the database
182182
func (db *db) GetCollectionByName(ctx context.Context, name string) (client.Collection, error) {
183183
if name == "" {
184-
return nil, errors.New("Collection name can't be empty")
184+
return nil, errors.New("collection name can't be empty")
185185
}
186186

187187
key := core.NewCollectionKey(name)
@@ -233,7 +233,7 @@ func (db *db) GetCollectionBySchemaID(
233233
schemaID string,
234234
) (client.Collection, error) {
235235
if schemaID == "" {
236-
return nil, errors.New("Schema ID can't be empty")
236+
return nil, errors.New("schema ID can't be empty")
237237
}
238238

239239
key := core.NewCollectionSchemaKey(schemaID)
@@ -256,7 +256,7 @@ func (db *db) GetAllCollections(ctx context.Context) ([]client.Collection, error
256256
KeysOnly: true,
257257
})
258258
if err != nil {
259-
return nil, errors.Wrap("Failed to create collection prefix query", err)
259+
return nil, errors.Wrap("failed to create collection prefix query", err)
260260
}
261261
defer func() {
262262
if err := q.Close(); err != nil {

db/collection_delete.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ import (
3030
)
3131

3232
var (
33-
ErrDeleteTargetEmpty = errors.New("The doc delete targeter cannot be empty")
34-
ErrDeleteEmpty = errors.New("The doc delete cannot be empty")
33+
ErrDeleteTargetEmpty = errors.New("the doc delete targeter cannot be empty")
34+
ErrDeleteEmpty = errors.New("the doc delete cannot be empty")
3535
)
3636

3737
// DeleteWith deletes a target document. Target can be a Filter statement,
@@ -293,7 +293,7 @@ func (c *collection) applyFullDelete(
293293
// Get all the heads (cids).
294294
heads, _, err := headset.List(ctx)
295295
if err != nil {
296-
return errors.Wrap("Failed to get document heads", err)
296+
return errors.Wrap("failed to get document heads", err)
297297
}
298298

299299
dagDel := newDagDeleter(txn.DAGstore())

db/collection_test.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ func TestNewCollectionReturnsErrorGivenDuplicateSchema(t *testing.T) {
101101
assert.NoError(t, err)
102102

103103
_, err = newTestCollectionWithSchema(ctx, db)
104-
assert.Errorf(t, err, "Collection already exists")
104+
assert.Errorf(t, err, "collection already exists")
105105
}
106106

107107
func TestNewCollectionReturnsErrorGivenNoFields(t *testing.T) {
@@ -117,7 +117,7 @@ func TestNewCollectionReturnsErrorGivenNoFields(t *testing.T) {
117117
}
118118

119119
_, err = db.CreateCollection(ctx, desc)
120-
assert.EqualError(t, err, "Collection schema has no fields")
120+
assert.EqualError(t, err, "collection schema has no fields")
121121
}
122122

123123
func TestNewCollectionReturnsErrorGivenNoName(t *testing.T) {
@@ -133,7 +133,7 @@ func TestNewCollectionReturnsErrorGivenNoName(t *testing.T) {
133133
}
134134

135135
_, err = db.CreateCollection(ctx, desc)
136-
assert.EqualError(t, err, "Collection requires name to not be empty")
136+
assert.EqualError(t, err, "collection requires name to not be empty")
137137
}
138138

139139
func TestNewCollectionReturnsErrorGivenNoKeyField(t *testing.T) {
@@ -155,7 +155,7 @@ func TestNewCollectionReturnsErrorGivenNoKeyField(t *testing.T) {
155155
}
156156

157157
_, err = db.CreateCollection(ctx, desc)
158-
assert.EqualError(t, err, "Collection schema first field must be a DocKey")
158+
assert.EqualError(t, err, "collection schema first field must be a DocKey")
159159
}
160160

161161
func TestNewCollectionReturnsErrorGivenKeyFieldIsNotFirstField(t *testing.T) {
@@ -181,7 +181,7 @@ func TestNewCollectionReturnsErrorGivenKeyFieldIsNotFirstField(t *testing.T) {
181181
}
182182

183183
_, err = db.CreateCollection(ctx, desc)
184-
assert.EqualError(t, err, "Collection schema first field must be a DocKey")
184+
assert.EqualError(t, err, "collection schema first field must be a DocKey")
185185
}
186186

187187
func TestNewCollectionReturnsErrorGivenFieldWithNoName(t *testing.T) {
@@ -207,7 +207,7 @@ func TestNewCollectionReturnsErrorGivenFieldWithNoName(t *testing.T) {
207207
}
208208

209209
_, err = db.CreateCollection(ctx, desc)
210-
assert.EqualError(t, err, "Collection schema field missing Name")
210+
assert.EqualError(t, err, "collection schema field missing Name")
211211
}
212212

213213
func TestNewCollectionReturnsErrorGivenFieldWithNoKind(t *testing.T) {
@@ -232,7 +232,7 @@ func TestNewCollectionReturnsErrorGivenFieldWithNoKind(t *testing.T) {
232232
}
233233

234234
_, err = db.CreateCollection(ctx, desc)
235-
assert.EqualError(t, err, "Collection schema field missing FieldKind")
235+
assert.EqualError(t, err, "collection schema field missing FieldKind")
236236
}
237237

238238
func TestNewCollectionReturnsErrorGivenFieldWithNoType(t *testing.T) {
@@ -257,7 +257,7 @@ func TestNewCollectionReturnsErrorGivenFieldWithNoType(t *testing.T) {
257257
}
258258

259259
_, err = db.CreateCollection(ctx, desc)
260-
assert.EqualError(t, err, "Collection schema field missing CRDT type")
260+
assert.EqualError(t, err, "collection schema field missing CRDT type")
261261
}
262262

263263
func TestGetCollectionByName(t *testing.T) {
@@ -303,5 +303,5 @@ func TestGetCollectionByNameReturnsErrorGivenEmptyString(t *testing.T) {
303303
assert.NoError(t, err)
304304

305305
_, err = db.GetCollectionByName(ctx, "")
306-
assert.EqualError(t, err, "Collection name can't be empty")
306+
assert.EqualError(t, err, "collection name can't be empty")
307307
}

db/collection_update.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ import (
2929
)
3030

3131
var (
32-
ErrUpdateTargetEmpty = errors.New("The doc update targeter cannot be empty")
33-
ErrUpdateEmpty = errors.New("The doc update cannot be empty")
32+
ErrUpdateTargetEmpty = errors.New("the doc update targeter cannot be empty")
33+
ErrUpdateEmpty = errors.New("the doc update cannot be empty")
3434
ErrInvalidMergeValueType = errors.New(
35-
"The type of value in the merge patch doesn't match the schema",
35+
"the type of value in the merge patch doesn't match the schema",
3636
)
3737
)
3838

@@ -604,7 +604,7 @@ func (c *collection) makeSelectionQuery(
604604
switch fval := filter.(type) {
605605
case string:
606606
if fval == "" {
607-
return nil, errors.New("Invalid filter")
607+
return nil, errors.New("invalid filter")
608608
}
609609
var p *parser.Filter
610610
p, err = parser.NewFilterFromString(fval)
@@ -615,10 +615,10 @@ func (c *collection) makeSelectionQuery(
615615
case *mapper.Filter:
616616
f = fval
617617
default:
618-
return nil, errors.New("Invalid filter")
618+
return nil, errors.New("invalid filter")
619619
}
620620
if filter == "" {
621-
return nil, errors.New("Invalid filter")
621+
return nil, errors.New("invalid filter")
622622
}
623623
slct, err := c.makeSelectLocal(f, mapping)
624624
if err != nil {
@@ -697,7 +697,7 @@ func (c *collection) getTargetKeyForPatchPath( //nolint:unused
697697
) (string, error) {
698698
_, length := splitPatchPath(path)
699699
if length == 0 {
700-
return "", errors.New("Invalid patch op path")
700+
return "", errors.New("invalid patch op path")
701701
}
702702

703703
return "", nil

db/db.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ var (
3838
log = logging.MustNewLogger("defra.db")
3939
// ErrDocVerification occurs when a documents contents fail the verification during a Create()
4040
// call against the supplied Document Key.
41-
ErrDocVerification = errors.New("The document verification failed")
41+
ErrDocVerification = errors.New("the document verification failed")
4242

43-
ErrOptionsEmpty = errors.New("Empty options configuration provided")
43+
ErrOptionsEmpty = errors.New("empty options configuration provided")
4444
)
4545

4646
// make sure we match our client interface
@@ -198,11 +198,11 @@ func (db *db) GetRelationshipIdField(fieldName, targetType, thisType string) (st
198198
rm := db.schema.Relations
199199
rel := rm.GetRelationByDescription(fieldName, targetType, thisType)
200200
if rel == nil {
201-
return "", errors.New("Relation does not exists")
201+
return "", errors.New("relation does not exists")
202202
}
203203
subtypefieldname, _, ok := rel.GetFieldFromSchemaType(targetType)
204204
if !ok {
205-
return "", errors.New("Relation is missing referenced field")
205+
return "", errors.New("relation is missing referenced field")
206206
}
207207
return subtypefieldname, nil
208208
}

0 commit comments

Comments
 (0)