Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(alerts/reports): add refresh action (#12071)
- Loading branch information
Showing
5 changed files
with
148 additions
and
7 deletions.
There are no files selected for viewing
43 changes: 43 additions & 0 deletions
43
superset-frontend/src/components/LastUpdated/LastUpdated.test.tsx
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 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 React from 'react'; | ||
| import { ReactWrapper } from 'enzyme'; | ||
| import { styledMount as mount } from 'spec/helpers/theming'; | ||
| import LastUpdated from '.'; | ||
|
|
||
| describe('LastUpdated', () => { | ||
| let wrapper: ReactWrapper; | ||
| const updatedAt = new Date('Sat Dec 12 2020 00:00:00 GMT-0800'); | ||
|
|
||
| it('renders the base component (no refresh)', () => { | ||
| const wrapper = mount(<LastUpdated updatedAt={updatedAt} />); | ||
| expect(/^Last Updated .+$/.test(wrapper.text())).toBe(true); | ||
| }); | ||
|
|
||
| it('renders a refresh action', () => { | ||
| const mockAction = jest.fn(); | ||
| wrapper = mount(<LastUpdated updatedAt={updatedAt} update={mockAction} />); | ||
| const props = wrapper.find('[data-test="refresh"]').props(); | ||
| if (props.onClick) { | ||
| props.onClick({} as React.MouseEvent); | ||
| } | ||
| expect(mockAction).toHaveBeenCalled(); | ||
| }); | ||
| }); |
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,80 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 React, { useEffect, useState, FunctionComponent } from 'react'; | ||
| import moment, { Moment, MomentInput } from 'moment'; | ||
| import { t, styled } from '@superset-ui/core'; | ||
| import Icon from 'src/components/Icon'; | ||
|
|
||
| const REFRESH_INTERVAL = 60000; // every minute | ||
|
|
||
| interface LastUpdatedProps { | ||
| updatedAt: MomentInput; | ||
| update?: React.MouseEventHandler<SVGSVGElement>; | ||
| } | ||
| moment.updateLocale('en', { | ||
| calendar: { | ||
| lastDay: '[Yesterday at] LTS', | ||
| sameDay: '[Today at] LTS', | ||
| nextDay: '[Tomorrow at] LTS', | ||
| lastWeek: '[last] dddd [at] LTS', | ||
| nextWeek: 'dddd [at] LTS', | ||
| sameElse: 'L', | ||
| }, | ||
| }); | ||
|
|
||
| const TextStyles = styled.span` | ||
| color: ${({ theme }) => theme.colors.grayscale.base}; | ||
| `; | ||
|
|
||
| const Refresh = styled(Icon)` | ||
| color: ${({ theme }) => theme.colors.primary.base}; | ||
| width: auto; | ||
| height: ${({ theme }) => theme.gridUnit * 5}px; | ||
| position: relative; | ||
| top: ${({ theme }) => theme.gridUnit}px; | ||
| left: ${({ theme }) => theme.gridUnit}px; | ||
| cursor: pointer; | ||
| `; | ||
|
|
||
| export const LastUpdated: FunctionComponent<LastUpdatedProps> = ({ | ||
| updatedAt, | ||
| update, | ||
| }) => { | ||
| const [timeSince, setTimeSince] = useState<Moment>(moment(updatedAt)); | ||
|
|
||
| useEffect(() => { | ||
| setTimeSince(() => moment(updatedAt)); | ||
|
|
||
| // update UI every minute in case day changes | ||
| const interval = setInterval(() => { | ||
| setTimeSince(() => moment(updatedAt)); | ||
| }, REFRESH_INTERVAL); | ||
|
|
||
| return () => clearInterval(interval); | ||
| }, [updatedAt]); | ||
|
|
||
| return ( | ||
| <TextStyles> | ||
| {t('Last Updated %s', timeSince.isValid() ? timeSince.calendar() : '--')} | ||
| {update && <Refresh name="refresh" onClick={update} />} | ||
| </TextStyles> | ||
| ); | ||
| }; | ||
|
|
||
| export default LastUpdated; |
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