Documentation
¶
Index ¶
- type AlbumCount
- type AlbumCountDiff
- type AlbumSummary
- type AlbumSummaryForUsers
- type AlbumSummaryInMemoryRepository
- func (r *AlbumSummaryInMemoryRepository) DeleteAllRowsForAlbum(ctx context.Context, albumId catalog.AlbumId) error
- func (r *AlbumSummaryInMemoryRepository) DeleteLegacyRowsForUser(_ context.Context, userId usermodel.UserId) error
- func (r *AlbumSummaryInMemoryRepository) DeleteRow(ctx context.Context, availability Availability, albumId catalog.AlbumId) error
- func (r *AlbumSummaryInMemoryRepository) IncrementCountForAllViewers(ctx context.Context, updates []AlbumCountDiff) error
- func (r *AlbumSummaryInMemoryRepository) ListSummariesForUser(ctx context.Context, userId usermodel.UserId) ([]UserAlbumSummary, error)
- func (r *AlbumSummaryInMemoryRepository) ListSummariesForUserAndOwners(ctx context.Context, userId usermodel.UserId, owner ...ownermodel.Owner) ([]UserAlbumSummary, error)
- func (r *AlbumSummaryInMemoryRepository) PutSummaries(ctx context.Context, summaries []AlbumSummaryForUsers) error
- func (r *AlbumSummaryInMemoryRepository) RenameAlbum(ctx context.Context, existingId, renamedId catalog.AlbumId, newName string) error
- func (r *AlbumSummaryInMemoryRepository) SetCountForAllViewers(ctx context.Context, updates []AlbumCount) error
- func (r *AlbumSummaryInMemoryRepository) SetDisplayFieldsForAllViewers(ctx context.Context, albumId catalog.AlbumId, name string, ...) error
- type AlbumSummaryRepository
- type AlbumSummaryReprojector
- type AlbumView
- func (v *AlbumView) AlbumShared(ctx context.Context, album catalog.Album, userId usermodel.UserId) error
- func (v *AlbumView) AlbumUnShared(ctx context.Context, albumId catalog.AlbumId, userId usermodel.UserId) error
- func (v *AlbumView) ListAlbums(ctx context.Context, user usermodel.CurrentUser, filter ListAlbumsFilter) ([]*VisibleAlbum, error)
- func (v *AlbumView) OnAlbumCreated(ctx context.Context, event catalog.AlbumCreated) error
- func (v *AlbumView) OnAlbumDatesAmended(ctx context.Context, event catalog.AlbumDatesAmended) error
- func (v *AlbumView) OnAlbumDeleted(ctx context.Context, event catalog.AlbumDeleted) error
- func (v *AlbumView) OnAlbumRenamed(ctx context.Context, event catalog.AlbumRenamed) error
- func (v *AlbumView) OnMediasInserted(ctx context.Context, medias map[catalog.AlbumId][]catalog.MediaId) error
- type Availability
- type DeleteLegacyRowsForUserPort
- type DeleteRowPort
- type Drift
- type DriftDetector
- type DriftObserver
- type DriftOption
- type DriftReason
- type DriftSynchronizerObserver
- type DriftSynchronizerPort
- type FindAlbumByOwnerFunc
- type FindAlbumByOwnerPort
- type FindAlbumsByIdsFunc
- type FindAlbumsByIdsPort
- type GetAlbumSharingGridFunc
- type GetAlbumSharingGridPort
- type GetCurrentAlbumSummariesPort
- type LegacyRowsCleaner
- type ListAlbumsFilter
- type ListUserWhoCanAccessAlbumPort
- type LoggerDriftObserver
- type MediaCounterFunc
- type MediaCounterPort
- type OwnerDriftReconciler
- type OwnerUserIdFunc
- type OwnerUserIdPort
- type PutSummariesPort
- type UserAlbumSummary
- type VisibleAlbum
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlbumCount ¶ added in v1.9.61
type AlbumCountDiff ¶ added in v1.9.61
type AlbumSummary ¶ added in v1.9.61
type AlbumSummary struct {
AlbumId catalog.AlbumId
MediaCount int
Name string
Start time.Time
End time.Time
}
AlbumSummary is the per-album projection carried by the album-list view: identity, display fields and the media count.
type AlbumSummaryForUsers ¶ added in v1.9.61
type AlbumSummaryForUsers struct {
AlbumSummary
Users []Availability
}
AlbumSummaryForUsers is a full projection to be written for a set of users (owner + visitors).
func (AlbumSummaryForUsers) String ¶ added in v1.9.61
func (a AlbumSummaryForUsers) String() string
type AlbumSummaryInMemoryRepository ¶ added in v1.9.61
type AlbumSummaryInMemoryRepository struct {
Summaries []UserAlbumSummary
LegacyRowsCleanedForUsers []usermodel.UserId
}
func (*AlbumSummaryInMemoryRepository) DeleteAllRowsForAlbum ¶ added in v1.9.61
func (*AlbumSummaryInMemoryRepository) DeleteLegacyRowsForUser ¶ added in v1.9.61
func (*AlbumSummaryInMemoryRepository) DeleteRow ¶ added in v1.9.61
func (r *AlbumSummaryInMemoryRepository) DeleteRow(ctx context.Context, availability Availability, albumId catalog.AlbumId) error
func (*AlbumSummaryInMemoryRepository) IncrementCountForAllViewers ¶ added in v1.9.61
func (r *AlbumSummaryInMemoryRepository) IncrementCountForAllViewers(ctx context.Context, updates []AlbumCountDiff) error
func (*AlbumSummaryInMemoryRepository) ListSummariesForUser ¶ added in v1.9.61
func (r *AlbumSummaryInMemoryRepository) ListSummariesForUser(ctx context.Context, userId usermodel.UserId) ([]UserAlbumSummary, error)
func (*AlbumSummaryInMemoryRepository) ListSummariesForUserAndOwners ¶ added in v1.9.61
func (r *AlbumSummaryInMemoryRepository) ListSummariesForUserAndOwners(ctx context.Context, userId usermodel.UserId, owner ...ownermodel.Owner) ([]UserAlbumSummary, error)
func (*AlbumSummaryInMemoryRepository) PutSummaries ¶ added in v1.9.61
func (r *AlbumSummaryInMemoryRepository) PutSummaries(ctx context.Context, summaries []AlbumSummaryForUsers) error
func (*AlbumSummaryInMemoryRepository) RenameAlbum ¶ added in v1.9.61
func (*AlbumSummaryInMemoryRepository) SetCountForAllViewers ¶ added in v1.9.61
func (r *AlbumSummaryInMemoryRepository) SetCountForAllViewers(ctx context.Context, updates []AlbumCount) error
type AlbumSummaryRepository ¶ added in v1.9.61
type AlbumSummaryRepository interface {
ListSummariesForUser(ctx context.Context, userId usermodel.UserId) ([]UserAlbumSummary, error)
PutSummaries(ctx context.Context, summaries []AlbumSummaryForUsers) error
SetDisplayFieldsForAllViewers(ctx context.Context, albumId catalog.AlbumId, name string, start, end time.Time) error
IncrementCountForAllViewers(ctx context.Context, updates []AlbumCountDiff) error
SetCountForAllViewers(ctx context.Context, updates []AlbumCount) error
RenameAlbum(ctx context.Context, existingId, renamedId catalog.AlbumId, newName string) error
DeleteRow(ctx context.Context, availability Availability, albumId catalog.AlbumId) error
DeleteAllRowsForAlbum(ctx context.Context, albumId catalog.AlbumId) error
}
type AlbumSummaryReprojector ¶ added in v1.9.61
type AlbumSummaryReprojector struct {
ListUserWhoCanAccessAlbumPort ListUserWhoCanAccessAlbumPort
MediaCounterPort MediaCounterPort
}
AlbumSummaryReprojector rebuilds AlbumSummaryForUsers projections from canonical albums, combining media counts and viewer availabilities queried per call. The albums are supplied by the caller so it can decide the scope (per-owner, per-album, ...) without a second round-trip.
func (*AlbumSummaryReprojector) Reproject ¶ added in v1.9.61
func (r *AlbumSummaryReprojector) Reproject(ctx context.Context, albums []*catalog.Album) ([]AlbumSummaryForUsers, error)
Reproject returns the expected AlbumSummaryForUsers for every album.
type AlbumView ¶
type AlbumView struct {
Repository AlbumSummaryRepository
GetAlbumSharingGridPort GetAlbumSharingGridPort
MediaCounterPort MediaCounterPort
FindAlbumsByIdsPort FindAlbumsByIdsPort
OwnerUserIdPort OwnerUserIdPort
}
func NewAlbumView ¶ added in v1.5.49
func NewAlbumView( repository AlbumSummaryRepository, getAlbumSharingGridPort GetAlbumSharingGridPort, mediaCounterPort MediaCounterPort, findAlbumsByIdsPort FindAlbumsByIdsPort, ownerUserIdPort OwnerUserIdPort, ) *AlbumView
func (*AlbumView) AlbumShared ¶ added in v1.9.61
func (*AlbumView) AlbumUnShared ¶ added in v1.9.61
func (*AlbumView) ListAlbums ¶
func (v *AlbumView) ListAlbums(ctx context.Context, user usermodel.CurrentUser, filter ListAlbumsFilter) ([]*VisibleAlbum, error)
func (*AlbumView) OnAlbumCreated ¶ added in v1.9.61
func (*AlbumView) OnAlbumDatesAmended ¶ added in v1.9.61
func (*AlbumView) OnAlbumDeleted ¶ added in v1.9.61
func (*AlbumView) OnAlbumRenamed ¶ added in v1.9.61
type Availability ¶ added in v1.6.4
type Availability struct {
UserId usermodel.UserId
AsOwner bool // AsOwner is true if the user is the owner of the album
}
func OwnerAvailability ¶ added in v1.6.4
func OwnerAvailability(userId usermodel.UserId) Availability
func VisitorAvailability ¶ added in v1.6.4
func VisitorAvailability(userId usermodel.UserId) Availability
func (Availability) String ¶ added in v1.6.7
func (a Availability) String() string
type DeleteLegacyRowsForUserPort ¶ added in v1.9.61
type DeleteRowPort ¶ added in v1.9.61
type Drift ¶ added in v1.6.7
type Drift struct {
AlbumId catalog.AlbumId
Reason DriftReason
Expected *UserAlbumSummary // Expected is the row that should exist ; set on MISSING and OVERRIDDEN.
NotExpected *UserAlbumSummary // NotExpected is the row that currently exists but must be removed ; set on DELETED.
}
Drift describes a single divergence between a projection and its canonical source, for one album and one viewer. Expected is set when the row must be written; NotExpected is set when a row must be removed. Both are set for a swap (availability changed).
func NewDeletedDrift ¶ added in v1.9.61
func NewDeletedDrift(current UserAlbumSummary) Drift
func NewMissingDrift ¶ added in v1.6.7
func NewMissingDrift(expected UserAlbumSummary) Drift
func NewOverrideDrift ¶ added in v1.6.7
func NewOverrideDrift(expected UserAlbumSummary) Drift
type DriftDetector ¶ added in v1.6.7
type DriftDetector struct {
GetCurrentAlbumSummariesPort GetCurrentAlbumSummariesPort
}
DriftDetector compares an expected projection against the current stored projection and returns the per-album drifts.
func (*DriftDetector) Detect ¶ added in v1.9.61
func (d *DriftDetector) Detect(ctx context.Context, summaries []AlbumSummaryForUsers) ([]Drift, []usermodel.UserId, error)
type DriftObserver ¶ added in v1.6.7
type DriftOption ¶ added in v1.6.7
type DriftOption struct {
// contains filtered or unexported fields
}
func DriftOptionDryMode ¶ added in v1.6.7
func DriftOptionDryMode(dry bool, synchronizer DriftSynchronizerPort) DriftOption
DriftOptionDryMode enable or not the DRY mode.
func DriftOptionObserver ¶ added in v1.6.7
func DriftOptionObserver(observer DriftObserver) DriftOption
DriftOptionObserver adds a custom observer.
func DriftOptionSynchronizer ¶ added in v1.6.7
func DriftOptionSynchronizer(synchronizer DriftSynchronizerPort) DriftOption
func (*DriftOption) Observer ¶ added in v1.6.7
func (o *DriftOption) Observer() DriftObserver
type DriftReason ¶ added in v1.9.61
type DriftReason string
DriftReason categorises a Drift.
const ( DriftReasonMissing DriftReason = "MISSING" // row absent from the projection but expected DriftReasonOverridden DriftReason = "OVERRIDDEN" // row present but with a stale content DriftReasonDeleted DriftReason = "DELETED" // row present but not expected any more (must be removed) )
type DriftSynchronizerObserver ¶ added in v1.6.7
type DriftSynchronizerObserver struct {
DriftSynchronizerPort DriftSynchronizerPort
}
func (*DriftSynchronizerObserver) OnDetectedDrifts ¶ added in v1.6.7
func (d *DriftSynchronizerObserver) OnDetectedDrifts(ctx context.Context, drifts []Drift) error
func (*DriftSynchronizerObserver) OnReconciledUser ¶ added in v1.9.61
type DriftSynchronizerPort ¶ added in v1.6.7
type DriftSynchronizerPort interface {
PutSummariesPort
DeleteRowPort
DeleteLegacyRowsForUserPort
}
type FindAlbumByOwnerFunc ¶ added in v1.5.49
type FindAlbumByOwnerFunc func(ctx context.Context, owner ownermodel.Owner) ([]*catalog.Album, error)
func (FindAlbumByOwnerFunc) FindAlbumsByOwner ¶ added in v1.5.49
func (f FindAlbumByOwnerFunc) FindAlbumsByOwner(ctx context.Context, owner ownermodel.Owner) ([]*catalog.Album, error)
type FindAlbumByOwnerPort ¶
type FindAlbumsByIdsFunc ¶ added in v1.5.49
func (FindAlbumsByIdsFunc) FindAlbumsById ¶ added in v1.5.49
type FindAlbumsByIdsPort ¶
type GetAlbumSharingGridFunc ¶ added in v1.5.49
type GetAlbumSharingGridFunc func(ctx context.Context, owner ownermodel.Owner) (map[catalog.AlbumId][]usermodel.UserId, error)
func (GetAlbumSharingGridFunc) GetAlbumSharingGrid ¶ added in v1.5.49
func (f GetAlbumSharingGridFunc) GetAlbumSharingGrid(ctx context.Context, owner ownermodel.Owner) (map[catalog.AlbumId][]usermodel.UserId, error)
type GetAlbumSharingGridPort ¶ added in v1.5.49
type GetCurrentAlbumSummariesPort ¶ added in v1.9.61
type GetCurrentAlbumSummariesPort interface {
ListSummariesForUserAndOwners(ctx context.Context, userId usermodel.UserId, owner ...ownermodel.Owner) ([]UserAlbumSummary, error)
}
type LegacyRowsCleaner ¶ added in v1.9.61
type ListAlbumsFilter ¶
type ListAlbumsFilter struct {
OnlyDirectlyOwned bool // OnlyDirectlyOwned provides a sub-view where only resources directly owned by user are displayed and accessible
}
type ListUserWhoCanAccessAlbumPort ¶ added in v1.6.4
type LoggerDriftObserver ¶ added in v1.6.7
type LoggerDriftObserver struct{}
func (LoggerDriftObserver) OnDetectedDrifts ¶ added in v1.6.7
func (l LoggerDriftObserver) OnDetectedDrifts(_ context.Context, drifts []Drift) error
type MediaCounterFunc ¶ added in v1.5.50
type MediaCounterPort ¶ added in v1.5.50
type OwnerDriftReconciler ¶ added in v1.6.7
type OwnerDriftReconciler struct {
FindAlbumByOwnerPort FindAlbumByOwnerPort
AlbumSummaryReprojector AlbumSummaryReprojector
DriftDetector *DriftDetector
DriftObservers []DriftObserver
}
func NewDriftReconciler ¶ added in v1.6.7
func NewDriftReconciler( findAlbumByOwnerPort FindAlbumByOwnerPort, getCurrentAlbumSummariesPort GetCurrentAlbumSummariesPort, listUserWhoCanAccessAlbumPort ListUserWhoCanAccessAlbumPort, mediaCounterPort MediaCounterPort, driftOptions ...DriftOption, ) *OwnerDriftReconciler
NewDriftReconciler creates a new DriftReconciler in DRY mode ; use the option DriftOptionSynchronizer to reconcile.
func (*OwnerDriftReconciler) Reconcile ¶ added in v1.6.7
func (d *OwnerDriftReconciler) Reconcile(ctx context.Context, owner ownermodel.Owner) ([]Drift, error)
Reconcile rebuilds the album-list projection for the owner, detects drifts against the current projection, hands them to every observer (logger, synchronizer, ...) and returns them so callers can render their own reports.
type OwnerUserIdFunc ¶ added in v1.9.61
func (OwnerUserIdFunc) GetOwnerUserId ¶ added in v1.9.61
func (f OwnerUserIdFunc) GetOwnerUserId(ctx context.Context, owner ownermodel.Owner) (usermodel.UserId, error)
type OwnerUserIdPort ¶ added in v1.9.61
type PutSummariesPort ¶ added in v1.9.61
type PutSummariesPort interface {
PutSummaries(ctx context.Context, summaries []AlbumSummaryForUsers) error
}
type UserAlbumSummary ¶ added in v1.9.61
type UserAlbumSummary struct {
AlbumSummary AlbumSummary
Availability Availability
}
func (UserAlbumSummary) ToSummaryForUsers ¶ added in v1.9.61
func (s UserAlbumSummary) ToSummaryForUsers() AlbumSummaryForUsers
type VisibleAlbum ¶
type VisibleAlbum struct {
catalog.Album
MediaCount int // MediaCount is the number of medias on the album
Visitors []usermodel.UserId // Visitors are the users that can see the album ; only visible to the owner of the album
OwnedByCurrentUser bool // OwnedByCurrentUser is set to true when the user is an owner of the album
}