Fix tests and golint warnings (hypermodeinc#79)

mangalaman93 · web-flow · commit 28677e95a993 · 2019-08-23T07:24:16.000+05:30
diff --git a/client.go b/client.go
@@ -29,19 +29,18 @@ import (
 	"google.golang.org/grpc/status"
 )
 
-// Dgraph is a transaction aware client to a set of dgraph server instances.
+// Dgraph is a transaction aware client to a set of Dgraph server instances.
 type Dgraph struct {
 	jwtMutex sync.RWMutex
 	jwt      api.Jwt
 	dc       []api.DgraphClient
 }
 
-// NewDgraphClient creates a new Dgraph for interacting with the Dgraph store connected to in
-// conns.
-// The client can be backed by multiple connections (to the same server, or multiple servers in a
-// cluster).
+// NewDgraphClient creates a new Dgraph (client) for interacting with Alphas.
+// The client is backed by multiple connections to the same or different
+// servers in a cluster.
 //
-// A single client is thread safe for sharing with multiple go routines.
+// A single Dgraph (client) is thread safe for sharing with multiple goroutines.
 func NewDgraphClient(clients ...api.DgraphClient) *Dgraph {
 	dg := &Dgraph{
 		dc: clients,
@@ -50,6 +49,8 @@ func NewDgraphClient(clients ...api.DgraphClient) *Dgraph {
 	return dg
 }
 
+// Login logs in the current client using the provided credentials.
+// Valid for the duration the client is alive.
 func (d *Dgraph) Login(ctx context.Context, userid string, password string) error {
 	d.jwtMutex.Lock()
 	defer d.jwtMutex.Unlock()
@@ -67,6 +68,29 @@ func (d *Dgraph) Login(ctx context.Context, userid string, password string) erro
 	return d.jwt.Unmarshal(resp.Json)
 }
 
+// Alter can be used to do the following by setting various fields of api.Operation:
+//   1. Modify the schema.
+//   2. Drop a predicate.
+//   3. Drop the database.
+func (d *Dgraph) Alter(ctx context.Context, op *api.Operation) error {
+	dc := d.anyClient()
+
+	ctx = d.getContext(ctx)
+	_, err := dc.Alter(ctx, op)
+
+	if isJwtExpired(err) {
+		err = d.retryLogin(ctx)
+		if err != nil {
+			return err
+		}
+
+		ctx = d.getContext(ctx)
+		_, err = dc.Alter(ctx, op)
+	}
+
+	return err
+}
+
 func (d *Dgraph) retryLogin(ctx context.Context) error {
 	d.jwtMutex.Lock()
 	defer d.jwtMutex.Unlock()
@@ -83,52 +107,29 @@ func (d *Dgraph) retryLogin(ctx context.Context) error {
 	if err != nil {
 		return err
 	}
+
 	return d.jwt.Unmarshal(resp.Json)
 }
 
 func (d *Dgraph) getContext(ctx context.Context) context.Context {
 	d.jwtMutex.RLock()
 	defer d.jwtMutex.RUnlock()
+
 	if len(d.jwt.AccessJwt) > 0 {
 		md, ok := metadata.FromOutgoingContext(ctx)
 		if !ok {
 			// no metadata key is in the context, add one
 			md = metadata.New(nil)
 		}
+
 		md.Set("accessJwt", d.jwt.AccessJwt)
 		return metadata.NewOutgoingContext(ctx, md)
 	}
 
 	return ctx
 }
 
-// By setting various fields of api.Operation, Alter can be used to do the
-// following:
-//
-// 1. Modify the schema.
-//
-// 2. Drop a predicate.
-//
-// 3. Drop the database.
-func (d *Dgraph) Alter(ctx context.Context, op *api.Operation) error {
-	dc := d.anyClient()
-
-	ctx = d.getContext(ctx)
-	_, err := dc.Alter(ctx, op)
-
-	if isJwtExpired(err) {
-		err = d.retryLogin(ctx)
-		if err != nil {
-			return err
-		}
-		ctx = d.getContext(ctx)
-		_, err = dc.Alter(ctx, op)
-	}
-
-	return err
-}
-
-// isJwtExpired returns true if the error indicates that the jwt has expired
+// isJwtExpired returns true if the error indicates that the jwt has expired.
 func isJwtExpired(err error) bool {
 	if err == nil {
 		return false
@@ -143,10 +144,10 @@ func (d *Dgraph) anyClient() api.DgraphClient {
 	return d.dc[rand.Intn(len(d.dc))]
 }
 
-// DeleteEdges sets the edges corresponding to predicates on the node with the given uid
-// for deletion.
-// This helper function doesn't run the mutation on the server. It must be done by the user
-// after the function returns.
+// DeleteEdges sets the edges corresponding to predicates
+// on the node with the given uid for deletion.
+// This helper function doesn't run the mutation on the server.
+// Txn needs to be committed in order to execute the mutation.
 func DeleteEdges(mu *api.Mutation, uid string, predicates ...string) {
 	for _, predicate := range predicates {
 		mu.Del = append(mu.Del, &api.NQuad{
diff --git a/doc.go b/doc.go
@@ -14,10 +14,6 @@
  * limitations under the License.
  */
 
-/*
-
-Package dgo is used to interact with a Dgraph server. Queries, mutations,
-and most other types of admin tasks can be run from the client.
-
-*/
+// Package dgo is used to interact with a Dgraph server. Queries, mutations,
+// and most other types of admin tasks can be run from the client.
 package dgo
diff --git a/example_set_object_test.go b/example_set_object_test.go
@@ -52,6 +52,7 @@ func Example_setObject() {
 	// In the example below new nodes for Alice, Bob and Charlie and school are created (since they
 	// dont have a Uid).
 	p := Person{
+		Uid:     "_:alice",
 		Name:    "Alice",
 		Age:     26,
 		Married: true,
@@ -103,9 +104,9 @@ func Example_setObject() {
 	}
 
 	// Assigned uids for nodes which were created would be returned in the assigned.Uids map.
-	variables := map[string]string{"$id": assigned.Uids["blank-0"]}
-	q := `query Me($id: string){
-		me(func: uid($id)) {
+	variables := map[string]string{"$id1": assigned.Uids["alice"]}
+	q := `query Me($id1: string){
+		me(func: uid($id1)) {
 			name
 			dob
 			age
diff --git a/examples_test.go b/examples_test.go
@@ -168,6 +168,7 @@ func ExampleTxn_Mutate() {
 	// In the example below new nodes for Alice, Bob and Charlie and school are created (since they
 	// don't have a Uid).
 	p := Person{
+		Uid:     "_:alice",
 		Name:    "Alice",
 		Age:     26,
 		Married: true,
@@ -214,7 +215,7 @@ func ExampleTxn_Mutate() {
 	}
 
 	// Assigned uids for nodes which were created would be returned in the assigned.Uids map.
-	puid := assigned.Uids["blank-0"]
+	puid := assigned.Uids["alice"]
 	const q = `query Me($id: string){
 		me(func: uid($id)) {
 			name
@@ -352,6 +353,7 @@ func ExampleTxn_Query_unmarshal() {
 	}
 
 	p := Person{
+		Uid:  "_:bob",
 		Name: "Bob",
 		Age:  24,
 	}
@@ -370,13 +372,14 @@ func ExampleTxn_Query_unmarshal() {
 	if err != nil {
 		log.Fatal(err)
 	}
-	bob := assigned.Uids["blank-0"]
+	bob := assigned.Uids["bob"]
 
 	// While setting an object if a struct has a Uid then its properties in the graph are updated
 	// else a new node is created.
 	// In the example below new nodes for Alice and Charlie and school are created (since they dont
 	// have a Uid).  Alice is also connected via the friend edge to an existing node Bob.
 	p = Person{
+		Uid:     "_:alice",
 		Name:    "Alice",
 		Age:     26,
 		Married: true,
@@ -407,7 +410,7 @@ func ExampleTxn_Query_unmarshal() {
 	}
 
 	// Assigned uids for nodes which were created would be returned in the assigned.Uids map.
-	puid := assigned.Uids["blank-0"]
+	puid := assigned.Uids["alice"]
 	variables := make(map[string]string)
 	variables["$id"] = puid
 	const q = `query Me($id: string){
@@ -489,6 +492,7 @@ func ExampleTxn_Mutate_facets() {
 	}
 
 	type Person struct {
+		Uid        string   `json:"uid,omitempty"`
 		Name       string   `json:"name,omitempty"`
 		NameOrigin string   `json:"name|origin,omitempty"`
 		Friends    []Person `json:"friend,omitempty"`
@@ -504,6 +508,7 @@ func ExampleTxn_Mutate_facets() {
 
 	ti := time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC)
 	p := Person{
+		Uid:        "_:alice",
 		Name:       "Alice",
 		NameOrigin: "Indonesia",
 		Friends: []Person{
@@ -539,7 +544,7 @@ func ExampleTxn_Mutate_facets() {
 		log.Fatal(err)
 	}
 
-	auid := assigned.Uids["blank-0"]
+	auid := assigned.Uids["alice"]
 	variables := make(map[string]string)
 	variables["$id"] = auid
 
@@ -572,7 +577,7 @@ func ExampleTxn_Mutate_facets() {
 	}
 
 	fmt.Printf("Me: %+v\n", r.Me)
-	// Output: Me: [{Name:Alice NameOrigin:Indonesia Friends:[{Name:Bob NameOrigin: Friends:[] Since:2009-11-10 23:00:00 +0000 UTC Family:yes Age:13 Close:true School:[]}] Since:0001-01-01 00:00:00 +0000 UTC Family: Age:0 Close:false School:[{Name:Wellington School Since:2009-11-10 23:00:00 +0000 UTC}]}]
+	// Output: Me: [{Uid: Name:Alice NameOrigin:Indonesia Friends:[{Uid: Name:Bob NameOrigin: Friends:[] Since:2009-11-10 23:00:00 +0000 UTC Family:yes Age:13 Close:true School:[]}] Since:0001-01-01 00:00:00 +0000 UTC Family: Age:0 Close:false School:[{Name:Wellington School Since:2009-11-10 23:00:00 +0000 UTC}]}]
 }
 
 func ExampleTxn_Mutate_list() {
@@ -678,6 +683,7 @@ func ExampleDeleteEdges() {
 
 	// Lets add some data first.
 	p := Person{
+		Uid:      "_:alice",
 		Name:     "Alice",
 		Age:      26,
 		Married:  true,
@@ -708,7 +714,7 @@ func ExampleDeleteEdges() {
 		log.Fatal(err)
 	}
 
-	alice := assigned.Uids["blank-0"]
+	alice := assigned.Uids["alice"]
 
 	variables := make(map[string]string)
 	variables["$alice"] = alice
@@ -772,14 +778,17 @@ func ExampleTxn_Mutate_deleteNode() {
 	}
 
 	p := Person{
+		Uid:        "_:alice",
 		Name:       "Alice",
 		Age:        26,
 		Married:    true,
 		DgraphType: "Person",
 		Friends: []*Person{&Person{
+			Uid:  "_:bob",
 			Name: "Bob",
 			Age:  24,
 		}, &Person{
+			Uid:  "_:charlie",
 			Name: "Charlie",
 			Age:  29,
 		}},
@@ -817,9 +826,9 @@ func ExampleTxn_Mutate_deleteNode() {
 		log.Fatal(err)
 	}
 
-	alice := assigned.Uids["blank-0"]
-	bob := assigned.Uids["blank-1"]
-	charlie := assigned.Uids["blank-2"]
+	alice := assigned.Uids["alice"]
+	bob := assigned.Uids["bob"]
+	charlie := assigned.Uids["charlie"]
 
 	variables := make(map[string]string)
 	variables["$alice"] = alice
@@ -910,6 +919,7 @@ func ExampleTxn_Mutate_deletePredicate() {
 	}
 
 	p := Person{
+		Uid:     "_:alice",
 		Name:    "Alice",
 		Age:     26,
 		Married: true,
@@ -948,7 +958,7 @@ func ExampleTxn_Mutate_deletePredicate() {
 		log.Fatal(err)
 	}
 
-	alice := assigned.Uids["blank-0"]
+	alice := assigned.Uids["alice"]
 
 	variables := make(map[string]string)
 	variables["$id"] = alice
diff --git a/txn.go b/txn.go
diff --git a/y/y.go b/y/y.go
