From 8263930939b8564b73bc314dc7dc3a073ef7224e Mon Sep 17 00:00:00 2001
From: Pablo Gamito <pablogamito@google.com>
Date: Fri, 17 Jul 2020 18:38:37 +0100
Subject: [PATCH 1/5] Add snackbar messages for data input loading

Test: Try loading file and see if the snackbar appears properly
Change-Id: I2af03ef4dedebc3c5e06efc318a5bc8afba1ab9a
---
 tools/winscope/src/DataInput.vue | 69 ++++++++++++++++++++++++++------
 tools/winscope/src/Rects.vue     |  2 +-
 2 files changed, 57 insertions(+), 14 deletions(-)

diff --git a/tools/winscope/src/DataInput.vue b/tools/winscope/src/DataInput.vue
index f20697d45..874c46bbb 100644
--- a/tools/winscope/src/DataInput.vue
+++ b/tools/winscope/src/DataInput.vue
@@ -54,6 +54,23 @@
         <md-button v-if="dataReady" @click="onSubmit" class="md-button md-primary md-raised md-theme-default">Submit</md-button>
       </div>
     </md-card-content>
+
+    <md-snackbar
+      md-position="center"
+      :md-duration="Infinity"
+      :md-active.sync="showFetchingSnackbar"
+      md-persistent
+    >
+      <span>{{ fetchingSnackbarText }}</span>
+    </md-snackbar>
+
+    <md-snackbar
+      md-position="center"
+      :md-active.sync="showSnackbar"
+      md-persistent
+    >
+      <span style="white-space: pre-line;">{{ snackbarText }}</span>
+    </md-snackbar>
   </flat-card>
 </template>
 <script>
@@ -80,6 +97,10 @@ export default {
       fileType: "auto",
       dataFiles: {},
       loadingFiles: false,
+      showFetchingSnackbar: false,
+      showSnackbar: false,
+      snackbarText: '',
+      fetchingSnackbarText: "Fetching files...",
     }
   },
   props: ['store'],
@@ -88,19 +109,38 @@ export default {
     this.loadFilesFromExtension();
   },
   methods: {
-    getLoadingStatusAnimation(message) {
+    showSnackbarMessage(message, duration) {
+      clearTimeout(this.showSnackbarTimeout);
+
+      // Toogle boolean first to make ref available
+      this.showSnackbar = true;
+      this.snackbarText = message;
+
+      if (duration !== Infinity) {
+        this.showSnackbarTimeout = setTimeout(() => {
+          this.showSnackbar = false;
+        }, duration);
+      }
+    },
+    hideSnackbarMessage() {
+      clearTimeout(this.showSnackbarTimeout);
+      this.showSnackbar = false;
+    },
+    getFetchFilesLoadingAnimation() {
       let frame = 0;
       const fetchingStatusAnimation = () => {
         frame++;
-        this.$emit('statusChange', `${message}${'.'.repeat(frame % 4)}`);
+        this.fetchingSnackbarText = `Fetching files${'.'.repeat(frame % 4)}`;
       };
       let interval = undefined;
 
       return Object.freeze({
         start: () => {
+          this.showFetchingSnackbar = true;
           interval = setInterval(fetchingStatusAnimation, 500);
         },
         stop: () => {
+          this.showFetchingSnackbar = false;
           clearInterval(interval);
         },
       });
@@ -117,7 +157,7 @@ export default {
         // Fetch files from extension
         const androidBugToolExtensionId = "mbbaofdfoekifkfpgehgffcpagbbjkmj";
 
-        const loading = this.getLoadingStatusAnimation('Fetching files');
+        const loading = this.getFetchFilesLoadingAnimation();
         loading.start();
 
         // Request to convert the blob object url "blob:chrome-extension://xxx"
@@ -149,21 +189,22 @@ export default {
                 loading.stop();
                 this.processFiles(files);
               } else {
-                console.warn("Got no attachements from extension...");
+                const failureMessages = "Got no attachements from extension...";
+                console.warn(failureMessages);
+                this.showSnackbarMessage(failureMessages, 3500);
               }
               break;
 
             default:
               loading.stop();
-              console.warn("Received unhandled response code from extension.");
+              const failureMessages = "Received unhandled response code from extension.";
+              console.warn(failureMessages);
+              this.showSnackbarMessage(failureMessages, 3500);
           }
         });
       }
     },
     onLoadFile(e) {
-      // Clear status to avoid keeping status of previous failed uploads
-      this.$emit('statusChange', null);
-
       const files = event.target.files || event.dataTransfer.files;
       this.processFiles(files);
     },
@@ -173,12 +214,12 @@ export default {
       for (const file of files) {
         try {
           this.loadingFiles = true;
-          this.$emit('statusChange', file.name + " (loading)");
+          this.showSnackbarMessage(`Loading ${file.name}`, Infinity);
           const result = await this.addFile(file);
           decodedFiles.push(...result);
-          this.$emit('statusChange', null);
+          this.hideSnackbarMessage();
         } catch(e) {
-          this.$emit('statusChange', `${file.name}: ${e}`);
+          this.showSnackbarMessage(`Failed to load '${file.name}'...\n${e}`, 5000);
           console.error(e);
           error = e;
           break;
@@ -256,8 +297,6 @@ export default {
       const zip = new JSZip();
       const content = await zip.loadAsync(buffer);
 
-      console.log("ZIP CONTENT", content);
-
       const decodedFiles = [];
       for (const filename of BUG_REPORT_FILES) {
         const file = content.files[filename];
@@ -270,6 +309,10 @@ export default {
         }
       }
 
+      if (decodedFiles.length == 0) {
+        throw new Error("No matching files found in archive", file);
+      }
+
       return decodedFiles;
     },
     onRemoveFile(typeName) {
diff --git a/tools/winscope/src/Rects.vue b/tools/winscope/src/Rects.vue
index 1f7c26c2f..0e3f1c5f9 100644
--- a/tools/winscope/src/Rects.vue
+++ b/tools/winscope/src/Rects.vue
@@ -51,7 +51,7 @@ export default {
   },
   methods: {
     s(sourceCoordinate) {  // translate source into target coordinates
-    var scale; 
+    var scale;
     if(this.boundsC.width < this.boundsC.height) {
       scale =  this.desiredHeight / this.boundsC.height;
     } else {

From 348275daecc2ac078cfaaa35caddd3edfe2af427 Mon Sep 17 00:00:00 2001
From: Pablo Gamito <pablogamito@google.com>
Date: Fri, 17 Jul 2020 19:18:47 +0100
Subject: [PATCH 2/5] Scan through entire archive to find matching files

Test: Upload .zip and see if all relevant files are picked up
Change-Id: Id8bfdcfb969032a6d5cec7e20a89ff9ef3db2706
---
 tools/winscope/src/DataInput.vue | 28 ++++++++++++----------------
 tools/winscope/src/decode.js     | 10 ++++++++--
 2 files changed, 20 insertions(+), 18 deletions(-)

diff --git a/tools/winscope/src/DataInput.vue b/tools/winscope/src/DataInput.vue
index 874c46bbb..97de8abf4 100644
--- a/tools/winscope/src/DataInput.vue
+++ b/tools/winscope/src/DataInput.vue
@@ -76,19 +76,9 @@
 <script>
 import FlatCard from './components/FlatCard.vue';
 import JSZip from 'jszip';
-import { detectAndDecode, FILE_TYPES, DATA_TYPES } from './decode.js';
+import { detectAndDecode, FILE_TYPES, DATA_TYPES, UndetectableFileType } from './decode.js';
 import { WebContentScriptMessageType } from './utils/consts';
 
-// Add any file that should be considered when extracting a bug report here
-// NOTE: If two files have the same type, the last one will be selected
-const BUG_REPORT_FILES = [
-  "proto/SurfaceFlinger_CRITICAL.proto",
-  "proto/window_CRITICAL.proto",
-  "FS/data/misc/wmtrace/layers_trace.pb",
-  "FS/data/misc/wmtrace/wm_log.pb",
-  "FS/data/misc/wmtrace/wm_trace.pb",
-];
-
 export default {
   name: 'datainput',
   data() {
@@ -298,14 +288,20 @@ export default {
       const content = await zip.loadAsync(buffer);
 
       const decodedFiles = [];
-      for (const filename of BUG_REPORT_FILES) {
-        const file = content.files[filename];
-        if (file) {
-          const fileBlob = await file.async("blob");
-          fileBlob.name = filename;
 
+      for (const filename in content.files) {
+        const file = content.files[filename];
+
+        const fileBlob = await file.async("blob");
+        fileBlob.name = filename;
+
+        try {
           const decodedFile = await this.decodeFile(fileBlob);
           decodedFiles.push(decodedFile);
+        } catch(e) {
+          if (!(e instanceof UndetectableFileType)) {
+            throw e;
+          }
         }
       }
 
diff --git a/tools/winscope/src/decode.js b/tools/winscope/src/decode.js
index ed6b29f36..ba887dd81 100644
--- a/tools/winscope/src/decode.js
+++ b/tools/winscope/src/decode.js
@@ -335,7 +335,13 @@ function detectAndDecode(buffer, fileName, store) {
       // ignore exception and try next filetype
     }
   }
-  throw new Error('Unable to detect file');
+  throw new UndetectableFileType('Unable to detect file');
 }
 
-export { detectAndDecode, decodeAndTransformProto, DATA_TYPES, FILE_TYPES };
+/**
+ * Error is raised when detectAndDecode is called but the file can't be
+ * automatically detected as being of a compatible file type.
+ */
+class UndetectableFileType extends Error { }
+
+export { detectAndDecode, decodeAndTransformProto, DATA_TYPES, FILE_TYPES, UndetectableFileType };

From 586756fff5ecdb5c2e29e6890ac709198121a299 Mon Sep 17 00:00:00 2001
From: Pablo Gamito <pablogamito@google.com>
Date: Fri, 17 Jul 2020 19:19:20 +0100
Subject: [PATCH 3/5] Add warning if files are overriden on upload

Test: Upload files of the same type and check that message appears
Change-Id: Ia2f5d7ba12dc03a36f42dc1debe7d35be98bfd67
---
 tools/winscope/src/DataInput.vue | 60 +++++++++++++++++++++++++++++++-
 1 file changed, 59 insertions(+), 1 deletion(-)

diff --git a/tools/winscope/src/DataInput.vue b/tools/winscope/src/DataInput.vue
index 97de8abf4..a5e55a6f0 100644
--- a/tools/winscope/src/DataInput.vue
+++ b/tools/winscope/src/DataInput.vue
@@ -224,9 +224,67 @@ export default {
         return;
       }
 
+      const decodedFileTypes = new Set(Object.keys(this.dataFiles));
+      // A file is overridden if a file of the same type is upload twice, as
+      // Winscope currently only support at most one file to each type
+      const overriddenDataTypes = new Set();
+      const overriddenFiles = {}; // filetype => array of file names
+      let overriddenCount = 0;
       for (const decodedFile of decodedFiles) {
+        const dataType = decodedFile.filetype.dataType.name;
+
+        if (decodedFileTypes.has(dataType)) {
+          overriddenDataTypes.add(dataType);
+          (overriddenFiles[dataType] = overriddenFiles[dataType] || [])
+            .push(this.dataFiles[dataType].filename);
+          overriddenCount++;
+        }
+        decodedFileTypes.add(dataType);
+
         this.$set(this.dataFiles,
-          decodedFile.filetype.dataType.name, decodedFile.data);
+          dataType, decodedFile.data);
+      }
+
+      if (overriddenDataTypes.size > 0) {
+        if (overriddenDataTypes.size === 1 && overriddenCount === 1) {
+          const type = overriddenDataTypes.values().next().value;
+          const overriddenFile = overriddenFiles[type][0];
+          const keptFile = this.dataFiles[type].filename;
+          const message = `'${overriddenFile}' is conflicting with '${keptFile}'. Only '${keptFile}' will be kept. If you wish to display '${overriddenFile}', please upload it again with no other file of the same type.`;
+
+          this.showSnackbarMessage(`WARNING: ${message}`, Infinity);
+          console.warn(message);
+        } else {
+          const message = `Mutiple conflicting files have been uploaded. ${overriddenCount} files have been discarded. Please check the developer console for more information.`;
+          this.showSnackbarMessage(`WARNING: ${message}`, Infinity);
+
+          const messageBuilder = [];
+          for (const type of overriddenDataTypes.values()) {
+            const keptFile = this.dataFiles[type].filename;
+            const overriddenFilesCount = overriddenFiles[type].length;
+
+            messageBuilder.push(`${overriddenFilesCount} file${overriddenFilesCount > 1 ? 's' : ''} of type ${type} ${overriddenFilesCount > 1 ? 'have' : 'has'} been overridden. Only '${keptFile}' has been kept.`);
+          }
+
+          messageBuilder.push("");
+          messageBuilder.push("Please reupload the specific files you want to read (one of each type).");
+          messageBuilder.push("");
+
+          messageBuilder.push("================DISCARDED FILES================");
+
+          for (const type of overriddenDataTypes.values()) {
+            const discardedFiles = overriddenFiles[type];
+            const keptFile = this.dataFiles[type].filename;
+
+            messageBuilder.push(`The following files of type ${type} have been discarded:`);
+            for (const discardedFile of discardedFiles) {
+              messageBuilder.push(`  - ${discardedFile}`);
+            }
+            messageBuilder.push("");
+          }
+
+          console.warn(messageBuilder.join("\n"));
+        }
       }
     },
     getFileExtensions(file) {

From afbfa78477bd51e73f2e2c847c154ad96b9b482f Mon Sep 17 00:00:00 2001
From: Pablo Gamito <pablogamito@google.com>
Date: Fri, 17 Jul 2020 19:26:56 +0100
Subject: [PATCH 4/5] Add snackbar dismiss button

Test: Click on button and seem if snackbar is dismissed
Change-Id: Ib0c7a93e8cbc2b8b1a71890b1fd0c2d3ba19dadc
---
 tools/winscope/src/DataInput.vue | 20 +++++++++-----------
 1 file changed, 9 insertions(+), 11 deletions(-)

diff --git a/tools/winscope/src/DataInput.vue b/tools/winscope/src/DataInput.vue
index a5e55a6f0..2f15c210e 100644
--- a/tools/winscope/src/DataInput.vue
+++ b/tools/winscope/src/DataInput.vue
@@ -66,10 +66,16 @@
 
     <md-snackbar
       md-position="center"
+      :md-duration="snackbarDuration"
       :md-active.sync="showSnackbar"
       md-persistent
     >
       <span style="white-space: pre-line;">{{ snackbarText }}</span>
+      <div @click="hideSnackbarMessage()">
+        <md-button class="md-icon-button">
+          <md-icon style="color: white">close</md-icon>
+        </md-button>
+      </div>
     </md-snackbar>
   </flat-card>
 </template>
@@ -89,6 +95,7 @@ export default {
       loadingFiles: false,
       showFetchingSnackbar: false,
       showSnackbar: false,
+      snackbarDuration: 3500,
       snackbarText: '',
       fetchingSnackbarText: "Fetching files...",
     }
@@ -100,20 +107,11 @@ export default {
   },
   methods: {
     showSnackbarMessage(message, duration) {
-      clearTimeout(this.showSnackbarTimeout);
-
-      // Toogle boolean first to make ref available
-      this.showSnackbar = true;
       this.snackbarText = message;
-
-      if (duration !== Infinity) {
-        this.showSnackbarTimeout = setTimeout(() => {
-          this.showSnackbar = false;
-        }, duration);
-      }
+      this.snackbarDuration = duration;
+      this.showSnackbar = true;
     },
     hideSnackbarMessage() {
-      clearTimeout(this.showSnackbarTimeout);
       this.showSnackbar = false;
     },
     getFetchFilesLoadingAnimation() {

From f77c452779a284aa16aca7f1bdfd1e3c345c7e32 Mon Sep 17 00:00:00 2001
From: Pablo Gamito <pablogamito@google.com>
Date: Mon, 20 Jul 2020 11:42:50 +0100
Subject: [PATCH 5/5] Ignore files decoded as empty transaction files

When uploading an archive files will fallback to being decoded as empty transaction files so we want to ignore these when decoding an archive.

Test: Upload bug report and see if any empty transaction file are loaded
Change-Id: I6c36b7155133f2c2b9ddfe96858e233c4c9f4176
---
 tools/winscope/src/DataInput.vue |  9 +++++----
 tools/winscope/src/decode.js     | 20 +++++++++++++++++---
 2 files changed, 22 insertions(+), 7 deletions(-)

diff --git a/tools/winscope/src/DataInput.vue b/tools/winscope/src/DataInput.vue
index 2f15c210e..80c6d6848 100644
--- a/tools/winscope/src/DataInput.vue
+++ b/tools/winscope/src/DataInput.vue
@@ -304,7 +304,7 @@ export default {
       // for more information.
       if (type === 'bugreport' ||
           (type === 'auto' && (extension === 'zip' || file.type === 'application/zip'))) {
-        const results = await this.decodeCompressedBugReport(file);
+        const results = await this.decodeArchive(file);
         decodedFiles.push(...results);
       } else {
         const decodedFile = await this.decodeFile(file);
@@ -337,8 +337,8 @@ export default {
 
       return {filetype, data};
     },
-    async decodeCompressedBugReport(file) {
-      const buffer = await this.readFile(file);
+    async decodeArchive(archive) {
+      const buffer = await this.readFile(archive);
 
       const zip = new JSZip();
       const content = await zip.loadAsync(buffer);
@@ -353,6 +353,7 @@ export default {
 
         try {
           const decodedFile = await this.decodeFile(fileBlob);
+
           decodedFiles.push(decodedFile);
         } catch(e) {
           if (!(e instanceof UndetectableFileType)) {
@@ -362,7 +363,7 @@ export default {
       }
 
       if (decodedFiles.length == 0) {
-        throw new Error("No matching files found in archive", file);
+        throw new Error("No matching files found in archive", archive);
       }
 
       return decodedFiles;
diff --git a/tools/winscope/src/decode.js b/tools/winscope/src/decode.js
index ba887dd81..6ff69713e 100644
--- a/tools/winscope/src/decode.js
+++ b/tools/winscope/src/decode.js
@@ -328,11 +328,25 @@ function detectAndDecode(buffer, fileName, store) {
   if (arrayStartsWith(buffer, LAUNCHER_MAGIC_NUMBER)) {
     return decodedFile(FILE_TYPES['launcher_trace'], buffer, fileName, store);
   }
-  for (var name of ['transaction', 'layers_dump', 'window_dump', 'wl_dump']) {
+
+  for (const [name, condition] of [
+    ['transaction', (file) => file.data.length > 0],
+    ['wl_dump', (file) => (file.data.length > 0 && file.data.children[0] > 0) || file.data.length > 1],
+    ['layers_dump'],
+    ['window_dump']
+  ]) {
     try {
-      return decodedFile(FILE_TYPES[name], buffer, fileName, store);
+      const [filetype, fileData] = decodedFile(FILE_TYPES[name], buffer, fileName, store);
+
+      // A generic file will often wrongly be decoded as an empty wayland dump file
+      if (condition && !condition(fileData)) {
+        // Fall through to next filetype
+        continue;
+      }
+
+      return [filetype, fileData];
     } catch (ex) {
-      // ignore exception and try next filetype
+      // ignore exception and fall through to next filetype
     }
   }
   throw new UndetectableFileType('Unable to detect file');