Skip to content
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.

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

GODRIVER-2392 Remove all "import comments" on Go Driver packages #1498

Merged
merged 1 commit into from
Dec 18, 2023

Conversation

prestonvasquez
Copy link
Collaborator

@prestonvasquez prestonvasquez commented Dec 13, 2023

GODRIVER-2392

Summary

Remove all vestigial "import comments" from the Go Driver. See GODRIVER-2977 for the ticket for removing import comments from the BSON library.

Background & Motivation

@prestonvasquez prestonvasquez requested a review from a team as a code owner December 13, 2023 18:44
@prestonvasquez prestonvasquez requested review from qingyang-hu and removed request for a team December 13, 2023 18:44
@prestonvasquez prestonvasquez changed the base branch from v1 to master December 13, 2023 18:45
@prestonvasquez prestonvasquez changed the title GODRIVER-2392 GODRIVER-2392 Remove all "import comments" on Go Driver packages Dec 13, 2023
Copy link
Contributor

API Change Report

./benchmark

incompatible changes

package removed

./cmd/build-oss-fuzz-corpus

incompatible changes

package removed

./cmd/godriver-benchmark

incompatible changes

package removed

./cmd/parse-api-report

incompatible changes

package removed

./cmd/testatlas

incompatible changes

package removed

./cmd/testaws

incompatible changes

package removed

./cmd/testentauth

incompatible changes

package removed

./cmd/testkms

incompatible changes

package removed

./event

incompatible changes

CommandFailedEvent.DurationNanos: removed
CommandFailedEvent.Failure: changed from string to error
CommandFailedEvent.ServerConnectionID64: removed
CommandFailedEvent.ServerConnectionID: changed from *int32 to *int64
CommandFinishedEvent.DurationNanos: removed
CommandFinishedEvent.ServerConnectionID64: removed
CommandFinishedEvent.ServerConnectionID: changed from *int32 to *int64
CommandStartedEvent.ServerConnectionID64: removed
CommandStartedEvent.ServerConnectionID: changed from *int32 to *int64
CommandSucceededEvent.DurationNanos: removed
CommandSucceededEvent.ServerConnectionID64: removed
CommandSucceededEvent.ServerConnectionID: changed from *int32 to *int64
ConnectionReturned: removed
GetFailed: removed
GetStarted: removed
GetSucceeded: removed
PoolEvent.ConnectionID: changed from uint64 to int64
ServerHeartbeatFailedEvent.DurationNanos: removed
ServerHeartbeatSucceededEvent.DurationNanos: removed

compatible changes

ConnectionCheckOutFailed: added
ConnectionCheckOutStarted: added
ConnectionCheckedIn: added
ConnectionCheckedOut: added

./examples/documentation_examples

incompatible changes

package removed

./mongo

incompatible changes

(*Client).Connect: removed
##(Collection).Drop: changed from func(context.Context) error to func(context.Context, ..../mongo/options.DropCollectionOptions) error
##(Collection).InsertMany: changed from func(context.Context, []interface{}, ..../mongo/options.InsertManyOptions) (InsertManyResult, error) to func(context.Context, interface{}, ..../mongo/options.InsertManyOptions) (*InsertManyResult, error)
(*CollectionSpecification).UnmarshalBSON: removed
(*IndexSpecification).UnmarshalBSON: removed
(SingleResult).DecodeBytes: removed
(UpdateResult).UnmarshalBSON: removed
BSONAppender: removed
BSONAppenderFunc: removed
##Connect: changed from func(context.Context, ...
./mongo/options.ClientOptions) (Client, error) to func(..../mongo/options.ClientOptions) (Client, error)
IndexOptionsBuilder: removed
##IndexView.DropAll: changed from func(context.Context, ...
./mongo/options.DropIndexesOptions) (./bson.Raw, error) to func(context.Context, ...
./mongo/options.DropIndexesOptions) error
NewClient: removed
NewIndexOptionsBuilder: removed

compatible changes

ErrNotSlice: added

./mongo/description

incompatible changes

SelectedServer.SessionTimeoutMinutes: changed from uint32 to *int64
SelectedServer.SessionTimeoutMinutesPtr: removed
Server.SessionTimeoutMinutes: changed from uint32 to *int64
Server.SessionTimeoutMinutesPtr: removed
Topology.SessionTimeoutMinutes: changed from uint32 to *int64
Topology.SessionTimeoutMinutesPtr: removed

./mongo/gridfs

incompatible changes

(*Bucket).Delete: changed from func(interface{}) error to func(context.Context, interface{}) error
(Bucket).DeleteContext: removed
(Bucket).DownloadToStream: changed from func(interface{}, io.Writer) (int64, error) to func(context.Context, interface{}, io.Writer) (int64, error)
##(Bucket).DownloadToStreamByName: changed from func(string, io.Writer, ..../mongo/options.NameOptions) (int64, error) to func(context.Context, string, io.Writer, ...
./mongo/options.NameOptions) (int64, error)
(Bucket).Drop: changed from func() error to func(context.Context) error
(Bucket).DropContext: removed
##(Bucket).Find: changed from func(interface{}, ..../mongo/options.GridFSFindOptions) (
./mongo.Cursor, error) to func(context.Context, interface{}, ...
./mongo/options.GridFSFindOptions) (
./mongo.Cursor, error)
(*Bucket).FindContext: removed
(*Bucket).OpenDownloadStream: changed from func(interface{}) (*DownloadStream, error) to func(context.Context, interface{}) (*DownloadStream, error)
##(Bucket).OpenDownloadStreamByName: changed from func(string, ..../mongo/options.NameOptions) (DownloadStream, error) to func(context.Context, string, ..../mongo/options.NameOptions) (*DownloadStream, error)
##(Bucket).OpenUploadStream: changed from func(string, ..../mongo/options.UploadOptions) (UploadStream, error) to func(context.Context, string, ..../mongo/options.UploadOptions) (*UploadStream, error)
##(Bucket).OpenUploadStreamWithID: changed from func(interface{}, string, ..../mongo/options.UploadOptions) (UploadStream, error) to func(context.Context, interface{}, string, ..../mongo/options.UploadOptions) (*UploadStream, error)
(*Bucket).Rename: changed from func(interface{}, string) error to func(context.Context, interface{}, string) error
(*Bucket).RenameContext: removed
(Bucket).SetReadDeadline: removed
(Bucket).SetWriteDeadline: removed
##(Bucket).UploadFromStream: changed from func(string, io.Reader, ..../mongo/options.UploadOptions) (./bson/primitive.ObjectID, error) to func(context.Context, string, io.Reader, ...
./mongo/options.UploadOptions) (./bson/primitive.ObjectID, error)
##(Bucket).UploadFromStreamWithID: changed from func(interface{}, string, io.Reader, ..../mongo/options.UploadOptions) error to func(context.Context, interface{}, string, io.Reader, ...
./mongo/options.UploadOptions) error
(*DownloadStream).SetReadDeadline: removed
(*File).UnmarshalBSON: removed
(*UploadStream).SetWriteDeadline: removed
ErrWrongIndex: removed

compatible changes

ErrMissingChunk: added

./mongo/integration

incompatible changes

package removed

./mongo/options

incompatible changes

(*AggregateOptions).SetComment: changed from func(string) *AggregateOptions to func(interface{}) *AggregateOptions
(*ChangeStreamOptions).SetComment: changed from func(string) *ChangeStreamOptions to func(interface{}) *ChangeStreamOptions
(*CountOptions).SetComment: changed from func(string) *CountOptions to func(interface{}) *CountOptions
(*FindOneOptions).SetBatchSize: removed
(*FindOneOptions).SetComment: changed from func(string) *FindOneOptions to func(interface{}) *FindOneOptions
(*FindOneOptions).SetCursorType: removed
(*FindOneOptions).SetMaxAwaitTime: removed
(*FindOneOptions).SetNoCursorTimeout: removed
(*FindOneOptions).SetOplogReplay: removed
(*FindOneOptions).SetSnapshot: removed
(*FindOptions).SetComment: changed from func(string) *FindOptions to func(interface{}) *FindOptions
(*FindOptions).SetOplogReplay: removed
(*FindOptions).SetSnapshot: removed
(*IndexOptions).SetBackground: removed
AggregateOptions.Comment: changed from *string to interface{}
ChangeStreamOptions.Comment: changed from *string to interface{}
ClientOptions.AuthenticateToAnything: removed
CountOptions.Comment: changed from *string to interface{}
FindOneOptions.BatchSize: removed
FindOneOptions.Comment: changed from *string to interface{}
FindOneOptions.CursorType: removed
FindOneOptions.MaxAwaitTime: removed
FindOneOptions.NoCursorTimeout: removed
FindOneOptions.OplogReplay: removed
FindOneOptions.Snapshot: removed
FindOptions.Comment: changed from *string to interface{}
FindOptions.OplogReplay: removed
FindOptions.Snapshot: removed
IndexOptions.Background: removed
MarshalError: removed
MergeAggregateOptions: removed
MergeAutoEncryptionOptions: removed
MergeBucketOptions: removed
MergeBulkWriteOptions: removed
MergeChangeStreamOptions: removed
MergeClientEncryptionOptions: removed
MergeCollectionOptions: removed
MergeCountOptions: removed
MergeCreateCollectionOptions: removed
MergeCreateIndexesOptions: removed
MergeCreateViewOptions: removed
MergeDataKeyOptions: removed
MergeDatabaseOptions: removed
MergeDeleteOptions: removed
MergeDistinctOptions: removed
MergeDropIndexesOptions: removed
MergeEncryptOptions: removed
MergeEstimatedDocumentCountOptions: removed
MergeFindOneAndDeleteOptions: removed
MergeFindOneAndReplaceOptions: removed
MergeFindOneAndUpdateOptions: removed
MergeFindOneOptions: removed
MergeFindOptions: removed
MergeGridFSFindOptions: removed
MergeIndexOptions: removed
MergeInsertManyOptions: removed
MergeInsertOneOptions: removed
MergeListCollectionsOptions: removed
MergeListDatabasesOptions: removed
MergeListIndexesOptions: removed
MergeNameOptions: removed
MergeReplaceOptions: removed
MergeRewrapManyDataKeyOptions: removed
MergeRunCmdOptions: removed
MergeSessionOptions: removed
MergeTransactionOptions: removed
MergeUpdateOptions: removed
MergeUploadOptions: removed

compatible changes

DropCollection: added
DropCollectionOptions: added
MergeDropCollectionOptions: added

./mongo/readconcern

incompatible changes

(*ReadConcern).GetLevel: removed
Level: removed
New: removed
Option: removed

./mongo/writeconcern

incompatible changes

(*WriteConcern).GetJ: removed
(*WriteConcern).GetW: removed
(*WriteConcern).GetWTimeout: removed
(*WriteConcern).WithOptions: removed
AckWrite: removed
AcknowledgedValue: removed
J: removed
New: removed
Option: removed
W: removed
WMajority: removed
WTagSet: removed
WTimeout: removed

compatible changes

WCMajority: added

./x/mongo/driver

incompatible changes

Connection.DriverConnectionID: changed from func() uint64 to func() int64

./x/mongo/driver/drivertest

incompatible changes

(*ChannelConn).DriverConnectionID: changed from func() uint64 to func() int64

./x/mongo/driver/mongocrypt/options

incompatible changes

MergeRewrapManyDataKeyOptions: removed

./x/mongo/driver/operation

incompatible changes

##(*Aggregate).Comment: changed from func(string) *Aggregate to func(./x/bsonx/bsoncore.Value) *Aggregate
##(*Find).Comment: changed from func(string) *Find to func(./x/bsonx/bsoncore.Value) *Find

./x/mongo/driver/session

incompatible changes

LoadBalancedTransactionConnection.DriverConnectionID: changed from func() uint64 to func() int64

./x/mongo/driver/topology

incompatible changes

(*Connection).DriverConnectionID: changed from func() uint64 to func() int64

Copy link
Collaborator

@qingyang-hu qingyang-hu left a comment

Choose a reason for hiding this comment

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

LGTM

@prestonvasquez prestonvasquez merged commit cdb8c9e into mongodb:master Dec 18, 2023
@prestonvasquez prestonvasquez deleted the GODRIVER-2392 branch December 18, 2023 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants