Merge pull request #316 from Microsoft/develop

0.5.0

Author: guperrot

README.md

@@ -193,14 +193,6 @@ You create your own Crashes listener and assign it like this:
         ```
         Pass one option of `SEND`, `DONT_SEND` or `ALWAYS_SEND`.
 
-    * **Binary attachment:**  If you'd like to attach text/binary data to a crash report, implement this callback. Before sending the crash, our SDK will add the attachment to the crash report and you can view it on the Mobile Center portal. Note that attachment will show in the portal in the future as the UI is still not ready.
-
-        ```Java
-        ErrorAttachment CrashesListener.getErrorAttachment(ErrorReport report) {
-            // return your own created ErrorAttachment object
-        }
-        ```
-
     * **Before sending a crash report:** This callback will be invoked just before the crash is sent to Mobile Center:
 
         ```Java

apps/sasquatch/src/main/java/com/microsoft/azure/mobile/sasquatch/activities/MainActivity.java

@@ -21,8 +21,6 @@
 import com.microsoft.azure.mobile.analytics.Analytics;
 import com.microsoft.azure.mobile.crashes.AbstractCrashesListener;
 import com.microsoft.azure.mobile.crashes.Crashes;
-import com.microsoft.azure.mobile.crashes.ErrorAttachments;
-import com.microsoft.azure.mobile.crashes.model.ErrorAttachment;
 import com.microsoft.azure.mobile.crashes.model.ErrorReport;
 import com.microsoft.azure.mobile.sasquatch.R;
 import com.microsoft.azure.mobile.sasquatch.features.TestFeatures;
@@ -31,7 +29,7 @@
 
 public class MainActivity extends AppCompatActivity {
 
-    public static final String LOG_TAG = "MobileCenterSasquatch";
+    private static final String LOG_TAG = "MobileCenterSasquatch";
     static final String APP_SECRET = "45d1d9f6-2492-4e68-bd44-7190351eb5f3";
     static final String APP_SECRET_KEY = "appSecret";
     static final String SERVER_URL_KEY = "serverUrl";
@@ -129,10 +127,11 @@ public void onClick(DialogInterface dialog, int which) {
                 return true;
             }
 
-            @Override
-            public ErrorAttachment getErrorAttachment(ErrorReport report) {
-                return ErrorAttachments.attachment("This is a text attachment.", "This is a binary attachment.".getBytes(), "binary.txt", "text/plain");
-            }
+            /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//            @Override
+//            public ErrorAttachment getErrorAttachment(ErrorReport report) {
+//                return ErrorAttachments.attachment("This is a text attachment.", "This is a binary attachment.".getBytes(), "binary.txt", "text/plain");
+//            }
 
             @Override
             public void onBeforeSending(ErrorReport report) {

sdk/mobile-center-crashes/src/androidTest/java/com/microsoft/azure/mobile/crashes/CrashesAndroidTest.java

@@ -171,7 +171,9 @@ public void onResult(ErrorReport errorReport) {
         verify(channel).enqueue(any(Log.class), anyString());
         assertNotNull(log.get());
         assertEquals(1, ErrorLogHelper.getErrorStorageDirectory().listFiles().length);
-        verify(crashesListener).getErrorAttachment(any(ErrorReport.class));
+
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        verify(crashesListener).getErrorAttachment(any(ErrorReport.class));
         verifyNoMoreInteractions(crashesListener);
 
         /* Third process: sending succeeds. */

sdk/mobile-center-crashes/src/main/java/com/microsoft/azure/mobile/crashes/AbstractCrashesListener.java

@@ -1,6 +1,5 @@
 package com.microsoft.azure.mobile.crashes;
 
-import com.microsoft.azure.mobile.crashes.model.ErrorAttachment;
 import com.microsoft.azure.mobile.crashes.model.ErrorReport;
 
 /**
@@ -17,10 +16,11 @@ public boolean shouldAwaitUserConfirmation() {
         return false;
     }
 
-    @Override
-    public ErrorAttachment getErrorAttachment(ErrorReport report) {
-        return null;
-    }
+    /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//    @Override
+//    public ErrorAttachment getErrorAttachment(ErrorReport report) {
+//        return null;
+//    }
 
     @SuppressWarnings("EmptyMethod")
     @Override

sdk/mobile-center-crashes/src/main/java/com/microsoft/azure/mobile/crashes/Crashes.java

@@ -17,7 +17,6 @@
 import com.microsoft.azure.mobile.channel.Channel;
 import com.microsoft.azure.mobile.crashes.ingestion.models.ManagedErrorLog;
 import com.microsoft.azure.mobile.crashes.ingestion.models.json.ManagedErrorLogFactory;
-import com.microsoft.azure.mobile.crashes.model.ErrorAttachment;
 import com.microsoft.azure.mobile.crashes.model.ErrorReport;
 import com.microsoft.azure.mobile.crashes.model.TestCrashException;
 import com.microsoft.azure.mobile.crashes.utils.ErrorLogHelper;
@@ -735,11 +734,13 @@ public void run() {
 
                         Map.Entry<UUID, ErrorLogReport> unprocessedEntry = unprocessedIterator.next();
                         ErrorLogReport errorLogReport = unprocessedEntry.getValue();
-                        ErrorAttachment attachment = mCrashesListener.getErrorAttachment(errorLogReport.report);
-                        if (attachment == null)
-                            MobileCenterLog.debug(LOG_TAG, "CrashesListener.getErrorAttachment returned null, no additional information will be attached to log: " + errorLogReport.log.getId().toString());
-                        else
-                            errorLogReport.log.setErrorAttachment(attachment);
+
+                        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//                        ErrorAttachment attachment = mCrashesListener.getErrorAttachment(errorLogReport.report);
+//                        if (attachment == null)
+//                            MobileCenterLog.debug(LOG_TAG, "CrashesListener.getErrorAttachment returned null, no additional information will be attached to log: " + errorLogReport.log.getId().toString());
+//                        else
+//                            errorLogReport.log.setErrorAttachment(attachment);
                         mChannel.enqueue(errorLogReport.log, ERROR_GROUP);
 
                         /* Clean up an error log file and map entry. */

sdk/mobile-center-crashes/src/main/java/com/microsoft/azure/mobile/crashes/CrashesListener.java

@@ -37,8 +37,9 @@ public interface CrashesListener {
      * @param report The crash report for additional information.
      * @return {@link ErrorAttachment} instance to be attached to the crash report.
      */
-    @WorkerThread
-    ErrorAttachment getErrorAttachment(ErrorReport report);
+    /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//    @WorkerThread
+//    ErrorAttachment getErrorAttachment(ErrorReport report);
 
     /**
      * Called right before sending a crash report. The callback can be invoked multiple times based on the number of crash reports.

sdk/mobile-center-crashes/src/main/java/com/microsoft/azure/mobile/crashes/ErrorAttachments.java

@@ -4,7 +4,6 @@
 
 import com.microsoft.azure.mobile.crashes.model.ErrorAttachment;
 import com.microsoft.azure.mobile.crashes.model.ErrorBinaryAttachment;
-import com.microsoft.azure.mobile.crashes.model.ErrorReport;
 import com.microsoft.azure.mobile.utils.MobileCenterLog;
 
 import static com.microsoft.azure.mobile.MobileCenter.LOG_TAG;
@@ -13,7 +12,8 @@
  * Error attachment utilities.
  */
 @SuppressWarnings("WeakerAccess")
-public final class ErrorAttachments {
+/* TODO (getErrorAttachment): Re-enable error attachment in javadoc when the feature becomes available. Add @ before link. */
+final class ErrorAttachments {
 
     @VisibleForTesting
     ErrorAttachments() {
@@ -22,7 +22,7 @@ public final class ErrorAttachments {
     }
 
     /**
-     * Build an attachment with text suitable for using in {@link CrashesListener#getErrorAttachment(ErrorReport)}.
+     * Build an attachment with text suitable for using in {link CrashesListener#getErrorAttachment(ErrorReport)}.
      *
      * @param text Text to attach to the error report.
      * @return error Attachment or null if null text is passed.
@@ -32,7 +32,7 @@ public static ErrorAttachment attachmentWithText(String text) {
     }
 
     /**
-     * Build an attachment with binary suitable for using in {@link CrashesListener#getErrorAttachment(ErrorReport)}.
+     * Build an attachment with binary suitable for using in {link CrashesListener#getErrorAttachment(ErrorReport)}.
      *
      * @param data        binary data.
      * @param fileName    file name to use on reports.
@@ -44,7 +44,7 @@ public static ErrorAttachment attachmentWithBinary(byte[] data, String fileName,
     }
 
     /**
-     * Build an attachment with text and binary suitable for using in {@link CrashesListener#getErrorAttachment(ErrorReport)}.
+     * Build an attachment with text and binary suitable for using in {link CrashesListener#getErrorAttachment(ErrorReport)}.
      *
      * @param text        text data.
      * @param data        binary data.

sdk/mobile-center-crashes/src/test/java/com/microsoft/azure/mobile/crashes/CrashesTest.java

@@ -12,7 +12,6 @@
 import com.microsoft.azure.mobile.crashes.ingestion.models.ManagedErrorLog;
 import com.microsoft.azure.mobile.crashes.ingestion.models.StackFrame;
 import com.microsoft.azure.mobile.crashes.ingestion.models.json.ManagedErrorLogFactory;
-import com.microsoft.azure.mobile.crashes.model.ErrorAttachment;
 import com.microsoft.azure.mobile.crashes.model.ErrorReport;
 import com.microsoft.azure.mobile.crashes.model.TestCrashException;
 import com.microsoft.azure.mobile.crashes.utils.ErrorLogHelper;
@@ -292,11 +291,14 @@ public void queuePendingCrashesShouldProcess() throws IOException, ClassNotFound
         when(StorageHelper.InternalStorage.read(any(File.class))).thenReturn("");
         when(StorageHelper.InternalStorage.readObject(any(File.class))).thenReturn(new RuntimeException());
 
-        ErrorAttachment mockAttachment = mock(ErrorAttachment.class);
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        ErrorAttachment mockAttachment = mock(ErrorAttachment.class);
         CrashesListener mockListener = mock(CrashesListener.class);
         when(mockListener.shouldProcess(report)).thenReturn(true);
         when(mockListener.shouldAwaitUserConfirmation()).thenReturn(false);
-        when(mockListener.getErrorAttachment(report)).thenReturn(mockAttachment);
+
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        when(mockListener.getErrorAttachment(report)).thenReturn(mockAttachment);
 
         Crashes crashes = Crashes.getInstance();
         LogSerializer logSerializer = mock(LogSerializer.class);
@@ -308,7 +310,9 @@ public void queuePendingCrashesShouldProcess() throws IOException, ClassNotFound
 
         verify(mockListener).shouldProcess(report);
         verify(mockListener).shouldAwaitUserConfirmation();
-        verify(mockListener).getErrorAttachment(report);
+
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        verify(mockListener).getErrorAttachment(report);
         verify(mockChannel).enqueue(argThat(new ArgumentMatcher<Log>() {
             @Override
             public boolean matches(Object log) {
@@ -344,7 +348,9 @@ public void queuePendingCrashesShouldNotProcess() throws IOException, ClassNotFo
 
         verify(mockListener).shouldProcess(report);
         verify(mockListener, never()).shouldAwaitUserConfirmation();
-        verify(mockListener, never()).getErrorAttachment(report);
+
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        verify(mockListener, never()).getErrorAttachment(report);
         verify(mockChannel, never()).enqueue(any(Log.class), eq(crashes.getGroupName()));
     }
 
@@ -376,7 +382,9 @@ public void queuePendingCrashesAlwaysSend() throws IOException, ClassNotFoundExc
 
         verify(mockListener).shouldProcess(report);
         verify(mockListener, never()).shouldAwaitUserConfirmation();
-        verify(mockListener).getErrorAttachment(report);
+
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        verify(mockListener).getErrorAttachment(report);
         verify(mockChannel).enqueue(argThat(new ArgumentMatcher<Log>() {
             @Override
             public boolean matches(Object log) {
@@ -469,6 +477,13 @@ public void disabledDuringHandleUserConfirmation() throws IOException, ClassNotF
         LogSerializer logSerializer = mock(LogSerializer.class);
         when(logSerializer.deserializeLog(anyString())).thenReturn(mErrorLog).thenReturn(errorLog);
         Channel channel = mock(Channel.class);
+        doAnswer(new Answer<Object>() {
+            @Override
+            public Object answer(InvocationOnMock invocation) throws Throwable {
+                Crashes.setEnabled(false);
+                return null;
+            }
+        }).when(channel).enqueue(any(Log.class), anyString());
 
         mockStatic(ErrorLogHelper.class);
         when(ErrorLogHelper.getStoredErrorLogFiles()).thenReturn(new File[]{mock(File.class), mock(File.class)});
@@ -480,14 +495,6 @@ public void disabledDuringHandleUserConfirmation() throws IOException, ClassNotF
         when(StorageHelper.InternalStorage.readObject(any(File.class))).thenReturn(EXCEPTION);
         when(StorageHelper.InternalStorage.read(any(File.class))).thenReturn("");
 
-        when(listener.getErrorAttachment(errorReport1)).thenAnswer(new Answer<ErrorAttachment>() {
-            @Override
-            public ErrorAttachment answer(InvocationOnMock invocation) throws Throwable {
-                Crashes.setEnabled(false);
-                return null;
-            }
-        });
-
         Crashes crashes = Crashes.getInstance();
         crashes.setLogSerializer(logSerializer);
         crashes.setInstanceListener(listener);
@@ -497,7 +504,9 @@ public ErrorAttachment answer(InvocationOnMock invocation) throws Throwable {
         verify(listener, times(2)).shouldProcess(any(ErrorReport.class));
         verify(listener).shouldAwaitUserConfirmation();
         verify(channel).enqueue(any(Log.class), anyString());
-        verify(listener).getErrorAttachment(any(ErrorReport.class));
+
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        verify(listener).getErrorAttachment(any(ErrorReport.class));
         verifyNoMoreInteractions(listener);
     }
 
@@ -712,7 +721,8 @@ public void handleUserConfirmationDoNotSend() throws IOException, ClassNotFoundE
 
         Crashes.notifyUserConfirmation(Crashes.DONT_SEND);
 
-        verify(mockListener, never()).getErrorAttachment(any(ErrorReport.class));
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        verify(mockListener, never()).getErrorAttachment(any(ErrorReport.class));
         verify(mMockLooper).quit();
 
         verifyStatic();
@@ -813,10 +823,11 @@ public boolean shouldAwaitUserConfirmation() {
                 return false;
             }
 
-            @Override
-            public ErrorAttachment getErrorAttachment(ErrorReport report) {
-                return null;
-            }
+            /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//            @Override
+//            public ErrorAttachment getErrorAttachment(ErrorReport report) {
+//                return null;
+//            }
 
             @Override
             public void onBeforeSending(ErrorReport report) {
@@ -841,7 +852,8 @@ public void onSendingSucceeded(ErrorReport report) {
         assertFalse(defaultListener.shouldAwaitUserConfirmation());
 
         /* Nothing to verify. */
-        defaultListener.getErrorAttachment(null);
+        /* TODO (getErrorAttachment): Re-enable error attachment when the feature becomes available. */
+//        defaultListener.getErrorAttachment(null);
         defaultListener.onBeforeSending(null);
         defaultListener.onSendingSucceeded(null);
         defaultListener.onSendingFailed(null, null);

versions.gradle

@@ -1,8 +1,8 @@
 // Version constants
 
 ext {
-    versionCode = 12
-    versionName = '0.4.0'
+    versionCode = 13
+    versionName = '0.5.0'
     minSdkVersion = 15
     targetSdkVersion = 25
     compileSdkVersion = 25