Reorganize the webUI and API code

Included in the changes: - create a new /api root package to hold all API code, migrate /graphql in there - git API handlers all use the cache instead of the repo directly - git API handlers are now tested - git API handlers now require a "repo" mux parameter - lots of untangling of API/handlers/middleware - less code in commands/webui.go
MichaelMure · Jun 27, 2020 · 2ab6381 · 2ab6381
1 parent 5f72b04
commit 2ab6381
Show file tree

Hide file tree

Showing 54 changed files with 472 additions and 309 deletions.
diff --git a/README.md b/README.md
@@ -174,7 +174,7 @@ You can launch a rich Web UI with `git bug webui`.
 
 This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
 
-The web UI interact with the backend through a GraphQL API. The schema is available [here](graphql/).
+The web UI interact with the backend through a GraphQL API. The schema is available [here](api/graphql/schema).
 
 ## Bridges
 

diff --git a/api/auth/context.go b/api/auth/context.go
@@ -0,0 +1,28 @@
+// Package auth contains helpers for managing identities within the GraphQL API.
+package auth
+
+import (
+	"context"
+
+	"github.com/MichaelMure/git-bug/cache"
+	"github.com/MichaelMure/git-bug/entity"
+)
+
+// identityCtxKey is a unique context key, accessible only in this package.
+var identityCtxKey = &struct{}{}
+
+// CtxWithUser attaches an Identity to a context.
+func CtxWithUser(ctx context.Context, userId entity.Id) context.Context {
+	return context.WithValue(ctx, identityCtxKey, userId)
+}
+
+// UserFromCtx retrieves an IdentityCache from the context.
+// If there is no identity in the context, ErrNotAuthenticated is returned.
+// If an error occurs while resolving the identity (e.g. I/O error), then it will be returned.
+func UserFromCtx(ctx context.Context, r *cache.RepoCache) (*cache.IdentityCache, error) {
+	id, ok := ctx.Value(identityCtxKey).(entity.Id)
+	if !ok {
+		return nil, ErrNotAuthenticated
+	}
+	return r.ResolveIdentity(id)
+}
diff --git a/graphql/graphqlidentity/errors.go → api/auth/errors.go b/graphql/graphqlidentity/errors.go → api/auth/errors.go
@@ -1,4 +1,4 @@
-package graphqlidentity
+package auth
 
 import "errors"
 

diff --git a/api/auth/middleware.go b/api/auth/middleware.go
@@ -0,0 +1,16 @@
+package auth
+
+import (
+	"net/http"
+
+	"github.com/MichaelMure/git-bug/entity"
+)
+
+func Middleware(fixedUserId entity.Id) func(http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			ctx := CtxWithUser(r.Context(), fixedUserId)
+			next.ServeHTTP(w, r.WithContext(ctx))
+		})
+	}
+}
diff --git a/graphql/connections/connection_template.go → ...raphql/connections/connection_template.go b/graphql/connections/connection_template.go → ...raphql/connections/connection_template.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/cheekybits/genny/generic"
 
-	"github.com/MichaelMure/git-bug/graphql/models"
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 )
 
 // Name define the name of the connection

diff --git a/graphql/connections/connections.go → api/graphql/connections/connections.go b/graphql/connections/connections.go → api/graphql/connections/connections.go
diff --git a/graphql/connections/edges.go → api/graphql/connections/edges.go b/graphql/connections/edges.go → api/graphql/connections/edges.go
diff --git a/graphql/connections/gen_comment.go → api/graphql/connections/gen_comment.go b/graphql/connections/gen_comment.go → api/graphql/connections/gen_comment.go
@@ -7,8 +7,8 @@ package connections
 import (
 	"fmt"
 
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/bug"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 // BugCommentEdgeMaker define a function that take a bug.Comment and an offset and

diff --git a/graphql/connections/gen_identity.go → api/graphql/connections/gen_identity.go b/graphql/connections/gen_identity.go → api/graphql/connections/gen_identity.go
@@ -7,7 +7,7 @@ package connections
 import (
 	"fmt"
 
-	"github.com/MichaelMure/git-bug/graphql/models"
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 )
 
 // ModelsIdentityWrapperEdgeMaker define a function that take a models.IdentityWrapper and an offset and

diff --git a/graphql/connections/gen_label.go → api/graphql/connections/gen_label.go b/graphql/connections/gen_label.go → api/graphql/connections/gen_label.go
@@ -7,8 +7,8 @@ package connections
 import (
 	"fmt"
 
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/bug"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 // BugLabelEdgeMaker define a function that take a bug.Label and an offset and

diff --git a/graphql/connections/gen_lazy_bug.go → api/graphql/connections/gen_lazy_bug.go b/graphql/connections/gen_lazy_bug.go → api/graphql/connections/gen_lazy_bug.go
@@ -7,8 +7,8 @@ package connections
 import (
 	"fmt"
 
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/entity"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 // EntityIdEdgeMaker define a function that take a entity.Id and an offset and

diff --git a/graphql/connections/gen_lazy_identity.go → api/graphql/connections/gen_lazy_identity.go b/graphql/connections/gen_lazy_identity.go → api/graphql/connections/gen_lazy_identity.go
@@ -7,8 +7,8 @@ package connections
 import (
 	"fmt"
 
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/entity"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 // EntityIdEdgeMaker define a function that take a entity.Id and an offset and

diff --git a/graphql/connections/gen_operation.go → api/graphql/connections/gen_operation.go b/graphql/connections/gen_operation.go → api/graphql/connections/gen_operation.go
@@ -7,8 +7,8 @@ package connections
 import (
 	"fmt"
 
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/bug"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 // BugOperationEdgeMaker define a function that take a bug.Operation and an offset and

diff --git a/graphql/connections/gen_timeline.go → api/graphql/connections/gen_timeline.go b/graphql/connections/gen_timeline.go → api/graphql/connections/gen_timeline.go
@@ -7,8 +7,8 @@ package connections
 import (
 	"fmt"
 
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/bug"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 // BugTimelineItemEdgeMaker define a function that take a bug.TimelineItem and an offset and

diff --git a/graphql/gen_graphql.go → api/graphql/gen_graphql.go b/graphql/gen_graphql.go → api/graphql/gen_graphql.go
diff --git a/graphql/gqlgen.yml → api/graphql/gqlgen.yml b/graphql/gqlgen.yml → api/graphql/gqlgen.yml
diff --git a/graphql/graph/gen_graph.go → api/graphql/graph/gen_graph.go b/graphql/graph/gen_graph.go → api/graphql/graph/gen_graph.go
diff --git a/graphql/graphql_test.go → api/graphql/graphql_test.go b/graphql/graphql_test.go → api/graphql/graphql_test.go
@@ -4,8 +4,11 @@ import (
 	"testing"
 
 	"github.com/99designs/gqlgen/client"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 
-	"github.com/MichaelMure/git-bug/graphql/models"
+	"github.com/MichaelMure/git-bug/api/graphql/models"
+	"github.com/MichaelMure/git-bug/cache"
 	"github.com/MichaelMure/git-bug/misc/random_bugs"
 	"github.com/MichaelMure/git-bug/repository"
 )
@@ -16,10 +19,11 @@ func TestQueries(t *testing.T) {
 
 	random_bugs.FillRepoWithSeed(repo, 10, 42)
 
-	handler, err := NewHandler(repo)
-	if err != nil {
-		t.Fatal(err)
-	}
+	mrc := cache.NewMultiRepoCache()
+	_, err := mrc.RegisterDefaultRepository(repo)
+	require.NoError(t, err)
+
+	handler := NewHandler(mrc)
 
 	c := client.New(handler)
 
@@ -211,5 +215,6 @@ func TestQueries(t *testing.T) {
 		}
 	}
 
-	c.MustPost(query, &resp)
+	err = c.Post(query, &resp)
+	assert.NoError(t, err)
 }
diff --git a/api/graphql/handler.go b/api/graphql/handler.go
@@ -0,0 +1,32 @@
+//go:generate go run gen_graphql.go
+
+// Package graphql contains the root GraphQL http handler
+package graphql
+
+import (
+	"io"
+	"net/http"
+
+	"github.com/99designs/gqlgen/graphql/handler"
+
+	"github.com/MichaelMure/git-bug/api/graphql/graph"
+	"github.com/MichaelMure/git-bug/api/graphql/resolvers"
+	"github.com/MichaelMure/git-bug/cache"
+)
+
+// Handler is the root GraphQL http handler
+type Handler struct {
+	http.Handler
+	io.Closer
+}
+
+func NewHandler(mrc *cache.MultiRepoCache) Handler {
+	rootResolver := resolvers.NewRootResolver(mrc)
+	config := graph.Config{Resolvers: rootResolver}
+	h := handler.NewDefaultServer(graph.NewExecutableSchema(config))
+
+	return Handler{
+		Handler: h,
+		Closer:  rootResolver,
+	}
+}
diff --git a/graphql/models/edges.go → api/graphql/models/edges.go b/graphql/models/edges.go → api/graphql/models/edges.go
diff --git a/graphql/models/gen_models.go → api/graphql/models/gen_models.go b/graphql/models/gen_models.go → api/graphql/models/gen_models.go
diff --git a/graphql/models/lazy_bug.go → api/graphql/models/lazy_bug.go b/graphql/models/lazy_bug.go → api/graphql/models/lazy_bug.go
diff --git a/graphql/models/lazy_identity.go → api/graphql/models/lazy_identity.go b/graphql/models/lazy_identity.go → api/graphql/models/lazy_identity.go
diff --git a/graphql/models/models.go → api/graphql/models/models.go b/graphql/models/models.go → api/graphql/models/models.go
diff --git a/graphql/resolvers/bug.go → api/graphql/resolvers/bug.go b/graphql/resolvers/bug.go → api/graphql/resolvers/bug.go
@@ -3,10 +3,10 @@ package resolvers
 import (
 	"context"
 
+	"github.com/MichaelMure/git-bug/api/graphql/connections"
+	"github.com/MichaelMure/git-bug/api/graphql/graph"
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/bug"
-	"github.com/MichaelMure/git-bug/graphql/connections"
-	"github.com/MichaelMure/git-bug/graphql/graph"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 var _ graph.BugResolver = &bugResolver{}

diff --git a/graphql/resolvers/color.go → api/graphql/resolvers/color.go b/graphql/resolvers/color.go → api/graphql/resolvers/color.go
@@ -4,7 +4,7 @@ import (
 	"context"
 	"image/color"
 
-	"github.com/MichaelMure/git-bug/graphql/graph"
+	"github.com/MichaelMure/git-bug/api/graphql/graph"
 )
 
 var _ graph.ColorResolver = &colorResolver{}

diff --git a/graphql/resolvers/comment.go → api/graphql/resolvers/comment.go b/graphql/resolvers/comment.go → api/graphql/resolvers/comment.go
@@ -3,9 +3,9 @@ package resolvers
 import (
 	"context"
 
+	"github.com/MichaelMure/git-bug/api/graphql/graph"
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/bug"
-	"github.com/MichaelMure/git-bug/graphql/graph"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 var _ graph.CommentResolver = &commentResolver{}

diff --git a/graphql/resolvers/identity.go → api/graphql/resolvers/identity.go b/graphql/resolvers/identity.go → api/graphql/resolvers/identity.go
@@ -3,8 +3,8 @@ package resolvers
 import (
 	"context"
 
-	"github.com/MichaelMure/git-bug/graphql/graph"
-	"github.com/MichaelMure/git-bug/graphql/models"
+	"github.com/MichaelMure/git-bug/api/graphql/graph"
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 )
 
 var _ graph.IdentityResolver = &identityResolver{}

diff --git a/graphql/resolvers/label.go → api/graphql/resolvers/label.go b/graphql/resolvers/label.go → api/graphql/resolvers/label.go
@@ -5,9 +5,9 @@ import (
 	"fmt"
 	"image/color"
 
+	"github.com/MichaelMure/git-bug/api/graphql/graph"
+	"github.com/MichaelMure/git-bug/api/graphql/models"
 	"github.com/MichaelMure/git-bug/bug"
-	"github.com/MichaelMure/git-bug/graphql/graph"
-	"github.com/MichaelMure/git-bug/graphql/models"
 )
 
 var _ graph.LabelResolver = &labelResolver{}