add support for Self and Kind fields in response from getDbRecord/s

Author: dfong

cx_test.go

@@ -46,8 +46,10 @@ func (cx *testContext) bump() {
 // assertEqual() fails the test unless exp and act are equal.
 func (cx *testContext) assertEqual(exp interface{}, act interface{}, msg string) bool {
 	if exp != act {
-		cx.Errorf(`*** Assertion Failed: %s, got (%T)<%v>; expected (%T)<%v>`,
-			msg, act, act, exp, exp)
+		cx.Errorf(`*** Assertion Failed: %s
+   expected: (%T)<%v>
+   got:      (%T)<%v>`,
+			msg, exp, exp, act, act)
 		return false
 	}
 	return true
@@ -56,8 +58,10 @@ func (cx *testContext) assertEqual(exp interface{}, act interface{}, msg string)
 // assertEqualObj() fails the test unless exp and act are deeply equal.
 func (cx *testContext) assertEqualObj(exp interface{}, act interface{}, msg string) bool {
 	if !reflect.DeepEqual(exp, act) {
-		cx.Errorf(`assertion failed: %s, got <%s>; expected <%s>`,
-			msg, act, exp)
+		cx.Errorf(`assertion failed: %s
+   expected: <%s>
+   got:      <%s>`,
+			msg, exp, act)
 		return false
 	}
 	return true

handlers.go

@@ -6,6 +6,7 @@ import (
 	"strconv"
 	"bytes"
 	"net/http"
+	"net/url"
 	"encoding/json"
 	"database/sql"
 )
@@ -77,7 +78,7 @@ func getDbRecordsHandler(harg *apiHandlerArg) apiHandlerRet {
 		return errorRet(badStat, err, "after fetchParams")
 	}
 
-	return getCommon(params)
+	return getCommon(harg.req.URL, params)
 }
 
 // getDbRecordHandler() handles GET requests on /db/_table/{table_name}/{id} .
@@ -90,7 +91,7 @@ func getDbRecordHandler(harg *apiHandlerArg) apiHandlerRet {
 	params["limit"] = strconv.Itoa(1)
 	params["offset"] = strconv.Itoa(0)
 
-	return getCommon(params)
+	return getCommon(harg.req.URL, params)
 }
 
 // updateDbRecordsHandler() handles PATCH requests on /db/_table/{table_name} .
@@ -180,7 +181,7 @@ func tablesQuery(tabName string,
 
 	idlist := []interface{}{}
 	qstring := fmt.Sprintf("select %s from %s", fieldName, tabName)
-	result, err := runQuery(db, qstring, idlist)
+	result, err := runQuery(db, nil, qstring, idlist)
 	if err != nil {
 		return errorRet(badStat, err, "after runQuery")
 	}
@@ -203,7 +204,7 @@ func schemaQuery(tabName string,
 	idlist := []interface{}{}
 	qstring := fmt.Sprintf(`select %s from %s where %s = "%s"`,
 			fieldName, tabName, selector, item)
-	result, err := runQuery(db, qstring, idlist)
+	result, err := runQuery(db, nil, qstring, idlist)
 	if err != nil {
 		return errorRet(badStat, err, "after runQuery")
 	}
@@ -245,9 +246,9 @@ func mkSQLRow(N int) []interface{} {
 
 // queryErrorRet() passes thru the first 2 args (ret and err),
 // while logging the third argument (dmsg).
-func queryErrorRet(ret []*KVRecord,
+func queryErrorRet(ret []*KVResponse,
 		err error,
-		dmsg string) ([]*KVRecord, error) {
+		dmsg string) ([]*KVResponse, error) {
 	if dmsg != "" {
 		log.Debugf("queryErrorRet [%s], %s", err, dmsg)
 	}
@@ -257,12 +258,13 @@ func queryErrorRet(ret []*KVRecord,
 // runQuery() does a select query using the given query string.
 // the return value is a list of the retrieved records.
 func runQuery(db dbType,
+		u *url.URL,
 		qstring string,
-		ivals []interface{}) ([]*KVRecord, error) {
+		ivals []interface{}) ([]*KVResponse, error) {
 	log.Debugf("query = %s", qstring)
 	log.Debugf("ivals = %s", ivals)
 
-	ret := make([]*KVRecord, 0, 1)
+	ret := make([]*KVResponse, 0, 1)
 
 	rows, err := db.handle.Query(qstring, ivals...)
 	if err != nil {
@@ -279,6 +281,7 @@ func runQuery(db dbType,
 	log.Debugf("cols = %s", cols)
 	ncols := len(cols)
 
+	i := 0
 	for rows.Next() {
 		vals := mkSQLRow(ncols)
 		err = rows.Scan(vals...)
@@ -290,11 +293,16 @@ func runQuery(db dbType,
 		if err != nil {
 			return queryErrorRet(ret, err, "failure after convValues")
 		}
-		kvrow := KVRecord{Keys: cols, Values: vals}
+		kvrow := KVResponse{Keys: cols,
+			Values: vals,
+			Kind: "KVResponse",
+			Self: mkSelf(u, ivals, i),
+			}
 		ret = append(ret, &kvrow)
 		if len(ret) >= maxRecs { // safety check
 			break
 		}
+		i++
 	}
 
 	err = rows.Err()
@@ -526,9 +534,9 @@ func mkSelectString(params map[string]string) (string, []interface{}) {
 }
 
 // getCommon() is common code for selection APIs.
-func getCommon(params map[string]string) apiHandlerRet {
+func getCommon(u *url.URL, params map[string]string) apiHandlerRet {
 	qstring, idlist := mkSelectString(params)
-	result, err := runQuery(db, qstring, idlist)
+	result, err := runQuery(db, u, qstring, idlist)
 	if err != nil {
 		return errorRet(badStat, err, "after runQuery")
 	}
@@ -560,7 +568,7 @@ func updateCommon(harg *apiHandlerArg, params map[string]string) apiHandlerRet {
 
 // convTableNames() converts the return format from runQuery()
 // into a simple list of names.
-func convTableNames(result []*KVRecord) ([]string, error) {
+func convTableNames(result []*KVResponse) ([]string, error) {
 	// convert from query format to simple list of names
 	ret := make([]string, len(result))
 	for i, row := range result {
@@ -689,3 +697,13 @@ func execN(db dbType, cmdList ...*xCmd) error {
 	}
 	return tx.Commit()
 }
+
+// mkSelf() returns a string for the self field of a KVResponse.
+func mkSelf(u *url.URL, idlist []interface{}, i int) string {
+	if u == nil || i >= len(idlist) {
+		log.Debugf("mkSelf: idlist=%s, i=%d", idlist, i)
+		return "??"
+	}
+	id, _ := idlist[i].(int64)
+	return fmt.Sprintf("%s://%s%s/%d", u.Scheme, u.Host, u.Path, id)
+}

handlers_test.go

@@ -428,9 +428,9 @@ var convTableNames_Tab = []convTableNames_TC {
 
 // mimicTableNamesQuery() returns an object that mimics the return from
 // the query to the "_tables_" table.
-func mimicTableNamesQuery(names []string) []*KVRecord {
+func mimicTableNamesQuery(names []string) []*KVResponse {
 	N := len(names)
-	ret := make([]*KVRecord, N)
+	ret := make([]*KVResponse, N)
 	for i := 0; i < N; i++ {
 		Keys := []string{"name"}
 		val := names[i]
@@ -442,7 +442,7 @@ func mimicTableNamesQuery(names []string) []*KVRecord {
 			ival = interface{}(val)
 		}
 		Values := []interface{}{ival}
-		ret[i] = &KVRecord{Keys, Values}
+		ret[i] = &KVResponse{Keys, Values, "KVResponse", ""}
 	}
 	return ret
 }
@@ -1366,18 +1366,18 @@ var getDbRecordHandler_Tab = []apiCall_TC {
 	{"setup: create table xxxget",
 		createDbTableHandler,
 		http.MethodPost,
-		`/db/_schema/ABC|table_name=xxxget||`+users_schema,
+		`/db/_schema/xxxget|table_name=xxxget||`+users_schema,
 		http.StatusCreated, noCheck},
 	{"setup: create db record 1",
 		createDbRecordsHandler,
 		http.MethodPost,
-		`/db/_table/tabname|table_name=xxxget||{"Records":[{"Keys":["uri","name"],"Values":["uri-a","name-a"]}]}`,
+		`/db/_table/xxxget|table_name=xxxget||{"Records":[{"Keys":["uri","name"],"Values":["uri-a","name-a"]}]}`,
 		http.StatusCreated, noCheck},
 	{"get db record 1",
 		getDbRecordHandler,
 		http.MethodGet,
-		`/db/_table/tabname|table_name=xxxget&id=1`,
-		http.StatusOK, `{"Records":[{"Keys":["id","uri","name"],"Values":["1","uri-a","name-a"]}]}`},
+		`http://localhost/db/_table/xxxget|table_name=xxxget&id=1`,
+		http.StatusOK, `{"Records":[{"Keys":["id","uri","name"],"Values":["1","uri-a","name-a"],"Kind":"KVResponse","Self":"http://localhost/db/_table/xxxget/1"}]}`},
 	{"teardown: delete table xxxget",
 		deleteDbTableHandler,
 		http.MethodDelete,
@@ -1405,19 +1405,19 @@ var getDbRecordsHandler_Tab = []apiCall_TC {
 	{"setup: create db record 1",
 		createDbRecordsHandler,
 		http.MethodPost,
-		`/db/_table/tabname|table_name=xxxget||{"Records":[{"Keys":["name","uri"],"Values":["name-a","uri-a"]}]}`,
+		`/db/_table/xxxget|table_name=xxxget||{"Records":[{"Keys":["name","uri"],"Values":["name-a","uri-a"]}]}`,
 		http.StatusCreated, noCheck},
 	{"setup: create db record 2",
 		createDbRecordsHandler,
 		http.MethodPost,
-		`/db/_table/tabname|table_name=xxxget||{"Records":[{"Keys":["uri","name"],"Values":["uri-b","name-b"]}]}`,
+		`/db/_table/xxxget|table_name=xxxget||{"Records":[{"Keys":["uri","name"],"Values":["uri-b","name-b"]}]}`,
 		http.StatusCreated, noCheck},
 	{"get db records 1,2",
 		getDbRecordsHandler,
 		http.MethodGet,
-		`/db/_table/tabname|table_name=xxxget&ids=1,2`,
+		`http://localhost/db/_table/xxxget|table_name=xxxget|ids=1,2`,
 		http.StatusOK,
-		`{"Records":[{"Keys":["id","uri","name"],"Values":["1","uri-a","name-a"]},{"Keys":["id","uri","name"],"Values":["2","uri-b","name-b"]}]}`},
+		`{"Records":[{"Keys":["id","uri","name"],"Values":["1","uri-a","name-a"],"Kind":"KVResponse","Self":"http://localhost/db/_table/xxxget/1"},{"Keys":["id","uri","name"],"Values":["2","uri-b","name-b"],"Kind":"KVResponse","Self":"http://localhost/db/_table/xxxget/2"}]}`},
 	{"teardown: delete table xxxget",
 		deleteDbTableHandler,
 		http.MethodDelete,

records.go

@@ -13,20 +13,27 @@ type ErrorResponse struct {
 	Message string
 }
 
+// KVRecord represents record data in requests, used in multiple APIs.
+type KVRecord struct {
+	Keys []string
+	Values []interface{}
+}
+
 // BodyRecord is the body data for APIs that create or update database records.
 type BodyRecord struct {
 	Records []KVRecord
 }
 
-// KVRecord represents record data in requests, used in multiple APIs.
-type KVRecord struct {
+type KVResponse struct {
 	Keys []string
 	Values []interface{}
+	Kind string
+	Self string
 }
 
 // RecordsResponse is the type for multiple get*Record* APIs.
 type RecordsResponse struct {
-	Records []*KVRecord
+	Records []*KVResponse
 }
 
 // IdsResponse is the type returned by createDbRecords .