mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Alex ShtinandGitHub
8e8f1b0f7c
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.
## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
78 lines
2.4 KiB
Go
78 lines
2.4 KiB
Go
package archiver
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"go.temporal.io/sdk/activity"
|
|
)
|
|
|
|
type (
|
|
// ArchiveOption is used to provide options for adding features to
|
|
// the Archive method of History/Visibility Archiver
|
|
ArchiveOption func(featureCatalog *ArchiveFeatureCatalog)
|
|
|
|
// ArchiveFeatureCatalog is a collection features for the Archive method of
|
|
// History/Visibility Archiver
|
|
ArchiveFeatureCatalog struct {
|
|
ProgressManager ProgressManager
|
|
NonRetryableError NonRetryableError
|
|
}
|
|
|
|
// NonRetryableError returns an error indicating archiver has encountered an non-retryable error
|
|
NonRetryableError func() error
|
|
|
|
// ProgressManager is used to record and load archive progress
|
|
ProgressManager interface {
|
|
RecordProgress(ctx context.Context, progress interface{}) error
|
|
LoadProgress(ctx context.Context, valuePtr interface{}) error
|
|
HasProgress(ctx context.Context) bool
|
|
}
|
|
)
|
|
|
|
// GetFeatureCatalog applies all the ArchiveOptions to the catalog and returns the catalog.
|
|
// It should be called inside the Archive method.
|
|
func GetFeatureCatalog(opts ...ArchiveOption) *ArchiveFeatureCatalog {
|
|
catalog := &ArchiveFeatureCatalog{}
|
|
for _, opt := range opts {
|
|
opt(catalog)
|
|
}
|
|
return catalog
|
|
}
|
|
|
|
// GetHeartbeatArchiveOption returns an ArchiveOption for enabling heartbeating.
|
|
// It should be used when the Archive method is invoked inside an activity.
|
|
func GetHeartbeatArchiveOption() ArchiveOption {
|
|
return func(catalog *ArchiveFeatureCatalog) {
|
|
catalog.ProgressManager = &heartbeatProgressManager{}
|
|
}
|
|
}
|
|
|
|
type heartbeatProgressManager struct{}
|
|
|
|
func (h *heartbeatProgressManager) RecordProgress(ctx context.Context, progress interface{}) error {
|
|
activity.RecordHeartbeat(ctx, progress)
|
|
return nil
|
|
}
|
|
|
|
func (h *heartbeatProgressManager) LoadProgress(ctx context.Context, valuePtr interface{}) error {
|
|
if !h.HasProgress(ctx) {
|
|
return errors.New("no progress information in the context")
|
|
}
|
|
return activity.GetHeartbeatDetails(ctx, valuePtr)
|
|
}
|
|
|
|
func (h *heartbeatProgressManager) HasProgress(ctx context.Context) bool {
|
|
return activity.HasHeartbeatDetails(ctx)
|
|
}
|
|
|
|
// GetNonRetryableErrorOption returns an ArchiveOption so that archiver knows what should
|
|
// be returned when an non-retryable error is encountered.
|
|
func GetNonRetryableErrorOption(nonRetryableErr error) ArchiveOption {
|
|
return func(catalog *ArchiveFeatureCatalog) {
|
|
catalog.NonRetryableError = func() error {
|
|
return nonRetryableErr
|
|
}
|
|
}
|
|
}
|