Skip to content

Update mongodb driver from 1.17.1 to 2.10.0 #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jemiahw wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update mongodb driver from 1.17.1 to 2.10.0 #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions api/api_gomux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (

"github.com/gorilla/websocket"
"github.com/swaggo/http-swagger"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/v2/bson"

"github.com/square/etre"
"github.com/square/etre/app"
Expand Down Expand Up @@ -494,13 +494,13 @@ func (api *API) id(next http.Handler) http.Handler {
rc := ctx.Value(reqKey).(*req)

var err error
var entityId primitive.ObjectID
var entityId bson.ObjectID

id := r.PathValue("id") // 1. from URL
if id == "" {
err = ErrMissingParam.New("missing id param")
} else {
entityId, err = primitive.ObjectIDFromHex(id) // 2. convert to/validate as ObjectID
entityId, err = bson.ObjectIDFromHex(id) // 2. convert to/validate as ObjectID
if err != nil {
err = ErrInvalidParam.New("id '%s' is not a valid ObjectID: %v", id, err)
}
Expand Down Expand Up @@ -1297,8 +1297,8 @@ func (api *API) WriteResult(rc *req, w http.ResponseWriter, ids interface{}, err
diffs := ids.([]etre.Entity)
writes = make([]etre.Write, len(diffs))
for i, diff := range diffs {
// _id from db is primitive.ObjectID, convert to string
id := diff["_id"].(primitive.ObjectID).Hex()
// _id from db is bson.ObjectID, convert to string
id := diff["_id"].(bson.ObjectID).Hex()
writes[i] = etre.Write{
EntityId: id,
URI: api.addr + etre.API_ROOT + "/entity/" + id,
Expand All @@ -1322,8 +1322,8 @@ func (api *API) WriteResult(rc *req, w http.ResponseWriter, ids interface{}, err
case etre.Entity:
// Entity from DeleteLabel
diff := ids.(etre.Entity)
// _id from db is primitive.ObjectID, convert to string
id := diff["_id"].(primitive.ObjectID).Hex()
// _id from db is bson.ObjectID, convert to string
id := diff["_id"].(bson.ObjectID).Hex()
writes = []etre.Write{
{
EntityId: id,
Expand Down
8 changes: 4 additions & 4 deletions api/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/v2/bson"

"github.com/square/etre"
"github.com/square/etre/api"
Expand Down Expand Up @@ -60,9 +60,9 @@ var testEntities = []etre.Entity{
var testEntityIds = []string{"59f10d2a5669fc79103a0000", "59f10d2a5669fc79103a1111", "59f10d2a5669fc79103a2222"}

var (
testEntityId0, _ = primitive.ObjectIDFromHex(testEntityIds[0])
testEntityId1, _ = primitive.ObjectIDFromHex(testEntityIds[1])
testEntityId2, _ = primitive.ObjectIDFromHex(testEntityIds[2])
testEntityId0, _ = bson.ObjectIDFromHex(testEntityIds[0])
testEntityId1, _ = bson.ObjectIDFromHex(testEntityIds[1])
testEntityId2, _ = bson.ObjectIDFromHex(testEntityIds[2])
)

var testEntitiesWithObjectIDs = []etre.Entity{
Expand Down
4 changes: 2 additions & 2 deletions cdc/changestream/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import (

"github.com/square/etre"

"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"
)

var (
Expand Down
4 changes: 2 additions & 2 deletions cdc/changestream/server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"

"github.com/square/etre"
"github.com/square/etre/cdc"
Expand Down
11 changes: 6 additions & 5 deletions cdc/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ import (
"sort"
"time"

"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"
"go.mongodb.org/mongo-driver/v2/mongo/options"

"github.com/square/etre"
)
Expand Down Expand Up @@ -107,8 +107,9 @@ func (s *store) Read(f Filter) ([]etre.CDCEvent, error) {
// etre.CDC to match so, below, cursor.All() doesn't have to realloc the
// slice. For small fetches, this is overkill, but it makes large fetchs
// (>100k events) very quick and efficient.
opts := options.Count().SetMaxTime(5 * time.Second)
count, err := s.coll.CountDocuments(context.TODO(), q, opts)
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
count, err := s.coll.CountDocuments(ctx, q, options.Count())
if err != nil {
return nil, err
}
Expand Down
8 changes: 4 additions & 4 deletions cdc/store_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"
"go.mongodb.org/mongo-driver/v2/mongo/options"

"github.com/square/etre"
"github.com/square/etre/cdc"
Expand Down Expand Up @@ -47,7 +47,7 @@ func setup(t *testing.T, fallbackFile string, wrp cdc.RetryPolicy) cdc.Store {
// First time, create unique index on "x"
if coll == nil {
iv := cdcColl.Indexes()
if _, err := iv.DropAll(context.TODO()); err != nil {
if err := iv.DropAll(context.TODO()); err != nil {
t.Fatal(err)
}
idx := mongo.IndexModel{
Expand Down
28 changes: 5 additions & 23 deletions db/db.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
package db

import (
"context"
"crypto/tls"
"crypto/x509"
"io/ioutil"
"log"
"os"
"time"

"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/v2/mongo"
"go.mongodb.org/mongo-driver/v2/mongo/options"

"github.com/square/etre/config"
)
Expand Down Expand Up @@ -68,24 +67,7 @@ func (d Default) Connect(cfg config.DatasourceConfig) (*mongo.Client, error) {
log.Printf("WARNING: No database username for %s specified in config. Authentication will fail unless MongoDB access control is disabled.", cfg.URL)
}

client, err := mongo.NewClient(opts)
if err != nil {
return nil, err
}

// mongo.Connect() does not actually connect:
// The Client.Connect method starts background goroutines to monitor the
// state of the deployment and does not do any I/O in the main goroutine to
// prevent the main goroutine from blocking. Therefore, it will not error if
// the deployment is down.
// https://pkg.go.dev/go.mongodb.org/mongo-driver/mongo?tab=doc#Connect
// The caller must call client.Ping() to actually connect. Consequently,
// we don't need a context here. As long as there's not a bug in the mongo
// driver, this won't block.
if err := client.Connect(context.Background()); err != nil {
return nil, err
}
return client, nil
return mongo.Connect(opts)
}

func loadTLS(cfg config.DatasourceConfig) (*tls.Config, error) {
Expand All @@ -95,7 +77,7 @@ func loadTLS(cfg config.DatasourceConfig) (*tls.Config, error) {

// Root CA
if cfg.TLSCA != "" {
caCert, err := ioutil.ReadFile(cfg.TLSCA)
caCert, err := os.ReadFile(cfg.TLSCA)
if err != nil {
return nil, err
}
Expand Down
13 changes: 6 additions & 7 deletions entity/entity.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ import (
"github.com/square/etre"
"github.com/square/etre/query"

"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"
)

type DbError struct {
Expand Down Expand Up @@ -66,16 +65,16 @@ func Filter(q query.Query) bson.M {
if p.Label == etre.META_LABEL_ID {
switch p.Value.(type) {
case string:
id, _ := primitive.ObjectIDFromHex(p.Value.(string))
id, _ := bson.ObjectIDFromHex(p.Value.(string))

Copilot AI Mar 27, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check and handle the error returned by bson.ObjectIDFromHex rather than discarding it to avoid potential panics when an invalid ObjectID string is passed.

Suggested change
id, _ := bson.ObjectIDFromHex(p.Value.(string))
id, err := bson.ObjectIDFromHex(p.Value.(string))
if err != nil {
fmt.Printf("Invalid ObjectID string: %v\n", p.Value.(string))
continue
}

Copilot uses AI. Check for mistakes.
filter[p.Label] = bson.M{operatorMap[p.Operator]: id}
case []string:
vals := p.Value.([]string)
oids := make([]primitive.ObjectID, len(vals))
oids := make([]bson.ObjectID, len(vals))
for i, v := range vals {
oids[i], _ = primitive.ObjectIDFromHex(v)
oids[i], _ = bson.ObjectIDFromHex(v)
}
filter[p.Label] = bson.M{operatorMap[p.Operator]: oids}
case primitive.ObjectID:
case bson.ObjectID:
filter[p.Label] = bson.M{operatorMap[p.Operator]: p.Value}
default:
panic(fmt.Sprintf("invalid _id value type: %T", p.Value))
Expand Down
33 changes: 18 additions & 15 deletions entity/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ import (
"context"
"time"

"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"
"go.mongodb.org/mongo-driver/v2/mongo/options"

"github.com/square/etre"
"github.com/square/etre/cdc"
Expand Down Expand Up @@ -38,7 +37,7 @@ type store struct {
}

// NewStore creates a Store.
func NewStore(entities map[string]*mongo.Collection, cdcStore cdc.Store) store {
func NewStore(entities map[string]*mongo.Collection, cdcStore cdc.Store) Store {
return store{
coll: entities,
cdcs: cdcStore,
Expand All @@ -64,8 +63,12 @@ func (s store) ReadEntities(entityType string, q query.Query, f etre.QueryFilter
// "es -u node.metacluster zone=pd" returns a list of unique metacluster names.
// This is 10x faster than "es node.metacluster zone=pd | sort -u".
if len(f.ReturnLabels) == 1 && f.Distinct {
values, err := c.Distinct(s.ctx, f.ReturnLabels[0], Filter(q))
if err != nil {
res := c.Distinct(s.ctx, f.ReturnLabels[0], Filter(q))
if err := res.Err(); err != nil {
return nil, s.dbError(err, "db-read-distinct")
}
var values []string
if err := res.Decode(&values); err != nil {
return nil, s.dbError(err, "db-read-distinct")
}
entities := make([]etre.Entity, len(values))
Expand Down Expand Up @@ -126,15 +129,15 @@ func (s store) CreateEntities(wo WriteOp, entities []etre.Entity) ([]string, err
newIds := make([]string, 0, len(entities))

for i := range entities {
entities[i]["_id"] = primitive.NewObjectID()
entities[i]["_id"] = bson.NewObjectID()
entities[i]["_type"] = wo.EntityType
entities[i]["_rev"] = int64(0)

res, err := c.InsertOne(s.ctx, entities[i])
if err != nil {
return newIds, s.dbError(err, "db-insert")
}
id := res.InsertedID.(primitive.ObjectID)
id := res.InsertedID.(bson.ObjectID)
newIds = append(newIds, id.Hex())

// Create a CDC event.
Expand Down Expand Up @@ -196,7 +199,7 @@ func (s store) UpdateEntities(wo WriteOp, q query.Query, patch etre.Entity) ([]e
}
opts := options.FindOneAndUpdate().SetProjection(p)

nextId := map[string]primitive.ObjectID{}
nextId := map[string]bson.ObjectID{}
for cursor.Next(s.ctx) {
if err := cursor.Decode(&nextId); err != nil {
return diffs, s.dbError(err, "db-cursor-decode")
Expand All @@ -223,7 +226,7 @@ func (s store) UpdateEntities(wo WriteOp, q query.Query, patch etre.Entity) ([]e

cp := cdcPartial{
op: "u",
id: orig["_id"].(primitive.ObjectID),
id: orig["_id"].(bson.ObjectID),
rev: orig.Rev() + 1,
old: &old,
new: &patch,
Expand Down Expand Up @@ -267,7 +270,7 @@ func (s store) DeleteEntities(wo WriteOp, q query.Query) ([]etre.Entity, error)
deleted = append(deleted, old)
ce := cdcPartial{
op: "d",
id: old["_id"].(primitive.ObjectID),
id: old["_id"].(bson.ObjectID),
old: &old,
new: nil,
rev: old.Rev() + 1,
Expand All @@ -287,7 +290,7 @@ func (s store) DeleteLabel(wo WriteOp, label string) (etre.Entity, error) {
panic("invalid entity type passed to DeleteLabel: " + wo.EntityType)
}

id, _ := primitive.ObjectIDFromHex(wo.EntityId)
id, _ := bson.ObjectIDFromHex(wo.EntityId)
filter := bson.M{"_id": id}
update := bson.M{
"$unset": bson.M{label: ""}, // removes label, Mongo expects "" (see $unset docs)
Expand Down Expand Up @@ -323,7 +326,7 @@ func (s store) DeleteLabel(wo WriteOp, label string) (etre.Entity, error) {

cp := cdcPartial{
op: "u",
id: old["_id"].(primitive.ObjectID),
id: old["_id"].(bson.ObjectID),
new: &new,
old: &old,
rev: old.Rev() + 1,
Expand Down Expand Up @@ -356,7 +359,7 @@ func (s store) dbError(err error, errType string) error {
// which makes a complete CDCEvent from the partial and a WriteOp.
type cdcPartial struct {
op string
id primitive.ObjectID
id bson.ObjectID
old *etre.Entity
new *etre.Entity
rev int64
Expand Down
Loading