Files
temporal/common/archiver/s3store/query_parser_test.go
Yichao Yang beb31c3569 Accept WorkflowType in S3 visibility queries (#11383)
## What changed
- Allow the S3 visibility archiver query parser to accept
`WorkflowType`.
- Keep `WorkflowTypeName` as a deprecated compatibility alias.
- Rename the parsed query field to `workflowType` and update S3
visibility archiver tests.
- Fix the S3 parser StartTime test assertion and StartTime operator
error message.

## Why
- S3 visibility archiver queries only accepted `WorkflowTypeName`, while
filestore, gcloud, and non-archived visibility records use
`WorkflowType`. This keeps old queries working while accepting the
standard field name.
- Fix https://github.com/temporalio/temporal/issues/7821
2026-08-01 02:02:49 +00:00

265 lines
6.0 KiB
Go

package s3store
import (
"testing"
"time"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
)
type queryParserSuite struct {
*require.Assertions
suite.Suite
parser QueryParser
}
func TestQueryParserSuite(t *testing.T) {
suite.Run(t, new(queryParserSuite))
}
func (s *queryParserSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.parser = NewQueryParser()
}
func (s *queryParserSuite) TestParseWorkflowIDAndWorkflowTypeName() {
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: "WorkflowId = \"random workflowID\"",
expectErr: false,
parsedQuery: &parsedQuery{
workflowID: new("random workflowID"),
},
},
{
query: "WorkflowTypeName = \"random workflowTypeName\"",
expectErr: false,
parsedQuery: &parsedQuery{
workflowType: new("random workflowTypeName"),
},
},
{
query: "WorkflowType = \"random workflowType\"",
expectErr: false,
parsedQuery: &parsedQuery{
workflowType: new("random workflowType"),
},
},
{
query: "WorkflowId = \"random workflowID\" and WorkflowTypeName = \"random workflowTypeName\"",
expectErr: true,
},
{
query: "WorkflowId = \"random workflowID\" and WorkflowType = \"random workflowTypeName\"",
expectErr: true,
},
{
query: "WorkflowTypeName = \"random workflowTypeName\" and WorkflowType = \"random workflowTypeName\"",
expectErr: true,
},
{
query: "WorkflowId = \"random workflowID\" and WorkflowId = \"random workflowID\"",
expectErr: true,
},
{
query: "RunId = \"random runID\"",
expectErr: true,
},
{
query: "WorkflowId = 'random workflowID'",
expectErr: false,
parsedQuery: &parsedQuery{
workflowID: new("random workflowID"),
},
},
{
query: "(WorkflowId = \"random workflowID\")",
expectErr: false,
parsedQuery: &parsedQuery{
workflowID: new("random workflowID"),
},
},
{
query: "runId = random workflowID",
expectErr: true,
},
{
query: "WorkflowId = \"random workflowID\" or WorkflowId = \"another workflowID\"",
expectErr: true,
},
{
query: "WorkflowId = \"random workflowID\" or runId = \"random runID\"",
expectErr: true,
},
{
query: "workflowid = \"random workflowID\"",
expectErr: true,
},
{
query: "runId > \"random workflowID\"",
expectErr: true,
},
}
for _, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err)
s.Equal(tc.parsedQuery.workflowID, parsedQuery.workflowID)
s.Equal(tc.parsedQuery.workflowType, parsedQuery.workflowType)
}
}
func (s *queryParserSuite) TestParsePrecision() {
commonQueryPart := "WorkflowId = \"random workflowID\" AND "
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: commonQueryPart + "CloseTime = 1000 and SearchPrecision = 'Day'",
expectErr: false,
parsedQuery: &parsedQuery{
searchPrecision: new(PrecisionDay),
},
},
{
query: commonQueryPart + "CloseTime = 1000 and SearchPrecision = 'Hour'",
expectErr: false,
parsedQuery: &parsedQuery{
searchPrecision: new(PrecisionHour),
},
},
{
query: commonQueryPart + "CloseTime = 1000 and SearchPrecision = 'Minute'",
expectErr: false,
parsedQuery: &parsedQuery{
searchPrecision: new(PrecisionMinute),
},
},
{
query: commonQueryPart + "StartTime = 1000 and SearchPrecision = 'Second'",
expectErr: false,
parsedQuery: &parsedQuery{
searchPrecision: new(PrecisionSecond),
},
},
{
query: commonQueryPart + "SearchPrecision = 'Second'",
expectErr: true,
},
{
query: commonQueryPart + "SearchPrecision = 'Invalid string'",
expectErr: true,
},
}
for _, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err)
s.Equal(tc.parsedQuery.searchPrecision, parsedQuery.searchPrecision)
}
}
func (s *queryParserSuite) TestParseCloseTime() {
commonQueryPart := "WorkflowId = \"random workflowID\" AND SearchPrecision = 'Day' AND "
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: commonQueryPart + "CloseTime = 1000",
expectErr: false,
parsedQuery: &parsedQuery{
closeTime: new(time.Unix(0, 1000).UTC()),
},
},
{
query: commonQueryPart + "CloseTime = \"2019-01-01T11:11:11Z\"",
expectErr: false,
parsedQuery: &parsedQuery{
closeTime: new(time.Date(2019, 1, 1, 11, 11, 11, 0, time.UTC)),
},
},
{
query: commonQueryPart + "closeTime = 2000",
expectErr: true,
},
{
query: commonQueryPart + "CloseTime > \"2019-01-01 00:00:00\"",
expectErr: true,
},
}
for _, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err)
s.Equal(tc.parsedQuery.closeTime, parsedQuery.closeTime)
}
}
func (s *queryParserSuite) TestParseStartTime() {
commonQueryPart := "WorkflowId = \"random workflowID\" AND SearchPrecision = 'Day' AND "
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: commonQueryPart + "StartTime = 1000",
expectErr: false,
parsedQuery: &parsedQuery{
startTime: new(time.Unix(0, 1000).UTC()),
},
},
{
query: commonQueryPart + "StartTime = \"2019-01-01T11:11:11Z\"",
expectErr: false,
parsedQuery: &parsedQuery{
startTime: new(time.Date(2019, 1, 1, 11, 11, 11, 0, time.UTC)),
},
},
{
query: commonQueryPart + "startTime = 2000",
expectErr: true,
},
{
query: commonQueryPart + "StartTime > \"2019-01-01 00:00:00\"",
expectErr: true,
},
}
for _, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err)
s.Equal(tc.parsedQuery.startTime, parsedQuery.startTime)
}
}