Skip to content

Commit 62004e6

Browse files
author
Isabella Siu
committed
GODRIVER-595 Better BSON Transition Errors
Change-Id: Ie40ab494cc0521856ebdcd3d81d0e5f7e92974a4
1 parent cc449c9 commit 62004e6

File tree

9 files changed

+524
-126
lines changed

9 files changed

+524
-126
lines changed

‎bson/bsonrw/extjson_reader.go

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -187,10 +187,13 @@ func (ejvr *extJSONValueReader) skipArray() error {
187187
return err
188188
}
189189

190-
func (ejvr *extJSONValueReader) invalidTransitionErr(destination mode) error {
190+
func (ejvr *extJSONValueReader) invalidTransitionErr(destination mode, name string, modes []mode) error {
191191
te := TransitionError{
192+
name: name,
192193
current: ejvr.stack[ejvr.frame].mode,
193194
destination: destination,
195+
modes: modes,
196+
action: "read",
194197
}
195198
if ejvr.frame != 0 {
196199
te.parent = ejvr.stack[ejvr.frame-1].mode
@@ -202,14 +205,18 @@ func (ejvr *extJSONValueReader) typeError(t bsontype.Type) error {
202205
return fmt.Errorf("positioned on %s, but attempted to read %s", ejvr.stack[ejvr.frame].vType, t)
203206
}
204207

205-
func (ejvr *extJSONValueReader) ensureElementValue(t bsontype.Type, destination mode) error {
208+
func (ejvr *extJSONValueReader) ensureElementValue(t bsontype.Type, destination mode, callerName string, addModes ...mode) error {
206209
switch ejvr.stack[ejvr.frame].mode {
207210
case mElement, mValue:
208211
if ejvr.stack[ejvr.frame].vType != t {
209212
return ejvr.typeError(t)
210213
}
211214
default:
212-
return ejvr.invalidTransitionErr(destination)
215+
modes := []mode{mElement, mValue}
216+
if addModes != nil {
217+
modes = append(modes, addModes...)
218+
}
219+
return ejvr.invalidTransitionErr(destination, callerName, modes)
213220
}
214221

215222
return nil
@@ -223,7 +230,7 @@ func (ejvr *extJSONValueReader) Skip() error {
223230
switch ejvr.stack[ejvr.frame].mode {
224231
case mElement, mValue:
225232
default:
226-
return ejvr.invalidTransitionErr(0)
233+
return ejvr.invalidTransitionErr(0, "Skip", []mode{mElement, mValue})
227234
}
228235

229236
defer ejvr.pop()
@@ -270,7 +277,7 @@ func (ejvr *extJSONValueReader) ReadArray() (ArrayReader, error) {
270277
case mArray:
271278
return ejvr, nil
272279
default:
273-
if err := ejvr.ensureElementValue(bsontype.Array, mArray); err != nil {
280+
if err := ejvr.ensureElementValue(bsontype.Array, mArray, "ReadArray", mTopLevel, mArray); err != nil {
274281
return nil, err
275282
}
276283
}
@@ -281,7 +288,7 @@ func (ejvr *extJSONValueReader) ReadArray() (ArrayReader, error) {
281288
}
282289

283290
func (ejvr *extJSONValueReader) ReadBinary() (b []byte, btype byte, err error) {
284-
if err := ejvr.ensureElementValue(bsontype.Binary, 0); err != nil {
291+
if err := ejvr.ensureElementValue(bsontype.Binary, 0, "ReadBinary"); err != nil {
285292
return nil, 0, err
286293
}
287294

@@ -297,7 +304,7 @@ func (ejvr *extJSONValueReader) ReadBinary() (b []byte, btype byte, err error) {
297304
}
298305

299306
func (ejvr *extJSONValueReader) ReadBoolean() (bool, error) {
300-
if err := ejvr.ensureElementValue(bsontype.Boolean, 0); err != nil {
307+
if err := ejvr.ensureElementValue(bsontype.Boolean, 0, "ReadBoolean"); err != nil {
301308
return false, err
302309
}
303310

@@ -326,12 +333,12 @@ func (ejvr *extJSONValueReader) ReadDocument() (DocumentReader, error) {
326333
ejvr.pushDocument()
327334
return ejvr, nil
328335
default:
329-
return nil, ejvr.invalidTransitionErr(mDocument)
336+
return nil, ejvr.invalidTransitionErr(mDocument, "ReadDocument", []mode{mTopLevel, mElement, mValue})
330337
}
331338
}
332339

333340
func (ejvr *extJSONValueReader) ReadCodeWithScope() (code string, dr DocumentReader, err error) {
334-
if err = ejvr.ensureElementValue(bsontype.CodeWithScope, 0); err != nil {
341+
if err = ejvr.ensureElementValue(bsontype.CodeWithScope, 0, "ReadCodeWithScope"); err != nil {
335342
return "", nil, err
336343
}
337344

@@ -347,7 +354,7 @@ func (ejvr *extJSONValueReader) ReadCodeWithScope() (code string, dr DocumentRea
347354
}
348355

349356
func (ejvr *extJSONValueReader) ReadDBPointer() (ns string, oid objectid.ObjectID, err error) {
350-
if err = ejvr.ensureElementValue(bsontype.DBPointer, 0); err != nil {
357+
if err = ejvr.ensureElementValue(bsontype.DBPointer, 0, "ReadDBPointer"); err != nil {
351358
return "", objectid.NilObjectID, err
352359
}
353360

@@ -363,7 +370,7 @@ func (ejvr *extJSONValueReader) ReadDBPointer() (ns string, oid objectid.ObjectI
363370
}
364371

365372
func (ejvr *extJSONValueReader) ReadDateTime() (int64, error) {
366-
if err := ejvr.ensureElementValue(bsontype.DateTime, 0); err != nil {
373+
if err := ejvr.ensureElementValue(bsontype.DateTime, 0, "ReadDateTime"); err != nil {
367374
return 0, err
368375
}
369376

@@ -379,7 +386,7 @@ func (ejvr *extJSONValueReader) ReadDateTime() (int64, error) {
379386
}
380387

381388
func (ejvr *extJSONValueReader) ReadDecimal128() (decimal.Decimal128, error) {
382-
if err := ejvr.ensureElementValue(bsontype.Decimal128, 0); err != nil {
389+
if err := ejvr.ensureElementValue(bsontype.Decimal128, 0, "ReadDecimal128"); err != nil {
383390
return decimal.Decimal128{}, err
384391
}
385392

@@ -395,7 +402,7 @@ func (ejvr *extJSONValueReader) ReadDecimal128() (decimal.Decimal128, error) {
395402
}
396403

397404
func (ejvr *extJSONValueReader) ReadDouble() (float64, error) {
398-
if err := ejvr.ensureElementValue(bsontype.Double, 0); err != nil {
405+
if err := ejvr.ensureElementValue(bsontype.Double, 0, "ReadDouble"); err != nil {
399406
return 0, err
400407
}
401408

@@ -411,7 +418,7 @@ func (ejvr *extJSONValueReader) ReadDouble() (float64, error) {
411418
}
412419

413420
func (ejvr *extJSONValueReader) ReadInt32() (int32, error) {
414-
if err := ejvr.ensureElementValue(bsontype.Int32, 0); err != nil {
421+
if err := ejvr.ensureElementValue(bsontype.Int32, 0, "ReadInt32"); err != nil {
415422
return 0, err
416423
}
417424

@@ -427,7 +434,7 @@ func (ejvr *extJSONValueReader) ReadInt32() (int32, error) {
427434
}
428435

429436
func (ejvr *extJSONValueReader) ReadInt64() (int64, error) {
430-
if err := ejvr.ensureElementValue(bsontype.Int64, 0); err != nil {
437+
if err := ejvr.ensureElementValue(bsontype.Int64, 0, "ReadInt64"); err != nil {
431438
return 0, err
432439
}
433440

@@ -443,7 +450,7 @@ func (ejvr *extJSONValueReader) ReadInt64() (int64, error) {
443450
}
444451

445452
func (ejvr *extJSONValueReader) ReadJavascript() (code string, err error) {
446-
if err = ejvr.ensureElementValue(bsontype.JavaScript, 0); err != nil {
453+
if err = ejvr.ensureElementValue(bsontype.JavaScript, 0, "ReadJavascript"); err != nil {
447454
return "", err
448455
}
449456

@@ -459,7 +466,7 @@ func (ejvr *extJSONValueReader) ReadJavascript() (code string, err error) {
459466
}
460467

461468
func (ejvr *extJSONValueReader) ReadMaxKey() error {
462-
if err := ejvr.ensureElementValue(bsontype.MaxKey, 0); err != nil {
469+
if err := ejvr.ensureElementValue(bsontype.MaxKey, 0, "ReadMaxKey"); err != nil {
463470
return err
464471
}
465472

@@ -475,7 +482,7 @@ func (ejvr *extJSONValueReader) ReadMaxKey() error {
475482
}
476483

477484
func (ejvr *extJSONValueReader) ReadMinKey() error {
478-
if err := ejvr.ensureElementValue(bsontype.MinKey, 0); err != nil {
485+
if err := ejvr.ensureElementValue(bsontype.MinKey, 0, "ReadMinKey"); err != nil {
479486
return err
480487
}
481488

@@ -491,7 +498,7 @@ func (ejvr *extJSONValueReader) ReadMinKey() error {
491498
}
492499

493500
func (ejvr *extJSONValueReader) ReadNull() error {
494-
if err := ejvr.ensureElementValue(bsontype.Null, 0); err != nil {
501+
if err := ejvr.ensureElementValue(bsontype.Null, 0, "ReadNull"); err != nil {
495502
return err
496503
}
497504

@@ -509,7 +516,7 @@ func (ejvr *extJSONValueReader) ReadNull() error {
509516
}
510517

511518
func (ejvr *extJSONValueReader) ReadObjectID() (objectid.ObjectID, error) {
512-
if err := ejvr.ensureElementValue(bsontype.ObjectID, 0); err != nil {
519+
if err := ejvr.ensureElementValue(bsontype.ObjectID, 0, "ReadObjectID"); err != nil {
513520
return objectid.ObjectID{}, err
514521
}
515522

@@ -525,7 +532,7 @@ func (ejvr *extJSONValueReader) ReadObjectID() (objectid.ObjectID, error) {
525532
}
526533

527534
func (ejvr *extJSONValueReader) ReadRegex() (pattern string, options string, err error) {
528-
if err = ejvr.ensureElementValue(bsontype.Regex, 0); err != nil {
535+
if err = ejvr.ensureElementValue(bsontype.Regex, 0, "ReadRegex"); err != nil {
529536
return "", "", err
530537
}
531538

@@ -541,7 +548,7 @@ func (ejvr *extJSONValueReader) ReadRegex() (pattern string, options string, err
541548
}
542549

543550
func (ejvr *extJSONValueReader) ReadString() (string, error) {
544-
if err := ejvr.ensureElementValue(bsontype.String, 0); err != nil {
551+
if err := ejvr.ensureElementValue(bsontype.String, 0, "ReadString"); err != nil {
545552
return "", err
546553
}
547554

@@ -559,7 +566,7 @@ func (ejvr *extJSONValueReader) ReadString() (string, error) {
559566
}
560567

561568
func (ejvr *extJSONValueReader) ReadSymbol() (symbol string, err error) {
562-
if err = ejvr.ensureElementValue(bsontype.Symbol, 0); err != nil {
569+
if err = ejvr.ensureElementValue(bsontype.Symbol, 0, "ReadSymbol"); err != nil {
563570
return "", err
564571
}
565572

@@ -575,7 +582,7 @@ func (ejvr *extJSONValueReader) ReadSymbol() (symbol string, err error) {
575582
}
576583

577584
func (ejvr *extJSONValueReader) ReadTimestamp() (t uint32, i uint32, err error) {
578-
if err = ejvr.ensureElementValue(bsontype.Timestamp, 0); err != nil {
585+
if err = ejvr.ensureElementValue(bsontype.Timestamp, 0, "ReadTimestamp"); err != nil {
579586
return 0, 0, err
580587
}
581588

@@ -591,7 +598,7 @@ func (ejvr *extJSONValueReader) ReadTimestamp() (t uint32, i uint32, err error)
591598
}
592599

593600
func (ejvr *extJSONValueReader) ReadUndefined() error {
594-
if err := ejvr.ensureElementValue(bsontype.Undefined, 0); err != nil {
601+
if err := ejvr.ensureElementValue(bsontype.Undefined, 0, "ReadUndefined"); err != nil {
595602
return err
596603
}
597604

@@ -610,7 +617,7 @@ func (ejvr *extJSONValueReader) ReadElement() (string, ValueReader, error) {
610617
switch ejvr.stack[ejvr.frame].mode {
611618
case mTopLevel, mDocument, mCodeWithScope:
612619
default:
613-
return "", nil, ejvr.invalidTransitionErr(mElement)
620+
return "", nil, ejvr.invalidTransitionErr(mElement, "ReadElement", []mode{mTopLevel, mDocument, mCodeWithScope})
614621
}
615622

616623
name, t, err := ejvr.p.readKey()
@@ -638,7 +645,7 @@ func (ejvr *extJSONValueReader) ReadValue() (ValueReader, error) {
638645
switch ejvr.stack[ejvr.frame].mode {
639646
case mArray:
640647
default:
641-
return nil, ejvr.invalidTransitionErr(mValue)
648+
return nil, ejvr.invalidTransitionErr(mValue, "ReadValue", []mode{mArray})
642649
}
643650

644651
t, err := ejvr.p.peekType()

‎bson/bsonrw/extjson_reader_test.go

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
// Copyright (C) MongoDB, Inc. 2017-present.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License"); you may
4+
// not use this file except in compliance with the License. You may obtain
5+
// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
6+
7+
package bsonrw
8+
9+
import (
10+
"testing"
11+
12+
"github.com/google/go-cmp/cmp"
13+
"github.com/mongodb/mongo-go-driver/bson/bsontype"
14+
)
15+
16+
func TestExtJSONReader(t *testing.T) {
17+
t.Run("ReadDocument", func(t *testing.T) {
18+
t.Run("EmbeddedDocument", func(t *testing.T) {
19+
ejvr := &extJSONValueReader{
20+
stack: []ejvrState{
21+
{mode: mTopLevel},
22+
{mode: mElement, vType: bsontype.Boolean},
23+
},
24+
frame: 1,
25+
}
26+
27+
ejvr.stack[1].mode = mArray
28+
wanterr := ejvr.invalidTransitionErr(mDocument, "ReadDocument", []mode{mTopLevel, mElement, mValue})
29+
_, err := ejvr.ReadDocument()
30+
if err == nil || err.Error() != wanterr.Error() {
31+
t.Errorf("Incorrect returned error. got %v; want %v", err, wanterr)
32+
}
33+
34+
})
35+
})
36+
37+
t.Run("invalid transition", func(t *testing.T) {
38+
t.Run("Skip", func(t *testing.T) {
39+
ejvr := &extJSONValueReader{stack: []ejvrState{{mode: mTopLevel}}}
40+
wanterr := (&extJSONValueReader{stack: []ejvrState{{mode: mTopLevel}}}).invalidTransitionErr(0, "Skip", []mode{mElement, mValue})
41+
goterr := ejvr.Skip()
42+
if !cmp.Equal(goterr, wanterr, cmp.Comparer(compareErrors)) {
43+
t.Errorf("Expected correct invalid transition error. got %v; want %v", goterr, wanterr)
44+
}
45+
})
46+
})
47+
}

0 commit comments

Comments
 (0)