Make missing ad reports great again

[suhan3z]

Message structure

productName: String (optional)

Describes Adguard product Can be one of the following Windows, Android, Extension, iOS, macOS

email: String (optional)

User email

pageUrl: String

Page url where complaint take place

referrerUrl: String (optional)

Referrer

userAgent: String (optional)

User agent

productVersion: String (optional)

Adguard product version. Format: x.x.x.x

osType: String.

OS name like Windows/Linux/OSX/iOS/Android

osVersion: String

OS version like 10.0.10586 Build 10586

settings: JSON object

Key-value pairs. Key: setting name. Value: setting value

requests: Array of Request objects (optional)

Request object:

• url: String Request url
• type: String Content type of request. Can be one of the following HTML, Javascript, Ajax, Images, Media, Other
• thirdParty: Bool Is third party request
• rules: Array of Strings Applied rules
• responseStatus: Int Response status code
• httpRequestHeaders: Array of Objects Array of key-value pairs. Key: header name. Value: header value.
• httpResponseHeaders: Array of Objects Array of key-value pairs. Key: header name. Value: header value.

  filters: Array of FilterObject's

Array of enabled filters

Filter Object:

• name: String. Optional Filter name
• version: String. Optional Filter version. Can be timestamp if filter have no version
• subscriptionUrl: String Filter subscription url

comment: String. Optional

User comment

Screenshots

Just an array of base64 encoded data: urls.

Message example:

{  
   productName:'windows',
   email:'some@mail.com',
   pageUrl:'https://lenta.ru/news/2016/08/26/corvette/',
   referrerUrl:'https://lenta.ru/',
   userAgent:'Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36',
   productVersion:'6.1.255.1268',
   osType:'Windows',
   osVersion:'10.0.10586 Build 10586',
   settings:{  
      GeneralSettings:{  
         IsBetaChannel:"true",
         IsAutoUpdateEnabled:"true"
      },
      NetworkSettings:{  
         ProxyConfig:{  
            Port:3048,
            Ip:"168.26.38.21"
         }
      }
   },
   requests:[  
      {  
         url:"https://somesite.com/rtg/xk.svg",
         type:"Images",
         thirdParty:true,
         rules:[  
            "||somesite.com/rtrg$third-party"
         ],
         responseStatus:404,
         httpRequestHeaders:[  
            {  
               "Connection":"keep-alive"
            },
            {  
               "Upgrade-Insecure-Requests":"1"
            }
         ],
         httpResponseHeaders:[  
            {  
               "Server":"cloudflare-nginx"
            }
         ]
      }
   ],
   filters:[  
      {  
         name:"EasyList",
         version:"2059464323",
         subscriptionUrl:"https://easylist.to/easylist/easylist.txt"
      }
   ],
   screenshots: [
        "data:image/png;base64,ASDASDASDADASD",
        "data:image/png;base64,ASDASDASDADASD"
    ],
   comment:'some user comment'
}

[ameshkov]

Flow

1. User reports an issue from the webpage (using Adguard Assistant browser module).
2. Adguard opens an "Issue report" dialog window

Issue report dialog UI

We should implement a wizard-like dialog window.

Step 1: Problem type


Step 2: Attach screenshots


Step 2.1: Edit screenshot


Step 3: Submit report


Step 4: Result


[ameshkov]

@suhan3z design: https://www.dropbox.com/sh/59e1eu4kwc9iplr/AADl-LZ4MjTtnMcivoOfskWoa?dl=0

[vozersky]

separate repo now: https://github.com/AdguardTeam/ReportsWebApp