| // Licensed to the Apache Software Foundation (ASF) under one or more |
| // contributor license agreements. See the NOTICE file distributed with |
| // this work for additional information regarding copyright ownership. |
| // The ASF licenses this file to You under the Apache License, Version 2.0 |
| // (the "License"); you may not use this file except in compliance with |
| // the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package client |
| |
| import ( |
| "context" |
| "crypto/tls" |
| "crypto/x509" |
| "fmt" |
| "io/ioutil" |
| "time" |
| |
| "github.com/apache/servicecomb-service-center/pkg/goutil" |
| "github.com/apache/servicecomb-service-center/pkg/log" |
| "github.com/apache/servicecomb-service-center/server/plugin/security/cipher" |
| "github.com/go-chassis/foundation/gopool" |
| "github.com/go-chassis/go-chassis/v2/storage" |
| "go.mongodb.org/mongo-driver/bson" |
| "go.mongodb.org/mongo-driver/mongo" |
| "go.mongodb.org/mongo-driver/mongo/options" |
| ) |
| |
| const ( |
| MongoDB = "servicecenter" |
| MongoCheckDelay = 2 * time.Second |
| HeathChekRetryTimes = 3 |
| ) |
| |
| var ( |
| mc *MongoClient |
| ) |
| |
| type MongoClient struct { |
| client *mongo.Client |
| db *mongo.Database |
| dbconfig storage.Options |
| |
| err chan error |
| ready chan struct{} |
| goroutine *gopool.Pool |
| } |
| |
| type MongoOperation struct { |
| Table string |
| Models []mongo.WriteModel |
| } |
| |
| func GetMongoClient() *MongoClient { |
| return mc |
| } |
| func DeleteDoc(ctx context.Context, Table string, filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error) { |
| return mc.Delete(ctx, Table, filter, opts...) |
| } |
| func Find(ctx context.Context, Table string, filter interface{}, opts ...*options.FindOptions) (*mongo.Cursor, error) { |
| return mc.Find(ctx, Table, filter, opts...) |
| } |
| func Count(ctx context.Context, Table string, filter interface{}, opts ...*options.CountOptions) (int64, error) { |
| return mc.db.Collection(Table).CountDocuments(ctx, filter, opts...) |
| } |
| func NewMongoClient(config storage.Options) { |
| inst := &MongoClient{} |
| if err := inst.Initialize(config); err != nil { |
| log.Error("failed to init mongodb", err) |
| inst.err <- err |
| } |
| mc = inst |
| } |
| |
| func (mc *MongoClient) Initialize(config storage.Options) (err error) { |
| mc.err = make(chan error, 1) |
| mc.ready = make(chan struct{}) |
| mc.goroutine = goutil.New() |
| mc.dbconfig = config |
| err = mc.newClient(context.Background()) |
| if err != nil { |
| return |
| } |
| mc.StartHealthCheck() |
| close(mc.ready) |
| return nil |
| } |
| |
| // ExecTxn execute a transaction command |
| // want to abort transaction, return error in cmd fn impl, otherwise it will commit transaction |
| func (mc *MongoClient) ExecTxn(ctx context.Context, cmd func(sessionContext mongo.SessionContext) error) error { |
| session, err := mc.client.StartSession() |
| if err != nil { |
| return err |
| } |
| if err = session.StartTransaction(); err != nil { |
| return err |
| } |
| defer session.EndSession(ctx) |
| if err = mongo.WithSession(ctx, session, func(sc mongo.SessionContext) error { |
| if err = cmd(sc); err != nil { |
| if err = session.AbortTransaction(sc); err != nil { |
| return err |
| } |
| } else { |
| if err = session.CommitTransaction(sc); err != nil { |
| return err |
| } |
| } |
| return nil |
| }); err != nil { |
| return err |
| } |
| return nil |
| } |
| func (mc *MongoClient) Err() <-chan error { |
| return mc.err |
| } |
| |
| func (mc *MongoClient) Ready() <-chan struct{} { |
| return mc.ready |
| } |
| |
| func (mc *MongoClient) Close() { |
| if mc.client != nil { |
| if err := mc.client.Disconnect(context.TODO()); err != nil { |
| log.Error("[close mongo client] failed disconnect the mongo client", err) |
| } |
| } |
| } |
| |
| func (mc *MongoClient) StartHealthCheck() { |
| mc.goroutine.Do(mc.HealthCheck) |
| } |
| |
| func (mc *MongoClient) HealthCheck(ctx context.Context) { |
| for { |
| select { |
| case <-ctx.Done(): |
| mc.Close() |
| return |
| case <-time.After(MongoCheckDelay): |
| for i := 0; i < HeathChekRetryTimes; i++ { |
| err := mc.client.Ping(context.Background(), nil) |
| if err == nil { |
| break |
| } |
| log.Error(fmt.Sprintf("retry to connect to mongodb %s after %s", mc.dbconfig.URI, MongoCheckDelay), err) |
| select { |
| case <-ctx.Done(): |
| mc.Close() |
| return |
| case <-time.After(MongoCheckDelay): |
| } |
| } |
| } |
| } |
| } |
| |
| func (mc *MongoClient) newClient(ctx context.Context) (err error) { |
| var uri string |
| uri, err = cipher.Decrypt(mc.dbconfig.URI) |
| if err != nil { |
| log.Info("cipher fallback: " + err.Error()) |
| uri = mc.dbconfig.URI |
| } |
| clientOptions := []*options.ClientOptions{options.Client().ApplyURI(uri)} |
| clientOptions = append(clientOptions, options.Client().SetMaxPoolSize(uint64(mc.dbconfig.PoolSize))) |
| if mc.dbconfig.SSLEnabled { |
| if mc.dbconfig.RootCA == "" { |
| err = ErrRootCAMissing |
| return |
| } |
| pool := x509.NewCertPool() |
| caCert, err := ioutil.ReadFile(mc.dbconfig.RootCA) |
| if err != nil { |
| err = fmt.Errorf("read ca cert file %s failed", mc.dbconfig.RootCA) |
| log.Error("ca cert :", err) |
| return err |
| } |
| pool.AppendCertsFromPEM(caCert) |
| clientCerts := make([]tls.Certificate, 0) |
| if mc.dbconfig.CertFile != "" && mc.dbconfig.KeyFile != "" { |
| cert, err := tls.LoadX509KeyPair(mc.dbconfig.CertFile, mc.dbconfig.KeyFile) |
| if err != nil { |
| log.Error("load X509 keyPair failed: ", err) |
| return err |
| } |
| clientCerts = append(clientCerts, cert) |
| } |
| tc := &tls.Config{ |
| RootCAs: pool, |
| InsecureSkipVerify: !mc.dbconfig.VerifyPeer, |
| Certificates: clientCerts, |
| } |
| clientOptions = append(clientOptions, options.Client().SetTLSConfig(tc)) |
| log.Info("enabled ssl communication to mongodb") |
| } |
| mc.client, err = mongo.Connect(ctx, clientOptions...) |
| if err != nil { |
| log.Error("failed to connect to mongo", err) |
| if derr := mc.client.Disconnect(ctx); derr != nil { |
| log.Error("[init mongo client] failed to disconnect mongo clients", derr) |
| } |
| return |
| } |
| mc.db = mc.client.Database(MongoDB) |
| if mc.db == nil { |
| return ErrOpenDbFailed |
| } |
| return nil |
| } |
| |
| func (mc *MongoClient) CreateIndexes(ctx context.Context, Table string, indexes []mongo.IndexModel) error { |
| _, err := mc.db.Collection(Table).Indexes().CreateMany(ctx, indexes) |
| if err != nil { |
| return err |
| } |
| return nil |
| } |
| |
| func (mc *MongoClient) Insert(ctx context.Context, Table string, document interface{}, opts ...*options.InsertOneOptions) (*mongo.InsertOneResult, error) { |
| return mc.db.Collection(Table).InsertOne(ctx, document, opts...) |
| } |
| |
| func (mc *MongoClient) BatchInsert(ctx context.Context, Table string, document []interface{}, opts ...*options.InsertManyOptions) (*mongo.InsertManyResult, error) { |
| return mc.db.Collection(Table).InsertMany(ctx, document, opts...) |
| } |
| |
| func (mc *MongoClient) Delete(ctx context.Context, Table string, filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error) { |
| return mc.db.Collection(Table).DeleteMany(ctx, filter, opts...) |
| } |
| |
| func (mc *MongoClient) BatchDelete(ctx context.Context, Table string, models []mongo.WriteModel, opts ...*options.BulkWriteOptions) (*mongo.BulkWriteResult, error) { |
| return mc.db.Collection(Table).BulkWrite(ctx, models, opts...) |
| } |
| |
| func (mc *MongoClient) Update(ctx context.Context, Table string, filter interface{}, update interface{}, opts ...*options.UpdateOptions) (*mongo.UpdateResult, error) { |
| return mc.db.Collection(Table).UpdateMany(ctx, filter, update, opts...) |
| } |
| |
| func (mc *MongoClient) FindOneAndUpdate(ctx context.Context, Table string, filter interface{}, update interface{}, opts ...*options.FindOneAndUpdateOptions) (*mongo.SingleResult, error) { |
| return mc.db.Collection(Table).FindOneAndUpdate(ctx, filter, update, opts...), nil |
| } |
| |
| func (mc *MongoClient) BatchUpdate(ctx context.Context, Table string, models []mongo.WriteModel, opts ...*options.BulkWriteOptions) (*mongo.BulkWriteResult, error) { |
| return mc.db.Collection(Table).BulkWrite(ctx, models, opts...) |
| } |
| |
| func (mc *MongoClient) Find(ctx context.Context, Table string, filter interface{}, opts ...*options.FindOptions) (*mongo.Cursor, error) { |
| return mc.db.Collection(Table).Find(ctx, filter, opts...) |
| } |
| |
| func (mc *MongoClient) FindOne(ctx context.Context, Table string, filter interface{}, opts ...*options.FindOneOptions) (*mongo.SingleResult, error) { |
| return mc.db.Collection(Table).FindOne(ctx, filter, opts...), nil |
| } |
| |
| func (mc *MongoClient) Count(ctx context.Context, Table string, filter interface{}, opts ...*options.CountOptions) (int64, error) { |
| return mc.db.Collection(Table).CountDocuments(ctx, filter, opts...) |
| } |
| |
| func (mc *MongoClient) Aggregate(ctx context.Context, Table string, pipeline interface{}, opts ...*options.AggregateOptions) (*mongo.Cursor, error) { |
| return mc.db.Collection(Table).Aggregate(ctx, pipeline, opts...) |
| } |
| |
| func (mc *MongoClient) Watch(ctx context.Context, Table string, pipeline interface{}, opts ...*options.ChangeStreamOptions) (*mongo.ChangeStream, error) { |
| return mc.db.Collection(Table).Watch(ctx, pipeline, opts...) |
| } |
| |
| func (mc *MongoClient) StartSession(ctx context.Context) (mongo.Session, error) { |
| return mc.client.StartSession() |
| } |
| |
| func (mc *MongoClient) MultiTableBatchUpdate(ctx context.Context, opts []MongoOperation) error { |
| for _, op := range opts { |
| _, err := mc.BatchUpdate(ctx, op.Table, op.Models) |
| if err != nil { |
| return err |
| } |
| } |
| return nil |
| } |
| |
| func (mc *MongoClient) DocExist(ctx context.Context, table string, filter interface{}) (bool, error) { |
| res, err := mc.FindOne(ctx, table, filter) |
| if err != nil { |
| return false, err |
| } |
| if res.Err() != nil { |
| return false, nil |
| } |
| return true, nil |
| } |
| |
| func (mc *MongoClient) DocUpdate(ctx context.Context, table string, filter interface{}, m bson.M, opts ...*options.FindOneAndUpdateOptions) error { |
| res, err := mc.FindOneAndUpdate(ctx, table, filter, m, opts...) |
| if err != nil { |
| return err |
| } |
| if res.Err() != nil { |
| // means no doc find, if the operation is update,should return err |
| return ErrNoDocuments |
| } |
| return nil |
| } |
| |
| func (mc *MongoClient) DocDelete(ctx context.Context, table string, filter interface{}) (bool, error) { |
| res, err := mc.DeleteOne(ctx, table, filter) |
| if err != nil { |
| return false, err |
| } |
| return res.DeletedCount != 0, nil |
| } |
| |
| func (mc *MongoClient) DeleteOne(ctx context.Context, Table string, filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error) { |
| return mc.db.Collection(Table).DeleteOne(ctx, filter, opts...) |
| } |
| |
| func (mc *MongoClient) GetDB() *mongo.Database { |
| return mc.db |
| } |
