PR: Move panics under must functions & add a linter

shahzadlone · Oct 17, 2024 · 196e54a · 196e54a
1 parent 0a91f2a
commit 196e54a
Show file tree

Hide file tree

Showing 15 changed files with 202 additions and 89 deletions.
diff --git a/cli/p2p_info.go b/cli/p2p_info.go
@@ -12,8 +12,6 @@ package cli
 
 import (
 	"github.com/spf13/cobra"
-
-	"github.com/sourcenetwork/defradb/http"
 )
 
 func MakeP2PInfoCommand() *cobra.Command {
@@ -22,7 +20,7 @@ func MakeP2PInfoCommand() *cobra.Command {
 		Short: "Get peer info from a DefraDB node",
 		Long:  `Get peer info from a DefraDB node`,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			db := cmd.Context().Value(dbContextKey).(*http.Client)
+			db := mustGetContextHTTP(cmd)
 			return writeJSON(cmd, db.PeerInfo())
 		},
 	}

diff --git a/cli/purge.go b/cli/purge.go
@@ -12,8 +12,6 @@ package cli
 
 import (
 	"github.com/spf13/cobra"
-
-	"github.com/sourcenetwork/defradb/http"
 )
 
 func MakePurgeCommand() *cobra.Command {
@@ -24,7 +22,7 @@ func MakePurgeCommand() *cobra.Command {
 		Long: `Delete all persisted data and restart.
 WARNING this operation cannot be reversed.`,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			db := mustGetContextDB(cmd).(*http.Client)
+			db := mustGetContextHTTP(cmd)
 			if !force {
 				return ErrPurgeForceFlagRequired
 			}

diff --git a/cli/utils.go b/cli/utils.go
@@ -60,35 +60,42 @@ const (
 //
 // If a db is not set in the current context this function panics.
 func mustGetContextDB(cmd *cobra.Command) client.DB {
-	return cmd.Context().Value(dbContextKey).(client.DB)
+	return cmd.Context().Value(dbContextKey).(client.DB) //nolint:forcetypeassert
 }
 
 // mustGetContextStore returns the store for the current command context.
 //
 // If a store is not set in the current context this function panics.
 func mustGetContextStore(cmd *cobra.Command) client.Store {
-	return cmd.Context().Value(dbContextKey).(client.Store)
+	return cmd.Context().Value(dbContextKey).(client.Store) //nolint:forcetypeassert
 }
 
 // mustGetContextP2P returns the p2p implementation for the current command context.
 //
 // If a p2p implementation is not set in the current context this function panics.
 func mustGetContextP2P(cmd *cobra.Command) client.P2P {
-	return cmd.Context().Value(dbContextKey).(client.P2P)
+	return cmd.Context().Value(dbContextKey).(client.P2P) //nolint:forcetypeassert
+}
+
+// mustGetContextHTTP returns the http client for the current command context.
+//
+// If http client is not set in the current context this function panics.
+func mustGetContextHTTP(cmd *cobra.Command) *http.Client {
+	return cmd.Context().Value(dbContextKey).(*http.Client) //nolint:forcetypeassert
 }
 
 // mustGetContextConfig returns the config for the current command context.
 //
 // If a config is not set in the current context this function panics.
 func mustGetContextConfig(cmd *cobra.Command) *viper.Viper {
-	return cmd.Context().Value(cfgContextKey).(*viper.Viper)
+	return cmd.Context().Value(cfgContextKey).(*viper.Viper) //nolint:forcetypeassert
 }
 
 // mustGetContextRootDir returns the rootdir for the current command context.
 //
 // If a rootdir is not set in the current context this function panics.
 func mustGetContextRootDir(cmd *cobra.Command) string {
-	return cmd.Context().Value(rootDirContextKey).(string)
+	return cmd.Context().Value(rootDirContextKey).(string) //nolint:forcetypeassert
 }
 
 // tryGetContextCollection returns the collection for the current command context

diff --git a/http/errors.go b/http/errors.go
@@ -29,17 +29,18 @@ const (
 // This list is incomplete. Undefined errors may also be returned.
 // Errors returned from this package may be tested against these errors with errors.Is.
 var (
-	ErrNoListener                = errors.New("cannot serve with no listener")
-	ErrNoEmail                   = errors.New("email address must be specified for tls with autocert")
-	ErrInvalidRequestBody        = errors.New("invalid request body")
-	ErrStreamingNotSupported     = errors.New("streaming not supported")
-	ErrMigrationNotFound         = errors.New("migration not found")
-	ErrMissingRequest            = errors.New("missing request")
-	ErrInvalidTransactionId      = errors.New("invalid transaction id")
-	ErrP2PDisabled               = errors.New("p2p network is disabled")
-	ErrMethodIsNotImplemented    = errors.New(errMethodIsNotImplemented)
-	ErrMissingIdentityPrivateKey = errors.New("identity has no private key")
-	ErrMissingIdentityPublicKey  = errors.New("identity has no public key")
+	ErrNoListener                  = errors.New("cannot serve with no listener")
+	ErrNoEmail                     = errors.New("email address must be specified for tls with autocert")
+	ErrInvalidRequestBody          = errors.New("invalid request body")
+	ErrStreamingNotSupported       = errors.New("streaming not supported")
+	ErrMigrationNotFound           = errors.New("migration not found")
+	ErrMissingRequest              = errors.New("missing request")
+	ErrInvalidTransactionId        = errors.New("invalid transaction id")
+	ErrInvalidDataStoreTransaction = errors.New("invalid datastore transaction")
+	ErrP2PDisabled                 = errors.New("p2p network is disabled")
+	ErrMethodIsNotImplemented      = errors.New(errMethodIsNotImplemented)
+	ErrMissingIdentityPrivateKey   = errors.New("identity has no private key")
+	ErrMissingIdentityPublicKey    = errors.New("identity has no public key")
 )
 
 type errorResponse struct {

diff --git a/http/handler.go b/http/handler.go
@@ -12,7 +12,6 @@ package http
 
 import (
 	"context"
-	"fmt"
 	"net/http"
 	"sync"
 
@@ -100,9 +99,15 @@ func NewHandler(db client.DB) (*Handler, error) {
 func (h *Handler) Transaction(id uint64) (datastore.Txn, error) {
 	tx, ok := h.txs.Load(id)
 	if !ok {
-		return nil, fmt.Errorf("invalid transaction id")
+		return nil, ErrInvalidTransactionId
 	}
-	return tx.(datastore.Txn), nil
+
+	dsTxn, ok := tx.(datastore.Txn)
+	if !ok {
+		return nil, ErrInvalidDataStoreTransaction
+	}
+
+	return dsTxn, nil
 }
 
 func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request) {

diff --git a/http/handler_acp.go b/http/handler_acp.go
@@ -15,14 +15,12 @@ import (
 	"net/http"
 
 	"github.com/getkin/kin-openapi/openapi3"
-
-	"github.com/sourcenetwork/defradb/client"
 )
 
 type acpHandler struct{}
 
 func (s *acpHandler) AddPolicy(rw http.ResponseWriter, req *http.Request) {
-	db := req.Context().Value(dbContextKey).(client.DB)
+	db := mustGetContextClientDB(req)
 
 	policyBytes, err := io.ReadAll(req.Body)
 	if err != nil {
@@ -43,7 +41,7 @@ func (s *acpHandler) AddPolicy(rw http.ResponseWriter, req *http.Request) {
 }
 
 func (s *acpHandler) AddDocActorRelationship(rw http.ResponseWriter, req *http.Request) {
-	db := req.Context().Value(dbContextKey).(client.DB)
+	db := mustGetContextClientDB(req)
 
 	var message addDocActorRelationshipRequest
 	err := requestJSON(req, &message)
@@ -68,7 +66,7 @@ func (s *acpHandler) AddDocActorRelationship(rw http.ResponseWriter, req *http.R
 }
 
 func (s *acpHandler) DeleteDocActorRelationship(rw http.ResponseWriter, req *http.Request) {
-	db := req.Context().Value(dbContextKey).(client.DB)
+	db := mustGetContextClientDB(req)
 
 	var message deleteDocActorRelationshipRequest
 	err := requestJSON(req, &message)

diff --git a/http/handler_ccip.go b/http/handler_ccip.go
@@ -18,8 +18,6 @@ import (
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/go-chi/chi/v5"
-
-	"github.com/sourcenetwork/defradb/client"
 )
 
 type ccipHandler struct{}
@@ -35,7 +33,7 @@ type CCIPResponse struct {
 
 // ExecCCIP handles GraphQL over Cross Chain Interoperability Protocol requests.
 func (c *ccipHandler) ExecCCIP(rw http.ResponseWriter, req *http.Request) {
-	store := req.Context().Value(dbContextKey).(client.Store)
+	store := mustGetContextClientStore(req)
 
 	var ccipReq CCIPRequest
 	switch req.Method {

diff --git a/http/handler_collection.go b/http/handler_collection.go
@@ -40,7 +40,7 @@ type CollectionUpdateRequest struct {
 }
 
 func (s *collectionHandler) Create(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	data, err := io.ReadAll(req.Body)
 	if err != nil {
@@ -89,7 +89,7 @@ func (s *collectionHandler) Create(rw http.ResponseWriter, req *http.Request) {
 }
 
 func (s *collectionHandler) DeleteWithFilter(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	var request CollectionDeleteRequest
 	if err := requestJSON(req, &request); err != nil {
@@ -106,7 +106,7 @@ func (s *collectionHandler) DeleteWithFilter(rw http.ResponseWriter, req *http.R
 }
 
 func (s *collectionHandler) UpdateWithFilter(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	var request CollectionUpdateRequest
 	if err := requestJSON(req, &request); err != nil {
@@ -123,7 +123,7 @@ func (s *collectionHandler) UpdateWithFilter(rw http.ResponseWriter, req *http.R
 }
 
 func (s *collectionHandler) Update(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	docID, err := client.NewDocIDFromString(chi.URLParam(req, "docID"))
 	if err != nil {
@@ -160,7 +160,7 @@ func (s *collectionHandler) Update(rw http.ResponseWriter, req *http.Request) {
 }
 
 func (s *collectionHandler) Delete(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	docID, err := client.NewDocIDFromString(chi.URLParam(req, "docID"))
 	if err != nil {
@@ -177,7 +177,7 @@ func (s *collectionHandler) Delete(rw http.ResponseWriter, req *http.Request) {
 }
 
 func (s *collectionHandler) Get(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 	showDeleted, _ := strconv.ParseBool(req.URL.Query().Get("show_deleted"))
 
 	docID, err := client.NewDocIDFromString(chi.URLParam(req, "docID"))
@@ -211,7 +211,7 @@ type DocIDResult struct {
 }
 
 func (s *collectionHandler) GetAllDocIDs(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	flusher, ok := rw.(http.Flusher)
 	if !ok {
@@ -252,7 +252,7 @@ func (s *collectionHandler) GetAllDocIDs(rw http.ResponseWriter, req *http.Reque
 }
 
 func (s *collectionHandler) CreateIndex(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	var indexDesc client.IndexDescription
 	if err := requestJSON(req, &indexDesc); err != nil {
@@ -268,7 +268,7 @@ func (s *collectionHandler) CreateIndex(rw http.ResponseWriter, req *http.Reques
 }
 
 func (s *collectionHandler) GetIndexes(rw http.ResponseWriter, req *http.Request) {
-	store := req.Context().Value(dbContextKey).(client.Store)
+	store := mustGetContextClientStore(req)
 	indexesMap, err := store.GetAllIndexes(req.Context())
 
 	if err != nil {
@@ -283,7 +283,7 @@ func (s *collectionHandler) GetIndexes(rw http.ResponseWriter, req *http.Request
 }
 
 func (s *collectionHandler) DropIndex(rw http.ResponseWriter, req *http.Request) {
-	col := req.Context().Value(colContextKey).(client.Collection)
+	col := mustGetContextClientCollection(req)
 
 	err := col.DropIndex(req.Context(), chi.URLParam(req, "index"))
 	if err != nil {

diff --git a/http/handler_extras.go b/http/handler_extras.go
@@ -15,15 +15,14 @@ import (
 
 	"github.com/getkin/kin-openapi/openapi3"
 
-	"github.com/sourcenetwork/defradb/client"
 	"github.com/sourcenetwork/defradb/event"
 )
 
 // extrasHandler contains additional http handlers not found in client interfaces.
 type extrasHandler struct{}
 
 func (s *extrasHandler) Purge(rw http.ResponseWriter, req *http.Request) {
-	db := req.Context().Value(dbContextKey).(client.DB)
+	db := mustGetContextClientDB(req)
 	rw.WriteHeader(http.StatusOK) // write the response before we restart to purge
 	db.Events().Publish(event.NewMessage(event.PurgeName, nil))
 }

diff --git a/http/handler_lens.go b/http/handler_lens.go
@@ -15,14 +15,12 @@ import (
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/sourcenetwork/immutable/enumerable"
-
-	"github.com/sourcenetwork/defradb/client"
 )
 
 type lensHandler struct{}
 
 func (s *lensHandler) ReloadLenses(rw http.ResponseWriter, req *http.Request) {
-	store := req.Context().Value(dbContextKey).(client.Store)
+	store := mustGetContextClientStore(req)
 
 	err := store.LensRegistry().ReloadLenses(req.Context())
 	if err != nil {
@@ -33,7 +31,7 @@ func (s *lensHandler) ReloadLenses(rw http.ResponseWriter, req *http.Request) {
 }
 
 func (s *lensHandler) SetMigration(rw http.ResponseWriter, req *http.Request) {
-	store := req.Context().Value(dbContextKey).(client.Store)
+	store := mustGetContextClientStore(req)
 
 	var request setMigrationRequest
 	if err := requestJSON(req, &request); err != nil {
@@ -50,7 +48,7 @@ func (s *lensHandler) SetMigration(rw http.ResponseWriter, req *http.Request) {
 }
 
 func (s *lensHandler) MigrateUp(rw http.ResponseWriter, req *http.Request) {
-	store := req.Context().Value(dbContextKey).(client.Store)
+	store := mustGetContextClientStore(req)
 
 	var request migrateRequest
 	if err := requestJSON(req, &request); err != nil {
@@ -75,7 +73,7 @@ func (s *lensHandler) MigrateUp(rw http.ResponseWriter, req *http.Request) {
 }
 
 func (s *lensHandler) MigrateDown(rw http.ResponseWriter, req *http.Request) {
-	store := req.Context().Value(dbContextKey).(client.Store)
+	store := mustGetContextClientStore(req)
 
 	var request migrateRequest
 	if err := requestJSON(req, &request); err != nil {