patched with DBRef proxy to initiate proper DB when using multiple databases

binarycodifier · binarycodifier · commit 5789cafb9c97 · 2012-11-08T21:57:00.000Z
diff --git a/.gitignore b/.gitignore
@@ -50,4 +50,6 @@ src/test/ed/webtests/webtest-local.bash
 
 *.ipr
 *.iws
+*.iml
+.idea
 atlassian-ide-plugin.xml
diff --git a/.idea/libraries/Maven__com_beust_jcommander_1_12.xml b/.idea/libraries/Maven__com_beust_jcommander_1_12.xml
diff --git a/.idea/libraries/Maven__junit_junit_3_8_1.xml b/.idea/libraries/Maven__junit_junit_3_8_1.xml
diff --git a/.idea/libraries/Maven__org_beanshell_bsh_2_0b4.xml b/.idea/libraries/Maven__org_beanshell_bsh_2_0b4.xml
diff --git a/.idea/libraries/Maven__org_testng_testng_6_3_1.xml b/.idea/libraries/Maven__org_testng_testng_6_3_1.xml
diff --git a/.idea/libraries/Maven__org_yaml_snakeyaml_1_6.xml b/.idea/libraries/Maven__org_yaml_snakeyaml_1_6.xml
diff --git a/mongo-java-driver.iml b/mongo-java-driver.iml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module org.jetbrains.idea.maven.project.MavenProjectsManager.isMavenModule="true" type="JAVA_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="Osmorc" name="OSGi">
+      <configuration manifestGenerationMode="OsmorcControlled" manifestLocation="" jarfileLocation="mongo-java-driver-2.10.0-SNAPSHOT.jar" outputPathType="CompilerOutputPath" bndFileLocation="" bundlorFileLocation="" bundleActivator="" bundleSymbolicName="org.mongodb.mongo-java-driver" bundleVersion="2.10.0.SNAPSHOT" ignoreFilePattern="" useProjectDefaultManifestFileLocation="true" alwaysRebuildBundleJAR="false" doNotSynchronizeWithMaven="false">
+        <additionalProperties>
+          <property key="Bundle-Description" value="The MongoDB Java driver" />
+          <property key="Export-Package" value="org.bson.*" />
+          <property key="Bundle-Name" value="MongoDB Java Driver" />
+        </additionalProperties>
+        <additionalJARContents />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="false">
+    <output url="file://$MODULE_DIR$/target/classes" />
+    <output-test url="file://$MODULE_DIR$/target/test-classes" />
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src/main" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/src/test" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/target" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="TEST" name="Maven: org.testng:testng:6.3.1" level="project" />
+    <orderEntry type="library" scope="TEST" name="Maven: junit:junit:3.8.1" level="project" />
+    <orderEntry type="library" scope="TEST" name="Maven: org.beanshell:bsh:2.0b4" level="project" />
+    <orderEntry type="library" scope="TEST" name="Maven: com.beust:jcommander:1.12" level="project" />
+    <orderEntry type="library" scope="TEST" name="Maven: org.yaml:snakeyaml:1.6" level="project" />
+  </component>
+</module>
+
diff --git a/pom.xml b/pom.xml
@@ -8,7 +8,7 @@ driver developers who would rather use Maven than Ant as their build tool.
     <artifactId>mongo-java-driver</artifactId>
     <packaging>bundle</packaging>
     <name>MongoDB Java Driver</name>
-    <version>2.10.0-SNAPSHOT</version>
+    <version>2.10.0-PATCH</version>
     <description>The MongoDB Java driver</description>
     <url>http://www.mongodb.org</url>
 
diff --git a/src/main/com/mongodb/DB.java b/src/main/com/mongodb/DB.java
@@ -60,7 +60,7 @@ public abstract class DB {
     public DB( Mongo mongo , String name ){
         _mongo = mongo;
     	_name = name;
-        _options = new Bytes.OptionHolder( _mongo._netOptions );
+        _options = (_mongo == null) ? null : new Bytes.OptionHolder( _mongo._netOptions );
     }
 
     /**
diff --git a/src/main/com/mongodb/DBApiLayer.java b/src/main/com/mongodb/DBApiLayer.java
@@ -182,6 +182,11 @@ void killCursors( ServerAddress addr , List<Long> all ){
         _connector.say( this , om ,com.mongodb.WriteConcern.NONE , addr );
     }
 
+    @Override
+    public String toString() {
+        return getName();
+    }
+
     class MyCollection extends DBCollection {
         MyCollection( String name ){
             super( DBApiLayer.this , name );
diff --git a/src/main/com/mongodb/DBProxy.java b/src/main/com/mongodb/DBProxy.java
@@ -0,0 +1,38 @@
+package com.mongodb;
+
+public class DBProxy extends DB {
+
+    public DBProxy(Mongo mongo, String name) {
+        super(mongo, name);
+    }
+
+    @Override
+    public void requestStart() {
+        throw new RuntimeException("Not supported by DB Proxy");
+    }
+
+    @Override
+    public void requestDone() {
+        throw new RuntimeException("Not supported by DB Proxy");
+    }
+
+    @Override
+    public void requestEnsureConnection() {
+        throw new RuntimeException("Not supported by DB Proxy");
+    }
+
+    @Override
+    protected DBCollection doGetCollection(String name) {
+        throw new RuntimeException("Not supported by DB Proxy");
+    }
+
+    @Override
+    public String toString(){
+        return getName();
+    }
+
+    @Override
+    public void cleanCursors(boolean force) {
+        throw new RuntimeException("Not supported by DB Proxy");
+    }
+}
diff --git a/src/main/com/mongodb/DBRefBase.java b/src/main/com/mongodb/DBRefBase.java
@@ -57,7 +57,7 @@ public DBObject fetch() throws MongoException {
 
     @Override
     public String toString(){
-        return "{ \"$ref\" : \"" + _ns + "\", \"$id\" : \"" + _id + "\" }";
+        return "{ \"$ref\" : \"" + _ns + "\", \"$id\" : \"" + _id + "\", \"$db\" : \"" + _db + "\" }";
     }
 
     /**
@@ -93,6 +93,7 @@ public boolean equals(final Object o) {
 
         if (_id != null ? !_id.equals(dbRefBase._id) : dbRefBase._id != null) return false;
         if (_ns != null ? !_ns.equals(dbRefBase._ns) : dbRefBase._ns != null) return false;
+        if (_db != null ? !_db.equals(dbRefBase._db) : dbRefBase._db != null) return false;
 
         return true;
     }
@@ -101,6 +102,7 @@ public boolean equals(final Object o) {
     public int hashCode() {
         int result = _id != null ? _id.hashCode() : 0;
         result = 31 * result + (_ns != null ? _ns.hashCode() : 0);
+        result = (_db != null) ? 31 * result + _db.hashCode() : result;
         return result;
     }
 
diff --git a/src/main/com/mongodb/DefaultDBCallback.java b/src/main/com/mongodb/DefaultDBCallback.java
@@ -69,6 +69,13 @@ public Object objectDone(){
         if ( ! ( o instanceof List ) &&
              o.containsField( "$ref" ) &&
              o.containsField( "$id" ) ){
+
+            if(_db != null && o.containsField("$db")) {
+                //get the real database for this reference (when using multiple databases)
+                DB actualDB = _db.getMongo().getDB((String)o.get("$db"));
+                return cur().put( _lastName , new DBRef( actualDB, o ) );
+            }
+
             return cur().put( _lastName , new DBRef( _db, o ) );
         }
 
diff --git a/src/main/com/mongodb/DefaultDBEncoder.java b/src/main/com/mongodb/DefaultDBEncoder.java
@@ -69,6 +69,10 @@ protected void putDBRef( String name, DBRefBase ref ){
         _putObjectField( "$ref" , ref.getRef() );
         _putObjectField( "$id" , ref.getId() );
 
+        if(ref.getDB() != null) {
+            _putObjectField( "$db" , ref.getDB().toString() );
+        }
+
         _buf.write( EOO );
         _buf.writeInt( sizePos , _buf.getPosition() - sizePos );
     }
diff --git a/src/main/com/mongodb/util/JSONCallback.java b/src/main/com/mongodb/util/JSONCallback.java
@@ -26,6 +26,7 @@
 import java.util.UUID;
 import java.util.regex.Pattern;
 
+import com.mongodb.*;
 import org.bson.BSON;
 import org.bson.BSONObject;
 import org.bson.BasicBSONCallback;
@@ -36,11 +37,6 @@
 import org.bson.types.MinKey;
 import org.bson.types.ObjectId;
 
-import com.mongodb.BasicDBList;
-import com.mongodb.BasicDBObject;
-import com.mongodb.DBObject;
-import com.mongodb.DBRef;
-
 public class JSONCallback extends BasicBSONCallback {
     
     @Override
@@ -122,7 +118,7 @@ public Object objectDone(){
 		    setRoot(o);
 		}
 	    } else if ( b.containsField( "$ref" ) ) {
-                o = new DBRef(null, (String)b.get("$ref"), b.get("$id"));
+                o = new DBRef(( (b.get("$db") != null) ? new DBProxy(null, (String)b.get("$db")) : null ), (String)b.get("$ref"), b.get("$id"));
 		if (!isStackEmpty()) {
 		    cur().put( name, o );
 		} else {
diff --git a/src/main/com/mongodb/util/JSONSerializers.java b/src/main/com/mongodb/util/JSONSerializers.java
@@ -255,6 +255,11 @@ public void serialize(Object obj, StringBuilder buf) {
             BasicDBObject temp = new BasicDBObject();
             temp.put("$ref", ref.getRef());
             temp.put("$id", ref.getId());
+
+            if(ref.getDB() != null) {
+                temp.put("$db", ref.getDB().toString());
+            }
+
             serializer.serialize(temp, buf);
         }
 
diff --git a/src/main/org/bson/BasicBSONEncoder.java b/src/main/org/bson/BasicBSONEncoder.java
@@ -257,6 +257,11 @@ else if (val instanceof DBRefBase) {
             BSONObject temp = new BasicBSONObject();
             temp.put("$ref", ((DBRefBase)val).getRef());
             temp.put("$id", ((DBRefBase)val).getId());
+
+            if(((DBRefBase)val).getDB() != null) {
+                temp.put("$db", ((DBRefBase)val).getDB().toString());
+            }
+
             putObject( name, temp );
         }
         else if ( val instanceof MinKey )
diff --git a/src/test/com/mongodb/DBRefTest.java b/src/test/com/mongodb/DBRefTest.java
@@ -34,7 +34,9 @@ public DBRefTest() {
         try {
 	    cleanupMongo = new Mongo( "127.0.0.1" );
 	    cleanupDB = "com_monogodb_unittest_DBRefTest";
+        cleanupOtherDB = "com_monogodb_unittest_DBRefTest_other";
 	    _db = cleanupMongo.getDB( cleanupDB );
+        _dbOther = cleanupMongo.getDB( cleanupOtherDB );
         }
         catch(UnknownHostException e) {
             throw new MongoException("couldn't connect");
@@ -51,13 +53,24 @@ public void testEqualsAndHashCode() {
        assertEquals(ref.hashCode(), other.hashCode());
     }
 
+    @Test(groups = {"basic"})
+    public void testNotEqualsAndHashCodeForDifferentDatabases() {
+        DBRef ref = new DBRef(_db, "foo.bar", 4);
+        DBRef other = new DBRef(_dbOther, "foo.bar", 4);
+        assertEquals(ref, ref);
+        assertEquals(other, other);
+        assertNotEquals(ref, other);
+        assertNotEquals(other, new DBRefBase(_db, "foo.bar", 4));
+        assertNotEquals(ref.hashCode(), other.hashCode());
+    }
+
     @Test(groups = {"basic"})
     public void testDBRefBaseToString(){
 
         ObjectId id = new ObjectId("123456789012345678901234");
         DBRefBase ref = new DBRefBase(_db, "foo.bar", id);
 
-        assertEquals("{ \"$ref\" : \"foo.bar\", \"$id\" : \"123456789012345678901234\" }", ref.toString());
+        assertEquals("{ \"$ref\" : \"foo.bar\", \"$id\" : \"123456789012345678901234\", \"$db\" : \"com_monogodb_unittest_DBRefTest\" }", ref.toString());
     }
 
     @Test(groups = {"basic"})
@@ -71,6 +84,24 @@ public void testDBRef(){
 
         encoder.writeObject(buf, o);
 
+        DefaultDBCallback cb = new DefaultDBCallback( _db.getCollection("foo.bar") );
+        BSONDecoder decoder = new BasicBSONDecoder();
+        decoder.decode( buf.toByteArray() , cb );
+        DBObject read = cb.dbget();
+
+        assertEquals("{\"!\":{\"$ref\":\"hello\",\"$id\":\"world\",\"$db\":\"com_monogodb_unittest_DBRefTest\"}}", read.toString().replaceAll(" +", ""));
+    }
+
+    @Test(groups = {"basic"})
+    public void testDBRefWithNullDBCallbackState(){
+        DBRef ref = new DBRef(_db, "hello", "world");
+        DBObject o = new BasicDBObject("!", ref);
+
+        DBEncoder encoder = DefaultDBEncoder.FACTORY.create();
+        OutputBuffer buf = new BasicOutputBuffer();
+
+        encoder.writeObject(buf, o);
+
         DefaultDBCallback cb = new DefaultDBCallback( null );
         BSONDecoder decoder = new BasicBSONDecoder();
         decoder.decode( buf.toByteArray() , cb );
@@ -159,6 +190,7 @@ public void testFindByDBRef(){
     }
 
     DB _db;
+    DB _dbOther;
 
     public static void main( String args[] ) {
         (new DBRefTest()).runConsole();
diff --git a/src/test/com/mongodb/util/JSONTest.java b/src/test/com/mongodb/util/JSONTest.java
@@ -349,7 +349,7 @@ public void testDate() {
 
     @org.testng.annotations.Test
     public void testJSONEncoding() throws ParseException {
-        String json = "{ 'str' : 'asdfasd' , 'long' : 123123123123 , 'int' : 5 , 'float' : 0.4 , 'bool' : false , 'date' : { '$date' : '2011-05-18T18:56:00Z'} , 'pat' : { '$regex' : '.*' , '$options' : ''} , 'oid' : { '$oid' : '4d83ab3ea39562db9c1ae2ae'} , 'ref' : { '$ref' : 'test.test' , '$id' : { '$oid' : '4d83ab59a39562db9c1ae2af'}} , 'code' : { '$code' : 'asdfdsa'} , 'codews' : { '$code' : 'ggggg' , '$scope' : { }} , 'ts' : { '$ts' : 1300474885 , '$inc' : 10} , 'null' :  null, 'uuid' : { '$uuid' : '60f65152-6d4a-4f11-9c9b-590b575da7b5' }}";
+        String json = "{ 'str' : 'asdfasd' , 'long' : 123123123123 , 'int' : 5 , 'float' : 0.4 , 'bool' : false , 'date' : { '$date' : '2011-05-18T18:56:00Z'} , 'pat' : { '$regex' : '.*' , '$options' : ''} , 'oid' : { '$oid' : '4d83ab3ea39562db9c1ae2ae'} , 'ref' : { '$ref' : 'test.test' , '$id' : { '$oid' : '4d83ab59a39562db9c1ae2af'}, '$db' : 'test_db'} , 'code' : { '$code' : 'asdfdsa'} , 'codews' : { '$code' : 'ggggg' , '$scope' : { }} , 'ts' : { '$ts' : 1300474885 , '$inc' : 10} , 'null' :  null, 'uuid' : { '$uuid' : '60f65152-6d4a-4f11-9c9b-590b575da7b5' }}";
         BasicDBObject a = (BasicDBObject) JSON.parse(json);
         assert (a.get("str").equals("asdfasd"));
         assert (a.get("int").equals(5));
@@ -367,6 +367,7 @@ public void testJSONEncoding() throws ParseException {
         ObjectId oid = (ObjectId) a.get("oid");
         assert (oid.equals(new ObjectId("4d83ab3ea39562db9c1ae2ae")));
         DBRef ref = (DBRef) a.get("ref");
+        assertEquals("test_db", ref.getDB().getName(), "should be proxy reference name for the database.");
         assert (ref.equals(new DBRef(null, "test.test", new ObjectId("4d83ab59a39562db9c1ae2af"))));
         assert (a.get("code").equals(new Code("asdfdsa")));
         assert (a.get("codews").equals(new CodeWScope("ggggg", new BasicBSONObject())));
diff --git a/src/test/com/mongodb/util/TestCase.java b/src/test/com/mongodb/util/TestCase.java
@@ -135,6 +135,7 @@ public void add( TestCase tc ){
     }
 
     public String cleanupDB = null;
+    public String cleanupOtherDB = null;
     public Mongo cleanupMongo = null;
 
     @org.testng.annotations.AfterClass
@@ -143,6 +144,9 @@ public void cleanup() {
             if (cleanupDB != null) {
                 cleanupMongo.dropDatabase(cleanupDB);
             }
+            if (cleanupOtherDB != null) {
+                cleanupMongo.dropDatabase(cleanupOtherDB);
+            }
             cleanupMongo.close();
         }
     }

-Original file line number
+Diff line change
 *.ipr
 *.iws
 +*.iml
 +.idea
 atlassian-ide-plugin.xml
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public abstract class DB {`
`60`	`60`	`public DB( Mongo mongo , String name ){`
`61`	`61`	`_mongo = mongo;`
`62`	`62`	`_name = name;`
`63`		`- _options = new Bytes.OptionHolder( _mongo._netOptions );`
	`63`	`+ _options = (_mongo == null) ? null : new Bytes.OptionHolder( _mongo._netOptions );`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`