Cleanup datastore package (#400)

* Remove fetch api
* Move it to projector, since it is used there

internal/projector/datastore/alias.go

@@ -0,0 +1,9 @@
+package datastore
+
+import "github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+
+// NewRecorder from datastore.NewRecorder
+var NewRecorder = datastore.NewRecorder
+
+// DoesNotExistError is a type alias from datastore.DoesNotExistError
+type DoesNotExistError = datastore.DoesNotExistError

pkg/datastore/fetch.go → internal/projector/datastore/fetch.go

@@ -5,14 +5,9 @@ import (
 	"encoding/json"
 	"fmt"
 	"strings"
-)
 
-// Getter can get values from keys.
-//
-// The Datastore object implements this interface.
-type Getter interface {
-	Get(ctx context.Context, keys ...string) (map[string][]byte, error)
-}
+	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+)
 
 // Fetcher is a helper to fetch many keys from the datastore.
 //
@@ -24,12 +19,12 @@ type Getter interface {
 //
 // Make sure to call Fetcher.Err() at the end to see, if an error happend.
 type Fetcher struct {
-	getter Getter
+	getter datastore.Getter
 	err    error
 }
 
 // NewFetcher initializes a Fetcher object.
-func NewFetcher(getter Getter) *Fetcher {
+func NewFetcher(getter datastore.Getter) *Fetcher {
 	return &Fetcher{getter: getter}
 }
 
@@ -85,7 +80,7 @@ func (f *Fetcher) FetchIfExist(ctx context.Context, value interface{}, keyFmt st
 	}
 
 	if fields[idField] == nil {
-		f.err = DoesNotExistError(fqid)
+		f.err = datastore.DoesNotExistError(fqid)
 		return
 	}
 	if fields[fqfield] == nil {
@@ -121,7 +116,7 @@ func (f *Fetcher) Object(ctx context.Context, fqID string, fields ...string) map
 	}
 
 	if vals[fqID+"/id"] == nil {
-		f.err = DoesNotExistError(fqID)
+		f.err = datastore.DoesNotExistError(fqID)
 		return nil
 	}
 
@@ -163,11 +158,3 @@ func String(ctx context.Context, fetch FetchFunc, keyFmt string, a ...interface{
 	fetch(ctx, &value, keyFmt, a...)
 	return value
 }
-
-// DoesNotExistError is thrown by the methods of a Fetcher when an object does
-// not exist.
-type DoesNotExistError string
-
-func (e DoesNotExistError) Error() string {
-	return fmt.Sprintf("%s does not exist.", string(e))
-}

pkg/datastore/fetch_test.go → internal/projector/datastore/fetch_test.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

internal/projector/projector.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 // Datastore gets values for keys and informs, if they change.

internal/projector/projector_test.go

@@ -8,7 +8,7 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

internal/projector/slide/agenda.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbAgendaItem struct {

internal/projector/slide/agenda_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/assignment.go

@@ -7,7 +7,7 @@ import (
 	"sort"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbAssignment struct {

internal/projector/slide/assignment_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/list_of_speakers.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbListOfSpeakers struct {

internal/projector/slide/list_of_speakers_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

internal/projector/slide/mediafile.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbMediafile struct {

internal/projector/slide/mediafile_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/meeting.go

@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbMeeting struct {

internal/projector/slide/motion.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbMotionState struct {

internal/projector/slide/motion_block.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbMotionBlock struct {

internal/projector/slide/motion_block_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/motion_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/poll.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type optionRepr struct {

internal/projector/slide/poll_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/projector.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbProjectorCountdown struct {

internal/projector/slide/projector_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/topic.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 type dbTopic struct {

internal/projector/slide/topic_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slide/user.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 // DbUser is the class with methods to get needed User Informations

internal/projector/slide/user_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/slide"
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
 	"github.com/OpenSlides/openslides-autoupdate-service/pkg/dsmock"
 	"github.com/stretchr/testify/assert"
 )

internal/projector/slides.go

@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/OpenSlides/openslides-autoupdate-service/pkg/datastore"
+	"github.com/OpenSlides/openslides-autoupdate-service/internal/projector/datastore"
 )
 
 // Slider knows how to create a slide.

pkg/datastore/datastore.go

@@ -27,6 +27,19 @@ const (
 	httpTimeout              = 3 * time.Second
 )
 
+// Updater returns keys that have changes. Blocks until there is
+// changed data.
+type Updater interface {
+	Update(context.Context) (map[string][]byte, error)
+}
+
+// Getter can get values from keys.
+//
+// The Datastore object implements this interface.
+type Getter interface {
+	Get(ctx context.Context, keys ...string) (map[string][]byte, error)
+}
+
 // Datastore can be used to get values from the datastore-service.
 //
 // Has to be created with datastore.New().

pkg/datastore/gen_request/value.go.tmpl

@@ -37,14 +37,13 @@ type {{.TypeName}} struct {
 	}
 {{end}}
 
-{{if not .MaybeType}}
-	// Lazy sets a value as soon as it es executed.
-	//
-	// Make sure to call request.Execute() before using the value.
-	func (v *{{.TypeName}}) Lazy(value *{{.GoType}}) {
-		v.lazies = append(v.lazies, value)
-	}
-{{end}}
+
+// Lazy sets a value as soon as it es executed.
+//
+// Make sure to call request.Execute() before using the value.
+func (v *{{.TypeName}}) Lazy(value *{{.GoType}}) {
+	v.lazies = append(v.lazies, value)
+}
 
 {{if not .MaybeType}}
 	// ErrorLater is like Value but does not return an error.
@@ -67,10 +66,10 @@ type {{.TypeName}} struct {
 		return v.value
 	}
 {{else}}
-// ErrorLater is like Value but does not return an error.
-//
-// If an error happs, it is saved internaly. Make sure to call request.Err() later to
-// access it.
+	// ErrorLater is like Value but does not return an error.
+	//
+	// If an error happs, it is saved internaly. Make sure to call request.Err() later to
+	// access it.
 	func (v *{{.TypeName}}) ErrorLater(ctx context.Context) ({{.GoType}}, bool) {
 		if v.request.err != nil {
 			return {{.Zero}}, false

pkg/datastore/request.go

@@ -153,3 +153,10 @@ func (v *ValueRequiredInt) execute(p []byte) error {
 	v.executed = true
 	return nil
 }
+
+// DoesNotExistError is thrown when an object does not exist.
+type DoesNotExistError string
+
+func (e DoesNotExistError) Error() string {
+	return fmt.Sprintf("%s does not exist.", string(e))
+}