Skip to content

feat(feedback): Save form state for un-submitted data #4538

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

Merged
merged 8 commits into from
Feb 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 43 additions & 4 deletions packages/core/src/js/feedback/FeedbackWidget.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ export class FeedbackWidget extends React.Component<FeedbackWidgetProps, Feedbac
...defaultConfiguration
}

private static _savedState: Omit<FeedbackWidgetState, 'isVisible'> = {
name: '',
email: '',
description: '',
filename: undefined,
attachment: undefined,
};

private _didSubmitForm: boolean = false;

public constructor(props: FeedbackWidgetProps) {
super(props);

Expand All @@ -45,9 +55,11 @@ export class FeedbackWidget extends React.Component<FeedbackWidgetProps, Feedbac

this.state = {
isVisible: true,
name: currentUser.useSentryUser.name,
email: currentUser.useSentryUser.email,
description: '',
name: FeedbackWidget._savedState.name || currentUser.useSentryUser.name,
email: FeedbackWidget._savedState.email || currentUser.useSentryUser.email,
description: FeedbackWidget._savedState.description || '',
filename: FeedbackWidget._savedState.filename || undefined,
attachment: FeedbackWidget._savedState.attachment || undefined,
};
}

Expand Down Expand Up @@ -92,9 +104,10 @@ export class FeedbackWidget extends React.Component<FeedbackWidgetProps, Feedbac
this.setState({ isVisible: false });
}
captureFeedback(userFeedback, attachments ? { attachments } : undefined);
onSubmitSuccess({ name: trimmedName, email: trimmedEmail, message: trimmedDescription, attachments: undefined });
onSubmitSuccess({ name: trimmedName, email: trimmedEmail, message: trimmedDescription, attachments: attachments });
Alert.alert(text.successMessageText);
onFormSubmitted();
this._didSubmitForm = true;
} catch (error) {
const errorString = `Feedback form submission failed: ${error}`;
onSubmitError(new Error(errorString));
Expand Down Expand Up @@ -152,6 +165,18 @@ export class FeedbackWidget extends React.Component<FeedbackWidgetProps, Feedbac
}
}

/**
* Save the state before unmounting the component.
*/
public componentWillUnmount(): void {
if (this._didSubmitForm) {
this._clearFormState();
this._didSubmitForm = false;
} else {
this._saveFormState();
}
}

/**
* Renders the feedback form screen.
*/
Expand Down Expand Up @@ -259,4 +284,18 @@ export class FeedbackWidget extends React.Component<FeedbackWidgetProps, Feedbac
</SafeAreaView>
);
}

private _saveFormState = (): void => {
FeedbackWidget._savedState = { ...this.state };
};

private _clearFormState = (): void => {
FeedbackWidget._savedState = {
name: '',
email: '',
description: '',
filename: undefined,
attachment: undefined,
};
};
}
47 changes: 47 additions & 0 deletions packages/core/test/feedback/FeedbackWidget.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -354,4 +354,51 @@ describe('FeedbackWidget', () => {

expect(mockOnFormClose).toHaveBeenCalled();
});

it('onUnmount the input is saved and restored when the form reopens', async () => {
const { getByPlaceholderText, unmount } = render(<FeedbackWidget {...defaultProps} />);

fireEvent.changeText(getByPlaceholderText(defaultProps.namePlaceholder), 'John Doe');
fireEvent.changeText(getByPlaceholderText(defaultProps.emailPlaceholder), '[email protected]');
fireEvent.changeText(getByPlaceholderText(defaultProps.messagePlaceholder), 'This is a feedback message.');

unmount();
const { queryByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);

expect(queryByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe('John Doe');
expect(queryByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe('[email protected]');
expect(queryByPlaceholderText(defaultProps.messagePlaceholder).props.value).toBe('This is a feedback message.');
});

it('onCancel the input is saved and restored when the form reopens', async () => {
const { getByPlaceholderText, getByText, unmount } = render(<FeedbackWidget {...defaultProps} />);

fireEvent.changeText(getByPlaceholderText(defaultProps.namePlaceholder), 'John Doe');
fireEvent.changeText(getByPlaceholderText(defaultProps.emailPlaceholder), '[email protected]');
fireEvent.changeText(getByPlaceholderText(defaultProps.messagePlaceholder), 'This is a feedback message.');

fireEvent.press(getByText(defaultProps.cancelButtonLabel));
unmount();
const { queryByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);

expect(queryByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe('John Doe');
expect(queryByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe('[email protected]');
expect(queryByPlaceholderText(defaultProps.messagePlaceholder).props.value).toBe('This is a feedback message.');
});

it('onSubmit the saved input is cleared and not restored when the form reopens', async () => {
const { getByPlaceholderText, getByText, unmount } = render(<FeedbackWidget {...defaultProps} />);

fireEvent.changeText(getByPlaceholderText(defaultProps.namePlaceholder), 'John Doe');
fireEvent.changeText(getByPlaceholderText(defaultProps.emailPlaceholder), '[email protected]');
fireEvent.changeText(getByPlaceholderText(defaultProps.messagePlaceholder), 'This is a feedback message.');

fireEvent.press(getByText(defaultProps.submitButtonLabel));
unmount();
const { queryByPlaceholderText } = render(<FeedbackWidget {...defaultProps} />);

expect(queryByPlaceholderText(defaultProps.namePlaceholder).props.value).toBe('Test User');
expect(queryByPlaceholderText(defaultProps.emailPlaceholder).props.value).toBe('[email protected]');
expect(queryByPlaceholderText(defaultProps.messagePlaceholder).props.value).toBe('');
});
});
Loading