@percy/report 1.0.4 → 1.0.6

package/README.md

@@ -46,7 +46,7 @@ Step 3 : Execute the Percy Report Generation Step<br>
 [Example](/example/percy.sh):
 ```sh
 export PERCY_TOKEN=<your-percy-token>
-BUILD_ID=$(npx percy exec -- {Test Command} | grep build | awk -F "/" '{print $NF}')
+BUILD_ID=$(npx percy exec -- {Test Command} | grep https:\/\/percy.io\/.*\/builds | awk -F "/" '{print $NF}')
 npx percy-report generate $BUILD_ID
 ```
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@percy/report",
   "description": "Package to generate a build report and project summary report for Percy, BrowserStack's visual testing platform",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "src/index.js",
   "license": "MIT",
   "author": "BrowserStack Pvt Ltd",

package/src/generate.js

@@ -34,7 +34,7 @@ module.exports.Generate = async function (config) {
             downloadQueue =  new PQueue({concurrency:1,intervalCap:5,interval:5000})
         })
     }
-    const isApp = buildDetails['data']['attributes']['type'] == 'app'
+    const useCompTag = buildDetails['data']['attributes']['type'] == 'app' || buildDetails['data']['attributes']['type'] == 'automate'
     while (buildDetails.data && buildDetails.data.attributes.state !== 'finished') {
         console.log("Waiting for build to complete on Percy...")
         await wait(30000)
@@ -49,17 +49,41 @@ module.exports.Generate = async function (config) {
             throw new Error("Build Failed with an Error on Percy Server. Please check your percy dashboard for more information.")
         }
     }
-    
+
     console.log(`Generating report for Build ID ${buildId}`)
-    let snapshotsData = await axios.get(`/snapshots?build_id=${buildId}`, { responseType: 'json' }).then((res) => {
-        if (res.status == 200) {
-            let parser = new Parser(res.data)
-            let data = parser.getSimplified()
-            return data
+    // let snapshotsData = await axios.get(`/snapshots?build_id=${buildId}`, { responseType: 'json' }).then((res) => {
+    //     if (res.status == 200) {
+    //         let parser = new Parser(res.data)
+    //         let data = parser.getSimplified()
+    //         return data
+    //     } else {
+    //         throw res.data
+    //     }
+    // })
+    //
+    let snapshotsData = [];
+    let cursor = null;
+    let hasMore = true;
+
+    while (hasMore) {
+        const cursorParam = cursor ? `&page[cursor]=${cursor}` : '';
+        const response = await axios.get(`/snapshots?build_id=${buildId}${cursorParam}`, { responseType: 'json' });
+        if (response.status === 200) {
+            let parser = new Parser(response.data);
+            let data = parser.getSimplified();
+            if (data.length > 0) {
+                snapshotsData.push(...data);
+                cursor = data[data.length - 1].id; // update cursor to last snapshot ID
+                // If less than a typical page size (usually 20), stop
+                // hasMore = data.length >= 20;
+            } else {
+                hasMore = false;
+            }
         } else {
-            throw res.data
+            throw response.data;
         }
-    })
+    }
+
     buildURL = buildDetails['data']['attributes']['web-url']
     projectURL = buildURL.split("/builds/")[0]
     projectName = projectURL.split('/').slice(-1)[0]
@@ -89,8 +113,8 @@ module.exports.Generate = async function (config) {
             let head = images['head'] = getComparisonImage(comp, 'head-screenshot')
             let diff = images['diff'] = getComparisonImage(comp, 'diff-image')
             let compTag;
-            Object.assign(comparison, comp.attributes, { images }, isApp?{ device:compTag }:{browser:compTag});
-            if (isApp) {
+            Object.assign(comparison, comp.attributes, { images }, useCompTag?{ device:compTag }:{browser:compTag});
+            if (useCompTag) {
                 let device = getComparisonDevice(comp)
                 compTag = `${device.name} (${device['os-name']} ${device['os-version']})`
                 if(!report.devices.includes(compTag)){
@@ -130,7 +154,7 @@ module.exports.Generate = async function (config) {
                 report['unreviewedScreenshots']++
                 flagChanged = true
             }
-            Object.assign(comparison, comp.attributes, { images }, isApp?{ device:compTag }:{browser:compTag})
+            Object.assign(comparison, comp.attributes, { images }, useCompTag?{ device:compTag }:{browser:compTag})
 
             
             comparison['diff-percentage'] = (comparison['diff-ratio'] * 100).toFixed(2)
@@ -146,7 +170,7 @@ module.exports.Generate = async function (config) {
         return formattedSnapshot
     })
     fs.writeFileSync(`${baseDir}/report.json`, JSON.stringify(report, undefined, 2))
-    HtmlReportGenerator(config, report, isApp)
+    HtmlReportGenerator(config, report, useCompTag)
     console.log("Build Report Generated.")
     return report
 }

package/src/html-render.js

@@ -2,7 +2,7 @@ const fs = require('fs')
 const ejs = require('ejs');
 const path = require('path')
 
-function HtmlReportGenerator(config, jsonReport, isApp) {
+function HtmlReportGenerator(config, jsonReport, useCompTag) {
     let {
         buildId,
         downloadPath
@@ -24,8 +24,8 @@ function HtmlReportGenerator(config, jsonReport, isApp) {
     fs.writeFileSync(`${downloadPath}/${buildId}/report.html`, htmlReport)
 }
 
-function HtmlSummary(summary, filename, isApp) {
-    if (isApp) {
+function HtmlSummary(summary, filename, useCompTag) {
+    if (useCompTag) {
         let template_path = path.resolve(__dirname, 'template/app-summary.html')
         const template = fs.readFileSync(template_path, {
             encoding: "utf-8"

package/src/summary.js

@@ -35,7 +35,7 @@ module.exports.Summary = async function (opts) {
             throw res.data
         }
     })
-    const isApp = project['data']['attributes']['type'] == 'app'
+    const useCompTag = project['data']['attributes']['type'] == 'app' || project['data']['attributes']['type'] == 'automate'
     let projectId = project.data.id
     let projectURL = "https://percy.io/"+project.data.attributes['full-slug']
     let projectName = project.data.attributes.name
@@ -131,7 +131,7 @@ module.exports.Summary = async function (opts) {
         fs.mkdirSync('Summary',{recursive:true})
     }
     fs.writeFileSync(`Summary/${summary.projectName}-${Date.now()}.json`,JSON.stringify(summary,undefined,2))
-    HtmlSummary(summary,`Summary/${summary.projectName}-${Date.now()}.html`, isApp)
+    HtmlSummary(summary,`Summary/${summary.projectName}-${Date.now()}.html`, useCompTag)
     console.log("Summary report generated")
     return summary;