Skip to content

Add options to customize UserFeedback error messages #6790

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.

Sign up for GitHub

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Add options to customize UserFeedback error messages #6790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a68e432
Add new options to customize error messages
itaybre Nov 14, 2025
503983f
Use new user messages in User Feedback form
itaybre Nov 14, 2025
10f3976
Add custom messages for our test samples
itaybre Nov 14, 2025
ca7364c
Update broken test
itaybre Nov 14, 2025
809059c
Update changelog
itaybre Nov 14, 2025
dc5f915
Update sdk_api.json
itaybre Nov 14, 2025
90a23f9
Merge branch 'main' of github.com:getsentry/sentry-cocoa into itay/cu…
itaybre Nov 17, 2025
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@
- Increase attachment max size to 100MB (#6537)
- Increase maximum attachment size to 200MB (#6726)

### Improvements

- Add options to customize UserFeedback error messages (#6790)
Copy link
Contributor

@github-actions github-actions bot Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 🚫 The changelog entry seems to be part of an already released section ## 9.0.0.
    Consider moving the entry to the ## Unreleased section, please.


## 9.0.0-alpha.1

### Breaking Changes
Expand Down
4 changes: 4 additions & 0 deletions Samples/SentrySampleShared/SentrySampleShared/SentrySDKWrapper.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,10 @@ extension SentrySDKWrapper {
config.messageLabel = "Thy complaint"
config.emailLabel = "Thine email"
config.nameLabel = "Thy name"
config.unexpectedErrorText = "Santry doesn't know how to process this error"
config.validationErrorMessage = { multipleErrors in
return "You got \(multipleErrors ? "many" : "a" ) error\(multipleErrors ? "s" : "") in this form"
}
}

func configureFeedbackTheme(config: SentryUserFeedbackThemeConfiguration) {
Expand Down
14 changes: 14 additions & 0 deletions ...s/Swift/Integrations/UserFeedback/Configuration/SentryUserFeedbackFormConfiguration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,20 @@ public final class SentryUserFeedbackFormConfiguration: NSObject {
func fullLabelText(labelText: String, required: Bool) -> String {
required ? labelText + " " + isRequiredLabel : labelText
}

/**
* Message shown to the user when an unexpected error happens while submitting feedback.
* - note: Default: `"Unexpected client error."`
*/
public var unexpectedErrorText: String = "Unexpected client error."

/**
* Message shown to the user when the form fails the validation.
* - note: Default: `"You must provide all required information before submitting. Please check the following field(s)"`
*/
public var validationErrorMessage: (Bool) -> String = { multipleErrors in
return "You must provide all required information before submitting. Please check the following field\(multipleErrors ? "s" : ""):"
}
}

#endif // os(iOS) && !SENTRY_NO_UIKIT
4 changes: 2 additions & 2 deletions Sources/Swift/Integrations/UserFeedback/SentryUserFeedbackFormController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,11 @@ extension SentryUserFeedbackFormController: SentryUserFeedbackFormViewModelDeleg

guard case let SentryUserFeedbackFormViewModel.InputError.validationError(missing) = error else {
SentrySDKLog.warning("Unexpected error type.")
presentAlert(message: "Unexpected client error.", errorCode: 2, info: [NSLocalizedDescriptionKey: "Client error: ."])
presentAlert(message: config.formConfig.unexpectedErrorText, errorCode: 2, info: [NSLocalizedDescriptionKey: "Client error: ."])
return
}

presentAlert(message: error.description, errorCode: 1, info: ["missing_fields": missing, NSLocalizedDescriptionKey: "The user did not complete the feedback form."])
presentAlert(message: error.getDescription(formConfig: config.formConfig), errorCode: 1, info: ["missing_fields": missing, NSLocalizedDescriptionKey: "The user did not complete the feedback form."])
}
}

Expand Down
6 changes: 3 additions & 3 deletions Sources/Swift/Integrations/UserFeedback/SentryUserFeedbackFormViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ extension SentryUserFeedbackFormViewModel {
func updateSubmitButtonAccessibilityHint() {
switch validate() {
case .success(let hint): submitButton.accessibilityHint = hint
case .failure(let error): submitButton.accessibilityHint = error.description
case .failure(let error): submitButton.accessibilityHint = error.getDescription(formConfig: config.formConfig)
}
}

Expand Down Expand Up @@ -443,11 +443,11 @@ extension SentryUserFeedbackFormViewModel {
enum InputError: Error {
case validationError(missingFields: [String])

var description: String {
func getDescription(formConfig: SentryUserFeedbackFormConfiguration) -> String {
switch self {
case .validationError(let missingFields):
let list = missingFields.count == 1 ? missingFields[0] : missingFields[0 ..< missingFields.count - 1].joined(separator: ", ") + " and " + missingFields[missingFields.count - 1]
return "You must provide all required information before submitting. Please check the following field\(missingFields.count > 1 ? "s" : ""): \(list)."
return "\(formConfig.validationErrorMessage(missingFields.count > 1 )): \(list)."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion Tests/SentryTests/Integrations/Feedback/SentryFeedbackTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ class SentryFeedbackTests: XCTestCase {
XCTAssert(input.shouldValidate)
XCTAssertEqual(hint, input.expectedSubmitButtonAccessibilityHint, testCaseDescription())
case .failure(let error):
XCTAssertFalse(input.shouldValidate, error.description + "; " + testCaseDescription())
XCTAssertFalse(input.shouldValidate, error.getDescription(formConfig: config.formConfig) + "; " + testCaseDescription())
}

}
Expand Down
191 changes: 191 additions & 0 deletions sdk_api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56840,6 +56840,197 @@
}
]
},
{
"kind": "Var",
"name": "unexpectedErrorText",
"printedName": "unexpectedErrorText",
"children": [
{
"kind": "TypeNominal",
"name": "String",
"printedName": "Swift.String",
"usr": "s:SS"
}
],
"declKind": "Var",
"usr": "c:@M@Sentry@objc(cs)SentryUserFeedbackFormConfiguration(py)unexpectedErrorText",
"mangledName": "$s6Sentry0A29UserFeedbackFormConfigurationC19unexpectedErrorTextSSvp",
"moduleName": "Sentry",
"declAttributes": [
"Final",
"ObjC",
"HasStorage"
],
"hasStorage": true,
"accessors": [
{
"kind": "Accessor",
"name": "Get",
"printedName": "Get()",
"children": [
{
"kind": "TypeNominal",
"name": "String",
"printedName": "Swift.String",
"usr": "s:SS"
}
],
"declKind": "Accessor",
"usr": "c:@M@Sentry@objc(cs)SentryUserFeedbackFormConfiguration(im)unexpectedErrorText",
"mangledName": "$s6Sentry0A29UserFeedbackFormConfigurationC19unexpectedErrorTextSSvg",
"moduleName": "Sentry",
"implicit": true,
"declAttributes": [
"Final",
"ObjC"
],
"accessorKind": "get"
},
{
"kind": "Accessor",
"name": "Set",
"printedName": "Set()",
"children": [
{
"kind": "TypeNominal",
"name": "Void",
"printedName": "()"
},
{
"kind": "TypeNominal",
"name": "String",
"printedName": "Swift.String",
"usr": "s:SS"
}
],
"declKind": "Accessor",
"usr": "c:@M@Sentry@objc(cs)SentryUserFeedbackFormConfiguration(im)setUnexpectedErrorText:",
"mangledName": "$s6Sentry0A29UserFeedbackFormConfigurationC19unexpectedErrorTextSSvs",
"moduleName": "Sentry",
"implicit": true,
"declAttributes": [
"Final",
"ObjC"
],
"accessorKind": "set"
}
]
},
{
"kind": "Var",
"name": "validationErrorMessage",
"printedName": "validationErrorMessage",
"children": [
{
"kind": "TypeFunc",
"name": "Function",
"printedName": "(Swift.Bool) -> Swift.String",
"children": [
{
"kind": "TypeNominal",
"name": "String",
"printedName": "Swift.String",
"usr": "s:SS"
},
{
"kind": "TypeNominal",
"name": "Bool",
"printedName": "Swift.Bool",
"usr": "s:Sb"
}
]
}
],
"declKind": "Var",
"usr": "c:@M@Sentry@objc(cs)SentryUserFeedbackFormConfiguration(py)validationErrorMessage",
"mangledName": "$s6Sentry0A29UserFeedbackFormConfigurationC22validationErrorMessageySSSbcvp",
"moduleName": "Sentry",
"declAttributes": [
"Final",
"ObjC",
"HasStorage"
],
"hasStorage": true,
"accessors": [
{
"kind": "Accessor",
"name": "Get",
"printedName": "Get()",
"children": [
{
"kind": "TypeFunc",
"name": "Function",
"printedName": "(Swift.Bool) -> Swift.String",
"children": [
{
"kind": "TypeNominal",
"name": "String",
"printedName": "Swift.String",
"usr": "s:SS"
},
{
"kind": "TypeNominal",
"name": "Bool",
"printedName": "Swift.Bool",
"usr": "s:Sb"
}
]
}
],
"declKind": "Accessor",
"usr": "c:@M@Sentry@objc(cs)SentryUserFeedbackFormConfiguration(im)validationErrorMessage",
"mangledName": "$s6Sentry0A29UserFeedbackFormConfigurationC22validationErrorMessageySSSbcvg",
"moduleName": "Sentry",
"implicit": true,
"declAttributes": [
"Final",
"ObjC"
],
"accessorKind": "get"
},
{
"kind": "Accessor",
"name": "Set",
"printedName": "Set()",
"children": [
{
"kind": "TypeNominal",
"name": "Void",
"printedName": "()"
},
{
"kind": "TypeFunc",
"name": "Function",
"printedName": "(Swift.Bool) -> Swift.String",
"children": [
{
"kind": "TypeNominal",
"name": "String",
"printedName": "Swift.String",
"usr": "s:SS"
},
{
"kind": "TypeNominal",
"name": "Bool",
"printedName": "Swift.Bool",
"usr": "s:Sb"
}
]
}
],
"declKind": "Accessor",
"usr": "c:@M@Sentry@objc(cs)SentryUserFeedbackFormConfiguration(im)setValidationErrorMessage:",
"mangledName": "$s6Sentry0A29UserFeedbackFormConfigurationC22validationErrorMessageySSSbcvs",
"moduleName": "Sentry",
"implicit": true,
"declAttributes": [
"Final",
"ObjC"
],
"accessorKind": "set"
}
]
},
{
"kind": "Constructor",
"name": "init",
Expand Down
Loading