sitespeed.io 23.4.0 → 23.5.2

package/.dockerignore

@@ -2,4 +2,6 @@
 !bin
 !lib
 !package.json
+!LICENSE
+!npm-shrinkwrap.json
 !docker

package/.github/workflows/building-docker-release.yml

@@ -7,6 +7,9 @@ jobs:
   docker:
     runs-on: ubuntu-latest
     steps:
+      -
+          name: Checkout
+          uses: actions/checkout@v2
       -
         name: Set up QEMU
         uses: docker/setup-qemu-action@v1
@@ -29,6 +32,7 @@ jobs:
         name: Build and push sitespeed.io
         uses: docker/build-push-action@v2
         with:
+          context: .
           platforms: linux/amd64,linux/arm64
           push: true
           tags: sitespeedio/sitespeed.io:${{steps.tag.outputs.tag}},sitespeedio/sitespeed.io:latest
@@ -36,6 +40,7 @@ jobs:
         name: Build and push sitespeed.io+1
         uses: docker/build-push-action@v2
         with:
+          context: .
           platforms: linux/amd64,linux/arm64
           file: ./docker/Dockerfile-plus1
           build-args: version=${{steps.tag.outputs.tag}} 
@@ -45,6 +50,7 @@ jobs:
         name: Build and push sitespeed.io+wpt
         uses: docker/build-push-action@v2
         with:
+          context: .
           platforms: linux/amd64,linux/arm64
           file: ./docker/Dockerfile-webpagetest
           build-args: version=${{steps.tag.outputs.tag}} 
@@ -54,6 +60,7 @@ jobs:
         name: Build and push sitespeed.io-slim
         uses: docker/build-push-action@v2
         with:
+          context: .
           platforms: linux/amd64,linux/arm64
           file: ./Dockerfile-slim
           build-args: version=${{steps.tag.outputs.tag}} 

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG - sitespeed.io  (we use [semantic versioning](https://semver.org))
 
+
+## 23.5.2 - 2022-03-22
+### Fixed
+* Updated to latest NodeJS and Ubuntu updates in the Docker container with some security updates[#3306](https://github.com/sitespeedio/sitespeed.io/pull/3606). Also updated the slim container with latest NodeJS.
+* Make sure the shrinkwrap file is used when building the container [#3604](https://github.com/sitespeedio/sitespeed.io/pull/3604) and (hopefully) fix so that .dockerignore is not ignored when Github Actions build the containers.
+
+## 23.5.0 - 2022-03-11
+
+### Added
+* The -slim Docker container now uses Firefox 98.
+* Updated Grafana to latest 8.4.3 in the Docker compose file.
+* Updated [Graphite dashboards](https://github.com/sitespeedio/grafana-bootstrap-docker/tree/main/dashboards/graphite) to use Timeseries graphs instead of old "Graph".
+* You can use `-o` or `--open` or `--view` to open the result page after you run sitespeed.io on Mac and Linux [#3569](https://github.com/sitespeedio/sitespeed.io/pull/3596). 
+* Open the result with `-o` on Linux using xdg-open [#3597](https://github.com/sitespeedio/sitespeed.io/pull/3597).
+
 ## 23.4.0 - 2022-03-09
 ### Added
 * Firefox 98 in the Docker container [#3592](https://github.com/sitespeedio/sitespeed.io/pull/3592).

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM sitespeedio/webbrowsers:chrome-99.0-firefox-98.0-edge-99.0
+FROM sitespeedio/webbrowsers:chrome-99.0-firefox-98.0-edge-99.0-b
 
 ARG TARGETPLATFORM=linux/amd64
 
@@ -26,7 +26,8 @@ RUN wpr installroot --https_cert_file /webpagereplay/certs/wpr_cert.pem --https_
 RUN mkdir -p /usr/src/app
 WORKDIR /usr/src/app
 
-COPY package.* /usr/src/app/
+COPY package.json /usr/src/app/
+COPY npm-shrinkwrap.json /usr/src/app/
 RUN npm install --production && npm cache clean --force
 COPY . /usr/src/app
 
@@ -37,7 +38,6 @@ RUN mkdir -m 0750 /root/.android
 ADD docker/adb/insecure_shared_adbkey /root/.android/adbkey
 ADD docker/adb/insecure_shared_adbkey.pub /root/.android/adbkey.pub
 
-
 # Allow all users to run commands needed by sitespeedio/throttle via sudo
 # See https://github.com/sitespeedio/throttle/blob/main/lib/tc.js
 RUN echo 'ALL ALL=NOPASSWD: /usr/sbin/tc, /usr/sbin/route, /usr/sbin/ip' > /etc/sudoers.d/tc

package/Dockerfile-slim

@@ -1,4 +1,4 @@
-FROM node:16.14.0-bullseye-slim
+FROM node:16.14.2-bullseye-slim
 
 ARG TARGETPLATFORM=linux/amd64
 

package/bin/sitespeed.js

@@ -29,6 +29,8 @@ async function run(options) {
 
     if ((options.open || options.o) && os.platform() === 'darwin') {
       execSync('open ' + result.localPath + '/index.html');
+    } else if ((options.open || options.o) && os.platform() === 'linux') {
+      execSync('xdg-open ' + result.localPath + '/index.html');
     }
 
     if (

package/lib/cli/cli.js

@@ -1487,8 +1487,9 @@ module.exports.parseCommandLine = function parseCommandLine() {
       describe: 'Give your test a name.'
     })
     .option('open', {
-      alias: 'o',
-      describe: 'Open your test result in your default browser (Mac OS only).'
+      alias: ['o', 'view'],
+      describe:
+        'Open your test result in your default browser (Mac OS or Linux with xdg-open).'
     })
     .option('slug', {
       describe:

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "sitespeed.io",
-  "version": "23.4.0",
+  "version": "23.5.2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "sitespeed.io",
-      "version": "23.4.0",
+      "version": "23.5.2",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/storage": "5.8.3",
@@ -59,7 +59,7 @@
         "bluebird": "3.5.5",
         "chai": "4.2.0",
         "chai-as-promised": "7.1.1",
-        "changelog-parser": "2.8.0",
+        "changelog-parser": "2.8.1",
         "clean-css-cli": "4.3.0",
         "eslint": "8.0.0",
         "eslint-config-prettier": "8.3.0",
@@ -67,6 +67,7 @@
         "feed": "4.2.2",
         "jsdoc": "^3.6.7",
         "license-checker": "^16.0.0",
+        "marked": "4.0.12",
         "mocha": "^5.0.4",
         "prettier": "2.4.1",
         "pug-lint": "^2.6.0",
@@ -1628,9 +1629,9 @@
       }
     },
     "node_modules/changelog-parser": {
-      "version": "2.8.0",
-      "resolved": "https://registry.npmjs.org/changelog-parser/-/changelog-parser-2.8.0.tgz",
-      "integrity": "sha512-ZtSwN0hY7t+WpvaXqqXz98RHCNhWX9HsvCRAv1aBLlqJ7BpKtqdM6Nu6JOiUhRAWR7Gov0aN0fUnmflTz0WgZg==",
+      "version": "2.8.1",
+      "resolved": "https://registry.npmjs.org/changelog-parser/-/changelog-parser-2.8.1.tgz",
+      "integrity": "sha512-tNUYFRCEeWTXmwLqoNtOEzx9wcytg72MmGQqsEs14ClYwIDln7sbQw7FJj/dulXgSlsxkemc9gpPQhZYZx1TPw==",
       "dev": true,
       "dependencies": {
         "line-reader": "^0.2.4",
@@ -4164,6 +4165,18 @@
         "markdown-it": "bin/markdown-it.js"
       }
     },
+    "node_modules/jsdoc/node_modules/marked": {
+      "version": "2.1.3",
+      "resolved": "https://registry.npmjs.org/marked/-/marked-2.1.3.tgz",
+      "integrity": "sha512-/Q+7MGzaETqifOMWYEA7HVMaZb4XbcRfaOzcSsHZEith83KGlvaSG33u0SKu89Mj5h+T8V2hM+8O45Qc5XTgwA==",
+      "dev": true,
+      "bin": {
+        "marked": "bin/marked"
+      },
+      "engines": {
+        "node": ">= 10"
+      }
+    },
     "node_modules/jsdoc/node_modules/mkdirp": {
       "version": "1.0.4",
       "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
@@ -4726,15 +4739,15 @@
       }
     },
     "node_modules/marked": {
-      "version": "2.0.4",
-      "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.4.tgz",
-      "integrity": "sha512-MIL0xKRDQM3DE7dJr/wa6JV0EmK9yZ3cwuTc2bu66FNm/tmEMm9cJCgJZpt9R+K1T+pB2iBNV55wvnwSd345zg==",
+      "version": "4.0.12",
+      "resolved": "https://registry.npmjs.org/marked/-/marked-4.0.12.tgz",
+      "integrity": "sha512-hgibXWrEDNBWgGiK18j/4lkS6ihTe9sxtV4Q1OQppb/0zzyPSzoFANBa5MfsG/zgsWklmNnhm0XACZOH/0HBiQ==",
       "dev": true,
       "bin": {
-        "marked": "bin/marked"
+        "marked": "bin/marked.js"
       },
       "engines": {
-        "node": ">= 8.16.2"
+        "node": ">= 12"
       }
     },
     "node_modules/mdurl": {
@@ -8735,9 +8748,9 @@
       }
     },
     "changelog-parser": {
-      "version": "2.8.0",
-      "resolved": "https://registry.npmjs.org/changelog-parser/-/changelog-parser-2.8.0.tgz",
-      "integrity": "sha512-ZtSwN0hY7t+WpvaXqqXz98RHCNhWX9HsvCRAv1aBLlqJ7BpKtqdM6Nu6JOiUhRAWR7Gov0aN0fUnmflTz0WgZg==",
+      "version": "2.8.1",
+      "resolved": "https://registry.npmjs.org/changelog-parser/-/changelog-parser-2.8.1.tgz",
+      "integrity": "sha512-tNUYFRCEeWTXmwLqoNtOEzx9wcytg72MmGQqsEs14ClYwIDln7sbQw7FJj/dulXgSlsxkemc9gpPQhZYZx1TPw==",
       "dev": true,
       "requires": {
         "line-reader": "^0.2.4",
@@ -10755,6 +10768,12 @@
             "uc.micro": "^1.0.5"
           }
         },
+        "marked": {
+          "version": "2.1.3",
+          "resolved": "https://registry.npmjs.org/marked/-/marked-2.1.3.tgz",
+          "integrity": "sha512-/Q+7MGzaETqifOMWYEA7HVMaZb4XbcRfaOzcSsHZEith83KGlvaSG33u0SKu89Mj5h+T8V2hM+8O45Qc5XTgwA==",
+          "dev": true
+        },
         "mkdirp": {
           "version": "1.0.4",
           "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz",
@@ -11230,9 +11249,9 @@
       "requires": {}
     },
     "marked": {
-      "version": "2.0.4",
-      "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.4.tgz",
-      "integrity": "sha512-MIL0xKRDQM3DE7dJr/wa6JV0EmK9yZ3cwuTc2bu66FNm/tmEMm9cJCgJZpt9R+K1T+pB2iBNV55wvnwSd345zg==",
+      "version": "4.0.12",
+      "resolved": "https://registry.npmjs.org/marked/-/marked-4.0.12.tgz",
+      "integrity": "sha512-hgibXWrEDNBWgGiK18j/4lkS6ihTe9sxtV4Q1OQppb/0zzyPSzoFANBa5MfsG/zgsWklmNnhm0XACZOH/0HBiQ==",
       "dev": true
     },
     "mdurl": {

package/package.json

@@ -4,7 +4,7 @@
     "sitespeed.io": "./bin/sitespeed.js",
     "sitespeed.io-wpr": "./bin/browsertimeWebPageReplay.js"
   },
-  "version": "23.4.0",
+  "version": "23.5.2",
   "description": "Analyze the web performance of your site",
   "keywords": [
     "performance",
@@ -54,7 +54,7 @@
     "bluebird": "3.5.5",
     "chai": "4.2.0",
     "chai-as-promised": "7.1.1",
-    "changelog-parser": "2.8.0",
+    "changelog-parser": "2.8.1",
     "clean-css-cli": "4.3.0",
     "eslint": "8.0.0",
     "eslint-config-prettier": "8.3.0",
@@ -62,6 +62,7 @@
     "feed": "4.2.2",
     "jsdoc": "^3.6.7",
     "license-checker": "^16.0.0",
+    "marked": "4.0.12",
     "mocha": "^5.0.4",
     "sass": "1.34.0",
     "prettier": "2.4.1",

package/release/feed.js

@@ -2,6 +2,22 @@ const Feed = require('feed').Feed;
 const fs = require('fs');
 const path = require('path');
 const parseChangelog = require('changelog-parser');
+const { marked } = require('marked');
+
+const allFeeds = [];
+
+const images = {
+  'sitespeed.io': 'https://www.sitespeed.io/img/logos/sitespeed.io.png',
+  browsertime: 'https://www.sitespeed.io/img/logos/browsertime.png',
+  'coach-core': 'https://www.sitespeed.io/img/logos/coach.png',
+  pagexray: 'https://www.sitespeed.io/img/logos/pagexray.png',
+  throttle: '',
+  coach: 'https://www.sitespeed.io/img/logos/coach.png',
+  'chrome-har': '',
+  'chrome-trace': '',
+  compare: 'https://www.sitespeed.io/img/logos/compare.png',
+  humble: ''
+};
 
 const getSortedFiles = dir => {
   const files = fs.readdirSync(dir);
@@ -16,118 +32,162 @@ const getSortedFiles = dir => {
     .sort((a, b) => b.time - a.time);
 };
 
-function getResult(result) {
+function getFeed(tool, time) {
+  return new Feed({
+    title: `${tool} release feed`,
+    description: `New releases and changelog feed of ${tool}`,
+    id: `${tool}-release-feed`,
+    link: 'https://www.sitespeed.io',
+    language: 'en', // optional, used only in RSS 2.0, possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
+    image: images[tool],
+    favicon: 'http://www.sitespeed.io/favicon.ico',
+    copyright: 'All rights reserved 2022, Peter Hedenskog and team',
+    updated: new Date(time),
+    feedLinks: {
+      atom:
+        tool === 'sitespeed.io'
+          ? `https://www.sitespeed.io/feed/atom.xml`
+          : `https://www.sitespeed.io/feed/${tool}.atom`,
+      rss:
+        tool === 'sitespeed.io'
+          ? `https://www.sitespeed.io/feed/rss.xml`
+          : `https://www.sitespeed.io/feed/${tool}.rss`
+    },
+    author: {
+      name: 'Peter Hedenskog',
+      email: 'peter@soulgalore.com',
+      link: 'https://www.peterhedenskog.com'
+    }
+  });
+}
+
+function addItemToFeed(feed, item, tool) {
+  feed.addItem({
+    title: `${tool} ${item.version}`,
+    id: `https://github.com/sitespeedio/${tool}/blob/main/CHANGELOG.md#${item.version}`,
+    link: `https://github.com/sitespeedio/${tool}/blob/main/CHANGELOG.md#${item.version}`,
+    description: getResultAsHTML(item),
+    author: [
+      {
+        name: 'Sitespeed.io',
+        link: 'https://www.sitespeed.io'
+      }
+    ],
+    date: new Date(item.date),
+    image: images[tool]
+  });
+}
+
+function getResultAsHTML(result) {
   let allData = '';
   if (result.parsed) {
     if (result.parsed.Added) {
+      allData += `<h3>Added</h3>\n`;
       for (let added of result.parsed.Added) {
-        allData += ' ' + added;
+        allData += ' ' + marked.parse(added);
       }
     }
     if (result.parsed.Fixed) {
+      allData += `<h3>Fixed</h3>\n`;
       for (let fixed of result.parsed.Fixed) {
-        allData += ' ' + fixed;
+        allData += ' ' + marked.parse(fixed);
       }
     }
 
     if (result.parsed.Changed) {
+      allData += `<h3>Changed</h3>\n`;
       for (let changed of result.parsed.Changed) {
-        allData += ' ' + changed;
+        allData += ' ' + marked.parse(changed);
       }
     }
 
     if (result.parsed['Breaking changes']) {
+      allData += `<h3>Breaking changes</h3>\n`;
       for (let breaking of result.parsed['Breaking changes']) {
-        allData += ' ' + breaking;
+        allData += ' ' + marked.parse(breaking);
+      }
+    }
+
+    if (result.parsed['Deprecated']) {
+      allData += `<h3>Deprecated</h3>\n`;
+      for (let deprecated of result.parsed['Deprecated']) {
+        allData += ' ' + marked.parse(deprecated);
+      }
+    }
+
+    if (result.parsed['Removed']) {
+      allData += `<h3>Removed</h3>\n`;
+      for (let removed of result.parsed['Removed']) {
+        allData += ' ' + marked.parse(removed);
       }
     }
+
+    if (result.parsed['Security']) {
+      allData += `<h3>Security</h3>\n`;
+      for (let security of result.parsed['Security']) {
+        allData += ' ' + marked.parse(security);
+      }
+    }
+
     return allData;
   }
 }
 
+const getContent = async tool => {
+  const content = [];
+  const changelog =
+    tool === 'sitespeed.io' ? './CHANGELOG.md' : '../' + tool + '/CHANGELOG.md';
+  const result = await parseChangelog({
+    filePath: changelog,
+    removeMarkdown: false
+  });
+
+  for (let i = 0; i < 10; i++) {
+    // It's not unreleased
+    if (result.versions[i] && result.versions[i].date !== null) {
+      content.push(result.versions[i]);
+      allFeeds.push({ tool, item: result.versions[i] });
+    }
+  }
+  return content;
+};
 async function generateFeed() {
   const versionDir = './docs/_includes/version/';
   const sortedVersionFiles = getSortedFiles(versionDir);
 
-  const feed = new Feed({
-    title: 'sitespeed.io release feed',
-    description: 'Follow new releases of sitespeed.io tools',
-    id: 'https://www.sitespeed.io',
-    link: 'https://www.sitespeed.io',
-    language: 'en', // optional, used only in RSS 2.0, possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
-    image: 'https://www.sitespeed.io/img/logos/sitespeed.io.png',
-    favicon: 'http://www.sitespeed.io/favicon.ico',
-    copyright: 'All rights reserved 2021, Peter Hedenskog and team',
-    updated: new Date(sortedVersionFiles[0].time), // use the date from the latest updated version file
-    feedLinks: {
-      atom: 'https://www.sitespeed.io/feed/atom.xml',
-      rss: 'https://www.sitespeed.io/feed/rss.xml'
-    },
-    author: {
-      name: 'Peter Hedenskog',
-      email: 'peter@soulgalore.com',
-      link: 'https://www.peterhedenskog.com'
+  for (let tool of sortedVersionFiles) {
+    const feed = getFeed(tool.name, tool.time);
+    feed.addCategory('Web Performance');
+    const items = await getContent(tool.name);
+    for (let item of items) {
+      addItemToFeed(feed, item, tool.name);
     }
-  });
 
-  const getContent = async () => {
-    const content = {};
-    for (let tool of sortedVersionFiles) {
-      const changelog =
-        tool.name === 'sitespeed.io'
-          ? './CHANGELOG.md'
-          : '../' + tool.name + '/CHANGELOG.md';
-      const result = await parseChangelog(changelog);
-      if (result.versions[0].date !== null) {
-        content[tool.name] = getResult(result.versions[0]);
-      } else if (result.versions[1]) {
-        content[tool.name] = getResult(result.versions[1]);
-      } else {
-        // skip missing data
-        console.log(`Missing data for tool ${tool.name}`);
-      }
-    }
-    return content;
-  };
-
-  const descriptions = await getContent();
-  const images = {
-    'sitespeed.io': 'https://www.sitespeed.io/img/logos/sitespeed.io.png',
-    browsertime: 'https://www.sitespeed.io/img/logos/browsertime.png',
-    'coach-core': 'https://www.sitespeed.io/img/logos/coach.png',
-    pagexray: 'https://www.sitespeed.io/img/logos/pagexray.png',
-    throttle: '',
-    coach: 'https://www.sitespeed.io/img/logos/coach.png',
-    'chrome-har': '',
-    'chrome-trace': '',
-    compare: 'https://www.sitespeed.io/img/logos/compare.png',
-    humble: ''
-  };
-
-  sortedVersionFiles.forEach(file => {
-    feed.addItem({
-      title: `${file.name} ${file.version}`,
-      id: `https://github.com/sitespeedio/${file.name}/blob/main/CHANGELOG.md#${file.version}`,
-      link: `https://github.com/sitespeedio/${file.name}/blob/main/CHANGELOG.md#`,
-      description: descriptions[file.name],
-      // content: content[file.name],
-      author: [
-        {
-          name: 'Sitespeed.io',
-          link: 'https://www.sitespeed.io'
-        }
-      ],
-      date: new Date(file.time),
-      image: images[file.name]
-    });
+    const docPath = './docs/';
+
+    fs.writeFileSync(
+      path.join(docPath, 'feed', `${tool.name}.rss`),
+      feed.rss2()
+    );
+    fs.writeFileSync(
+      path.join(docPath, 'feed', `${tool.name}.atom`),
+      feed.atom1()
+    );
+  }
+
+  allFeeds.sort(function (a, b) {
+    return new Date(b.item.date) - new Date(a.item.date);
   });
 
-  feed.addCategory('Performance');
+  const allFeed = getFeed('sitespeed.io', allFeeds[0].item.date);
+  for (let item of allFeeds) {
+    addItemToFeed(allFeed, item.item, item.tool);
+  }
 
   const docPath = './docs/';
 
-  fs.writeFileSync(path.join(docPath, 'feed', 'rss.xml'), feed.rss2());
-  fs.writeFileSync(path.join(docPath, 'feed', 'atom.xml'), feed.atom1());
+  fs.writeFileSync(path.join(docPath, 'feed', `rss.xml`), allFeed.rss2());
+  fs.writeFileSync(path.join(docPath, 'feed', `atom.xml`), allFeed.atom1());
 }
 
 generateFeed();