Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Handle nil HistoryURI during visibility archival #4880

Merged
merged 1 commit into from
Oct 5, 2023
Merged

Handle nil HistoryURI during visibility archival #4880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion service/history/archival/archiver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,11 @@ func (a *archiver) archiveVisibility(ctx context.Context, request *Request, logg
return err
}

var historyArchivalUri string
if request.HistoryURI != nil {
historyArchivalUri = request.HistoryURI.String()
}

return visibilityArchiver.Archive(ctx, request.VisibilityURI, &archiverspb.VisibilityRecord{
NamespaceId: request.NamespaceID,
Namespace: request.Namespace,
Expand All @@ -260,7 +265,7 @@ func (a *archiver) archiveVisibility(ctx context.Context, request *Request, logg
HistoryLength: request.HistoryLength,
Memo: request.Memo,
SearchAttributes: searchAttributes,
HistoryArchivalUri: request.HistoryURI.String(),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This value is not initialized here when history archival is disabled

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the visibility archiver need to have the value for the historyuri?

An alternative fix would be to always fill out both URIs in the request generation method so that it never reaches here nil. Then it could presumably have the correct value instead of an empty string.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tristan-instacart

fill out both URIs

Fill them out how?
The branching for filling this out is currently set on history archival being enabled.
URI values also cannot be empty (parsing will fail).
How can we fill out the value if it were to not be available?

My understanding of this record is to record the current values for the fields and the error is that this crashes when history URI is nil (but should be empty)

HistoryArchivalUri: historyArchivalUri,
})
}

Expand Down
14 changes: 13 additions & 1 deletion service/history/archival/archiver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ func TestArchiver(t *testing.T) {
SearchAttributesErr error
NameTypeMap searchattribute.NameTypeMap
NameTypeMapErr error
NilHistoryUri bool

ExpectArchiveHistory bool
ExpectArchiveVisibility bool
Expand Down Expand Up @@ -98,6 +99,13 @@ func TestArchiver(t *testing.T) {

ExpectArchiveVisibility: true,
},
{
Name: "Visibility archival succeeds with nil HistoryURI",
Targets: []Target{TargetVisibility},
NilHistoryUri: true,

ExpectArchiveVisibility: true,
},
{
Name: "History succeeds but visibility fails",
Targets: []Target{TargetHistory, TargetVisibility},
Expand Down Expand Up @@ -181,7 +189,11 @@ func TestArchiver(t *testing.T) {
sdkClientFactory := sdk.NewMockClientFactory(controller)
sdkClientFactory.EXPECT().GetSystemClient().Return(sdkClient).AnyTimes()

historyURI, err := carchiver.NewURI("test:///history/archival")
var historyURI carchiver.URI
var err error
if !c.NilHistoryUri {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit crude because if we just did c.HistoryURI - we wouldn't know whether to use default or if it's unset

historyURI, err = carchiver.NewURI("test:///history/archival")
}
require.NoError(t, err)

if c.ExpectArchiveHistory {
Expand Down
Loading