feedx 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1978c7def650e2a2630e36fc0bfc59b9eb66c5ead0f7dda9cc83e773a85c1d8
-  data.tar.gz: 548208072baf9e6f84a7541df5e8a22a5960982007bce4385c7fa538e0290e94
+  metadata.gz: 3586f5580c4f0379b966d324df5dee69f2463ad516842194baf180ee222aad3a
+  data.tar.gz: '090b0c6828614705ddefa87d9966ff94ca7a61bab334ad891b2df5850f2100f1'
 SHA512:
-  metadata.gz: a5b0be41feeafabbffcbbda6ccc1b12df4d24b8d9a9f03f4b8d04ce2fec7b644b99f15db98e67a79294dca1c3b56c072a67ab20b8cbffaed25ec502e74de9ca2
-  data.tar.gz: d3434d54accaf281ec5e06e25753de74a052d1386a63badf97ff8bfa8a1426162528d8256cbd288969ef1c348d24cf9358c0827b4c7b1af500c71e5349900b63
+  metadata.gz: b35993b35880d79d869fb12d2eed818edc675c0a23ea75ea49af8c488c3ca97bbb71812d50dffbb823ad4a0d437e1108629838c658f30ffe2587358902eb4b5b
+  data.tar.gz: 801a0aee9a0899215ab80ba379d8c08956a477cea9179be86dd44e5f140feec5d459e75a230c1d28b0b4b0c2c3719bffacf141abacd02610623c46c47f4a68dc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    feedx (0.14.0)
+    feedx (0.15.0)
       bfs (>= 0.8.0)
 
 GEM
@@ -55,9 +55,9 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.7.0)
+    rubocop-rspec (3.8.0)
       lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)

data/consumer.go

@@ -9,7 +9,7 @@ import (
 )
 
 // ConsumeFunc is a callback invoked by consumers.
-type ConsumeFunc func(context.Context, *Reader) error
+type ConsumeFunc func(*Reader) error
 
 // Consumer manages data retrieval from a remote feed.
 // It queries the feed in regular intervals, continuously retrieving new updates.
@@ -106,7 +106,7 @@ func (c *consumer) Consume(ctx context.Context, opt *ReaderOptions, fn ConsumeFu
 	defer reader.Close()
 
 	// consume feed
-	if err := fn(ctx, reader); err != nil {
+	if err := fn(reader); err != nil {
 		return nil, err
 	}
 

data/consumer_test.go

@@ -1,7 +1,6 @@
 package feedx_test
 
 import (
-	"context"
 	"reflect"
 	"testing"
 
@@ -134,7 +133,7 @@ func fixIncrementalConsumer(t *testing.T, version int64) feedx.Consumer {
 func testConsume(t *testing.T, csm feedx.Consumer, exp *feedx.Status) (msgs []*testdata.MockMessage) {
 	t.Helper()
 
-	status, err := csm.Consume(t.Context(), nil, func(ctx context.Context, r *feedx.Reader) (err error) {
+	status, err := csm.Consume(t.Context(), nil, func(r *feedx.Reader) (err error) {
 		msgs, err = readMessages(r)
 		return err
 	})

data/example_test.go

@@ -43,7 +43,7 @@ func Example() {
 
 	// consume data
 	var msgs []*message
-	status, err = csm.Consume(context.TODO(), nil, func(ctx context.Context, r *feedx.Reader) error {
+	status, err = csm.Consume(context.TODO(), nil, func(r *feedx.Reader) error {
 		for {
 			var msg message
 			if err := r.Decode(&msg); err != nil {
@@ -81,7 +81,7 @@ func ExampleScheduler_Consume() {
 	csm := feedx.NewConsumerForRemote(obj)
 	defer csm.Close()
 
-	job := feedx.Every(time.Hour).
+	job, err := feedx.Every(time.Hour).
 		WithContext(ctx).
 		BeforeSync(func(_ int64) bool {
 			fmt.Println("1. Before sync")
@@ -90,10 +90,14 @@ func ExampleScheduler_Consume() {
 		AfterSync(func(_ *feedx.Status, err error) {
 			fmt.Printf("3. After sync - error:%v", err)
 		}).
-		Consume(csm, func(_ context.Context, _ *feedx.Reader) error {
+		Consume(csm, func(_ *feedx.Reader) error {
 			fmt.Println("2. Consuming feed")
 			return nil
 		})
+	if err != nil {
+		panic(err)
+	}
+
 	job.Stop()
 
 	// Output:
@@ -113,7 +117,7 @@ func ExampleScheduler_Produce() {
 	pcr := feedx.NewProducerForRemote(obj)
 	defer pcr.Close()
 
-	job := feedx.Every(time.Hour).
+	job, err := feedx.Every(time.Hour).
 		WithContext(ctx).
 		BeforeSync(func(_ int64) bool {
 			fmt.Println("2. Before sync")
@@ -130,6 +134,10 @@ func ExampleScheduler_Produce() {
 			fmt.Println("3. Producing feed")
 			return nil
 		})
+	if err != nil {
+		panic(err)
+	}
+
 	job.Stop()
 
 	// Output:

data/feedx.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'feedx'
-  s.version       = '0.14.0'
+  s.version       = '0.15.0'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
   s.summary       = %(Exchange data between components via feeds)

data/scheduler.go

@@ -60,15 +60,16 @@ func (s *Scheduler) WithReaderOptions(opt *ReaderOptions) *Scheduler {
 }
 
 // Consume starts a consumer job.
-func (s *Scheduler) Consume(csm Consumer, cfn ConsumeFunc) *CronJob {
-	return newCronJob(s.ctx, s.interval, func(ctx context.Context) {
+func (s *Scheduler) Consume(csm Consumer, cfn ConsumeFunc) (*CronJob, error) {
+	return newCronJob(s.ctx, s.interval, func(ctx context.Context) error {
 		version := csm.Version()
 		if !s.runBeforeHooks(version) {
-			return
+			return nil
 		}
 
 		status, err := csm.Consume(ctx, s.readerOpt, cfn)
 		s.runAfterHooks(status, err)
+		return err
 	})
 }
 
@@ -85,36 +86,38 @@ func (s *Scheduler) WithVersionCheck(fn VersionCheck) *Scheduler {
 }
 
 // Produce starts a producer job.
-func (s *Scheduler) Produce(pcr *Producer, pfn ProduceFunc) *CronJob {
+func (s *Scheduler) Produce(pcr *Producer, pfn ProduceFunc) (*CronJob, error) {
 	return s.produce(func(ctx context.Context, version int64) (*Status, error) {
 		return pcr.Produce(ctx, version, s.writerOpt, pfn)
 	})
 }
 
 // ProduceIncrementally starts an incremental producer job.
-func (s *Scheduler) ProduceIncrementally(pcr *IncrementalProducer, pfn IncrementalProduceFunc) *CronJob {
+func (s *Scheduler) ProduceIncrementally(pcr *IncrementalProducer, pfn IncrementalProduceFunc) (*CronJob, error) {
 	return s.produce(func(ctx context.Context, version int64) (*Status, error) {
 		return pcr.Produce(ctx, version, s.writerOpt, pfn)
 	})
 }
 
-func (s *Scheduler) produce(fn func(context.Context, int64) (*Status, error)) *CronJob {
-	return newCronJob(s.ctx, s.interval, func(ctx context.Context) {
+func (s *Scheduler) produce(fn func(context.Context, int64) (*Status, error)) (*CronJob, error) {
+	return newCronJob(s.ctx, s.interval, func(ctx context.Context) error {
 		var version int64
 		if s.versionCheck != nil {
 			latest, err := s.versionCheck(s.ctx)
 			if err != nil {
-				return
+				s.runAfterHooks(nil, err)
+				return err
 			}
 			version = latest
 		}
 
 		if !s.runBeforeHooks(version) {
-			return
+			return nil
 		}
 
 		status, err := fn(ctx, version)
 		s.runAfterHooks(status, err)
+		return err
 	})
 }
 
@@ -135,22 +138,21 @@ func (s *Scheduler) runAfterHooks(status *Status, err error) {
 
 // CronJob runs in regular intervals until it's stopped.
 type CronJob struct {
-	ctx      context.Context
 	cancel   context.CancelFunc
 	interval time.Duration
-	perform  func(context.Context)
+	perform  func(context.Context) error
 	wait     sync.WaitGroup
 }
 
-func newCronJob(ctx context.Context, interval time.Duration, perform func(context.Context)) *CronJob {
-	ctx, cancel := context.WithCancel(ctx)
-
-	job := &CronJob{ctx: ctx, cancel: cancel, interval: interval, perform: perform}
-	job.perform(ctx) // perform immediately
+func newCronJob(ctx context.Context, interval time.Duration, perform func(context.Context) error) (*CronJob, error) {
+	if err := perform(ctx); err != nil {
+		return nil, err
+	}
 
-	job.wait.Add(1)
-	go job.loop()
-	return job
+	ctx, cancel := context.WithCancel(ctx)
+	job := &CronJob{cancel: cancel, interval: interval, perform: perform}
+	go job.loop(ctx)
+	return job, nil
 }
 
 // Stop stops the job and waits until it is complete.
@@ -159,7 +161,8 @@ func (j *CronJob) Stop() {
 	j.wait.Wait()
 }
 
-func (j *CronJob) loop() {
+func (j *CronJob) loop(ctx context.Context) {
+	j.wait.Add(1)
 	defer j.wait.Done()
 
 	ticker := time.NewTicker(j.interval)
@@ -167,10 +170,10 @@ func (j *CronJob) loop() {
 
 	for {
 		select {
-		case <-j.ctx.Done():
+		case <-ctx.Done():
 			return
 		case <-ticker.C:
-			j.perform(j.ctx)
+			_ = j.perform(ctx)
 		}
 	}
 }

data/scheduler_test.go

@@ -2,6 +2,7 @@ package feedx_test
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"sync/atomic"
 	"testing"
@@ -17,14 +18,23 @@ func TestScheduler(t *testing.T) {
 	numCycles := new(atomic.Int32)
 	numErrors := new(atomic.Int32)
 
+	resetCounters := func() {
+		beforeCallbacks.Store(0)
+		afterCallbacks.Store(0)
+		numCycles.Store(0)
+		numErrors.Store(0)
+	}
+
 	obj := bfs.NewInMemObject("file.json")
 	defer obj.Close()
 
 	t.Run("produce", func(t *testing.T) {
+		resetCounters()
+
 		pcr := feedx.NewProducerForRemote(obj)
 		defer pcr.Close()
 
-		job := feedx.Every(time.Millisecond).
+		job, err := feedx.Every(time.Millisecond).
 			BeforeSync(func(_ int64) bool {
 				beforeCallbacks.Add(1)
 				return true
@@ -45,6 +55,9 @@ func TestScheduler(t *testing.T) {
 				}
 				return nil
 			})
+		if err != nil {
+			t.Fatal("unexpected error", err)
+		}
 
 		time.Sleep(5 * time.Millisecond)
 		job.Stop()
@@ -71,17 +84,29 @@ func TestScheduler(t *testing.T) {
 		}
 	})
 
-	beforeCallbacks.Store(0)
-	afterCallbacks.Store(0)
-	numCycles.Store(0)
-	numErrors.Store(0)
+	t.Run("produce may fail", func(t *testing.T) {
+		resetCounters()
+
+		pcr := feedx.NewProducerForRemote(obj)
+		defer pcr.Close()
+
+		exp := fmt.Errorf("failed!")
+		_, err := feedx.Every(time.Millisecond).
+			Produce(pcr, func(w *feedx.Writer) error {
+				return exp
+			})
+		if !errors.Is(err, exp) {
+			t.Errorf("expected %v, got %v", exp, err)
+		}
+	})
 
 	t.Run("consume", func(t *testing.T) {
+		resetCounters()
 
 		csm := feedx.NewConsumerForRemote(obj)
 		defer csm.Close()
 
-		job := feedx.Every(time.Millisecond).
+		job, err := feedx.Every(time.Millisecond).
 			BeforeSync(func(_ int64) bool {
 				beforeCallbacks.Add(1)
 				return true
@@ -93,12 +118,15 @@ func TestScheduler(t *testing.T) {
 					numErrors.Add(1)
 				}
 			}).
-			Consume(csm, func(ctx context.Context, r *feedx.Reader) error {
+			Consume(csm, func(r *feedx.Reader) error {
 				if numCycles.Add(1)%2 == 0 {
 					return fmt.Errorf("failed!")
 				}
 				return nil
 			})
+		if err != nil {
+			t.Fatal("unexpected error", err)
+		}
 
 		time.Sleep(5 * time.Millisecond)
 		job.Stop()
@@ -125,4 +153,19 @@ func TestScheduler(t *testing.T) {
 		}
 	})
 
+	t.Run("consume may fail", func(t *testing.T) {
+		resetCounters()
+
+		csm := feedx.NewConsumerForRemote(obj)
+		defer csm.Close()
+
+		exp := fmt.Errorf("failed!")
+		_, err := feedx.Every(time.Millisecond).
+			Consume(csm, func(r *feedx.Reader) error {
+				return exp
+			})
+		if !errors.Is(err, exp) {
+			t.Errorf("expected %v, got %v", exp, err)
+		}
+	})
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedx
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Black Square Media Ltd