Skip to content
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

Extra error details #881

Merged
merged 2 commits into from
Jan 2, 2020
Merged

Extra error details #881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce757be
Add stacktrace to some error notifications
di72nn Dec 16, 2019
dc07c1c
Add action to copy error text to clipboard
di72nn Dec 16, 2019
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
3 changes: 3 additions & 0 deletions app/src/main/AndroidManifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,9 @@
<receiver
android:name="fr.gaulupeau.apps.Poche.service.AlarmReceiver"
android:enabled="false" />
<receiver
android:name="fr.gaulupeau.apps.Poche.service.NotificationActionReceiver"
android:exported="false"/>

<service
android:name="fr.gaulupeau.apps.Poche.service.WallabagJobService"
Expand Down
30 changes: 27 additions & 3 deletions app/src/main/java/fr/gaulupeau/apps/Poche/events/EventProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,17 @@
import android.os.Handler;
import androidx.core.app.NotificationCompat;
import androidx.core.content.FileProvider;

import android.text.TextUtils;
import android.util.Log;
import android.webkit.MimeTypeMap;
import android.widget.Toast;

import org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Locale;
Expand All @@ -29,6 +33,7 @@
import fr.gaulupeau.apps.Poche.service.ActionRequest;
import fr.gaulupeau.apps.Poche.service.ActionResult;
import fr.gaulupeau.apps.Poche.service.AlarmHelper;
import fr.gaulupeau.apps.Poche.service.NotificationActionReceiver;
import fr.gaulupeau.apps.Poche.service.ServiceHelper;
import fr.gaulupeau.apps.Poche.ui.IconUnreadWidget;
import fr.gaulupeau.apps.Poche.ui.preferences.SettingsActivity;
Expand Down Expand Up @@ -521,10 +526,29 @@ public void onActionResultEvent(ActionResultEvent event) {
: R.string.notification_error))
.setContentText(detailedText);

if(result.getMessage() != null) {
String extra = "";
if(!TextUtils.isEmpty(result.getMessage())) {
extra += result.getMessage() + "\n";
}
if(result.getException() != null) {
StringWriter sw = new StringWriter();

sw.append(context.getString(R.string.notification_stacktrace)).append("\n");
result.getException().printStackTrace(new PrintWriter(sw));

extra += sw.toString();
}
if(!TextUtils.isEmpty(extra)) {
notificationBuilder.setStyle(new NotificationCompat.BigTextStyle()
.bigText(context.getString(R.string.notification_expandedError,
result.getMessage())));
.bigText(context.getString(R.string.notification_expandedError, extra)));

extra = detailedText + "\n" + extra;

PendingIntent copyIntent = NotificationActionReceiver
.getCopyToClipboardPendingIntent(context,
context.getString(R.string.notification_clipboardLabel), extra);
notificationBuilder.addAction(0,
context.getString(R.string.notification_copyToClipboard), copyIntent);
}

notification = notificationBuilder.build();
Expand Down
23 changes: 21 additions & 2 deletions app/src/main/java/fr/gaulupeau/apps/Poche/service/ActionResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,26 @@ public enum ErrorType {
private boolean success = true;
private ErrorType errorType;
private String message;
private Exception exception;

public ActionResult() {}

public ActionResult(ErrorType errorType) {
setErrorType(errorType);
this(errorType, null, null);
}

public ActionResult(ErrorType errorType, String message) {
this(errorType);
this(errorType, message, null);
}

public ActionResult(ErrorType errorType, Exception exception) {
this(errorType, exception.toString(), exception);
}

public ActionResult(ErrorType errorType, String message, Exception exception) {
setErrorType(errorType);
this.message = message;
this.exception = exception;
}

public boolean isSuccess() {
Expand Down Expand Up @@ -48,12 +58,21 @@ public void setMessage(String message) {
this.message = message;
}

public Exception getException() {
return exception;
}

public void setException(Exception exception) {
this.exception = exception;
}

void updateWith(ActionResult r) {
if(r == null || r.isSuccess()) return;

success = false;
errorType = r.getErrorType();
message = r.getMessage();
exception = r.getException();
}

}
3 changes: 3 additions & 0 deletions app/src/main/java/fr/gaulupeau/apps/Poche/service/IntentServiceBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ protected ActionResult processException(Exception e, String scope) {
? ActionResult.ErrorType.SERVER_ERROR
: ActionResult.ErrorType.UNKNOWN);
result.setMessage(e.toString());
result.setException(e);
}
} else if(e instanceof IncorrectConfigurationException) {
result.setErrorType(ActionResult.ErrorType.INCORRECT_CONFIGURATION);
Expand Down Expand Up @@ -72,6 +73,7 @@ protected ActionResult processException(Exception e, String scope) {
if(!handled) {
result.setErrorType(ActionResult.ErrorType.UNKNOWN);
result.setMessage(e.toString());
result.setException(e);
}
// IOExceptions in most cases mean temporary error,
// in some cases may mean that the action was completed anyway.
Expand All @@ -81,6 +83,7 @@ protected ActionResult processException(Exception e, String scope) {
} else { // other exceptions meant to be handled outside
result.setErrorType(ActionResult.ErrorType.UNKNOWN);
result.setMessage(e.toString());
result.setException(e);
}

return result;
Expand Down
4 changes: 3 additions & 1 deletion app/src/main/java/fr/gaulupeau/apps/Poche/service/MainService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ private Pair<ActionResult, Long> syncOfflineQueue(ActionRequest actionRequest) {
} catch(Exception e) {
Log.e(TAG, "syncOfflineQueue() item processing exception", e);

itemResult = new ActionResult(ActionResult.ErrorType.UNKNOWN, e.toString());
itemResult = new ActionResult(ActionResult.ErrorType.UNKNOWN, e);
}

if(itemResult != null && !itemResult.isSuccess() && canTolerateNotFound
Expand Down Expand Up @@ -440,6 +440,7 @@ public void onSuccess(long latestUpdatedItemTimestamp) {

result.setErrorType(ActionResult.ErrorType.UNKNOWN);
result.setMessage(e.toString());
result.setException(e);
}
} else {
result.setErrorType(ActionResult.ErrorType.NO_NETWORK);
Expand Down Expand Up @@ -478,6 +479,7 @@ public void onProgress(int current, int total) {

result.setErrorType(ActionResult.ErrorType.UNKNOWN);
result.setMessage(e.toString());
result.setException(e);
}
} else {
result.setErrorType(ActionResult.ErrorType.NO_NETWORK);
Expand Down
50 changes: 50 additions & 0 deletions app/src/main/java/fr/gaulupeau/apps/Poche/service/NotificationActionReceiver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
package fr.gaulupeau.apps.Poche.service;

import android.app.PendingIntent;
import android.content.BroadcastReceiver;
import android.content.ClipData;
import android.content.ClipboardManager;
import android.content.Context;
import android.content.Intent;
import android.widget.Toast;

import java.util.concurrent.ThreadLocalRandom;

import fr.gaulupeau.apps.InThePoche.R;

public class NotificationActionReceiver extends BroadcastReceiver {

public static final String ACTION_COPY_TO_CLIPBOARD = "copy_to_clipboard";

public static final String EXTRA_COPY_TO_CLIPBOARD_LABEL = "copy_to_clipboard_label";
public static final String EXTRA_COPY_TO_CLIPBOARD_TEXT = "copy_to_clipboard_text";

public static PendingIntent getCopyToClipboardPendingIntent(
Context context, String label, String text) {
Intent intent = new Intent(context, NotificationActionReceiver.class);
intent.setAction(ACTION_COPY_TO_CLIPBOARD);
intent.putExtra(EXTRA_COPY_TO_CLIPBOARD_LABEL, label);
intent.putExtra(EXTRA_COPY_TO_CLIPBOARD_TEXT, text);

int code = ThreadLocalRandom.current().nextInt(); // so `PendingIntent` creates a **new** pending intent
return PendingIntent.getBroadcast(context, code, intent, 0);
}

@Override
public void onReceive(Context context, Intent intent) {
String action = intent.getAction();
if(ACTION_COPY_TO_CLIPBOARD.equals(action)) {
ClipboardManager clipboardManager = (ClipboardManager) context
.getSystemService(Context.CLIPBOARD_SERVICE);

ClipData data = ClipData.newPlainText(
intent.getStringExtra(EXTRA_COPY_TO_CLIPBOARD_LABEL),
intent.getStringExtra(EXTRA_COPY_TO_CLIPBOARD_TEXT));

clipboardManager.setPrimaryClip(data);

Toast.makeText(context, context.getString(R.string.copiedToClipboard), Toast.LENGTH_SHORT).show();
}
}

}
5 changes: 5 additions & 0 deletions app/src/main/res/values/strings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,4 +318,9 @@
<string name="connectionWizard_summary_prev">Back</string>
<string name="connectionWizard_summary_next">Save settings</string>
<string name="remove_tag">Remove tag</string>

<string name="notification_stacktrace">Stacktrace:</string>
<string name="notification_copyToClipboard">Copy to clipboard</string>
<string name="notification_clipboardLabel">Error details</string>
<string name="copiedToClipboard">Copied to clipboard</string>
</resources>