You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "EnxDev (via GitHub)" <gi...@apache.org> on 2024/02/16 12:39:03 UTC
[PR] chore: Migrate ErrorBoundary to typescript [superset]
EnxDev opened a new pull request, #27143:
URL: https://github.com/apache/superset/pull/27143
<!---
Please write the PR title following the conventions at https://www.conventionalcommits.org/en/v1.0.0/
Example:
fix(dashboard): load charts correctly
-->
### SUMMARY
Migrate ErrorBoundary to typescript
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N.A.
### TESTING INSTRUCTIONS
- All tests should pass
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] chore: Migrate ErrorBoundary to typescript [superset]
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #27143:
URL: https://github.com/apache/superset/pull/27143#issuecomment-1948351462
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/27143?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
Attention: `2 lines` in your changes are missing coverage. Please review.
> Comparison is base [(`8a2f7d3`)](https://app.codecov.io/gh/apache/superset/commit/8a2f7d378ab13c156fa183d9284b607ed69f5ecc?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) 67.31% compared to head [(`33b6cfd`)](https://app.codecov.io/gh/apache/superset/pull/27143?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) 67.13%.
> Report is 125 commits behind head on master.
| [Files](https://app.codecov.io/gh/apache/superset/pull/27143?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Patch % | Lines |
|---|---|---|
| [...et-frontend/src/components/ErrorBoundary/index.tsx](https://app.codecov.io/gh/apache/superset/pull/27143?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQtZnJvbnRlbmQvc3JjL2NvbXBvbmVudHMvRXJyb3JCb3VuZGFyeS9pbmRleC50c3g=) | 66.66% | [0 Missing and 2 partials :warning: ](https://app.codecov.io/gh/apache/superset/pull/27143?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) |
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #27143 +/- ##
==========================================
- Coverage 67.31% 67.13% -0.19%
==========================================
Files 1895 1902 +7
Lines 74202 74424 +222
Branches 8219 8306 +87
==========================================
+ Hits 49949 49964 +15
- Misses 22204 22406 +202
- Partials 2049 2054 +5
```
| [Flag](https://app.codecov.io/gh/apache/superset/pull/27143/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [javascript](https://app.codecov.io/gh/apache/superset/pull/27143/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `56.84% <66.66%> (-0.29%)` | :arrow_down: |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/superset/pull/27143?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: Migrate ErrorBoundary to typescript [superset]
Posted by "michael-s-molina (via GitHub)" <gi...@apache.org>.
michael-s-molina merged PR #27143:
URL: https://github.com/apache/superset/pull/27143
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] refactor: Migrate ErrorBoundary to typescript [superset]
Posted by "michael-s-molina (via GitHub)" <gi...@apache.org>.
michael-s-molina commented on code in PR #27143:
URL: https://github.com/apache/superset/pull/27143#discussion_r1492834691
##########
superset-frontend/src/components/ErrorBoundary/index.tsx:
##########
@@ -17,47 +17,60 @@
* under the License.
*/
import React from 'react';
-import PropTypes from 'prop-types';
import { t } from '@superset-ui/core';
import ErrorMessageWithStackTrace from 'src/components/ErrorMessage/ErrorMessageWithStackTrace';
-const propTypes = {
- children: PropTypes.node.isRequired,
- onError: PropTypes.func,
- showMessage: PropTypes.bool,
-};
-const defaultProps = {
- onError: () => {},
- showMessage: true,
-};
+export interface ErrorBoundaryProps {
+ children: React.ReactNode;
+ onError?: (error: Error, info: React.ErrorInfo) => void;
+ showMessage?: boolean;
+}
+
+interface ErrorBoundaryState {
+ error: Error | null;
+ info: React.ErrorInfo | null;
+}
-export default class ErrorBoundary extends React.Component {
- constructor(props) {
+export default class ErrorBoundary extends React.Component<
+ ErrorBoundaryProps,
+ ErrorBoundaryState
+> {
+ static defaultProps: Partial<ErrorBoundaryProps> = {
+ showMessage: true,
+ };
+
+ constructor(props: ErrorBoundaryProps) {
super(props);
this.state = { error: null, info: null };
}
- componentDidCatch(error, info) {
- if (this.props.onError) this.props.onError(error, info);
+ componentDidCatch(error: Error, info: React.ErrorInfo): void {
+ this.props.onError?.(error, info);
this.setState({ error, info });
}
render() {
- const { error, info } = this.state;
+ const { error } = this.state;
if (error) {
const firstLine = error.toString();
- const message = (
+ const messageString = `${t('Unexpected error')}${
+ firstLine ? `: ${firstLine}` : ''
+ }`;
+ const messageElement = (
<span>
<strong>{t('Unexpected error')}</strong>
{firstLine ? `: ${firstLine}` : ''}
</span>
);
+
if (this.props.showMessage) {
return (
<ErrorMessageWithStackTrace
- subtitle={message}
- copyText={message}
- stackTrace={info ? info.componentStack : null}
+ subtitle={messageElement}
+ copyText={messageString}
+ stackTrace={
+ this.state.info ? this.state.info.componentStack : undefined
+ }
Review Comment:
```suggestion
stackTrace={info?.componentStack}
```
##########
superset-frontend/src/components/ErrorBoundary/index.tsx:
##########
@@ -17,47 +17,60 @@
* under the License.
*/
import React from 'react';
-import PropTypes from 'prop-types';
import { t } from '@superset-ui/core';
import ErrorMessageWithStackTrace from 'src/components/ErrorMessage/ErrorMessageWithStackTrace';
-const propTypes = {
- children: PropTypes.node.isRequired,
- onError: PropTypes.func,
- showMessage: PropTypes.bool,
-};
-const defaultProps = {
- onError: () => {},
- showMessage: true,
-};
+export interface ErrorBoundaryProps {
+ children: React.ReactNode;
+ onError?: (error: Error, info: React.ErrorInfo) => void;
+ showMessage?: boolean;
+}
+
+interface ErrorBoundaryState {
+ error: Error | null;
+ info: React.ErrorInfo | null;
+}
-export default class ErrorBoundary extends React.Component {
- constructor(props) {
+export default class ErrorBoundary extends React.Component<
+ ErrorBoundaryProps,
+ ErrorBoundaryState
+> {
+ static defaultProps: Partial<ErrorBoundaryProps> = {
+ showMessage: true,
+ };
+
+ constructor(props: ErrorBoundaryProps) {
super(props);
this.state = { error: null, info: null };
}
- componentDidCatch(error, info) {
- if (this.props.onError) this.props.onError(error, info);
+ componentDidCatch(error: Error, info: React.ErrorInfo): void {
+ this.props.onError?.(error, info);
this.setState({ error, info });
}
render() {
- const { error, info } = this.state;
+ const { error } = this.state;
Review Comment:
```suggestion
const { error, info } = this.state;
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org