fix: minor adjustments of docs,imports

DoNewsCode · Jan 17, 2022 · 160ea54 · 160ea54
1 parent f2026e4
commit 160ea54
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 24 deletions.
diff --git a/c.go b/c.go
@@ -9,7 +9,6 @@ package core
 import (
 	"context"
 	"fmt"
-	"github.com/spf13/cobra"
 	"reflect"
 
 	"github.com/DoNewsCode/core/codec/yaml"
@@ -22,6 +21,7 @@ import (
 	"github.com/go-kit/log"
 	"github.com/knadh/koanf/providers/confmap"
 	"github.com/knadh/koanf/providers/file"
+	"github.com/spf13/cobra"
 	"go.uber.org/dig"
 )
 
@@ -225,7 +225,7 @@ func (c *C) AddModule(modules ...interface{}) {
 	}
 }
 
-// Provide adds a dependencies provider to the core. Note the dependency provider
+// Provide adds dependencies provider to the core. Note the dependency provider
 // must be a function in the form of:
 //
 //  func(foo Foo) Bar
@@ -385,7 +385,7 @@ func (c *C) Shutdown() {
 	}
 }
 
-// AddModuleFunc add the module after Invoking its' constructor. Clean up
+// AddModuleFunc add the module after Invoking its constructor. Clean up
 // functions and errors are handled automatically.
 func (c *C) AddModuleFunc(constructor interface{}) {
 	c.provide(constructor)

diff --git a/cron/cron.go b/cron/cron.go
@@ -148,20 +148,20 @@ func (c *Cron) Run(ctx context.Context) error {
 				if c.jobDescriptors[0].next.After(now) || c.jobDescriptors[0].next.IsZero() {
 					break
 				}
-				descriptor := heap.Pop(&c.jobDescriptors)
+				descriptor := heap.Pop(&c.jobDescriptors).(*JobDescriptor)
 
-				descriptor.(*JobDescriptor).prev = descriptor.(*JobDescriptor).next
-				descriptor.(*JobDescriptor).next = descriptor.(*JobDescriptor).Schedule.Next(now)
+				descriptor.prev = descriptor.next
+				descriptor.next = descriptor.Schedule.Next(now)
 				heap.Push(&c.jobDescriptors, descriptor)
 
 				var innerCtx context.Context
-				innerCtx = context.WithValue(ctx, prevContextKey, descriptor.(*JobDescriptor).prev)
-				innerCtx = context.WithValue(innerCtx, nextContextKey, descriptor.(*JobDescriptor).next)
+				innerCtx = context.WithValue(ctx, prevContextKey, descriptor.prev)
+				innerCtx = context.WithValue(innerCtx, nextContextKey, descriptor.next)
 
 				c.quitWaiter.Add(1)
 				go func() {
 					defer c.quitWaiter.Done()
-					descriptor.(*JobDescriptor).Run(innerCtx)
+					descriptor.Run(innerCtx)
 				}()
 			}
 			c.lock.L.Unlock()

diff --git a/cron/example_test.go b/cron/example_test.go
@@ -3,11 +3,12 @@ package cron_test
 import (
 	"context"
 	"fmt"
+	"time"
+
 	"github.com/DoNewsCode/core"
 	"github.com/DoNewsCode/core/cron"
 	"github.com/DoNewsCode/core/di"
 	"github.com/DoNewsCode/core/observability"
-	"time"
 )
 
 type CronModule struct {

diff --git a/cron/metrics.go b/cron/metrics.go
@@ -1,16 +1,17 @@
 package cron
 
 import (
-	"github.com/go-kit/kit/metrics"
 	"time"
+
+	"github.com/go-kit/kit/metrics"
 )
 
 // CronJobMetrics collects metrics for cron jobs.
 type CronJobMetrics struct {
 	cronJobDurationSeconds metrics.Histogram
 	cronJobFailCount       metrics.Counter
 
-	// labels that has been set
+	// labels that have been set
 	module   string
 	job      string
 	schedule string

diff --git a/cron/options.go b/cron/options.go
@@ -83,7 +83,7 @@ func WithTracing(tracer opentracing.Tracer) JobOption {
 			span.SetTag("schedule", descriptor.RawSpec)
 			err := innerRun(ctx)
 			if err != nil {
-				ext.Error.Set(span, true)
+				ext.LogError(span, err)
 				return err
 			}
 			return nil

diff --git a/cron/options_test.go b/cron/options_test.go
@@ -4,13 +4,14 @@ import (
 	"bytes"
 	"context"
 	"errors"
+	"strings"
+	"testing"
+	"time"
+
 	"github.com/DoNewsCode/core/internal/stub"
 	"github.com/go-kit/log"
 	"github.com/opentracing/opentracing-go/mocktracer"
 	"github.com/robfig/cron/v3"
-	"strings"
-	"testing"
-	"time"
 )
 
 type mockScheduler func(now time.Time) time.Time // mockScheduler is a function that returns the next time to run

diff --git a/internal/stub/metrics.go b/internal/stub/metrics.go
@@ -1,8 +1,9 @@
 package stub
 
 import (
-	"github.com/go-kit/kit/metrics"
 	"sync"
+
+	"github.com/go-kit/kit/metrics"
 )
 
 // LabelValues contains the set of labels and their corresponding values.

diff --git a/observability/metrics.go b/observability/metrics.go
@@ -54,12 +54,12 @@ func ProvideGRPCRequestDurationSeconds(in MetricsIn) *srvgrpc.RequestDurationSec
 	return srvgrpc.NewRequestDurationSeconds(prometheus.NewHistogram(grpc))
 }
 
-// ProvideCronJobMetrics returns a *deprecated_cronopts.CronJobMetrics that is designed to
+// ProvideCronJobMetrics returns a *cron.CronJobMetrics that is designed to
 // measure cron job metrics. The returned metrics can be used like this:
-//  metrics := deprecated_cronopts.NewCronJobMetrics(...)
+//  metrics := cron.NewCronJobMetrics(...)
 //  job := cron.NewChain(
 //  	cron.Recover(logger),
-//  	deprecated_cronopts.Measure(metrics),
+//  	cron.Measure(metrics),
 //	).Then(job)
 func ProvideCronJobMetrics(in MetricsIn) *cron.CronJobMetrics {
 	histogram := stdprometheus.NewHistogramVec(stdprometheus.HistogramOpts{

diff --git a/serve_test.go b/serve_test.go
@@ -4,19 +4,19 @@ import (
 	"bytes"
 	"context"
 	"errors"
-	"github.com/DoNewsCode/core/cron"
-	"github.com/DoNewsCode/core/di"
-	"github.com/DoNewsCode/core/observability"
-	deprecatedcron "github.com/robfig/cron/v3"
 	"os"
 	"runtime"
 	"sync/atomic"
 	"testing"
 	"time"
 
+	"github.com/DoNewsCode/core/cron"
+	"github.com/DoNewsCode/core/di"
 	"github.com/DoNewsCode/core/logging"
+	"github.com/DoNewsCode/core/observability"
 	"github.com/go-kit/log"
 	"github.com/oklog/run"
+	deprecatedcron "github.com/robfig/cron/v3"
 	"github.com/stretchr/testify/assert"
 )