e10cd368bf
This change introduces notifications via mail when a migration fails. It will contain the error message and a hint to post it in the forum when Sentry is disabled, otherwise the error message will be sent directly to sentry and the notification will inform accordingly. I've tried to balance "this thing failed, go figure it out" with "here is what we know and how you can get help", we'll see how well that approach works.
106 lines
4.4 KiB
Go
106 lines
4.4 KiB
Go
// Vikunja is a to-do list application to facilitate your life.
|
|
// Copyright 2018-present Vikunja and contributors. All rights reserved.
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public Licensee as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public Licensee for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public Licensee
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package handler
|
|
|
|
import (
|
|
"golang.org/x/text/cases"
|
|
"golang.org/x/text/language"
|
|
|
|
"code.vikunja.io/api/pkg/config"
|
|
"code.vikunja.io/api/pkg/notifications"
|
|
)
|
|
|
|
// MigrationDoneNotification represents a MigrationDoneNotification notification
|
|
type MigrationDoneNotification struct {
|
|
MigratorName string
|
|
}
|
|
|
|
// ToMail returns the mail notification for MigrationDoneNotification
|
|
func (n *MigrationDoneNotification) ToMail() *notifications.Mail {
|
|
kind := cases.Title(language.English).String(n.MigratorName)
|
|
|
|
return notifications.NewMail().
|
|
Subject("The migration from "+kind+" to Vikunja was completed").
|
|
Line("Vikunja has imported all lists/projects, tasks, notes, reminders and files from "+kind+" you have access to.").
|
|
Action("View your imported projects in Vikunja", config.ServicePublicURL.GetString()).
|
|
Line("Have fun with your new (old) projects!")
|
|
}
|
|
|
|
// ToDB returns the MigrationDoneNotification notification in a format which can be saved in the db
|
|
func (n *MigrationDoneNotification) ToDB() interface{} {
|
|
return nil
|
|
}
|
|
|
|
// Name returns the name of the notification
|
|
func (n *MigrationDoneNotification) Name() string {
|
|
return "migration.done"
|
|
}
|
|
|
|
// MigrationFailedReportedNotification represents a MigrationFailedReportedNotification notification
|
|
type MigrationFailedReportedNotification struct {
|
|
MigratorName string
|
|
}
|
|
|
|
// ToMail returns the mail notification for MigrationFailedReportedNotification
|
|
func (n *MigrationFailedReportedNotification) ToMail() *notifications.Mail {
|
|
kind := cases.Title(language.English).String(n.MigratorName)
|
|
|
|
return notifications.NewMail().
|
|
Subject("The migration from " + kind + " to Vikunja was has failed").
|
|
Line("Looks like the move from " + kind + " didn't go as planned this time.").
|
|
Line("No worries, though! Just give it another shot by starting over the same way you did before. Sometimes, these hiccups happen because of glitches on " + kind + "'s end, but trying again often does the trick.").
|
|
Line("We've got the error message on our radar and are on it to get it sorted out soon.")
|
|
}
|
|
|
|
// ToDB returns the MigrationFailedReportedNotification notification in a format which can be saved in the db
|
|
func (n *MigrationFailedReportedNotification) ToDB() interface{} {
|
|
return nil
|
|
}
|
|
|
|
// Name returns the name of the notification
|
|
func (n *MigrationFailedReportedNotification) Name() string {
|
|
return "migration.failed.reported"
|
|
}
|
|
|
|
// MigrationFailedNotification represents a MigrationFailedNotification notification
|
|
type MigrationFailedNotification struct {
|
|
MigratorName string
|
|
Error error
|
|
}
|
|
|
|
// ToMail returns the mail notification for MigrationFailedNotification
|
|
func (n *MigrationFailedNotification) ToMail() *notifications.Mail {
|
|
kind := cases.Title(language.English).String(n.MigratorName)
|
|
|
|
return notifications.NewMail().
|
|
Subject("The migration from " + kind + " to Vikunja was has failed").
|
|
Line("Looks like the move from " + kind + " didn't go as planned this time.").
|
|
Line("No worries, though! Just give it another shot by starting over the same way you did before. Sometimes, these hiccups happen because of glitches on " + kind + "'s end, but trying again often does the trick.").
|
|
Line("We bumped into a little error along the way: `" + n.Error.Error() + "`.").
|
|
Line("Please drop us a note about this [in the forum](https://community.vikunja.io/) or any of the usual places so that we can take a look at why it failed.")
|
|
}
|
|
|
|
// ToDB returns the MigrationFailedNotification notification in a format which can be saved in the db
|
|
func (n *MigrationFailedNotification) ToDB() interface{} {
|
|
return nil
|
|
}
|
|
|
|
// Name returns the name of the notification
|
|
func (n *MigrationFailedNotification) Name() string {
|
|
return "migration.failed"
|
|
}
|