Full Code of ankurparihar/readme-pagespeed-insights for AI

Repository: ankurparihar/readme-pagespeed-insights
Branch: master
Commit: 812280424c25
Files: 23
Total size: 40.1 KB

Directory structure:
gitextract__ij7v20e/

├── .eslintrc.js
├── .github/
│   └── workflows/
│       ├── main.yml
│       └── pagespeed.yml
├── .gitignore
├── .prettierignore
├── .prettierrc
├── .vscode/
│   ├── extensions.json
│   └── settings.json
├── LICENSE
├── README.md
├── package.json
├── src/
│   ├── app.ts
│   ├── constants.ts
│   ├── interfaces/
│   │   └── options.ts
│   ├── psi-runner.ts
│   ├── svg.ts
│   ├── tests/
│   │   ├── index.ts
│   │   ├── performance.ts
│   │   ├── pwa.ts
│   │   └── simpleTest.ts
│   └── utils/
│       ├── url.ts
│       └── utils.ts
└── tsconfig.json

================================================
FILE CONTENTS
================================================

================================================
FILE: .eslintrc.js
================================================
module.exports = {
    env: {
        node: true,
        commonjs: true,
        es2021: true,
    },
    extends: [
        "eslint:recommended",
        "plugin:@typescript-eslint/recommended",
        "plugin:import/recommended",
        "plugin:import/typescript",
    ],
    parser: "@typescript-eslint/parser",
    parserOptions: {
        ecmaVersion: 2015,
    },
    plugins: ["@typescript-eslint", "import"],
    settings: {
        "import/parsers": {
            "@typescript-eslint/parser": [".ts", ".tsx"],
        },
    },
    rules: {
        "import/order": [
            "error",
            {
                "alphabetize": { order: "asc", caseInsensitive: true },
                "groups": ["builtin", "external", "internal", "parent", "sibling", "index"],
                "newlines-between": "always",
            },
        ],
    },
};


================================================
FILE: .github/workflows/main.yml
================================================
name: Deploy to Heroku

on:
    push:
        branches:
            - master

jobs:
    deploy:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout master
              uses: actions/checkout@v2
              with:
                  ref: master

            - name: Push to Heroku
              run: |
                  git fetch origin master --unshallow
                  git push https://heroku:${{ secrets.HEROKU_API_KEY }}@git.heroku.com/pagespeed-insights.git master


================================================
FILE: .github/workflows/pagespeed.yml
================================================
name: Get Pagespeed results
on:
  # schedule:
    # * is a special character in YAML so you have to quote this string
    # - cron:  '0 0 * * *' # 00:00 UTC
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  getpsresults:
    env:
      HOST: your_website_url
      PSURL: https://pagespeed-insights.herokuapp.com
      PSRDESKTOP: psresultdesktop
      PSRMOBILE: psresultmobile
      RESULTSFOLDER: reports
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2 # This is a premade github action
      with:
        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
    - name: Create local changes
      run: | # Have to be sure a folder is present if not, make it
          mkdir -p ${RESULTSFOLDER}
          curl "${PSURL}/?url=${HOST}" > ./${RESULTSFOLDER}/${PSRDESKTOP}.svg
          curl "${PSURL}/?url=${HOST}&strategy=mobile" > ./${RESULTSFOLDER}/${PSRMOBILE}.svg
    - name: Commit files 
      run: |
        git add .
        git config --local user.email "actions@github.com"
        git config --local user.name "github-actions[bot]"
        git diff --quiet && git diff --staged --quiet || git commit -am "Updated Pagespeed results"
    - name: Push changes
      uses: ad-m/github-push-action@master # This is a premade github action
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        branch: ${{ github.ref }}


================================================
FILE: .gitignore
================================================
node_modules
key.txt
.env
dist/

================================================
FILE: .prettierignore
================================================
assets
*.md

================================================
FILE: .prettierrc
================================================
{
    "endOfLine": "lf",
    "semi": true,
    "singleQuote": false,
    "tabWidth": 4,
    "printWidth": 120,
    "trailingComma": "es5",
    "quoteProps": "consistent"
}


================================================
FILE: .vscode/extensions.json
================================================
{
    "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
}


================================================
FILE: .vscode/settings.json
================================================
{
    "files.watcherExclude": {
        "**/.git/objects/**": true,
        "**/.git/subtree-cache/**": true,
        "**/node_modules/*/**": true,
        "**/.hg/store/**": true
    },
    "files.exclude": {
        "**/.git": true,
        "**/.svn": true,
        "**/.hg": true,
        "**/CVS": true,
        "**/.DS_Store": true,
        "**/node_modules": true,
        "**/Thumbs.db": true
    },
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
}


================================================
FILE: LICENSE
================================================
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


================================================
FILE: README.md
================================================
<p align="center">
	<img src="./assets/banner.svg" width="800px">
</p>

<h1 align='center'>PageSpeed Insights for README</h1>


> Embed your website's pagespeed score to your readme


### About PageSpeed Insights
PageSpeed Insights analyzes the content of a web page, then generates suggestions to make that page faster. [Learn more](https://developers.google.com/speed/docs/insights/about/).


## Info

### Guages
<p align="center">
	<img width="800px" src="./assets/guages.svg">
</p>

### PWA
<p align="center">
	<img width="800px" src="./assets/pwa.svg">
</p>

## API and Usage

__Important note: Do not embed url to readme, instead embed generated svg__
- It takes time to perform audits of website. So embedding it directly in readme would not render due to server timeout. Instead you must first visit and download the svg from the api (by simply visiting api url with desired parameters). And then embed that svg to your README files.
- Typically it takes 10-15 seconds to obtain the results from pagespeed api
- Some servers don't allow (eg. google.com) or delay (eg. cloudflare) pagespeed crawler, so it may result in unexpected results.
- The result may fluctuate slightly sometimes.

### API url
The api is called from `https://pagespeed-insights.herokuapp.com`

### Simple usage
In simple form it will return result for all categories for desktop version of your website. Replace `your_website_url` with your website's url
```md
https://pagespeed-insights.herokuapp.com?url=your_website_url
```
For example
```md
https://pagespeed-insights.herokuapp.com?url=https://ankurparihar.github.io
```

### Theme
Default result is theme-agnostic i.e. looks good in both light and dark environment. But you can force one of two additional themes that are `light` and `dark`.
```md
https://pagespeed-insights.herokuapp.com?url=your_website_url&theme=dark
```

### Strategy
Strategy specifies the type of device your website is audited for. You can specify `strategy` as either `mobile` or `desktop`. If none is specified `desktop` is chosen
```md
https://pagespeed-insights.herokuapp.com?url=your_website_url&strategy=mobile
```

### Category
There are 5 categories (in order)
| Category Name | param |
|-------------|---------------|
| Performance | `performance` |
| Accessibility | `accessibility` |
| Best Practices | `best-practices` |
| SEO | `seo` |
| Progressive Web App | `pwa` |

If not specified, all the categories are evaluated. But you can specify only categories which you want to evaluate. The `category` parameter is comma-separated category indicators.

Examples:

#### Only performance
```md
https://pagespeed-insights.herokuapp.com?url=your_website_url&categories=performance
```

#### All but PWA
```md
https://pagespeed-insights.herokuapp.com?url=your_website_url&categories=performance,accessibility,best-practices,seo
```

#### Ordering

Order of categories is preserved

```md
https://pagespeed-insights.herokuapp.com?url=your_website_url&categories=seo,performance,accessibility
```

### Options
Additional options you can specify in query parameter
| Name (default) | Description |
|------|-------------|
| `perfTestCount (1)` | Specify how many times __performance__ test to run |

<!-- 
### Accuracy

Performance is volatile so you can request up to 3 performance tests to retrieve more precise results
```md
https://pagespeed-insights.herokuapp.com?url=your_website_url&tests=30
``` -->

### Embedding into readme
After downloading svg you can embed into readme as following
- markdown method
```
![alt text](path/to/svg "tooltip text")
```
- html method
```html
<p align="center">	<!-- (optional) center align -->
    <img src="/path/to/svg" width="XXXpx">
</p>
```

### Keep results updated with action workflow
- [pagespeed.yml](.github/workflows/pagespeed.yml)

### Example
- [ankurparihar.github.io](https://github.com/ankurparihar/ankurparihar.github.io#readme)

================================================
FILE: package.json
================================================
{
    "name": "readme-pagespeed-insights",
    "version": "1.0.2",
    "description": "GitHub README compatible PageSpeed Insights of your website",
    "main": "dist/app.js",
    "dependencies": {
        "dotenv": "^10.0.0",
        "express": "^4.17.1",
        "node-fetch": "^2.6.0",
        "url": "^0.11.0"
    },
    "devDependencies": {
        "@types/express": "^4.17.13",
        "@types/node": "^17.0.21",
        "@types/node-fetch": "^2.6.1",
        "@typescript-eslint/eslint-plugin": "^5.12.1",
        "@typescript-eslint/parser": "^5.12.1",
        "eslint": "^8.9.0",
        "eslint-import-resolver-typescript": "^2.5.0",
        "eslint-plugin-import": "^2.25.4",
        "prettier": "^2.5.1",
        "typescript": "^4.5.5"
    },
    "scripts": {
        "build": "tsc",
        "start": "node dist/app.js",
        "format": "prettier --write \"**/*.{js,ts}\"",
        "lint": "eslint --ext .ts --ignore-path .gitignore .",
        "test": "echo \"Error: no test specified\" && exit 1"
    },
    "author": "Ankur Parihar",
    "license": "ISC",
    "engines": {
        "node": "14.x"
    }
}


================================================
FILE: src/app.ts
================================================
import "dotenv/config";

import { parse as parseURL } from "url";

import express from "express";

import constants from "./constants";
import { urlOptions } from "./interfaces/options";
import runTests from "./psi-runner";
import buildSVG from "./svg";
import { getSingleQueryParam } from "./utils/url";
import { removeDuplicates } from "./utils/utils";

const app = express();
const port = process.env.PORT || 3000;

app.listen(port, () => {
    console.log(`lighthouse-stats-app listening at PORT ${port}`);
});

const processURL = (
    url: string
): urlOptions & {
    error?: string;
} => {
    const queryObject = parseURL(url, true).query;
    const SITE_URL = getSingleQueryParam(queryObject.url);

    if (!SITE_URL) {
        return {
            error: "`url` not specified",
        };
    }

    const strategy = getSingleQueryParam(queryObject.strategy) || constants.STRATEGY_DESKTOP;
    const theme = getSingleQueryParam(queryObject.theme) || constants.THEME_AGNOSTIC;
    const perfTestCount = getSingleQueryParam(queryObject.perfTestCount) || "1";
    const perfCount = parseInt(perfTestCount);

    if (isNaN(perfCount)) {
        return {
            error: "perfCount param should be a number",
        };
    } else if (perfCount <= 0) {
        return {
            error: "perfCount param should be > 0",
        };
    } else if (perfCount > constants.MAX_PERF_TEST_COUNT) {
        return {
            error: `perfCount cannot exceed ${constants.MAX_PERF_TEST_COUNT}`,
        };
    }

    const defaultCategories = [
        constants.CAT_PERF,
        constants.CAT_A11Y,
        constants.CAT_BEST,
        constants.CAT_SEO,
        constants.CAT_PWA,
    ];
    let categories = defaultCategories;

    if (queryObject.categories) {
        try {
            categories = getSingleQueryParam(queryObject.categories).split(",");
            // remove duplicates
            categories = removeDuplicates(categories);
            // check for invalid categories
            const invalidCategories = categories.filter((category) => defaultCategories.indexOf(category) === -1);
            if (invalidCategories.length > 0) {
                return {
                    error: `Invalid categories: ${JSON.stringify(invalidCategories)}`,
                };
            }
        } catch (error) {
            return {
                error: "Invalid `categories`, unable to parse",
            };
        }
    }

    return {
        SITE_URL,
        strategy,
        categories,
        theme,
        perfCount,
    };
};

app.get("/", async (req, res) => {
    const { SITE_URL, strategy, categories, theme, perfCount, error } = processURL(req.url);

    if (error) {
        res.status(400).send(error);
    }

    const options = { performance: { iterations: perfCount } };
    const scores = await runTests(SITE_URL, categories, strategy, options);

    const svg = buildSVG(
        theme,
        categories.map((category) => ({ category, score: scores[category] }))
    );

    res.setHeader("Content-Type", "image/svg+xml");
    res.send(svg);
});


================================================
FILE: src/constants.ts
================================================
// TODO: Deep freeze
export default {
    API_KEY: process.env.API_KEY,
    PAGESPEED_API_URL: `https://www.googleapis.com/pagespeedonline/v5/runPagespeed`, //?url=${queryObject.url}&key=${API_KEY}&strategy=${strategy}&`;

    // categories
    CAT_PERF: "performance",
    CAT_A11Y: "accessibility",
    CAT_BEST: "best-practices",
    CAT_SEO: "seo",
    CAT_PWA: "pwa",

    // theme
    THEME_LIGHT: "light",
    THEME_DARK: "dark",
    THEME_AGNOSTIC: "agnostic",

    // strategy
    STRATEGY_MOBILE: "mobile",
    STRATEGY_DESKTOP: "desktop",

    // misc
    MAX_PERF_TEST_COUNT: 3,
};


================================================
FILE: src/interfaces/options.ts
================================================
interface urlOptions {
    SITE_URL?: string;
    strategy?: string;
    categories?: string[];
    theme?: string;
    perfCount?: number;
}

export { urlOptions };


================================================
FILE: src/psi-runner.ts
================================================
import constants from "./constants";
import { perfTest, pwaTest, simpleTest } from "./tests";

/**
 * Run lighthouse tests using pagespeed API and return the scores
 * @returns scores
 */
const runTests = async (url: string, categories: string[], strategy: string, options: { [x: string]: any }) => {
    const results = {};

    await Promise.all(
        categories.map((category) => {
            switch (category) {
                case constants.CAT_PWA:
                    return pwaTest(url, strategy);
                case constants.CAT_PERF:
                    return perfTest(url, strategy, options[category].iterations);
                default:
                    return simpleTest(url, category, strategy);
            }
        })
    ).then((scores) => {
        categories.forEach((category, index) => {
            results[category] = scores[index];
        });
    });
    // TODO: catch error
    return results;
};

export default runTests;


================================================
FILE: src/svg.ts
================================================
import constants from "./constants";

const guageClass = (score: number) => {
    if (score >= 90) {
        return "guage-green";
    } else if (score >= 50) {
        return "guage-orange";
    } else if (score >= 0) {
        return "guage-red";
    }
    return "guage-undefined";
};

const getSimpleGuage = (label: string, score: number, offset: any) => {
    return `<svg class="guage-div guage-perf ${guageClass(score)}"
				viewBox="0 0 200 200" width="200" height="200" x="${offset}" y="0">
		<circle class="gauge-base" r="56" cx="100" cy="60" stroke-width="8"></circle>
		<circle class="gauge-arc guage-arc-1" r="56" cx="100" cy="60" stroke-width="8" style="stroke-dasharray: ${
            score >= 0 ? (score * 351.858) / 100 : 351.858
        }, 351.858;"></circle>
		<text class="guage-text" x="100px" y="60px" alignment-baseline="central" dominant-baseline="central" text-anchor="middle">${
            score >= 0 ? score : "NA"
        }</text>
		<text class="guage-title" x="100px" y="160px" alignment-baseline="central" dominant-baseline="central" text-anchor="middle">${label}</text>
	</svg>`;
};

const getPWAGuage = (score: number, offset: any) => {
    return `<svg class="guage-div guage-pwa" viewBox="0 0 200 200" width="200" height="200" x="${offset}" y="0">
		<svg viewBox="0 0 60 60" width="112" height="112" x="44" y="4">
			<defs>
				<linearGradient id="lh-gauge--pwa__check-circle__gradient-0" x1="50%" y1="0%" x2="50%" y2="100%">
					<stop stop-color="#00C852" offset="0%"></stop>
					<stop stop-color="#009688" offset="100%"></stop>
				</linearGradient>
				<linearGradient id="lh-gauge--pwa__installable__shadow-gradient-0" x1="76.056%" x2="24.111%" y1="82.995%" y2="24.735%">
					<stop stop-color="#A5D6A7" offset="0%"></stop>
					<stop stop-color="#80CBC4" offset="100%"></stop>
				</linearGradient>
				<linearGradient id="lh-gauge--pwa__fast-reliable__shadow-gradient-0" x1="76.056%" y1="82.995%" x2="25.678%" y2="26.493%">
					<stop stop-color="#64B5F6" offset="0%"></stop>
					<stop stop-color="#2979FF" offset="100%"></stop>
				</linearGradient>

				<g id="lh-gauge--pwa__fast-reliable-badge-0">
					<circle fill="#FFFFFF" cx="10" cy="10" r="10"></circle>
					<path fill="#304FFE" d="M10 3.58l5.25 2.34v3.5c0 3.23-2.24 6.26-5.25 7-3.01-.74-5.25-3.77-5.25-7v-3.5L10 3.58zm-.47 10.74l2.76-4.83.03-.07c.04-.08 0-.24-.22-.24h-1.64l.47-3.26h-.47l-2.7 4.77c-.02.01.05-.1-.04.05-.09.16-.1.31.18.31h1.63l-.47 3.27h.47z"></path>
				</g>
				<g id="lh-gauge--pwa__installable-badge-0">
					<circle fill="#FFFFFF" cx="10" cy="10" r="10"></circle>
					<path fill="#009688" d="M10 4.167A5.835 5.835 0 0 0 4.167 10 5.835 5.835 0 0 0 10 15.833 5.835 5.835 0 0 0 15.833 10 5.835 5.835 0 0 0 10 4.167zm2.917 6.416h-2.334v2.334H9.417v-2.334H7.083V9.417h2.334V7.083h1.166v2.334h2.334v1.166z"></path>
				</g>
			</defs>
			<g stroke="none" fill-rule="nonzero">
				<!-- Background and PWA logo (color by default) -->
				<circle class="lh-gauge--pwa__disc" cx="30" cy="30" r="30"></circle>
				<g class="lh-gauge--pwa__logo">
					<path ${
                        score === 7 ? 'class="lh-gauge--pwa__logo--secondary-color"' : ""
                    } d="M35.66 19.39l.7-1.75h2L37.4 15 38.6 12l3.4 9h-2.51l-.58-1.61z"></path>
					<path ${
                        score === 7 ? 'class="lh-gauge--pwa__logo--primary-color"' : ""
                    } d="M33.52 21l3.65-9h-2.42l-2.5 5.82L30.5 12h-1.86l-1.9 5.82-1.35-2.65-1.21 3.72L25.4 21h2.38l1.72-5.2 1.64 5.2z"></path>
					<path ${
                        score === 7 ? 'class="lh-gauge--pwa__logo--secondary-color"' : ""
                    } fill-rule="nonzero" d="M20.3 17.91h1.48c.45 0 .85-.05 1.2-.15l.39-1.18 1.07-3.3a2.64 2.64 0 0 0-.28-.37c-.55-.6-1.36-.91-2.42-.91H18v9h2.3V17.9zm1.96-3.84c.22.22.33.5.33.87 0 .36-.1.65-.29.87-.2.23-.59.35-1.15.35h-.86v-2.41h.87c.52 0 .89.1 1.1.32z"></path>
				</g>
				<!-- No badges. -->
				<rect class="lh-gauge--pwa__component lh-gauge--pwa__na-line ${
                    score === 0 ? "lh-gauge--pwa__visible" : "lh-gauge--pwa__invisible"
                }" fill="#FFFFFF" x="20" y="32" width="20" height="4" rx="2"></rect>
				<!-- Just fast and reliable. -->
				<g class="lh-gauge--pwa__component lh-gauge--pwa__fast-reliable-badge ${
                    score === 1 ? "lh-gauge--pwa__visible" : "lh-gauge--pwa__invisible"
                }" transform="translate(20, 29)">
					<path fill="url(#lh-gauge--pwa__fast-reliable__shadow-gradient-0)" d="M33.63 19.49A30 30 0 0 1 16.2 30.36L3 17.14 17.14 3l16.49 16.49z"></path>
					<use href="#lh-gauge--pwa__fast-reliable-badge-0"></use>
				</g>
				<!-- Just installable. -->
				<g class="lh-gauge--pwa__component lh-gauge--pwa__installable-badge ${
                    score === 2 ? "lh-gauge--pwa__visible" : "lh-gauge--pwa__invisible"
                }" transform="translate(20, 29)">
					<path fill="url(#lh-gauge--pwa__installable__shadow-gradient-0)" d="M33.629 19.487c-4.272 5.453-10.391 9.39-17.415 10.869L3 17.142 17.142 3 33.63 19.487z"></path>
					<use href="#lh-gauge--pwa__installable-badge-0"></use>
				</g>
				<!-- Fast and reliable and installable. -->
				<g class="lh-gauge--pwa__component lh-gauge--pwa__fast-reliable-installable-badges ${
                    score === 3 ? "lh-gauge--pwa__visible" : "lh-gauge--pwa__invisible"
                }">
					<g transform="translate(8, 29)">						<!-- fast and reliable -->
						<path fill="url(#lh-gauge--pwa__fast-reliable__shadow-gradient-0)" d="M16.321 30.463L3 17.143 17.142 3l22.365 22.365A29.864 29.864 0 0 1 22 31c-1.942 0-3.84-.184-5.679-.537z"></path>
						<use href="#lh-gauge--pwa__fast-reliable-badge-0"></use>
					</g>
					<g transform="translate(32, 29)">						<!-- installable -->
						<path fill="url(#lh-gauge--pwa__installable__shadow-gradient-0)" d="M25.982 11.84a30.107 30.107 0 0 1-13.08 15.203L3 17.143 17.142 3l8.84 8.84z"></path>
						<use href="#lh-gauge--pwa__installable-badge-0"></use>
					</g>
				</g>
				<!-- Full PWA. -->
				<g class="lh-gauge--pwa__component lh-gauge--pwa__check-circle ${
                    score === 7 ? "lh-gauge--pwa__visible" : "lh-gauge--pwa__invisible"
                }" transform="translate(18, 28)">
					<circle fill="#FFFFFF" cx="12" cy="12" r="12"></circle>
					<path fill="url(#lh-gauge--pwa__check-circle__gradient-0)" d="M12 2a10 10 0 1 0 0 20 10 10 0 0 0 0-20zm-2 15l-5-5 1.41-1.41L10 14.17l7.59-7.59L19 8l-9 9z"></path>
				</g>
			</g>
		</svg>
		<text class="guage-title" y="160px" alignment-baseline="central" dominant-baseline="central" text-anchor="middle">
			<tspan x="100px" dy="-6px">Progressive</tspan>
			<tspan x="100px" dy="30px">Web App</tspan>
		</text>
	</svg>`;
};

const lableMaps = {
    "performance": "Performance",
    "accessibility": "Accessibility",
    "best-practices": "Best Practices",
    "seo": "SEO",
};

const getGuageSVG = (category: string, score: number, offset: number) => {
    switch (category) {
        case constants.CAT_PWA:
            return getPWAGuage(score, offset);
        case constants.CAT_PERF:
        case constants.CAT_A11Y:
        case constants.CAT_BEST:
        case constants.CAT_SEO:
            return getSimpleGuage(lableMaps[category], score, offset);
        default:
            return getSimpleGuage("NA", 0, offset);
    }
};

/**
 * Build thematic SVG from given scores
 * @returns
 */
const buildSVG = (theme: string = constants.THEME_AGNOSTIC, scores: { category: string; score: number }[]) => {
    const offset = 500 - scores.length * 100;

    const svg = `
	<svg class="theme--${theme}" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fill="none" width="1000" height="330">
		<style>
			.gauge-base {
				opacity: 0.1
			}

			.gauge-arc {
				fill: none;
				animation-delay: 250ms;
				stroke-linecap: round;
				transform: rotate(-90deg);
				transform-origin: 100px 60px;
				animation: load-gauge 1s ease forwards
			}

			.guage-text {
				font-size: 40px;
				font-family: monospace;
				text-align: center
			}

			.guage-red {
				color: #ff4e42;
				fill: #ff4e42;
				stroke: #ff4e42
			}
			.guage-orange {
				color: #ffa400;
				fill: #ffa400;
				stroke: #ffa400
			}
			.guage-green {
				color: #0cce6b;
				fill: #0cce6b;
				stroke: #0cce6b
			}
			.theme--agnostic .guage-undefined {
				color: #5c5c5c;
				fill: #5c5c5c;
				stroke: #5c5c5c
			}
			.theme--light .guage-undefined {
				color: #1e1e1e;
				fill: #1e1e1e;
				stroke: #1e1e1e
			}
			.theme--dark .guage-undefined {
				color: #f5f5f5;
				fill: #f5f5f5;
				stroke: #f5f5f5
			}

			.guage-title {
				stroke: none;
				font-size: 26px;
				line-height: 26px;
				font-family: Roboto, Halvetica, Arial, sans-serif
			}
			.metric.guage-title {
				font-family: 'Courier New', Courier, monospace
			}
			.theme--agnostic .guage-title {
				color: #737373;
				fill: #737373
			}
			.theme--light .guage-title {
				color: #212121;
				fill: #212121
			}
			.theme--dark .guage-title {
				color: #f5f5f5;
				fill: #f5f5f5
			}

			@keyframes load-gauge {
				from {
					stroke-dasharray: 0 352.858
				}
			}
			.lh-gauge--pwa__disc {
				fill: #e0e0e0
			}
			.lh-gauge--pwa__logo {
				position: relative;
				fill: #b0b0b0
			}
			.lh-gauge--pwa__invisible {
				display: none
			}
			.lh-gauge--pwa__visible {
				display: inline
			}
			.guage-invisible {
				display: none
			}
			.lh-gauge--pwa__logo--primary-color {
				fill: #304ffe
			}
			.theme--agnostic .lh-gauge--pwa__logo--secondary-color {
				fill: #787878
			}
			.theme--light .lh-gauge--pwa__logo--secondary-color {
				fill: #3d3d3d
			}
			.theme--dark .lh-gauge--pwa__logo--secondary-color {
				fill: #d8b6b6
			}
			.theme--light #svg_2 {
				stroke: #00000022
			}
			.theme--agnostic #svg_2 {
				stroke: #616161
			}
			.theme--light #svg_2 {
				stroke: #00000022
			}
			.theme--dark #svg_2 {
				stroke: #f5f5f566
			}
		</style>
		${scores.map(({ category, score }, i) => getGuageSVG(category, score, offset + i * 200))}
		<svg width="604" height="76" x="200" y="250">
			<g>
				<rect fill="none" id="canvas_background" height="80" width="604" y="-1" x="-1"/>
				<g display="none" overflow="visible" y="0" x="0" height="100%" width="100%" id="canvasGrid">
					<rect fill="url(#gridpattern)" stroke-width="0" y="0" x="0" height="100%" width="100%"/>
				</g>
			</g>
			<g>
				<rect fill-opacity="0" stroke-width="2" rx="40" id="svg_2" height="72" width="600" y="1" x="0" fill="#000000"/>
				<rect stroke="#000" rx="8" id="svg_3" height="14" width="48" y="30" x="35" stroke-opacity="null" stroke-width="0" fill="#ff4e42"/>
				<rect stroke="#000" rx="6" id="svg_4" height="14" width="48" y="30" x="220" stroke-opacity="null" stroke-width="0" fill="#ffa400"/>
				<rect stroke="#000" rx="6" id="svg_5" height="14" width="48" y="30" x="410" stroke-opacity="null" stroke-width="0" fill="#0cce6b"/>
				<text class="metric guage-title" xml:space="preserve" text-anchor="start" font-size="26" id="svg_6" y="45" x="100" stroke-opacity="null" stroke-width="0" stroke="#000">0-49</text>
				<text class="metric guage-title" xml:space="preserve" text-anchor="start" font-size="26" id="svg_7" y="45" x="280" stroke-opacity="null" stroke-width="0" stroke="#000">50-89</text>
				<text class="metric guage-title" xml:space="preserve" text-anchor="start" font-size="26" id="svg_8" y="45" x="470" stroke-opacity="null" stroke-width="0" stroke="#000">90-100</text>
			</g>
		</svg>
	</svg>`;
    return svg;
};

export default buildSVG;


================================================
FILE: src/tests/index.ts
================================================
import perfTest from "./performance";
import pwaTest from "./pwa";
import simpleTest from "./simpleTest";

export { simpleTest, perfTest, pwaTest };


================================================
FILE: src/tests/performance.ts
================================================
import fetch from "node-fetch";

import constants from "../constants";

const { PAGESPEED_API_URL, API_KEY, CAT_PERF } = constants;

/**
 * Performance test which requires multiple iterations to get better results
 * @returns score
 */
const perfTest = async (url: string, strategy: string, iterations = 1) => {
    const category = CAT_PERF;
    const queryURL = `${PAGESPEED_API_URL}?url=${url}&strategy=${strategy}&category=${category}&key=${API_KEY}`;
    try {
        const responses = await Promise.all(new Array(iterations).fill(0).map(() => fetch(queryURL)));
        const jsons = await Promise.all(responses.map((response) => response.json()));
        // Todo invalid json handling
        const scores = jsons.map((json) => json.lighthouseResult.categories[category].score * 100);
        return Math.round(scores.reduce((prev, curr) => prev + curr) / scores.length);
    } catch (error) {
        return -1;
    }
};

export default perfTest;


================================================
FILE: src/tests/pwa.ts
================================================
import fetch from "node-fetch";

import constants from "../constants";

const { PAGESPEED_API_URL, API_KEY, CAT_PWA } = constants;

/**
 * Test to get PWA score
 * @returns score
 */
const pwaTest = async (url: string, strategy: string) => {
    try {
        const response = await fetch(
            `${PAGESPEED_API_URL}?url=${url}&strategy=${strategy}&category=${CAT_PWA}&key=${API_KEY}`
        );
        const json = await response.json();
        const { lighthouseResult } = json;
        let fast_reliable = 0;
        let fast_reliable_total = 0;
        let installable = 0;
        let installable_total = 0;
        let optimized = 0;
        let optimized_total = 0;
        lighthouseResult.categories.pwa.auditRefs.forEach((auditRef) => {
            const audit = lighthouseResult.audits[auditRef.id];
            if (audit.scoreDisplayMode === "binary" || audit.scoreDisplayMode === "numeric") {
                if (auditRef.group === "pwa-fast-reliable") {
                    fast_reliable_total++;
                    if (audit && audit.score >= 0.9) {
                        fast_reliable++;
                    }
                } else if (auditRef.group === "pwa-installable") {
                    installable_total++;
                    if (audit && audit.score >= 0.9) {
                        installable++;
                    }
                } else if (auditRef.group === "pwa-optimized") {
                    optimized_total++;
                    if (audit && audit.score >= 0.9) {
                        optimized++;
                    }
                }
            }
        });
        let score = 0;
        if (fast_reliable === fast_reliable_total) score |= 1;
        if (installable === installable_total) score |= 2;
        if (optimized === optimized_total) score |= 4;
        return score;
    } catch (error) {
        return -1;
    }
};

export default pwaTest;


================================================
FILE: src/tests/simpleTest.ts
================================================
import fetch from "node-fetch";

import constants from "../constants";

const { PAGESPEED_API_URL, API_KEY } = constants;

/**
 * Basic test which requires single API call
 * @returns score
 */
const simpleTest = async (url: string, category: string, strategy: string) => {
    const queryURL = `${PAGESPEED_API_URL}?url=${url}&strategy=${strategy}&category=${category}&key=${API_KEY}`;
    try {
        const response = await fetch(queryURL);
        const json = await response.json();
        const score = json.lighthouseResult.categories[category].score * 100;
        return score;
    } catch (error) {
        return -1;
    }
};

export default simpleTest;


================================================
FILE: src/utils/url.ts
================================================
/**
 * Get single query parameter value from url
 */
const getSingleQueryParam = (queryParam: string | string[], arrayResolution = "first") => {
    if (!queryParam) return;
    if (Array.isArray(queryParam)) {
        switch (arrayResolution) {
            case "first":
                return arrayResolution[0];
            case "last":
                return arrayResolution[arrayResolution.length - 1];
            default:
                return;
        }
    }
    return queryParam;
};

export { getSingleQueryParam };


================================================
FILE: src/utils/utils.ts
================================================
/**
 * Remove duplicates from array
 */
const removeDuplicates = <Type>(array: Type[]) => {
    return array.filter((item, i) => array.indexOf(item) === i);
};

export { removeDuplicates };


================================================
FILE: tsconfig.json
================================================
{
    "compilerOptions": {
        "module": "commonjs",
        "esModuleInterop": true,
        "target": "es6",
        "moduleResolution": "node",
        "sourceMap": false,
        "outDir": "dist"
    },
    "lib": ["es2015"],
    "include": ["src/*.ts"]
}