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

Jump to bottom

Surface browser version change information #94

Merged
merged 2 commits into from
Jul 26, 2023
Merged

Surface browser version change information #94

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
41f3acd
surface browser version change information
dlockhart Jul 24, 2023
de3e180
Update src/server/visual-diff-reporter.js
dlockhart Jul 25, 2023
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
16 changes: 16 additions & 0 deletions .vdiff.json
View file
Open in desktop
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what the file we'll be checking into each repo would look like. Open to other suggestions around naming, etc.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"browsers": [
{
"name": "Chromium",
"version": 115
},
{
"name": "Firefox",
"version": 115
},
{
"name": "Webkit",
"version": 17
}
]
}
19 changes: 18 additions & 1 deletion src/server/report/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ class App extends LitElement {
return html`
<aside>
<div>
<h1>Visual-diff Results</h1>
<h1>Visual-Diff Report</h1>
${this._renderFilters()}
</div>
</aside>
Expand Down Expand Up @@ -222,12 +222,29 @@ class App extends LitElement {
${ data.browsers.map(b => renderBrowser(b))}
</fieldset>` : nothing;

const browserDiffs = data.browsers.reduce((acc, b) => {
const previousVersion = b.previousVersion || 'unknown';
if (previousVersion === b.version) {
return acc;
}
return acc.push(html`
<li>${b.name}: <strong>${previousVersion}</strong> to <strong>${b.version}</strong></li>
`) && acc;
}, []);
const browserDiffInfo = browserDiffs.length > 0 ? html`
<div class="browser-diff">
<div class="browser-diff-title">Browser Version Changes</div>
<ul>${browserDiffs}</ul>
</div>
` : nothing;

return html`
<fieldset>
<legend>Test Status</legend>
${statusFilters.map(f => renderStatusFilter(f))}
</fieldset>
${browserFilter}
${browserDiffInfo}
`;

}
Expand Down
18 changes: 18 additions & 0 deletions src/server/report/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,24 @@ export const COMMON_STYLE = css`
outline: 2px solid #007bff;
outline-offset: 1px;
}
.browser-diff {
background-color: #fff9d6;
border: 1px solid #ffba59;
border-radius: 4px;
color: #6e7477;
padding: 5px;
}
.result-browser > .browser-diff {
text-align: end;
}
.browser-diff-title {
color: #c47400;
font-weight: bold;
}
.browser-diff ul {
margin: 5px 0 0 0;
padding-inline-start: 15px;
}
.empty {
align-items: center;
display: flex;
Expand Down
2 changes: 1 addition & 1 deletion src/server/report/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Visual Diff Report</title>
<title>Visual-Diff Report</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<style>
Expand Down
35 changes: 28 additions & 7 deletions src/server/report/result.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { css, html, nothing } from 'lit';
import { FILTER_STATUS, FULL_MODE, LAYOUTS, renderEmpty, renderStatusText, STATUS_TYPE } from './common.js';
import { ICON_BROWSERS, ICON_NO_GOLDEN, ICON_TADA } from './icons.js';
import data from './data.js';

export const RESULT_STYLE = css`
.result-browser {
Expand All @@ -14,6 +15,9 @@ export const RESULT_STYLE = css`
height: 50px;
width: 50px;
}
.result-browser-info {
flex: 1 1 auto;
}
.result-browser-name {
font-size: 1.2rem;
font-weight: bold;
Expand Down Expand Up @@ -101,6 +105,29 @@ export const RESULT_STYLE = css`
}
`;

function renderBrowserInfo(browser) {

const previousVersion = data.browsers.find(b => b.name === browser.name).previousVersion || 'unknown';

let browserDiffInfo = nothing;
if (previousVersion !== browser.version) {
browserDiffInfo = html`
<div class="browser-diff">
<div class="browser-diff-title">Browser Version Change</div>
<div><strong>${previousVersion}</strong> (golden) to <strong>${browser.version}</strong> (new)</div>
</div>`;
}

return html`<div class="result-browser padding">
${ICON_BROWSERS[browser.name]}
<div class="result-browser-info">
<div class="result-browser-name">${browser.name}</div>
<div>version ${browser.version}</div>
</div>
${browserDiffInfo}
</div>`;
}

function renderResult(resultData, options) {

if (!resultData.passed && resultData.info === undefined) {
Expand Down Expand Up @@ -180,13 +207,7 @@ export function renderBrowserResults(browser, tests, options) {

}, []);
return html`
<div class="result-browser padding">
${ICON_BROWSERS[browser.name]}
<div>
<div class="result-browser-name">${browser.name}</div>
<div>version ${browser.version}</div>
</div>
</div>
${renderBrowserInfo(browser)}
${results.length === 0 ? renderEmpty() : results}
`;
}
1 change: 1 addition & 0 deletions src/server/visual-diff-plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export const PATHS = {
FAIL: 'fail',
GOLDEN: 'golden',
PASS: 'pass',
METADATA: '.vdiff.json',
REPORT_ROOT: '.report',
VDIFF_ROOT: '.vdiff'
};
Expand Down
17 changes: 15 additions & 2 deletions src/server/visual-diff-reporter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { cpSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
import { cpSync, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
import { dirname, join } from 'node:path';
import { getTestInfo, PATHS } from './visual-diff-plugin.js';
import { execSync } from 'node:child_process';
Expand All @@ -8,17 +8,25 @@ const __dirname = dirname(fileURLToPath(import.meta.url));

function createData(rootDir, sessions) {

let metadata = {};
const metadataPath = join(rootDir, PATHS.METADATA);
if (existsSync(metadataPath)) {
metadata = JSON.parse(readFileSync(metadataPath));
}

const files = new Map();
const browsers = new Map();

sessions.forEach(s => {

const browserName = s.browser.name;
if (!browsers.has(browserName)) {
const prevBrowser = metadata.browsers?.find(b => b.name === browserName);
browsers.set(browserName, {
name: browserName,
numFailed: 0,
version: s.browser.browser.version().substring(0, s.browser.browser.version().indexOf('.'))
version: parseInt(s.browser.browser.version()),
previousVersion: prevBrowser?.version
});
}
const browserData = browsers.get(browserName);
Expand All @@ -43,6 +51,11 @@ function createData(rootDir, sessions) {
});
});

metadata.browsers = Array.from(browsers.values()).map(b => {
return { name: b.name, version: b.version };
});
writeFileSync(metadataPath, JSON.stringify(metadata, undefined, '\t'));

return { browsers, files, numFailed, numTests };

}
Expand Down