-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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.
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
[vtadmin-web] Display timestamps + stream counts on Workflows view #8009
Merged
ajm188
merged 1 commit into
vitessio:master
from
tinyspeck:sarabee-vtadmin-web-workflow-utils
Apr 30, 2021
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/** | ||
* Copyright 2021 The Vitess Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
import { Pip, PipState } from './Pip'; | ||
|
||
interface Props { | ||
state?: string | null | undefined; | ||
} | ||
|
||
// TODO(doeg): add a protobuf enum for this (https://github.com/vitessio/vitess/projects/12#card-60190340) | ||
const STREAM_STATES: { [key: string]: PipState } = { | ||
Copying: 'primary', | ||
Error: 'danger', | ||
Running: 'success', | ||
Stopped: null, | ||
}; | ||
|
||
export const StreamStatePip = ({ state }: Props) => { | ||
const pipState = state ? STREAM_STATES[state] : null; | ||
return <Pip state={pipState} />; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
/** | ||
* Copyright 2021 The Vitess Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
import * as dayjs from 'dayjs'; | ||
import localizedFormat from 'dayjs/plugin/localizedFormat'; | ||
import relativeTime from 'dayjs/plugin/relativeTime'; | ||
|
||
dayjs.extend(localizedFormat); | ||
dayjs.extend(relativeTime); | ||
|
||
export const parse = (timestamp: number | null | undefined): dayjs.Dayjs | null => { | ||
if (typeof timestamp !== 'number') { | ||
return null; | ||
} | ||
return dayjs.unix(timestamp); | ||
}; | ||
|
||
export const format = (timestamp: number | null | undefined, template: string | undefined): string | null => { | ||
const u = parse(timestamp); | ||
return u ? u.format(template) : null; | ||
}; | ||
|
||
export const formatDateTime = (timestamp: number | null | undefined): string | null => { | ||
return format(timestamp, 'YYYY-MM-DD LT'); | ||
}; | ||
|
||
export const formatRelativeTime = (timestamp: number | null | undefined): string | null => { | ||
const u = parse(timestamp); | ||
return u ? u.fromNow() : null; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
/** | ||
* Copyright 2021 The Vitess Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
import { vtadmin as pb } from '../proto/vtadmin'; | ||
import { getStreams } from './workflows'; | ||
|
||
describe('getStreams', () => { | ||
const tests: { | ||
name: string; | ||
input: Parameters<typeof getStreams>; | ||
expected: ReturnType<typeof getStreams>; | ||
}[] = [ | ||
{ | ||
name: 'should return a flat list of streams', | ||
input: [ | ||
pb.Workflow.create({ | ||
workflow: { | ||
shard_streams: { | ||
'-80/us_east_1a-123456': { | ||
streams: [ | ||
{ id: 1, shard: '-80' }, | ||
{ id: 2, shard: '-80' }, | ||
], | ||
}, | ||
'80-/us_east_1a-789012': { | ||
streams: [ | ||
{ id: 1, shard: '80-' }, | ||
{ id: 2, shard: '80-' }, | ||
], | ||
}, | ||
}, | ||
}, | ||
}), | ||
], | ||
expected: [ | ||
{ id: 1, shard: '-80' }, | ||
{ id: 2, shard: '-80' }, | ||
{ id: 1, shard: '80-' }, | ||
{ id: 2, shard: '80-' }, | ||
], | ||
}, | ||
{ | ||
name: 'should handle when shard streams undefined', | ||
input: [pb.Workflow.create()], | ||
expected: [], | ||
}, | ||
{ | ||
name: 'should handle null input', | ||
input: [null], | ||
expected: [], | ||
}, | ||
]; | ||
|
||
test.each(tests.map(Object.values))( | ||
'%s', | ||
(name: string, input: Parameters<typeof getStreams>, expected: ReturnType<typeof getStreams>) => { | ||
expect(getStreams(...input)).toEqual(expected); | ||
} | ||
); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/** | ||
* Copyright 2021 The Vitess Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
import { vtctldata, vtadmin as pb } from '../proto/vtadmin'; | ||
|
||
/** | ||
* getStreams returns a flat list of streams across all keyspaces/shards in the workflow. | ||
*/ | ||
export const getStreams = <W extends pb.IWorkflow>(workflow: W | null | undefined): vtctldata.Workflow.IStream[] => { | ||
if (!workflow) { | ||
return []; | ||
} | ||
|
||
return Object.values(workflow.workflow?.shard_streams || {}).reduce((acc, shardStream) => { | ||
(shardStream.streams || []).forEach((stream) => { | ||
acc.push(stream); | ||
}); | ||
return acc; | ||
}, [] as vtctldata.Workflow.IStream[]); | ||
}; | ||
|
||
/** | ||
* getTimeUpdated returns the `time_updated` timestamp of the most recently | ||
* updated stream in the workflow. | ||
*/ | ||
export const getTimeUpdated = <W extends pb.IWorkflow>(workflow: W | null | undefined): number => { | ||
// Note: long-term it may be better to get this from the `vreplication_log` data | ||
// added by https://github.com/vitessio/vitess/pull/7831 | ||
const timestamps = getStreams(workflow).map((s) => parseInt(`${s.time_updated?.seconds}`, 10)); | ||
return Math.max(...timestamps); | ||
}; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
++