refactor: Migration publishedStatus to typescript (apache#30653)

preset-io · Oct 24, 2024 · e4d8f7a · e4d8f7a
1 parent 19f840c
commit e4d8f7a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 23 deletions.
diff --git a/superset-frontend/src/dashboard/components/Header/index.jsx b/superset-frontend/src/dashboard/components/Header/index.jsx
@@ -548,8 +548,8 @@ class Header extends PureComponent {
                 dashboardId={dashboardInfo.id}
                 isPublished={isPublished}
                 savePublished={this.props.savePublished}
-                canEdit={userCanEdit}
-                canSave={userCanSaveAs}
+                userCanEdit={userCanEdit}
+                userCanSave={userCanSaveAs}
                 visible={!editMode}
               />
             ),

diff --git a/superset-frontend/src/dashboard/components/Header/types.ts b/superset-frontend/src/dashboard/components/Header/types.ts
@@ -86,7 +86,7 @@ export interface HeaderProps {
   onSave: () => void;
   fetchFaveStar: () => void;
   saveFaveStar: () => void;
-  savePublished: () => void;
+  savePublished: (dashboardId: number, isPublished: boolean) => void;
   updateDashboardTitle: () => void;
   editMode: boolean;
   setEditMode: () => void;

diff --git a/superset-frontend/src/dashboard/components/PublishedStatus/PublishedStatus.test.tsx b/superset-frontend/src/dashboard/components/PublishedStatus/PublishedStatus.test.tsx
@@ -24,8 +24,8 @@ const defaultProps = {
   dashboardId: 1,
   isPublished: false,
   savePublished: jest.fn(),
-  canEdit: false,
-  canSave: false,
+  userCanEdit: false,
+  userCanSave: false,
 };
 
 test('renders with unpublished status and readonly permissions', async () => {
@@ -44,8 +44,8 @@ test('renders with unpublished status and write permissions', async () => {
   render(
     <PublishedStatus
       {...defaultProps}
-      canEdit
-      canSave
+      userCanEdit
+      userCanSave
       savePublished={savePublished}
     />,
   );
@@ -69,8 +69,8 @@ test('renders with published status and write permissions', async () => {
     <PublishedStatus
       {...defaultProps}
       isPublished
-      canEdit
-      canSave
+      userCanEdit
+      userCanSave
       savePublished={savePublished}
     />,
   );

diff --git a/...oard/components/PublishedStatus/index.jsx → ...oard/components/PublishedStatus/index.tsx b/...oard/components/PublishedStatus/index.jsx → ...oard/components/PublishedStatus/index.tsx
@@ -17,17 +17,17 @@
  * under the License.
  */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
 import { t } from '@superset-ui/core';
 import { Tooltip } from 'src/components/Tooltip';
 import Label from 'src/components/Label';
+import { HeaderProps, HeaderDropdownProps } from '../Header/types';
 
-const propTypes = {
-  dashboardId: PropTypes.number,
-  isPublished: PropTypes.bool.isRequired,
-  savePublished: PropTypes.func.isRequired,
-  canEdit: PropTypes.bool,
-  canSave: PropTypes.bool,
+export type DashboardPublishedStatusType = {
+  dashboardId: HeaderDropdownProps['dashboardId'];
+  userCanEdit: HeaderDropdownProps['userCanEdit'];
+  userCanSave: HeaderDropdownProps['userCanSave'];
+  isPublished: HeaderProps['isPublished'];
+  savePublished: HeaderProps['savePublished'];
 };
 
 const draftButtonTooltip = t(
@@ -44,8 +44,9 @@ const publishedTooltip = t(
   'This dashboard is published. Click to make it a draft.',
 );
 
-export default class PublishedStatus extends Component {
-  componentDidMount() {
+export default class PublishedStatus extends Component<DashboardPublishedStatusType> {
+  constructor(props: DashboardPublishedStatusType) {
+    super(props);
     this.togglePublished = this.togglePublished.bind(this);
   }
 
@@ -54,10 +55,12 @@ export default class PublishedStatus extends Component {
   }
 
   render() {
+    const { isPublished, userCanEdit, userCanSave } = this.props;
+
     // Show everybody the draft badge
-    if (!this.props.isPublished) {
+    if (!isPublished) {
       // if they can edit the dash, make the badge a button
-      if (this.props.canEdit && this.props.canSave) {
+      if (userCanEdit && userCanSave) {
         return (
           <Tooltip
             id="unpublished-dashboard-tooltip"
@@ -86,7 +89,7 @@ export default class PublishedStatus extends Component {
     }
 
     // Show the published badge for the owner of the dashboard to toggle
-    if (this.props.canEdit && this.props.canSave) {
+    if (userCanEdit && userCanSave) {
       return (
         <Tooltip
           id="published-dashboard-tooltip"
@@ -108,5 +111,3 @@ export default class PublishedStatus extends Component {
     return null;
   }
 }
-
-PublishedStatus.propTypes = propTypes;