Files
tasks/service/frontend/token_deprecated.go
Norbert HuandGitHub 113a2b2f17 Move dependencies on history persistence from FE to History (#4453)
<!-- Describe what has changed in this PR -->
All new code is gated behind the frontend.accessHistoryFraction dynamic
config. The new code is meant to be a port of the original FE code, but
primarily executed by the History service moving forward. Because this
change affects both FE and History, it requires a prolonged deprecation
process where:
- upon the 1st minor release (upcoming), the dynamic config must remain
  disabled by default
- by the 2nd minor release, the dynamic config to be switched to be
  enabled by default
- starting from the 3rd minor release, the deprecated code will be
  removed

This change is staged into the following 4 major steps:
- DEPRECATE - refactor FE logic/tests into deprecated files (no logic
change)
- DUPLICATE - dup deprecated logic to history service (verbatim
copy/paste)
- PLUMBING - introduce rpc and handlers along with basic necessities
(hooking up)
- IMPORTANT - call-by-call replacement (requires careful review)


<!-- Tell your future self why have you made these changes -->
This is a big refactor to move business logic from FE to History service.


<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
- Ported FE unit tests to the History service layer
- Spot checked by running in dev environment


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


<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
2023-08-30 15:45:36 -07:00

103 lines
3.8 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 frontend
import (
"go.temporal.io/server/api/adminservice/v1"
historyspb "go.temporal.io/server/api/history/v1"
tokenspb "go.temporal.io/server/api/token/v1"
)
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
func generatePaginationToken(
request *adminservice.GetWorkflowExecutionRawHistoryV2Request,
versionHistories *historyspb.VersionHistories,
) *tokenspb.RawHistoryContinuation {
execution := request.Execution
return &tokenspb.RawHistoryContinuation{
NamespaceId: request.GetNamespaceId(),
WorkflowId: execution.GetWorkflowId(),
RunId: execution.GetRunId(),
StartEventId: request.GetStartEventId(),
StartEventVersion: request.GetStartEventVersion(),
EndEventId: request.GetEndEventId(),
EndEventVersion: request.GetEndEventVersion(),
VersionHistories: versionHistories,
PersistenceToken: nil, // this is the initialized value
}
}
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
func validatePaginationToken(
request *adminservice.GetWorkflowExecutionRawHistoryV2Request,
token *tokenspb.RawHistoryContinuation,
) error {
execution := request.Execution
if request.GetNamespaceId() != token.GetNamespaceId() ||
execution.GetWorkflowId() != token.GetWorkflowId() ||
execution.GetRunId() != token.GetRunId() ||
request.GetStartEventId() != token.GetStartEventId() ||
request.GetStartEventVersion() != token.GetStartEventVersion() ||
request.GetEndEventId() != token.GetEndEventId() ||
request.GetEndEventVersion() != token.GetEndEventVersion() {
return errInvalidPaginationToken
}
return nil
}
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
func serializeRawHistoryToken(token *tokenspb.RawHistoryContinuation) ([]byte, error) {
if token == nil {
return nil, nil
}
return token.Marshal()
}
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
func deserializeRawHistoryToken(bytes []byte) (*tokenspb.RawHistoryContinuation, error) {
token := &tokenspb.RawHistoryContinuation{}
err := token.Unmarshal(bytes)
return token, err
}
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
func serializeHistoryToken(token *tokenspb.HistoryContinuation) ([]byte, error) {
if token == nil {
return nil, nil
}
return token.Marshal()
}
// DEPRECATED: DO NOT MODIFY UNLESS ALSO APPLIED TO ./service/history/api/token.go
func deserializeHistoryToken(bytes []byte) (*tokenspb.HistoryContinuation, error) {
token := &tokenspb.HistoryContinuation{}
err := token.Unmarshal(bytes)
return token, err
}