send metadata during handshake #28

feliixx · 2017-09-05T12:22:03Z

Annotate connections with metadata provided by the connecting client.

informations send:

{
 "aplication": {                        // optional
   "name": "myAppName"
 }
 "driver": {
    "name": "mgo",
    "version": "v2"
  },
  "os": {
    "type": runtime.GOOS,
    "architecture": runtime.GOARCH
  }
}

to set application.name, add appname param in options of string connection URI,
for example :
"mongodb://localhost:27017?appname=myAppName"

driver.name and driver.version are currently hardcoded as I couldn' find a way to get the driver name/version

os.name, os.version and plateform are not set yet as it would require some plateform dependant code

Mongodb specification: specifications/handshake

domodwyer · 2017-09-05T15:34:49Z

Hi @feliixx, that was fast!

Looks good - I'm fine with not including os.name, os.version and platform - if it's really needed this info could be included in the appName parameter by the user. Keeps the metadata small :)

As the driver/version is hardcoded (yeah, no easy way I think), can we set them to:

metaInfo := bson.M{
	"driver": bson.M{
		"name":    "mgo",
		"version": "globalsign",
	},
	"os": bson.M{
		"type":         runtime.GOOS,
		"architecture": runtime.GOARCH,
	},
}

as we don't have the "v2" tag in our fork.

I'll leave a couple small comments but this is a great PR, thanks!

Dom

domodwyer · 2017-09-05T15:36:16Z

session.go

@@ -296,6 +301,12 @@ func ParseURL(url string) (*DialInfo, error) {
 			if err != nil {
 				return nil, errors.New("bad value for maxPoolSize: " + opt.value)
 			}
+		case "appname":


Can you camel-case this like the others? appName

domodwyer · 2017-09-05T15:37:02Z

session.go

+		case "appname":
+			appName = opt.value
+			// make sur sizeOf(appName) < 128 bytes
+			if len(appName) > 32 {


This can be bumped to len(appName) > 128 - I double checked and the BSON encoded metadata doesn't exceed 512 bytes with this change.

I'd appreciate if we error out instead of truncating the metadata. Or at least document the maximum len properly. Additionally you can truncate the appName in a middle of an multi byte utf-8 rune, which will be ugly.

domodwyer · 2017-09-05T15:38:01Z

cluster.go

+	// provide some meta infos on the client,
+	// see https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.rst#connection-handshake
+	// for details
+	metaInfo := bson.M{"driver": bson.M{"name": "mgo", "version": "v2"},


See #28 (comment)

domodwyer · 2017-09-05T15:38:31Z

session_test.go

+	c.Assert(appName, Equals, profileResult.AppName)
+}
+
+func (s *S) TestURLWithAppNameTooLong(c *C) {


Thanks for the "unhappy" code path test!

fix [#484](https://github.com/go-mgo/mgo/issues/484) Annotate connections with metadata provided by the connecting client. informations send: { "aplication": { // optional "name": "myAppName" } "driver": { "name": "mgo", "version": "v2" }, "os": { "type": runtime.GOOS, "architecture": runtime.GOARCH } } to set "application.name", add `appname` param in options of string connection URI, for example : "mongodb://localhost:27017?appname=myAppName"

feliixx · 2017-09-06T06:40:04Z

code updated, thanks for the quick review !

domodwyer · 2017-09-06T09:23:22Z

Thanks @feliixx

We'll be running tests some time next week, so expect this to land in master shortly after :)

Dom

@feliixx

* development: add method CreateView() (#33) Update README to add appName (#32) send metadata during handshake (#28) readme: credit @feliixx for #25 (#26) add DropAllIndexes() method (#25) Run integration tests against 3.2.16 (#24) # Conflicts: # README.md

@feliixx

* add DropAllIndexes() method (#25) Create a new method to drop all the indexes of a collection in a single call * readme: credit @feliixx for #25 (#26) * send metadata during handshake (#28) fix [#484](https://github.com/go-mgo/mgo/issues/484) Annotate connections with metadata provided by the connecting client. informations send: { "aplication": { // optional "name": "myAppName" } "driver": { "name": "mgo", "version": "v2" }, "os": { "type": runtime.GOOS, "architecture": runtime.GOARCH } } to set "application.name", add `appname` param in options of string connection URI, for example : "mongodb://localhost:27017?appname=myAppName" * Update README to add appName (#32) * docs: elaborate on what appName does * readme: add appName to changes * add method CreateView() (#33) Fix #30. Thanks to @feliixx for the time and effort. * readme: credit @feliixx in the README (#36) * Don't panic on indexed int64 fields (#23) * Stop all db instances after tests (go-mgo#462) If all tests pass, the builds for mongo earlier than 2.6 are still failing. Running a clean up fixes the issue. * fixing int64 type failing when getting indexes and trying to type them * requested changes relating to case statement and panic * Update README.md to credit @mapete94. * tests: ensure indexed int64 fields do not cause a panic in Indexes() See: * #23 * https://github.com/go-mgo/mgo/issues/475 * go-mgo#476 * Add collation option to collection.Create() (#37) - Allow specifying the default collation for the collection when creating it. - Add some documentation to query.Collation() method. fix #29 * Test against MongoDB 3.4.x (#35) * test against MongoDB 3.4.x * tests: use listIndexes to assert index state for 3.4+ * make test pass against v3.4.x - skip `TestViewWithCollation` because of SERVER-31049, cf: https://jira.mongodb.org/browse/SERVER-31049 - add versionAtLeast() method in init.js script to better detect server version fixes #31

@bozaro

* development: readme: credit @bozaro (#47) Fix GetBSON() method usage (#40) readme: credit @feliixx (#46) fix golint, go vet and gofmt warnings (#44) readme: add missing features / credit bson.Unmarshal returns time in UTC (#42) Introduce constants for BSON element types (#41) Test against MongoDB 3.4.x (#35) Add collation option to collection.Create() (#37) Don't panic on indexed int64 fields (#23) readme: credit @feliixx in the README (#36) add method CreateView() (#33) Update README to add appName (#32) send metadata during handshake (#28) readme: credit @feliixx for #25 (#26) add DropAllIndexes() method (#25) # Conflicts: # README.md # cluster.go # session.go # session_test.go

@feliixx

* add DropAllIndexes() method (#25) Create a new method to drop all the indexes of a collection in a single call * readme: credit @feliixx for #25 (#26) * send metadata during handshake (#28) fix [#484](https://github.com/go-mgo/mgo/issues/484) Annotate connections with metadata provided by the connecting client. informations send: { "aplication": { // optional "name": "myAppName" } "driver": { "name": "mgo", "version": "v2" }, "os": { "type": runtime.GOOS, "architecture": runtime.GOARCH } } to set "application.name", add `appname` param in options of string connection URI, for example : "mongodb://localhost:27017?appname=myAppName" * Update README to add appName (#32) * docs: elaborate on what appName does * readme: add appName to changes * add method CreateView() (#33) Fix #30. Thanks to @feliixx for the time and effort. * readme: credit @feliixx in the README (#36) * Don't panic on indexed int64 fields (#23) * Stop all db instances after tests (go-mgo#462) If all tests pass, the builds for mongo earlier than 2.6 are still failing. Running a clean up fixes the issue. * fixing int64 type failing when getting indexes and trying to type them * requested changes relating to case statement and panic * Update README.md to credit @mapete94. * tests: ensure indexed int64 fields do not cause a panic in Indexes() See: * #23 * https://github.com/go-mgo/mgo/issues/475 * go-mgo#476 * Add collation option to collection.Create() (#37) - Allow specifying the default collation for the collection when creating it. - Add some documentation to query.Collation() method. fix #29 * Test against MongoDB 3.4.x (#35) * test against MongoDB 3.4.x * tests: use listIndexes to assert index state for 3.4+ * make test pass against v3.4.x - skip `TestViewWithCollation` because of SERVER-31049, cf: https://jira.mongodb.org/browse/SERVER-31049 - add versionAtLeast() method in init.js script to better detect server version fixes #31 * Introduce constants for BSON element types (#41) * bson.Unmarshal returns time in UTC (#42) * readme: add missing features / credit * Adds missing collation feature description (by @feliixx). * Adds missing 3.4 tests description (by @feliixx). * Adds BSON constants description (by @bozaro). * Adds UTC time.Time unmarshalling (by @gazoon). * fix golint, go vet and gofmt warnings (#44) Fixes #43 * readme: credit @feliixx (#46) * Fix GetBSON() method usage (#40) * Fix GetBSON() method usage Original issue --- You can't use type with custom GetBSON() method mixed with structure field type and structure field reference type. For example, you can't create custom GetBSON() for Bar type: ``` struct Foo { a Bar b *Bar } ``` Type implementation (`func (t Bar) GetBSON()` ) would crash on `Foo.b = nil` value encoding. Reference implementation (`func (t *Bar) GetBSON()` ) would not call on `Foo.a` value encoding. After this change --- For type implementation `func (t Bar) GetBSON()` would not call on `Foo.b = nil` value encoding. In this case `nil` value would be seariazied as `nil` BSON value. For reference implementation `func (t *Bar) GetBSON()` would call even on `Foo.a` value encoding. * Minor refactoring * readme: credit @bozaro (#47)

@bozaro

* commit '0454966c021aa1737c9680aceef7e2ba26952fe3': do not lock while writing to a socket (#52) (#54) readme: credit @bozaro and @idy (#53) Improve cursorData struct unmarshaling speed (#49) readme: credit @bozaro (#47) Fix GetBSON() method usage (#40) readme: credit @feliixx (#46) fix golint, go vet and gofmt warnings (#44) readme: add missing features / credit bson.Unmarshal returns time in UTC (#42) Introduce constants for BSON element types (#41) Test against MongoDB 3.4.x (#35) Add collation option to collection.Create() (#37) Don't panic on indexed int64 fields (#23) readme: credit @feliixx in the README (#36) add method CreateView() (#33) Update README to add appName (#32) send metadata during handshake (#28) readme: credit @feliixx for #25 (#26) add DropAllIndexes() method (#25) # Conflicts: # README.md # bson/decode.go

@feliixx

* add DropAllIndexes() method (#25) Create a new method to drop all the indexes of a collection in a single call * readme: credit @feliixx for #25 (#26) * send metadata during handshake (#28) fix [#484](https://github.com/go-mgo/mgo/issues/484) Annotate connections with metadata provided by the connecting client. informations send: { "aplication": { // optional "name": "myAppName" } "driver": { "name": "mgo", "version": "v2" }, "os": { "type": runtime.GOOS, "architecture": runtime.GOARCH } } to set "application.name", add `appname` param in options of string connection URI, for example : "mongodb://localhost:27017?appname=myAppName" * Update README to add appName (#32) * docs: elaborate on what appName does * readme: add appName to changes * add method CreateView() (#33) Fix #30. Thanks to @feliixx for the time and effort. * readme: credit @feliixx in the README (#36) * Don't panic on indexed int64 fields (#23) * Stop all db instances after tests (go-mgo#462) If all tests pass, the builds for mongo earlier than 2.6 are still failing. Running a clean up fixes the issue. * fixing int64 type failing when getting indexes and trying to type them * requested changes relating to case statement and panic * Update README.md to credit @mapete94. * tests: ensure indexed int64 fields do not cause a panic in Indexes() See: * #23 * https://github.com/go-mgo/mgo/issues/475 * go-mgo#476 * Add collation option to collection.Create() (#37) - Allow specifying the default collation for the collection when creating it. - Add some documentation to query.Collation() method. fix #29 * Test against MongoDB 3.4.x (#35) * test against MongoDB 3.4.x * tests: use listIndexes to assert index state for 3.4+ * make test pass against v3.4.x - skip `TestViewWithCollation` because of SERVER-31049, cf: https://jira.mongodb.org/browse/SERVER-31049 - add versionAtLeast() method in init.js script to better detect server version fixes #31 * Introduce constants for BSON element types (#41) * bson.Unmarshal returns time in UTC (#42) * readme: add missing features / credit * Adds missing collation feature description (by @feliixx). * Adds missing 3.4 tests description (by @feliixx). * Adds BSON constants description (by @bozaro). * Adds UTC time.Time unmarshalling (by @gazoon). * fix golint, go vet and gofmt warnings (#44) Fixes #43 * readme: credit @feliixx (#46) * Fix GetBSON() method usage (#40) * Fix GetBSON() method usage Original issue --- You can't use type with custom GetBSON() method mixed with structure field type and structure field reference type. For example, you can't create custom GetBSON() for Bar type: ``` struct Foo { a Bar b *Bar } ``` Type implementation (`func (t Bar) GetBSON()` ) would crash on `Foo.b = nil` value encoding. Reference implementation (`func (t *Bar) GetBSON()` ) would not call on `Foo.a` value encoding. After this change --- For type implementation `func (t Bar) GetBSON()` would not call on `Foo.b = nil` value encoding. In this case `nil` value would be seariazied as `nil` BSON value. For reference implementation `func (t *Bar) GetBSON()` would call even on `Foo.a` value encoding. * Minor refactoring * readme: credit @bozaro (#47) * Improve cursorData struct unmarshaling speed (#49) This change remove full BSON decoding on: - parsing to `bson.Raw` and `bson.DocElem` fields; - skipping unused BSON fields. * readme: credit @bozaro and @idy (#53) * readme: credit @bozaro and @idy * readme: add @idy to contributor list * do not lock while writing to a socket (#52) (#54) fix #51

@feliixx

* add DropAllIndexes() method (globalsign#25) Create a new method to drop all the indexes of a collection in a single call * readme: credit @feliixx for globalsign#25 (globalsign#26) * send metadata during handshake (globalsign#28) fix [#484](https://github.com/go-mgo/mgo/issues/484) Annotate connections with metadata provided by the connecting client. informations send: { "aplication": { // optional "name": "myAppName" } "driver": { "name": "mgo", "version": "v2" }, "os": { "type": runtime.GOOS, "architecture": runtime.GOARCH } } to set "application.name", add `appname` param in options of string connection URI, for example : "mongodb://localhost:27017?appname=myAppName" * Update README to add appName (globalsign#32) * docs: elaborate on what appName does * readme: add appName to changes * add method CreateView() (globalsign#33) Fix globalsign#30. Thanks to @feliixx for the time and effort. * readme: credit @feliixx in the README (globalsign#36) * Don't panic on indexed int64 fields (globalsign#23) * Stop all db instances after tests (go-mgo#462) If all tests pass, the builds for mongo earlier than 2.6 are still failing. Running a clean up fixes the issue. * fixing int64 type failing when getting indexes and trying to type them * requested changes relating to case statement and panic * Update README.md to credit @mapete94. * tests: ensure indexed int64 fields do not cause a panic in Indexes() See: * globalsign#23 * https://github.com/go-mgo/mgo/issues/475 * go-mgo#476 * Add collation option to collection.Create() (globalsign#37) - Allow specifying the default collation for the collection when creating it. - Add some documentation to query.Collation() method. fix globalsign#29 * Test against MongoDB 3.4.x (globalsign#35) * test against MongoDB 3.4.x * tests: use listIndexes to assert index state for 3.4+ * make test pass against v3.4.x - skip `TestViewWithCollation` because of SERVER-31049, cf: https://jira.mongodb.org/browse/SERVER-31049 - add versionAtLeast() method in init.js script to better detect server version fixes globalsign#31

@feliixx

* add DropAllIndexes() method (globalsign#25) Create a new method to drop all the indexes of a collection in a single call * readme: credit @feliixx for globalsign#25 (globalsign#26) * send metadata during handshake (globalsign#28) fix [#484](https://github.com/go-mgo/mgo/issues/484) Annotate connections with metadata provided by the connecting client. informations send: { "aplication": { // optional "name": "myAppName" } "driver": { "name": "mgo", "version": "v2" }, "os": { "type": runtime.GOOS, "architecture": runtime.GOARCH } } to set "application.name", add `appname` param in options of string connection URI, for example : "mongodb://localhost:27017?appname=myAppName" * Update README to add appName (globalsign#32) * docs: elaborate on what appName does * readme: add appName to changes * add method CreateView() (globalsign#33) Fix globalsign#30. Thanks to @feliixx for the time and effort. * readme: credit @feliixx in the README (globalsign#36) * Don't panic on indexed int64 fields (globalsign#23) * Stop all db instances after tests (go-mgo#462) If all tests pass, the builds for mongo earlier than 2.6 are still failing. Running a clean up fixes the issue. * fixing int64 type failing when getting indexes and trying to type them * requested changes relating to case statement and panic * Update README.md to credit @mapete94. * tests: ensure indexed int64 fields do not cause a panic in Indexes() See: * globalsign#23 * https://github.com/go-mgo/mgo/issues/475 * go-mgo#476 * Add collation option to collection.Create() (globalsign#37) - Allow specifying the default collation for the collection when creating it. - Add some documentation to query.Collation() method. fix globalsign#29 * Test against MongoDB 3.4.x (globalsign#35) * test against MongoDB 3.4.x * tests: use listIndexes to assert index state for 3.4+ * make test pass against v3.4.x - skip `TestViewWithCollation` because of SERVER-31049, cf: https://jira.mongodb.org/browse/SERVER-31049 - add versionAtLeast() method in init.js script to better detect server version fixes globalsign#31 * Introduce constants for BSON element types (globalsign#41) * bson.Unmarshal returns time in UTC (globalsign#42) * readme: add missing features / credit * Adds missing collation feature description (by @feliixx). * Adds missing 3.4 tests description (by @feliixx). * Adds BSON constants description (by @bozaro). * Adds UTC time.Time unmarshalling (by @gazoon). * fix golint, go vet and gofmt warnings (globalsign#44) Fixes globalsign#43 * readme: credit @feliixx (globalsign#46) * Fix GetBSON() method usage (globalsign#40) * Fix GetBSON() method usage Original issue --- You can't use type with custom GetBSON() method mixed with structure field type and structure field reference type. For example, you can't create custom GetBSON() for Bar type: ``` struct Foo { a Bar b *Bar } ``` Type implementation (`func (t Bar) GetBSON()` ) would crash on `Foo.b = nil` value encoding. Reference implementation (`func (t *Bar) GetBSON()` ) would not call on `Foo.a` value encoding. After this change --- For type implementation `func (t Bar) GetBSON()` would not call on `Foo.b = nil` value encoding. In this case `nil` value would be seariazied as `nil` BSON value. For reference implementation `func (t *Bar) GetBSON()` would call even on `Foo.a` value encoding. * Minor refactoring * readme: credit @bozaro (globalsign#47)

@feliixx

* add DropAllIndexes() method (globalsign#25) Create a new method to drop all the indexes of a collection in a single call * readme: credit @feliixx for globalsign#25 (globalsign#26) * send metadata during handshake (globalsign#28) fix [#484](https://github.com/go-mgo/mgo/issues/484) Annotate connections with metadata provided by the connecting client. informations send: { "aplication": { // optional "name": "myAppName" } "driver": { "name": "mgo", "version": "v2" }, "os": { "type": runtime.GOOS, "architecture": runtime.GOARCH } } to set "application.name", add `appname` param in options of string connection URI, for example : "mongodb://localhost:27017?appname=myAppName" * Update README to add appName (globalsign#32) * docs: elaborate on what appName does * readme: add appName to changes * add method CreateView() (globalsign#33) Fix globalsign#30. Thanks to @feliixx for the time and effort. * readme: credit @feliixx in the README (globalsign#36) * Don't panic on indexed int64 fields (globalsign#23) * Stop all db instances after tests (go-mgo#462) If all tests pass, the builds for mongo earlier than 2.6 are still failing. Running a clean up fixes the issue. * fixing int64 type failing when getting indexes and trying to type them * requested changes relating to case statement and panic * Update README.md to credit @mapete94. * tests: ensure indexed int64 fields do not cause a panic in Indexes() See: * globalsign#23 * https://github.com/go-mgo/mgo/issues/475 * go-mgo#476 * Add collation option to collection.Create() (globalsign#37) - Allow specifying the default collation for the collection when creating it. - Add some documentation to query.Collation() method. fix globalsign#29 * Test against MongoDB 3.4.x (globalsign#35) * test against MongoDB 3.4.x * tests: use listIndexes to assert index state for 3.4+ * make test pass against v3.4.x - skip `TestViewWithCollation` because of SERVER-31049, cf: https://jira.mongodb.org/browse/SERVER-31049 - add versionAtLeast() method in init.js script to better detect server version fixes globalsign#31 * Introduce constants for BSON element types (globalsign#41) * bson.Unmarshal returns time in UTC (globalsign#42) * readme: add missing features / credit * Adds missing collation feature description (by @feliixx). * Adds missing 3.4 tests description (by @feliixx). * Adds BSON constants description (by @bozaro). * Adds UTC time.Time unmarshalling (by @gazoon). * fix golint, go vet and gofmt warnings (globalsign#44) Fixes globalsign#43 * readme: credit @feliixx (globalsign#46) * Fix GetBSON() method usage (globalsign#40) * Fix GetBSON() method usage Original issue --- You can't use type with custom GetBSON() method mixed with structure field type and structure field reference type. For example, you can't create custom GetBSON() for Bar type: ``` struct Foo { a Bar b *Bar } ``` Type implementation (`func (t Bar) GetBSON()` ) would crash on `Foo.b = nil` value encoding. Reference implementation (`func (t *Bar) GetBSON()` ) would not call on `Foo.a` value encoding. After this change --- For type implementation `func (t Bar) GetBSON()` would not call on `Foo.b = nil` value encoding. In this case `nil` value would be seariazied as `nil` BSON value. For reference implementation `func (t *Bar) GetBSON()` would call even on `Foo.a` value encoding. * Minor refactoring * readme: credit @bozaro (globalsign#47) * Improve cursorData struct unmarshaling speed (globalsign#49) This change remove full BSON decoding on: - parsing to `bson.Raw` and `bson.DocElem` fields; - skipping unused BSON fields. * readme: credit @bozaro and @idy (globalsign#53) * readme: credit @bozaro and @idy * readme: add @idy to contributor list * do not lock while writing to a socket (globalsign#52) (globalsign#54) fix globalsign#51

feliixx mentioned this pull request Sep 5, 2017

Mongodb 3.4.x support #27

Closed

domodwyer assigned domodwyer and feliixx Sep 5, 2017

domodwyer added the enhancement label Sep 5, 2017

domodwyer suggested changes Sep 5, 2017

View reviewed changes

domodwyer reviewed Sep 5, 2017

View reviewed changes

domodwyer requested review from szank, brknstrngz and tadukurow September 5, 2017 15:38

domodwyer added the 3.4 feature label Sep 5, 2017

tadukurow approved these changes Sep 6, 2017

View reviewed changes

domodwyer approved these changes Sep 6, 2017

View reviewed changes

domodwyer merged commit 165af68 into globalsign:development Sep 6, 2017

domodwyer mentioned this pull request Sep 6, 2017

Update README to add appName #32

Merged

domodwyer mentioned this pull request Sep 18, 2017

Merge development #39

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

send metadata during handshake #28

send metadata during handshake #28

feliixx commented Sep 5, 2017

domodwyer commented Sep 5, 2017

domodwyer Sep 5, 2017

domodwyer Sep 5, 2017

szank Sep 5, 2017

domodwyer Sep 5, 2017

domodwyer Sep 5, 2017

feliixx commented Sep 6, 2017

domodwyer commented Sep 6, 2017

send metadata during handshake #28

send metadata during handshake #28

Conversation

feliixx commented Sep 5, 2017

domodwyer commented Sep 5, 2017

domodwyer Sep 5, 2017

Choose a reason for hiding this comment

domodwyer Sep 5, 2017

Choose a reason for hiding this comment

szank Sep 5, 2017

Choose a reason for hiding this comment

domodwyer Sep 5, 2017

Choose a reason for hiding this comment

domodwyer Sep 5, 2017

Choose a reason for hiding this comment

feliixx commented Sep 6, 2017

domodwyer commented Sep 6, 2017