Files
tasks/chasm/ref.go
Yichao YangandGitHub 9a4cda6c60 CHASM: Rename name to type (#7225)
## What changed?
<!-- Describe what has changed in this PR -->
- Rename component/taskName to component/TaskType in chasm framework to
avoid confusion.

## Why?
<!-- Tell your future self why have you made these changes -->

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
2025-02-04 15:57:01 -08:00

94 lines
3.0 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package chasm
import (
persistencespb "go.temporal.io/server/api/persistence/v1"
)
var (
defaultShardingFn = func(key EntityKey) string { return key.NamespaceID + "_" + key.BusinessID }
)
type EntityKey struct {
NamespaceID string
BusinessID string
EntityID string
}
type ComponentRef struct {
EntityKey
// Fully qualified component type name for routing.
rootComponentType string
// We could also make the routing infomation clear with
// routingKey string
// We can also simply put shardID here.
// TODO: Remove one of shardID and rootComponentType.
shardID int32
// Fully qualified component type name.
// From the component type, we can find the component struct definition,
// then use reflection to find sub-components and understand if those sub-components
// need to be loaded or not.
// We only need to do this for sub-components, path for parent/ancenstor components
// can be inferred from the current component path.
componentType string
componentPath componentPath
componentInitialVT *persistencespb.VersionedTransition // this identifies a component
entityLastUpdateVT *persistencespb.VersionedTransition // this is consistency token
validationFn func(Context, Component) error
}
// In V1, if you don't have a ref,
// then you can only interact with the top level entity.
func NewComponentRef(
entityKey EntityKey,
rootComponentType string,
) ComponentRef {
return ComponentRef{
EntityKey: entityKey,
// we probably don't even need this,
// can make the function generic and find the type from registry
rootComponentType: rootComponentType,
}
}
func (r *ComponentRef) Serialize() []byte {
if r == nil {
return nil
}
panic("not implemented")
}
func DeserializeComponentRef(data []byte) (ComponentRef, error) {
panic("not implemented")
}
// we may need to export this later for partial loading
type componentPath []string