PR: Fix all linter gofmt errors for v1.19

sourcenetwork · Feb 2, 2023 · 7eb225b · 7eb225b
1 parent 50566df
commit 7eb225b
Show file tree

Hide file tree

Showing 13 changed files with 98 additions and 78 deletions.
diff --git a/config/config.go b/config/config.go
@@ -39,7 +39,6 @@ How to use, e.g. without using a rootdir:
 	err := cfg.LoadWithoutRootDir()
 	if err != nil {
 		...
-
 */
 package config
 

diff --git a/db/collection.go b/db/collection.go
@@ -886,11 +886,16 @@ func (c *collection) getTxn(ctx context.Context, readonly bool) (datastore.Txn,
 }
 
 // discardImplicitTxn is a proxy function used by the collection to execute the Discard()
-//  transaction function only if its an implicit transaction.
+//
+//	transaction function only if its an implicit transaction.
+//
 // Implicit transactions are transactions that are created *during* an operation
-//  execution as a side effect.
+//
+//	execution as a side effect.
+//
 // Explicit transactions are provided to the collection object via
-//  the "WithTxn(...)" function.
+//
+//	the "WithTxn(...)" function.
 func (c *collection) discardImplicitTxn(ctx context.Context, txn datastore.Txn) {
 	if c.txn == nil {
 		txn.Discard(ctx)

diff --git a/db/collection_delete.go b/db/collection_delete.go
@@ -30,7 +30,9 @@ import (
 )
 
 // DeleteWith deletes a target document. Target can be a Filter statement,
-//  a single docKey, a single document, an array of docKeys, or an array of documents.
+//
+//	a single docKey, a single document, an array of docKeys, or an array of documents.
+//
 // If you want more type safety, use the respective typed versions of Delete.
 // Eg: DeleteWithFilter or DeleteWithKey
 func (c *collection) DeleteWith(
@@ -251,15 +253,17 @@ func newDagDeleter(bstore datastore.DAGStore) dagDeleter {
 }
 
 // Here is what our db stores look like:
-//   /db
-//   -> block /blocks => /db/blocks
-//   -> datastore /data => /db/data
-//   -> headstore /heads => /db/heads
-//   -> systemstore /system => /db/system
+//
+//	/db
+//	-> block /blocks => /db/blocks
+//	-> datastore /data => /db/data
+//	-> headstore /heads => /db/heads
+//	-> systemstore /system => /db/system
+//
 // For the delete operation we are concerned with:
-//   1) Deleting the actual blocks (blockstore).
-//   2) Deleting datastore state.
-//   3) Deleting headstore state.
+//  1. Deleting the actual blocks (blockstore).
+//  2. Deleting datastore state.
+//  3. Deleting headstore state.
 func (c *collection) applyFullDelete(
 	ctx context.Context,
 	txn datastore.Txn, dockey core.PrimaryDataStoreKey) error {
@@ -353,10 +357,11 @@ func (d dagDeleter) run(ctx context.Context, targetCid cid.Cid) error {
 	return d.delete(ctx, targetCid, block)
 }
 
-//  (ipld.Block
-//     (ipldProtobufNode{
-//                       Data: (cbor(crdt deltaPayload)),
-//                       Links: (_head => parentCid, fieldName => fieldCid)))
+// (ipld.Block
+//
+//	(ipldProtobufNode{
+//	                  Data: (cbor(crdt deltaPayload)),
+//	                  Links: (_head => parentCid, fieldName => fieldCid)))
 func (d dagDeleter) delete(
 	ctx context.Context,
 	targetCid cid.Cid,

diff --git a/db/fetcher/versioned.go b/db/fetcher/versioned.go
@@ -38,13 +38,13 @@ var (
 // to a specific version in the documents history graph, and return the fetched
 // state at that point exactly.
 //
-// Given the following Document state graph
+// # Given the following Document state graph
 //
 // {} --> V1 --> V2 --> V3 --> V4
+//
 //		  ^					   ^
 //		  |					   |
-// 	Target Version		 Current State
-//
+//	Target Version		 Current State
 //
 // A regular DocumentFetcher fetches and returns the state at V4, but the
 // VersionsedFetcher would step backwards through the update graph, recompose
@@ -64,11 +64,11 @@ var (
 // the scanNode request planner system.
 //
 // Current limitations:
-// - We can only return a single record from an VersionedFetcher
-// 	 instance.
-// - We can't request related sub objects (at the moment, as related objects
-//   ids aren't in the state graphs.
-// - Probably more...
+//   - We can only return a single record from an VersionedFetcher
+//     instance.
+//   - We can't request related sub objects (at the moment, as related objects
+//     ids aren't in the state graphs.
+//   - Probably more...
 //
 // Future optimizations:
 // - Incremental checkpoint/snapshotting

diff --git a/errors/errors.go b/errors/errors.go
@@ -45,6 +45,7 @@ func NewKV(key string, value any) KV {
 // A stacktrace will be yielded if formatting with a `+`, e.g `fmt.Sprintf("%+v", err)`.
 // This function will not be inlined by the compiler as it will spoil any stacktrace
 // generated.
+//
 //go:noinline
 func New(message string, keyvals ...KV) error {
 	return withStackTrace(message, 1, keyvals...)
@@ -54,6 +55,7 @@ func New(message string, keyvals ...KV) error {
 // the given inner error, suffixing any key-value pairs provided.
 // This function will not be inlined by the compiler as it will spoil any stacktrace
 // generated.
+//
 //go:noinline
 func Wrap(message string, inner error, keyvals ...KV) error {
 	err := withStackTrace(message, 1, keyvals...)
@@ -67,6 +69,7 @@ func Is(err, target error) bool {
 
 // This function will not be inlined by the compiler as it will spoil any stacktrace
 // generated.
+//
 //go:noinline
 func WithStack(err error, keyvals ...KV) error {
 	return withStackTrace(err.Error(), 1, keyvals...)
@@ -79,6 +82,7 @@ func WithStack(err error, keyvals ...KV) error {
 //
 // This function will not be inlined by the compiler as it will spoil any stacktrace
 // generated.
+//
 //go:noinline
 func withStackTrace(message string, depthToSkip int, keyvals ...KV) *defraError {
 	stackBuffer := make([]uintptr, MaxStackDepth)

diff --git a/net/pb/custom.go b/net/pb/custom.go
@@ -77,7 +77,8 @@ func (id ProtoPeerID) Size() int {
 }
 
 // ProtoAddr is a custom type used by gogo to serde raw multiaddresses into
-//  the ma.Multiaddr type, and back.
+//
+//	the ma.Multiaddr type, and back.
 type ProtoAddr struct {
 	ma.Multiaddr
 }

diff --git a/net/server.go b/net/server.go
@@ -265,6 +265,7 @@ func (s *server) addPubSubTopic(dockey string) error {
 }
 
 // removePubSubTopic unsubscribes to a DocKey topic
+//
 //nolint:unused
 func (s *server) removePubSubTopic(dockey string) error {
 	if s.peer.ps == nil {

diff --git a/planner/explain.go b/planner/explain.go
@@ -55,31 +55,33 @@ const (
 // buildSimpleExplainGraph builds the explainGraph from the given top level plan.
 //
 // Request:
-// query @explain {
-//     user {
-//       _key
-//       age
-//       name
-//     }
-// }
 //
-//  Response:
-// {
-//   "data": [
-//     {
-//       "explain": {
-//         "selectTopNode": {
-//           "selectNode": {
-//	           ...
-//             "scanNode": {
-//               ...
-//             }
-//           }
-//         }
-//       }
-//     }
-//   ]
-// }
+//	query @explain {
+//	    user {
+//	      _key
+//	      age
+//	      name
+//	    }
+//	}
+//
+//	Response:
+//
+//	{
+//	  "data": [
+//	    {
+//	      "explain": {
+//	        "selectTopNode": {
+//	          "selectNode": {
+//		           ...
+//	            "scanNode": {
+//	              ...
+//	            }
+//	          }
+//	        }
+//	      }
+//	    }
+//	  ]
+//	}
 func buildSimpleExplainGraph(source planNode) (map[string]any, error) {
 	explainGraph := map[string]any{}
 

diff --git a/planner/group.go b/planner/group.go
@@ -39,8 +39,9 @@ type groupNode struct {
 }
 
 // Creates a new group node.  The function is recursive and will construct the node-chain for any
-//  child (`_group`) collections. `groupSelect` is optional and will typically be nil if the
-//  child `_group` is not requested.
+//
+//	child (`_group`) collections. `groupSelect` is optional and will typically be nil if the
+//	child `_group` is not requested.
 func (p *Planner) GroupBy(n *mapper.GroupBy, parsed *mapper.Select, childSelects []*mapper.Select) (*groupNode, error) {
 	if n == nil {
 		return nil, nil

diff --git a/planner/multi.go b/planner/multi.go
@@ -54,22 +54,22 @@ type appendNode interface {
 // if a single request has multiple Select statements at the
 // same depth in the request.
 // Eg:
-// user {
-//		_key
-// 		name
-// 		friends {
-// 			name
-// 		}
-// 		_version {
-// 			cid
-// 		}
-// }
+//
+//	user {
+//			_key
+//			name
+//			friends {
+//				name
+//			}
+//			_version {
+//				cid
+//			}
+//	}
 //
 // In this example, both the friends selection and the _version
 // selection require their own planNode sub graphs to complete.
 // However, they are entirely independent graphs, so they can
 // be executed in parallel.
-//
 type parallelNode struct { // serialNode?
 	documentIterator
 	docMapper

diff --git a/planner/planner.go b/planner/planner.go
@@ -439,7 +439,8 @@ func walkAndFindPlanType[T planNode](plan planNode) (T, bool) {
 }
 
 // explainRequest walks through the plan graph, and outputs the concrete planNodes that should
-//  be executed, maintaing their order in the plan graph (does not actually execute them).
+//
+//	be executed, maintaing their order in the plan graph (does not actually execute them).
 func (p *Planner) explainRequest(
 	ctx context.Context,
 	plan planNode,

diff --git a/tests/bench/query/simple/utils.go b/tests/bench/query/simple/utils.go
@@ -24,7 +24,7 @@ import (
 )
 
 var (
-//log = logging.MustNewLogger("defra.bench")
+// log = logging.MustNewLogger("defra.bench")
 )
 
 func runQueryBenchGet(

diff --git a/tests/integration/utils.go b/tests/integration/utils.go
@@ -148,19 +148,19 @@ If this is set to true the integration test suite will instead of it's normal pr
 the following:
 
 On [package] Init:
-- Get the (local) latest commit from the target/parent branch // code assumes
-   git fetch has been done
-- Check to see if a clone of that commit/branch is available in the temp dir, and
-   if not clone the target branch
-- Check to see if there are any new .md files in the current branch's data_format_changes
-   dir (vs the target branch)
+  - Get the (local) latest commit from the target/parent branch // code assumes
+    git fetch has been done
+  - Check to see if a clone of that commit/branch is available in the temp dir, and
+    if not clone the target branch
+  - Check to see if there are any new .md files in the current branch's data_format_changes
+    dir (vs the target branch)
 
 For each test:
-- If new documentation detected, pass the test and exit
-- Create a new (test/auto-deleted) temp dir for defra to live/run in
-- Run the test setup (add initial schema, docs, updates) using the target branch (test is skipped
-   if test does not exist in target and is new to this branch)
-- Run the test request and assert results (as per normal tests) using the current branch
+  - If new documentation detected, pass the test and exit
+  - Create a new (test/auto-deleted) temp dir for defra to live/run in
+  - Run the test setup (add initial schema, docs, updates) using the target branch (test is skipped
+    if test does not exist in target and is new to this branch)
+  - Run the test request and assert results (as per normal tests) using the current branch
 */
 var DetectDbChanges bool
 var SetupOnly bool
@@ -222,9 +222,10 @@ func IsDetectingDbChanges() bool {
 }
 
 // AssertPanicAndSkipChangeDetection asserts that the code of function actually panics,
-//  also ensures the change detection is skipped so no false fails happen.
 //
-//  Usage: AssertPanicAndSkipChangeDetection(t, func() { executeTestCase(t, test) })
+//	also ensures the change detection is skipped so no false fails happen.
+//
+//	Usage: AssertPanicAndSkipChangeDetection(t, func() { executeTestCase(t, test) })
 func AssertPanicAndSkipChangeDetection(t *testing.T, f assert.PanicTestFunc) bool {
 	if IsDetectingDbChanges() {
 		// The `assert.Panics` call will falsely fail if this test is executed during