Escaping document, collection & document names/keys

Author: ewoutp

client_databases_impl.go

@@ -24,13 +24,15 @@ package driver
 
 import (
 	"context"
+	"net/url"
 	"path"
 )
 
 // Database opens a connection to an existing database.
 // If no database with given name exists, an NotFoundError is returned.
 func (c *client) Database(ctx context.Context, name string) (Database, error) {
-	req, err := c.conn.NewRequest("GET", path.Join("_db", name, "_api/database/current"))
+	escapedName := url.QueryEscape(name)
+	req, err := c.conn.NewRequest("GET", path.Join("_db", escapedName, "_api/database/current"))
 	if err != nil {
 		return nil, WithStack(err)
 	}
@@ -50,7 +52,8 @@ func (c *client) Database(ctx context.Context, name string) (Database, error) {
 
 // DatabaseExists returns true if a database with given name exists.
 func (c *client) DatabaseExists(ctx context.Context, name string) (bool, error) {
-	req, err := c.conn.NewRequest("GET", path.Join("_db", name, "_api/database/current"))
+	escapedName := url.QueryEscape(name)
+	req, err := c.conn.NewRequest("GET", path.Join("_db", escapedName, "_api/database/current"))
 	if err != nil {
 		return false, WithStack(err)
 	}

collection_document_impl.go

@@ -25,6 +25,7 @@ package driver
 import (
 	"context"
 	"fmt"
+	"net/url"
 	"path"
 	"reflect"
 )
@@ -36,7 +37,8 @@ func (c *collection) ReadDocument(ctx context.Context, key string, result interf
 	if err := validateKey(key); err != nil {
 		return DocumentMeta{}, WithStack(err)
 	}
-	req, err := c.conn.NewRequest("GET", path.Join(c.relPath("document"), key))
+	escapedKey := url.QueryEscape(key)
+	req, err := c.conn.NewRequest("GET", path.Join(c.relPath("document"), escapedKey))
 	if err != nil {
 		return DocumentMeta{}, WithStack(err)
 	}
@@ -164,7 +166,8 @@ func (c *collection) UpdateDocument(ctx context.Context, key string, update inte
 	if update == nil {
 		return DocumentMeta{}, WithStack(InvalidArgumentError{Message: "update nil"})
 	}
-	req, err := c.conn.NewRequest("PATCH", path.Join(c.relPath("document"), key))
+	escapedKey := url.QueryEscape(key)
+	req, err := c.conn.NewRequest("PATCH", path.Join(c.relPath("document"), escapedKey))
 	if err != nil {
 		return DocumentMeta{}, WithStack(err)
 	}
@@ -272,7 +275,8 @@ func (c *collection) ReplaceDocument(ctx context.Context, key string, document i
 	if document == nil {
 		return DocumentMeta{}, WithStack(InvalidArgumentError{Message: "document nil"})
 	}
-	req, err := c.conn.NewRequest("PUT", path.Join(c.relPath("document"), key))
+	escapedKey := url.QueryEscape(key)
+	req, err := c.conn.NewRequest("PUT", path.Join(c.relPath("document"), escapedKey))
 	if err != nil {
 		return DocumentMeta{}, WithStack(err)
 	}
@@ -376,7 +380,8 @@ func (c *collection) RemoveDocument(ctx context.Context, key string) (DocumentMe
 	if err := validateKey(key); err != nil {
 		return DocumentMeta{}, WithStack(err)
 	}
-	req, err := c.conn.NewRequest("DELETE", path.Join(c.relPath("document"), key))
+	escapedKey := url.QueryEscape(key)
+	req, err := c.conn.NewRequest("DELETE", path.Join(c.relPath("document"), escapedKey))
 	if err != nil {
 		return DocumentMeta{}, WithStack(err)
 	}

collection_impl.go

@@ -24,6 +24,7 @@ package driver
 
 import (
 	"context"
+	"net/url"
 	"path"
 )
 
@@ -50,7 +51,8 @@ type collection struct {
 
 // relPath creates the relative path to this collection (`_db/<db-name>/_api/<api-name>/<col-name>`)
 func (c *collection) relPath(apiName string) string {
-	return path.Join(c.db.relPath(), "_api", apiName, c.name)
+	escapedName := url.QueryEscape(c.name)
+	return path.Join(c.db.relPath(), "_api", apiName, escapedName)
 }
 
 // Name returns the name of the collection.

database_impl.go

@@ -24,6 +24,7 @@ package driver
 
 import (
 	"context"
+	"net/url"
 	"path"
 )
 
@@ -49,7 +50,8 @@ type database struct {
 
 // relPath creates the relative path to this database (`_db/<name>`)
 func (d *database) relPath() string {
-	return path.Join("_db", d.name)
+	escapedName := url.QueryEscape(d.name)
+	return path.Join("_db", escapedName)
 }
 
 // Name returns the name of the database.
@@ -60,7 +62,8 @@ func (d *database) Name() string {
 // Collection opens a connection to an existing collection within the database.
 // If no collection with given name exists, an NotFoundError is returned.
 func (d *database) Collection(ctx context.Context, name string) (Collection, error) {
-	req, err := d.conn.NewRequest("GET", path.Join(d.relPath(), "_api/collection", name))
+	escapedName := url.QueryEscape(name)
+	req, err := d.conn.NewRequest("GET", path.Join(d.relPath(), "_api/collection", escapedName))
 	if err != nil {
 		return nil, WithStack(err)
 	}
@@ -80,7 +83,8 @@ func (d *database) Collection(ctx context.Context, name string) (Collection, err
 
 // CollectionExists returns true if a collection with given name exists within the database.
 func (d *database) CollectionExists(ctx context.Context, name string) (bool, error) {
-	req, err := d.conn.NewRequest("GET", path.Join(d.relPath(), "_api/collection", name))
+	escapedName := url.QueryEscape(name)
+	req, err := d.conn.NewRequest("GET", path.Join(d.relPath(), "_api/collection", escapedName))
 	if err != nil {
 		return false, WithStack(err)
 	}