mattermost/mattermost-plugin-mscalendar

Any user-facing error messages should be user-friendly

Open

#189 opened on Sep 7, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (35 forks)auto 404
Difficulty/2:MediumGood First IssueHacktoberfestHelp WantedTech/GoType/EnhancementUp For Grabs

Repository metrics

Stars
 (22 stars)
PR merge metrics
 (PR metrics pending)

Description

Often times we show raw errors to the user, sometimes even in JSON form. We should make it so any user-facing error that is not specially crafted to be something of the effect "An error occurred, please contact your Mattermost administrator."

An error like this is returned to the UI when creating a subscription fails:

There has been a problem setting the property, err=msgraph CreateMySubscription: 401 Unauthorized: {"error":{"code":"InvalidAuthenticationToken","message":"CompactToken parsing failed with error code: 80049217","innerError":{"date":"2020-09-07T06:33:50","request-id":"32c9434c-3c46-4e29-9b68-478604c75636"}}}

image

Contributor guide

Research direction
Identify all points in the code where raw errors are returned to the user via the API and wrap them with user friendly messages.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65