Merge pull request #1770 from couchbase/feature/issue_1769

Allows channels to be a single string channel vale in default sync function
couchbase · May 16, 2016 · 7461744 · 7461744
2 parents a20985c + 02a6acf
commit 7461744
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 33 deletions.
diff --git a/base/util.go b/base/util.go
@@ -396,3 +396,23 @@ func SyncSourceFromURL(u *url.URL) string {
 
 	return buf.String()
 }
+
+//Convert string or array into a string array, otherwise return nil
+func ValueToStringArray(value interface{}) []string {
+	switch valueType := value.(type) {
+	case string:
+		return []string{valueType}
+	case []string:
+		return valueType
+	case []interface{}:
+		result := make([]string, 0, len(valueType))
+		for _, item := range valueType {
+			if str, ok := item.(string); ok {
+				result = append(result, str)
+			}
+		}
+		return result
+	default:
+		return nil
+	}
+}
diff --git a/base/util_test.go b/base/util_test.go
@@ -149,4 +149,15 @@ func TestSyncSourceFromURL(t *testing.T) {
 	assert.True(t, err == nil)
 	result = SyncSourceFromURL(u)
 	assert.Equals(t, result, "")
+}
+
+func TestValueToStringArray(t *testing.T) {
+	result := ValueToStringArray("foobar")
+	assert.DeepEquals(t, result, []string{"foobar"})
+
+	result = ValueToStringArray([]string{"foobar","moocar"})
+	assert.DeepEquals(t, result, []string{"foobar","moocar"})
+
+	result = ValueToStringArray([]interface{}{"foobar",1,true})
+	assert.DeepEquals(t, result, []string{"foobar"})
 }
diff --git a/channels/sync_runner.go b/channels/sync_runner.go
@@ -207,23 +207,12 @@ func compileAccessMap(input map[string][]string, prefix string) (AccessMap, erro
 // Converts a JS string or array into a Go string array.
 func ottoValueToStringArray(value otto.Value) []string {
 	nativeValue, _ := value.Export()
-	switch nativeValue := nativeValue.(type) {
-	case string:
-		return []string{nativeValue}
-	case []string:
-		return nativeValue
-	case []interface{}:
-		result := make([]string, 0, len(nativeValue))
-		for _, item := range nativeValue {
-			if str, ok := item.(string); ok {
-				result = append(result, str)
-			}
-		}
-		return result
-	default:
-		if !value.IsNull() && !value.IsUndefined() {
-			base.Warn("SyncRunner: Non-string, non-array passed to JS callback: %s", value)
-		}
-		return nil
+
+	result := base.ValueToStringArray(nativeValue)
+
+	if result == nil && !value.IsNull() && !value.IsUndefined() {
+		base.Warn("SyncRunner: Non-string, non-array passed to JS callback: %s", value)
 	}
+
+	return result
 }
diff --git a/db/crud.go b/db/crud.go
@@ -819,15 +819,9 @@ func (db *Database) getChannelsAndAccess(doc *document, body Body, revID string)
 
 	} else {
 		// No ChannelMapper so by default use the "channels" property:
-		value, _ := body["channels"].([]interface{})
+		value := body["channels"]
 		if value != nil {
-			array := make([]string, 0, len(value))
-			for _, channel := range value {
-				channelStr, ok := channel.(string)
-				if ok && len(channelStr) > 0 {
-					array = append(array, channelStr)
-				}
-			}
+			array := base.ValueToStringArray(value)
 			result, err = channels.SetFromArray(array, channels.KeepStar)
 		}
 	}

diff --git a/rest/api_test.go b/rest/api_test.go
@@ -1180,6 +1180,7 @@ func testAccessControl(t *testing.T, rt indexTester) {
 	assertStatus(t, rt.sendRequest("PUT", "/db/doc2", `{"channels":["CBS"]}`), 201)
 	assertStatus(t, rt.sendRequest("PUT", "/db/doc3", `{"channels":["CBS", "Cinemax"]}`), 201)
 	assertStatus(t, rt.sendRequest("PUT", "/db/doc4", `{"channels":["WB", "Cinemax"]}`), 201)
+	assertStatus(t, rt.sendRequest("PUT", "/db/doc5", `{"channels":"Cinemax"}`), 201)
 
 	guest.SetDisabled(true)
 	err = a.Save(guest)
@@ -1210,11 +1211,13 @@ func testAccessControl(t *testing.T, rt indexTester) {
 	log.Printf("Response = %s", response.Body.Bytes())
 	err = json.Unmarshal(response.Body.Bytes(), &allDocsResult)
 	assert.Equals(t, err, nil)
-	assert.Equals(t, len(allDocsResult.Rows), 2)
+	assert.Equals(t, len(allDocsResult.Rows), 3)
 	assert.Equals(t, allDocsResult.Rows[0].ID, "doc3")
 	assert.DeepEquals(t, allDocsResult.Rows[0].Value.Channels, []string{"Cinemax"})
 	assert.Equals(t, allDocsResult.Rows[1].ID, "doc4")
 	assert.DeepEquals(t, allDocsResult.Rows[1].Value.Channels, []string{"Cinemax"})
+	assert.Equals(t, allDocsResult.Rows[2].ID, "doc5")
+	assert.DeepEquals(t, allDocsResult.Rows[2].Value.Channels, []string{"Cinemax"})
 
 	//Check all docs limit option
 	request, _ = http.NewRequest("GET", "/db/_all_docs?limit=1&channels=true", nil)
@@ -1230,7 +1233,7 @@ func testAccessControl(t *testing.T, rt indexTester) {
 	assert.DeepEquals(t, allDocsResult.Rows[0].Value.Channels, []string{"Cinemax"})
 
 	//Check all docs startkey option
-	request, _ = http.NewRequest("GET", "/db/_all_docs?startkey=doc4&channels=true", nil)
+	request, _ = http.NewRequest("GET", "/db/_all_docs?startkey=doc5&channels=true", nil)
 	request.SetBasicAuth("alice", "letmein")
 	response = rt.send(request)
 	assertStatus(t, response, 200)
@@ -1239,11 +1242,11 @@ func testAccessControl(t *testing.T, rt indexTester) {
 	err = json.Unmarshal(response.Body.Bytes(), &allDocsResult)
 	assert.Equals(t, err, nil)
 	assert.Equals(t, len(allDocsResult.Rows), 1)
-	assert.Equals(t, allDocsResult.Rows[0].ID, "doc4")
+	assert.Equals(t, allDocsResult.Rows[0].ID, "doc5")
 	assert.DeepEquals(t, allDocsResult.Rows[0].Value.Channels, []string{"Cinemax"})
 
 	//Check all docs startkey option with double quote
-	request, _ = http.NewRequest("GET", `/db/_all_docs?startkey="doc4"&channels=true`, nil)
+	request, _ = http.NewRequest("GET", `/db/_all_docs?startkey="doc5"&channels=true`, nil)
 	request.SetBasicAuth("alice", "letmein")
 	response = rt.send(request)
 	assertStatus(t, response, 200)
@@ -1252,7 +1255,7 @@ func testAccessControl(t *testing.T, rt indexTester) {
 	err = json.Unmarshal(response.Body.Bytes(), &allDocsResult)
 	assert.Equals(t, err, nil)
 	assert.Equals(t, len(allDocsResult.Rows), 1)
-	assert.Equals(t, allDocsResult.Rows[0].ID, "doc4")
+	assert.Equals(t, allDocsResult.Rows[0].ID, "doc5")
 	assert.DeepEquals(t, allDocsResult.Rows[0].Value.Channels, []string{"Cinemax"})
 
 	//Check all docs endkey option
@@ -1290,9 +1293,10 @@ func testAccessControl(t *testing.T, rt indexTester) {
 	log.Printf("Response = %s", response.Body.Bytes())
 	err = json.Unmarshal(response.Body.Bytes(), &allDocsResult)
 	assert.Equals(t, err, nil)
-	assert.Equals(t, len(allDocsResult.Rows), 2)
+	assert.Equals(t, len(allDocsResult.Rows), 3)
 	assert.Equals(t, allDocsResult.Rows[0].ID, "doc3")
 	assert.Equals(t, allDocsResult.Rows[1].ID, "doc4")
+	assert.Equals(t, allDocsResult.Rows[2].ID, "doc5")
 
 	// Check POST to _all_docs:
 	body := `{"keys": ["doc4", "doc1", "doc3", "b0gus"]}`
@@ -1357,7 +1361,7 @@ func testAccessControl(t *testing.T, rt indexTester) {
 	log.Printf("Admin response = %s", response.Body.Bytes())
 	err = json.Unmarshal(response.Body.Bytes(), &allDocsResult)
 	assert.Equals(t, err, nil)
-	assert.Equals(t, len(allDocsResult.Rows), 4)
+	assert.Equals(t, len(allDocsResult.Rows), 5)
 	assert.Equals(t, allDocsResult.Rows[0].ID, "doc1")
 	assert.Equals(t, allDocsResult.Rows[1].ID, "doc2")