Files
hatchet/pkg/worker/service.go
Mohammed Nafees 8755cd5e8e Mark old v0 and generics-based v1 Go SDK methods as deprecated (#2962)
* add deprecation message to old Go SDK v0 and generics-based v1

* link to migration guide
2026-02-09 16:48:16 +01:00

136 lines
4.5 KiB
Go

package worker
import (
"fmt"
"github.com/hatchet-dev/hatchet/pkg/client/compute"
"github.com/hatchet-dev/hatchet/pkg/client/types"
)
// Deprecated: Service is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
type Service struct {
Name string
mws *middlewares
worker *Worker
}
// Deprecated: Use is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
func (s *Service) Use(mws ...MiddlewareFunc) {
s.mws.add(mws...)
}
// Deprecated: RegisterWorkflow is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
func (s *Service) RegisterWorkflow(workflow workflowConverter) error {
return s.On(workflow.ToWorkflowTrigger(), workflow)
}
// Deprecated: On is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
func (s *Service) On(t triggerConverter, workflow workflowConverter) error {
namespace := s.worker.client.Namespace()
apiWorkflow := workflow.ToWorkflow(s.Name, namespace)
wt := &types.WorkflowTriggers{}
t.ToWorkflowTriggers(wt, namespace)
apiWorkflow.Triggers = *wt
// create the workflow via the API
err := s.worker.client.Admin().PutWorkflow(&apiWorkflow)
if err != nil {
return err
}
// register all steps as actions
for actionId, action := range workflow.ToActionMap(s.Name) {
parsedAction, err := types.ParseActionID(actionId)
if err != nil {
return err
}
if parsedAction.Service != s.Name {
// check that it's concurrency, otherwise throw error
if parsedAction.Service != "concurrency" {
return fmt.Errorf("action %s does not belong to service %s (parsed action service %s)", actionId, s.Name, parsedAction.Service)
}
}
err = s.worker.registerAction(parsedAction.Service, parsedAction.Verb, action.fn, action.compute)
if err != nil {
return err
}
}
return nil
}
// Deprecated: registerActionOpts is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
type registerActionOpts struct {
name string
compute *compute.Compute
}
// Deprecated: RegisterActionOpt is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
type RegisterActionOpt func(*registerActionOpts)
// Deprecated: WithActionName is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
func WithActionName(name string) RegisterActionOpt {
return func(opts *registerActionOpts) {
opts.name = name
}
}
// Deprecated: WithCompute is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
func WithCompute(compute *compute.Compute) RegisterActionOpt {
return func(opts *registerActionOpts) {
opts.compute = compute
}
}
// Deprecated: RegisterAction is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
func (s *Service) RegisterAction(fn any, opts ...RegisterActionOpt) error {
fnOpts := &registerActionOpts{}
for _, opt := range opts {
opt(fnOpts)
}
if fnOpts.name == "" {
fnOpts.name = getFnName(fn)
}
return s.worker.registerAction(s.Name, fnOpts.name, fn, fnOpts.compute)
}
// Deprecated: Call is part of the legacy v0 workflow definition system.
// Use the new Go SDK at github.com/hatchet-dev/hatchet/sdks/go instead. Migration guide: https://docs.hatchet.run/home/migration-guide-go
func (s *Service) Call(verb string) *WorkflowStep {
actionId := fmt.Sprintf("%s:%s", s.Name, verb)
registeredAction, exists := s.worker.actions[actionId]
if !exists {
panic(fmt.Sprintf("action %s does not exist", actionId))
}
return &WorkflowStep{
Function: registeredAction.MethodFn(),
Name: verb,
}
}