[ { "path": ".github/actions/make-in-docker/action.yml", "content": "name: Run make in Docker\ndescription: Run a make target inside a container created from Dockerfile\ninputs:\n target:\n description: Target to make\n required: true\nruns:\n using: docker\n image: docker://webplatformtests/wpt.fyi:latest\n args:\n - /usr/bin/make\n - ${{ inputs.target }}\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n- package-ecosystem: \"pip\"\n directory: \"/results-processor\"\n schedule:\n interval: \"weekly\"\n- package-ecosystem: \"gomod\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n ignore:\n # https://github.com/web-platform-tests/wpt.fyi/commit/e52c7487ac4257ba39f8f081782a6443e9fd6a79\n - dependency-name: \"google.golang.org/genproto\"\n- package-ecosystem: \"npm\"\n directory: \"/webapp\"\n schedule:\n interval: \"weekly\"\n ignore:\n # https://github.com/web-platform-tests/wpt.fyi/commit/9b99cfd70568dc8d991d2b13ad9c5aec53c390a6\n - dependency-name: \"@vaadin/vaadin-grid\"\n - dependency-name: \"@vaadin/vaadin-date-picker\"\n - dependency-name: \"@vaadin/vaadin-context-menu\"\n- package-ecosystem: \"npm\"\n directory: \"/webdriver\"\n schedule:\n interval: \"weekly\"\n ignore:\n # https://github.com/web-platform-tests/wpt.fyi/commit/9b99cfd70568dc8d991d2b13ad9c5aec53c390a6\n - dependency-name: \"@vaadin/vaadin-grid\"\n - dependency-name: \"@vaadin/vaadin-date-picker\"\n - dependency-name: \"@vaadin/vaadin-context-menu\"\n- package-ecosystem: \"docker\"\n directory: \"/results-processor\"\n schedule:\n interval: \"weekly\"\n # Results Processor Docker image should ignore major and minor updates to Docker Python Image\n # There may be deprecations moving between minor vesrions that we need to\n # test.\n ignore:\n - dependency-name: \"*\"\n update-types:\n - \"version-update:semver-major\"\n - \"version-update:semver-minor\"\n- package-ecosystem: \"docker\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n # Webapp/Developer Docker image should ignore major and minor updates to Docker Go Image.\n # Go versions are backwards compatible but we want to stay with the\n # major.minor version supported by App Engine Standard. That should be\n # updated manually.\n ignore:\n - dependency-name: \"*\"\n update-types:\n - \"version-update:semver-major\"\n - \"version-update:semver-minor\"\n- package-ecosystem: \"docker\"\n directory: \"/api/query/cache/service\"\n schedule:\n interval: \"weekly\"\n # Searchcache Docker image should ignore major and minor updates to Docker Go Image\n # Searchcache follows the bring-your-own-container paradigm because it uses\n # App Engine Flex. While we could use the latest version, we want this Go\n # version to follow the same version used in the webapp above (which uses\n # App Engine Standard).\n ignore:\n - dependency-name: \"*\"\n update-types:\n - \"version-update:semver-major\"\n - \"version-update:semver-minor\"\n- package-ecosystem: \"docker\"\n directory: \"/webapp/web\"\n schedule:\n interval: \"weekly\"\n # Searchcache Docker image should ignore major and minor updates to Docker Go Image\n # Searchcache follows the bring-your-own-container paradigm because it uses\n # App Engine Flex. While we could use the latest version, we want this Go\n # version to follow the same version used in the webapp above (which uses\n # App Engine Standard).\n ignore:\n - dependency-name: \"*\"\n update-types:\n - \"version-update:semver-major\"\n - \"version-update:semver-minor\"\n" }, { "path": ".github/workflows/ci.yml", "content": "name: Continuous Integration\non:\n push:\n branches:\n - main\n pull_request:\njobs:\n lint:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n - uses: ./.github/actions/make-in-docker\n with:\n target: lint\n python_test:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n - uses: ./.github/actions/make-in-docker\n with:\n target: python_test\n go_test:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n - uses: ./.github/actions/make-in-docker\n with:\n target: go_test\n web_components_test:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n - uses: ./.github/actions/make-in-docker\n with:\n target: web_components_test\n go_chrome_test:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n - uses: ./.github/actions/make-in-docker\n with:\n target: go_chrome_test\n go_firefox_test:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n - uses: ./.github/actions/make-in-docker\n with:\n target: go_firefox_test\n go_cloud_test:\n # This job uses real Cloud resources.\n # This means this CI job will have access to the service account.\n # In that case, similar to deploy.yml, trust only pull requests that are\n # made within web-platform-tests and exclude forks.\n if: |\n (github.repository == 'web-platform-tests/wpt.fyi') &&\n ((github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'web-platform-tests/wpt.fyi' && github.actor != 'dependabot[bot]') ||\n (github.event_name != 'pull_request'))\n needs: [go_test, go_chrome_test, go_firefox_test]\n runs-on: ubuntu-latest\n env:\n DOCKER_IMAGE: webplatformtests/wpt.fyi:latest\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n steps:\n - uses: actions/checkout@v4\n with:\n fetch-depth: 2\n\n - name: secrets\n run: echo \"$GCLOUD_KEY_FILE_JSON\" > client-secret.json\n env:\n GCLOUD_KEY_FILE_JSON: ${{ secrets.GCLOUD_KEY_FILE_JSON }}\n\n - name: Set DOCKER_INSTANCE\n run: echo \"DOCKER_INSTANCE=wptd-dev-$(echo $RANDOM)\" >> $GITHUB_ENV\n\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n\n # run only if Docker configuration was not changed\n - if: steps.dockerchanges.outputs.dockerconf == 'false'\n name: Fetch latest Docker image\n run: docker pull \"${DOCKER_IMAGE}\"\n\n - name: pre-installation\n run: bash ./util/docker-dev/run.sh -d -q\n\n - name: run tests with \"cloud\" build tag\n run: docker exec -t \"${DOCKER_INSTANCE}\" make go_cloud_test;\n" }, { "path": ".github/workflows/codeql.yml", "content": "# For most projects, this workflow file will not need changing; you simply need\n# to commit it to your repository.\n#\n# You may wish to alter this file to override the set of languages analyzed,\n# or to provide custom queries or build logic.\n#\n# ******** NOTE ********\n# We have attempted to detect the languages in your repository. Please check\n# the `language` matrix defined below to confirm you have the correct set of\n# supported CodeQL languages.\n#\nname: \"CodeQL\"\n\non:\n push:\n branches: [ \"main\" ]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [ \"main\" ]\n schedule:\n - cron: '40 20 * * 0'\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [ 'go', 'javascript', 'python' ]\n # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]\n # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v3\n with:\n languages: ${{ matrix.language }}\n # If you wish to specify custom queries, you can do so here or in a config file.\n # By default, queries listed here will override any specified in a config file.\n # Prefix the list here with \"+\" to use these queries and those in the config file.\n\n # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs\n # queries: security-extended,security-and-quality\n\n\n # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).\n # If this step fails, then you should remove it and run the build manually (see below)\n - name: Autobuild\n uses: github/codeql-action/autobuild@v3\n\n # ℹ️ Command-line programs to run using the OS shell.\n # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun\n\n # If the Autobuild fails above, remove it and uncomment the following three lines.\n # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.\n\n # - run: |\n # echo \"Run, Build Application using script\"\n # ./location_of_script_within_repo/buildscript.sh\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v3\n with:\n category: \"/language:${{matrix.language}}\"\n" }, { "path": ".github/workflows/deploy.yml", "content": "name: Deploy\non:\n push:\n branches:\n - main\n pull_request:\njobs:\n deploy-staging:\n # Forks and dependabot cannot access secrets so the job would fail.\n # Run for non dependabot PRs or regular pushes to web-platform-tests/wpt.fyi\n if: |\n (github.repository == 'web-platform-tests/wpt.fyi') &&\n ((github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'web-platform-tests/wpt.fyi' && github.actor != 'dependabot[bot]') ||\n (github.event_name != 'pull_request'))\n name: Deploy staging.wpt.fyi\n runs-on: ubuntu-latest\n env:\n DOCKER_IMAGE: webplatformtests/wpt.fyi:latest\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n steps:\n - uses: actions/checkout@v4\n with:\n fetch-depth: 2\n\n - name: secrets\n run: echo \"$GCLOUD_KEY_FILE_JSON\" > client-secret.json\n env:\n GCLOUD_KEY_FILE_JSON: ${{ secrets.GCLOUD_KEY_FILE_JSON }}\n\n - name: Set DOCKER_INSTANCE\n run: echo \"DOCKER_INSTANCE=wptd-dev-$(echo $RANDOM)\" >> $GITHUB_ENV\n\n - name: Docker config check\n uses: dorny/paths-filter@v3\n id: dockerchanges\n with:\n filters: |\n dockerconf:\n - 'Dockerfile'\n\n # run only if Docker configuration was changed\n - if: steps.dockerchanges.outputs.dockerconf == 'true'\n name: Rebuild Docker image\n run: docker build -t webplatformtests/wpt.fyi:latest .\n\n # run only if Docker configuration was not changed\n - if: steps.dockerchanges.outputs.dockerconf == 'false'\n name: Fetch latest Docker image\n run: docker pull \"${DOCKER_IMAGE}\"\n\n - name: pre-installation\n run: bash ./util/docker-dev/run.sh -d -q\n\n - name: installation\n run: docker exec -t \"${DOCKER_INSTANCE}\" make go_build;\n\n # Set -f for main branch.\n - name: set deployment flag\n if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}\n run: echo \"FORCE_DEPLOYMENT=-f\" >> $GITHUB_ENV\n\n - name: deploy webapp\n run: ./util/deploy-staging.sh \"${FORCE_DEPLOYMENT}\" webapp/web/app.staging.yaml\n\n - name: Run go_large_test in main\n if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}\n run: docker exec -t \"${DOCKER_INSTANCE}\" make go_large_test STAGING=true\n\n - name: build processor\n run: ./util/deploy-staging.sh \"${FORCE_DEPLOYMENT}\" results-processor/app.staging.yaml\n\n - name: build searchcache\n run: ./util/deploy-staging.sh \"${FORCE_DEPLOYMENT}\" api/query/cache/service/app.staging.yaml\n\n - name: Clean up versions in main\n if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}\n run: docker exec -t \"${DOCKER_INSTANCE}\" make cleanup_staging_versions\n" }, { "path": ".github/workflows/docker-update.yml", "content": "name: Update Docker image\non:\n push:\n # Rebuild the image when Dockerfile is changed. This is safe on a PR\n # branch, too -- the automatically built Docker image will be tagged with\n # the branch name instead of \"latest\".\n paths:\n - 'Dockerfile'\n - '.github/workflows/docker-update.yml'\n schedule:\n # Rebuild the image weekly.\n - cron: '0 0 * * 0'\njobs:\n build-and-push:\n # Forks and dependabot cannot access secrets so the job would fail.\n # Run for non dependabot PRs or regular pushes to web-platform-tests/wpt.fyi\n if: |\n (github.repository == 'web-platform-tests/wpt.fyi' && github.actor != 'dependabot[bot]') &&\n ((github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'web-platform-tests/wpt.fyi') ||\n (github.event_name != 'pull_request'))\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: elgohr/Publish-Docker-Github-Action@v5\n # https://github.com/elgohr/Publish-Docker-Github-Action\n with:\n name: webplatformtests/wpt.fyi\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_TOKEN }}\n dockerfile: Dockerfile\n snapshot: true\n" }, { "path": ".gitignore", "content": "node_modules/\ndebug.test\n/web\n\n# Google Cloud secret\nclient-secret.json" }, { "path": ".golangci.yaml", "content": "version: \"2\"\nlinters:\n default: none\n enable:\n - containedctx\n - copyloopvar\n - dogsled\n - dupl\n - errcheck\n - errname\n - errorlint\n - exhaustive\n - exhaustruct\n - gochecknoglobals\n - gocognit\n - goconst\n - gocyclo\n - godot\n - godox\n - goheader\n - gomoddirectives\n - gosec\n - govet\n - importas\n - ineffassign\n - ireturn\n - lll\n - misspell\n - nakedret\n - nestif\n - nilerr\n - nilnil\n - nlreturn\n - noctx\n - prealloc\n - revive\n - staticcheck\n - unparam\n - unused\n - usestdlibvars\n settings:\n exhaustruct:\n exclude:\n - github\\.com/google/go-github/v65/github\\.CheckRunOutput\n - github\\.com/google/go-github/v65/github\\.ListCheckRunsOptions\n - github\\.com/google/go-github/v65/github\\.ListOptions\n - github\\.com/golang-jwt/jwt\\.StandardClaims\n - net/http\\.Client\n gomoddirectives:\n replace-allow-list:\n - launchpad.net/gocheck\n gosec:\n excludes:\n # TODO(DanielRyanSmith): Remove these exclusions after this PR is part\n # of the new version: https://github.com/securego/gosec/pull/1506\n - G704\n - G705\n # TODO(jrobbins): Remove these exclusions after looking more into\n # code changes needed to resolve them.\n - G118\n - G120\n exclusions:\n generated: lax\n presets:\n - comments\n - common-false-positives\n - legacy\n - std-error-handling\n paths:\n - third_party$\n - builtin$\n - examples$\nissues:\n max-issues-per-linter: 0\n max-same-issues: 0\nformatters:\n enable:\n - gofmt\n exclusions:\n generated: lax\n paths:\n - third_party$\n - builtin$\n - examples$\n" }, { "path": ".vscode/launch.json", "content": "{\n // Use IntelliSense to learn about possible attributes.\n // Hover to view descriptions of existing attributes.\n // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"name\": \"Web server\",\n \"type\": \"go\",\n \"request\": \"attach\",\n \"port\": 12345,\n \"host\": \"localhost\",\n \"mode\": \"remote\",\n \"debugAdapter\": \"dlv-dap\",\n \"dlvFlags\": [\"--check-go-version=false\"],\n \"substitutePath\": [\n {\n \"from\": \"${workspaceFolder}\", \"to\": \"/home/user/wpt.fyi\"\n }\n ]\n }\n ]\n}" }, { "path": ".vscode/settings.json", "content": "{\n \"go.buildTags\": \"small,medium,large,cloud\",\n \"search.exclude\": {\n \"**/node_modules\": true,\n \"**/bower_components\": true,\n \"webapp/static\": true\n },\n \"debug.node.autoAttach\": \"on\",\n \"go.formatTool\": \"goimports\"\n}\n" }, { "path": ".vscode/tasks.json", "content": "{\n \"version\": \"2.0.0\",\n \"tasks\": [\n {\n \"label\": \"Build\",\n \"type\": \"shell\",\n \"command\": \"make build\",\n \"group\": {\n \"kind\": \"build\",\n \"isDefault\": true\n },\n \"problemMatcher\": [\n \"$go\"\n ]\n },\n {\n \"label\": \"Install WebDriver Deps\",\n \"type\": \"shell\",\n \"command\": \"make chrome && make chromedriver\",\n },\n {\n \"label\": \"Webdriver Single Chrome Test\",\n \"type\": \"shell\",\n \"command\": \"go test -v -timeout=15m -tags=large ./webdriver -run ${input:testName} -args -chrome_path=/usr/bin/google-chrome -chromedriver_path=/usr/bin/chromedriver -frame_buffer=false -staging=false -browser=chrome\",\n \"group\": {\n \"kind\": \"test\",\n \"isDefault\": true\n },\n \"dependsOn\": [\n \"Install WebDriver Deps\"\n ],\n \"problemMatcher\": [\n \"$go\"\n ]\n },\n {\n \"label\": \"Webdriver Chrome Tests\",\n \"type\": \"shell\",\n \"command\": \"go test -v -timeout=15m -tags=large ./webdriver -args -chrome_path=/usr/bin/google-chrome -chromedriver_path=/usr/bin/chromedriver -frame_buffer=false -staging=false -browser=chrome\",\n \"group\": {\n \"kind\": \"test\",\n \"isDefault\": true\n },\n \"dependsOn\": [\n \"Install WebDriver Deps\"\n ],\n \"problemMatcher\": [\n \"$go\"\n ]\n }\n ],\n \"inputs\": [\n {\n \"id\": \"testName\",\n \"type\": \"promptString\",\n \"description\": \"Enter the test function name\"\n }\n ]\n}" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Code of Conduct\n\nAll code and communication under WPT Dashboard is covered by the [Chromium Code of Conduct](https://chromium.googlesource.com/chromium/src/+/master/CODE_OF_CONDUCT.md).\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing\n\nWe'd love to accept your patches and contributions to this project. There are\njust a few small guidelines you need to follow.\n\n## Code reviews\n\nAll submissions, including submissions by project members, require review. We\nuse GitHub pull requests for this purpose. Consult\n[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more\ninformation on using pull requests.\n\n# Local Development\n\n## Linting your code\n\nThere is a `make` rule for linting. Requirements for it are included in the docker image.\n\n```sh\nsource util/commands.sh\nwptd_exec_it make lint\n```\n\nTo run outside docker, you'll need to install `golint` and `eslint`.\n\nGlobally (in `wpt.fyi` root):\n```sh\nnpm install -g eslint babel-eslint eslint-plugin-html\nmake test\n```\n\nLocally (in `webapp/` dir):\n```sh\nnpm install\nnpm test\n```\n\n## Testing your code\n\nThere is a number of `make` rule for testing. To run tests in docker:\n\n```sh\nsource util/commands.sh\nwptd_exec_it make test\n```\n\nSee [`Makefile`](/Makefile) for more fine grained targets which take less time to run.\n\n## Git prepush\n\nYou should set up your repo to run `make prepush` in docker when you're pushing, to help catch trivial build/lint errors.\nSee [the git hooks folder](/git/hooks) for instructions.\n\n# Coding Guidelines\n\n## License header\n\nAll source files (including `.js`, `.go`, `.html`, `.css`) must begin with a comment of the below header:\n\n```go\n// Copyright {YEAR} The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n```\n" }, { "path": "Dockerfile", "content": "# vim: set expandtab sw=4\nFROM golang:1.26.2-bookworm\n\n# Create a non-priviledged user to run browsers as (Firefox and Chrome do not\n# like to run as root).\nRUN chmod a+rx $HOME && useradd --uid 9999 --user-group --create-home browser\n\n# Add apt repositories for Java, Node.js and Google Cloud CLI\nRUN export DISTRO_CODENAME=$(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) && \\\n echo \"deb [signed-by=/usr/share/keyrings/corretto.gpg] https://apt.corretto.aws stable main\" > /etc/apt/sources.list.d/corretto.list && \\\n curl -s https://apt.corretto.aws/corretto.key | gpg --dearmor -o /usr/share/keyrings/corretto.gpg && \\\n export NODE_VERSION=\"20.x\" && \\\n export ARCH=$(dpkg --print-architecture) && \\\n echo \"deb [arch=$ARCH signed-by=/usr/share/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_VERSION nodistro main\" > /etc/apt/sources.list.d/nodesource.list && \\\n curl -s https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /usr/share/keyrings/nodesource.gpg && \\\n echo \"deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk-$DISTRO_CODENAME main\" > /etc/apt/sources.list.d/google-cloud-sdk.list && \\\n curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg\n\n# Sort the package names!\n# firefox-esr: provides deps for Firefox (we don't use ESR directly)\n# java-11-amazon-corretto-jdk: provides JDK/JRE to Selenium & gcloud SDK\n# python-crcmod: native module to speed up CRC checksum in gsutil\nRUN apt-get update -qqy && apt-get install -qqy --no-install-suggests \\\n curl \\\n firefox-esr \\\n java-11-amazon-corretto-jdk \\\n nodejs \\\n python3.11 \\\n python3-crcmod \\\n sudo \\\n tox \\\n wget \\\n xvfb && \\\n rm /usr/bin/firefox\n\n# The base golang image adds Go paths to PATH, which cannot be inherited in\n# sudo by default because of the `secure_path` directive. Overwrite sudoers to\n# discard the setting.\nRUN echo \"root ALL=(ALL:ALL) ALL\" > /etc/sudoers\n\n# We must stick to 527.0.0 because the datastore emulator only requires Java 11.\n# Versions 528.0.0 and onwards require Java 21.\n# However, we can't upgrade to a newer version of Java because when Chrome\n# runs with WCT/Selenium, it only runs with java 11 and not 17 or 21.\nENV CLOUD_SDK_VERSION=527.0.0\n# Google Cloud SDK configuration\n# Based on https://github.com/GoogleCloudPlatform/cloud-sdk-docker/blob/master/Dockerfile\nRUN apt-get update -qqy && apt-get install -qqy --no-install-suggests \\\n google-cloud-cli=${CLOUD_SDK_VERSION}-0 \\\n google-cloud-cli-app-engine-python=${CLOUD_SDK_VERSION}-0 \\\n google-cloud-cli-app-engine-python-extras=${CLOUD_SDK_VERSION}-0 \\\n google-cloud-cli-app-engine-go=${CLOUD_SDK_VERSION}-0 \\\n google-cloud-cli-datastore-emulator=${CLOUD_SDK_VERSION}-0 && \\\n gcloud config set core/disable_usage_reporting true && \\\n gcloud config set component_manager/disable_update_check true && \\\n gcloud --version\n" }, { "path": "ISSUE_TEMPLATE/checks.md", "content": "### Check\nA link to the GitHub Check run containing my issue:\nhttps://github.com/web-platform-tests/wpt/pull/[PR Number]/checks?check_run_id=[Check run ID]\n\n### Description\n\n" }, { "path": "ISSUE_TEMPLATE/prod-deployment.md", "content": "Previous deployment was #ISSUE_NUM (PREV_SHA)\n\nChangelist PREV_SHA...NEW_SHA\n\nMajor changes:\n- A pull request title (#PR_NUM)\n- A different pull request title (#PR_NUM2)\n\nThis push is happening as part of the regular weekly push.\n\nPushing all three services - webapp, processor, and searchcache.\n" }, { "path": "ISSUE_TEMPLATE/screenshots.md", "content": "\n\n### Example\nPermalink to an example reftest:\n \n\nLink to the reftest analyzer:\n\n\n### Description\n\n" }, { "path": "ISSUE_TEMPLATE/search.md", "content": "### Search\nA link to the search containing my issue:\n \n\n### Description\n\n" }, { "path": "ISSUE_TEMPLATE.md", "content": "\n" }, { "path": "LICENSE", "content": "W3C 3-clause BSD License\n\nhttp://www.w3.org/Consortium/Legal/2008/03-bsd-license.html\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n* Redistributions of works must retain the original copyright notice,\n this list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the original copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n* Neither the name of the W3C nor the names of its contributors may be\n used to endorse or promote products derived from this work without\n specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\nLIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\nTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n" }, { "path": "Makefile", "content": "# Copyright 2017 The WPT Dashboard Project. All rights reserved.\n# Use of this source code is governed by a BSD-style license that can be\n# found in the LICENSE file.\n\n# Make targets in this file are intended to be run inside the Docker container\n# environment.\n\n# Make targets can be run in a host environment, but that requires ensuring\n# the correct version of tools are installed and environment variables are\n# set appropriately.\n\n# Prefer simply expanded variables (:=) to avoid confusion caused by recursion.\n# All variables can be overridden in command line by `make target FOO=bar`.\n\nSHELL := /bin/bash\n# WPTD_PATH will have a trailing slash, e.g. /home/user/wpt.fyi/\nWPTD_PATH := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))\nGECKODRIVER_TAG := v0.36.0\nGECKODRIVER_PATH=/usr/bin/geckodriver\nFIREFOX_PATH := /usr/bin/firefox\nCHROME_VERSION := 138.0.7204.94\nCHROME_INSTALL_DIR := /opt/chrome-for-testing\n # CFT_BINARY can also be 'chrome-headless-shell'\nCFT_BINARY := chrome\nCFT_FOLDER := $(CFT_BINARY)-linux64\nCHROME_ACTUAL_PATH := $(CHROME_INSTALL_DIR)/$(CFT_FOLDER)/$(CFT_BINARY)\n# Needed because some tools are hardcoded to /usr/bin/google-chrome\nCHROME_PATH := /usr/bin/google-chrome\nCHROMEDRIVER_PATH=/usr/bin/chromedriver\nUSE_FRAME_BUFFER := true\nSTAGING := false\nVERBOSE := -v\n\nGO_FILES := $(shell find $(WPTD_PATH) -type f -name '*.go')\nGO_TEST_FILES := $(shell find $(WPTD_PATH) -type f -name '*_test.go')\n# Golangci version should be updated periodically.\n# See: https://golangci-lint.run/welcome/install/\nGOLANGCI_LINT_VERSION := v2.1.6\n\nbuild: go_build\n\ntest: go_test python_test\n\nlint: eslint go_lint golangci_lint # TODO: Replace go_lint with golangci_lint\n\nprepush: VERBOSE := $() # Empty out the verbose flag.\nprepush: go_build go_test lint\n\npython_test: python3 tox\n\ttox -c results-processor/\n\n# Contains setup necessary only for github actions.\ngithub_action_go_setup:\n\t# https://github.com/web-platform-tests/wpt.fyi/issues/3089\n\tif [ -d \"/github/workspace\" ]; then \\\n\t\techo \"Avoiding buildvcs error for Go 1.18+ by marking github workspace safe.\"; \\\n\t\tgit config --global --add safe.directory /github/workspace ; \\\n\telse \\\n\t\techo \"Did not detect github workspace. Skipping.\" ; \\\n\tfi\n# NOTE: We prune before generate, because node_modules are embedded into the\n# binary (and part of the build).\ngo_build: git mockgen github_action_go_setup webapp_node_modules_prod\n\tgo generate ./...\n\t# Check all packages without producing any output.\n\tgo build -v ./...\n\t# Build the webapp.\n\tgo build -v ./webapp/web\n\ngo_build_dev:\n\t@ # Disable packr to always serve local node modules and dynamic components.\n\t@ # There's thus no need to prune node_modules.\n\t@ # Disable inlining and optimizations that can interfere with debugging.\n\tgo build -v -tags skippackr -gcflags=all=\"-N -l\" ./webapp/web\n\ngo_lint: golint go_test_tag_lint\n\tgolint -set_exit_status ./api/...\n\tgolint -set_exit_status ./shared/...\n\tgolint -set_exit_status ./util/...\n\tgolint -set_exit_status ./webapp/...\n\tgolint -set_exit_status ./webdriver/...\n\n# TODO: run on /shared/, /util/, /webapp/, /webdriver/\ngolangci_lint: golangci-lint github_action_go_setup\n\tgolangci-lint cache clean\n\tgolangci-lint run ./api/...\n\ngo_test_tag_lint:\n\t@ # Printing a list of test files without +build tag, asserting empty...\n\t@TAGLESS=$$(grep -PL '\\/\\/(\\s?\\+build|go:build) !?(small|medium|large|cloud)' $(GO_TEST_FILES)); \\\n\tif [ -n \"$$TAGLESS\" ]; then echo -e \"Files are missing '// +build TAG' or '//go:build TAG' tags:\\n$$TAGLESS\" && exit 1; fi\n\ngo_test: go_small_test go_medium_test\n\ngo_small_test: go_build gcc\n\tgo test -tags=small $(VERBOSE) ./...\n\ngo_medium_test: go_build dev_appserver_deps gcc\n\tgo test -tags=medium $(VERBOSE) $(FLAGS) ./...\n\n# Use sub-make because otherwise make would only execute the first invocation\n# of _go_webdriver_test. Variables will be passed into sub-make implicitly.\ngo_large_test:\n\tmake go_firefox_test\n\tmake go_chrome_test\n\ngo_firefox_test: firefox geckodriver\n\tmake _go_webdriver_test BROWSER=firefox\n\ngo_chrome_test: chrome chromedriver\n\tmake _go_webdriver_test BROWSER=chrome\n\ngo_cloud_test: go_build gcloud_login\n\tgcloud config set project wptdashboard-staging; \\\n\tif [[ -f \"$(WPTD_PATH)client-secret.json\" ]]; then \\\n\t\techo \"Running with client-secret.json credentials instead of possible system credentials. This should happen for CI runs.\"; \\\n\t\texport GOOGLE_APPLICATION_CREDENTIALS=\"$(WPTD_PATH)client-secret.json\"; \\\n\tfi ; \\\n\tGOOGLE_CLOUD_PROJECT=wptdashboard-staging GAE_SERVICE=test GAE_VERSION=1 go test -tags=cloud $(VERBOSE) $(FLAGS) ./...\n\npuppeteer_chrome_test: go_build dev_appserver_deps webdriver_node_deps\n\tcd webdriver; npm test\n\nwebdriver_node_deps:\n\tcd webdriver; npm install\n\n# _go_webdriver_test is not intended to be used directly; use go_firefox_test or\n# go_chrome_test instead.\n_go_webdriver_test: var-BROWSER java go_build xvfb geckodriver chromedriver dev_appserver_deps gcc\n\t@ # This Go test manages Xvfb itself, so we don't start/stop Xvfb for it.\n\t@ # The following variables are defined here because we don't know the\n\t@ # path before installing geckodriver as it includes version strings.\n\tGECKODRIVER_PATH=$(GECKODRIVER_PATH) \\\n\tCOMMAND=\"go test $(VERBOSE) -timeout=15m -tags=large ./webdriver -args \\\n\t\t-firefox_path=$(FIREFOX_PATH) \\\n\t\t-geckodriver_path=$$GECKODRIVER_PATH \\\n\t\t-chrome_path=$(CHROME_PATH) \\\n\t\t-chromedriver_path=$(CHROMEDRIVER_PATH) \\\n\t\t-frame_buffer=$(USE_FRAME_BUFFER) \\\n\t\t-staging=$(STAGING) \\\n\t\t-browser=$(BROWSER) $(FLAGS)\"; \\\n\tif [ \"$$UID\" == \"0\" ]; then sudo -u browser $$COMMAND; else $$COMMAND; fi\n\n# NOTE: psmisc includes killall, needed by wct.sh\nweb_components_test: xvfb firefox chrome webapp_node_modules_all psmisc\n\tutil/wct.sh $(USE_FRAME_BUFFER)\n\ndev_appserver_deps: gcloud-app-engine-go gcloud-cloud-datastore-emulator gcloud-beta java\n\nchrome: wget unzip\n\tif [[ ! -f \"$(CHROME_ACTUAL_PATH)\" ]]; then \\\n\t\tCHROME_CFT_URL=\"https://storage.googleapis.com/chrome-for-testing-public/$(CHROME_VERSION)/linux64/$(CFT_FOLDER).zip\"; \\\n\t\tTEMP_DIR=$$(mktemp -d); \\\n\t\twget -q -O $${TEMP_DIR}/$(CFT_FOLDER).zip $${CHROME_CFT_URL}; \\\n\t\tunzip -q $${TEMP_DIR}/$(CFT_FOLDER).zip -d $${TEMP_DIR}; \\\n\t\tsudo mkdir -p $(CHROME_INSTALL_DIR); \\\n\t\tsudo mv $${TEMP_DIR}/$(CFT_FOLDER) $(CHROME_INSTALL_DIR)/; \\\n\t\tsudo apt update; \\\n\t\twhile read pkg ; do sudo apt-get satisfy -y --no-install-recommends \"$${pkg}\" ; done < $(CHROME_INSTALL_DIR)/$(CFT_FOLDER)/deb.deps; \\\n\t\tsudo chmod +x $(CHROME_ACTUAL_PATH); \\\n\t\tsudo ln -sf $(CHROME_ACTUAL_PATH) $(CHROME_PATH); \\\n\t\trm -rf $${TEMP_DIR}; \\\n\tfi\n\n# Pull ChromeDriver from Chrome For Testing (CfT)\n# Need to create the CHROMEDRIVER_PATH and then move the files in because the\n# directory structure in chromedriver_linux64.zip has changed.\n#\n# CfT only has ChromeDriver URLs for chrome versions >=115. But assuming `chrome`\n# target above remains pulling the latest stable, this will not be a problem.\nchromedriver: wget unzip chrome jq\n\tif [[ ! -f \"$(CHROMEDRIVER_PATH)\" ]]; then \\\n\t\tCHROME_VERSION=$$(google-chrome --version | grep -ioE \"[0-9]+\\.[0-9]+\\.[0-9]+\"); \\\n\t\tCHROMEDRIVER_URL=$$(curl -s https://googlechromelabs.github.io/chrome-for-testing/latest-patch-versions-per-build-with-downloads.json | jq -r \".builds[\\\"$${CHROME_VERSION}\\\"].downloads.chromedriver[] | select(.platform == \\\"linux64\\\") | .url\"); \\\n\t\tTEMP_DIR=$$(mktemp -d); \\\n\t\twget -q -O $${TEMP_DIR}/chromedriver_linux64.zip $${CHROMEDRIVER_URL}; \\\n\t\tunzip -j $${TEMP_DIR}/chromedriver_linux64.zip -d $${TEMP_DIR}; \\\n\t\tsudo mv $${TEMP_DIR}/chromedriver $(CHROMEDRIVER_PATH); \\\n\t\tsudo chmod +x $(CHROMEDRIVER_PATH); \\\n\tfi\n\nfirefox: bzip2 wget\n\tif [[ -z \"$$(which firefox)\" ]]; then \\\n\t\twget -O firefox.tar.xz -q \"https://download.mozilla.org/?product=firefox-latest&os=linux64&lang=en-US\"; \\\n\t\tmkdir -p $$HOME/browsers; \\\n\t\ttar -xaf firefox.tar.xz -C $$HOME/browsers; \\\n\t\tsudo ln -s $$HOME/browsers/firefox/firefox $(FIREFOX_PATH); \\\n\tfi\n\ngeckodriver: wget unzip curl jq\n\tif [[ ! -f \"$(GECKODRIVER_PATH)\" ]]; then \\\n\t\tGECKODRIVER_URL=\"https://github.com/mozilla/geckodriver/releases/download/${GECKODRIVER_TAG}/geckodriver-${GECKODRIVER_TAG}-linux64.tar.gz\"; \\\n\t\tTEMP_DIR=$$(mktemp -d); \\\n\t\twget -q -O $${TEMP_DIR}/geckodriver-linux64.tar.gz $${GECKODRIVER_URL}; \\\n\t\ttar -xzf $${TEMP_DIR}/geckodriver-linux64.tar.gz -C $${TEMP_DIR}; \\\n\t\tsudo mv $${TEMP_DIR}/geckodriver $(GECKODRIVER_PATH); \\\n\t\tsudo chmod +x $(GECKODRIVER_PATH); \\\n\t\trm -rf $${TEMP_DIR}; \\\n\tfi\n\ngolangci-lint: curl gpg\n\tif [ \"$$(which golangci-lint)\" == \"\" ]; then \\\n\t\tcurl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/${GOLANGCI_LINT_VERSION}/install.sh | sh -s -- -b $$(go env GOPATH)/bin; \\\n\tfi\n\ngolint: git\n\tif [ \"$$(which golint)\" == \"\" ]; then \\\n\t\tgo install golang.org/x/lint/golint; \\\n\tfi\n\nmockgen: git\n\tif [ \"$$(which mockgen)\" == \"\" ]; then \\\n\t\tgo install go.uber.org/mock/mockgen; \\\n\tfi\n\npackage_service: var-APP_PATH\n\t# Trim the potential \"app.staging.yaml\" suffix.\n\tif [[ \"$(APP_PATH)\" == \"api/query/cache/service\"* ]]; then \\\n\t\tAPP_PATH=\"api/query/cache/service\"; \\\n\telif [[ \"$(APP_PATH)\" == \"webapp/web\"* ]]; then \\\n\t\tAPP_PATH=\"webapp/web\"; \\\n\telse \\\n\t\tAPP_PATH=\"$(APP_PATH)\"; \\\n\tfi ; \\\n\tif [[ \"$${APP_PATH}\" == \"api/query/cache/service\" || \"$${APP_PATH}\" == \"webapp/web\" ]]; then \\\n\t\tTMP_DIR=$$(mktemp -d); \\\n\t\trm -rf $(WPTD_PATH)$${APP_PATH}/wpt.fyi; \\\n\t\tcp -r $(WPTD_PATH)* $${TMP_DIR}/; \\\n\t\tmkdir $(WPTD_PATH)$${APP_PATH}/wpt.fyi; \\\n\t\tcp -r $${TMP_DIR}/* $(WPTD_PATH)$${APP_PATH}/wpt.fyi/; \\\n\t\trm -rf $${TMP_DIR}; \\\n\tfi\n\nsys_deps: apt_update\n\tmake gcloud\n\tmake git\n\tmake node\n\napt_update:\n\tsudo apt-get -qq update\n\nbzip2: apt-get-bzip2\ncurl: apt-get-curl\ngcc: apt-get-gcc\ngit: apt-get-git\njq: apt-get-jq\npsmisc: apt-get-psmisc\npython3: apt-get-python3.11\ntox: apt-get-tox\nunzip: apt-get-unzip\nwget: apt-get-wget\n\njava:\n\t@ # java has a different apt-get package name.\n\tif [[ \"$$(which java)\" == \"\" ]]; then \\\n\t\tsudo apt-get install -qqy --no-install-suggests java-11-amazon-corretto-jdk; \\\n\tfi\n\ngpg:\n\t@ # gpg has a different apt-get package name.\n\tif [[ \"$$(which gpg)\" == \"\" ]]; then \\\n\t\tsudo apt-get install -qqy --no-install-suggests gnupg; \\\n\tfi\n\ninotifywait:\n\t@ # inotifywait has a different apt-get package name.\n\tif [[ \"$$(which inotifywait)\" == \"\" ]]; then \\\n\t\tsudo apt-get install -qqy --no-install-suggests inotify-tools; \\\n\tfi\n\nnode: curl gpg\n\tif [[ \"$$(which node)\" == \"\" ]]; then \\\n\t\tcurl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -; \\\n\t\tsudo apt-get install -qqy nodejs; \\\n\tfi\n\ngcloud: python3 curl gpg\n\tif [[ \"$$(which gcloud)\" == \"\" ]]; then \\\n\t\tcurl -s https://sdk.cloud.google.com > ./install-gcloud.sh; \\\n\t\tbash ./install-gcloud.sh --disable-prompts --install-dir=$(HOME) > /dev/null; \\\n\t\trm -f ./install-gcloud.sh; \\\n\t\tgcloud components install --quiet core gsutil; \\\n\t\tgcloud config set disable_usage_reporting false; \\\n\tfi\n\neslint: webapp_node_modules_all\n\tcd webapp; npm run lint\n\ndev_data: FLAGS := -remote_host=staging.wpt.fyi\ndev_data: git\n\tgo run $(WPTD_PATH)util/populate_dev_data.go $(FLAGS)\n\ngcloud_login: gcloud\n\tif [[ -z \"$$(gcloud config list account --format \"value(core.account)\")\" ]]; then \\\n\t\tgcloud auth activate-service-account --key-file $(WPTD_PATH)client-secret.json; \\\n\tfi\n\ndeployment_state: go_build gcloud_login package_service var-APP_PATH\n\ndeploy_staging: git apt-get-jq\ndeploy_staging: BRANCH_NAME := $$(git rev-parse --abbrev-ref HEAD)\ndeploy_staging: deployment_state var-BRANCH_NAME\n\tgcloud config set project wptdashboard-staging\n\tif [[ \"$(BRANCH_NAME)\" == \"refs/heads/main\" ]]; then \\\n\t\tutil/deploy.sh -q -r -p $(APP_PATH); \\\n\telse \\\n\t\tutil/deploy.sh -q -b $(BRANCH_NAME) $(APP_PATH); \\\n\tfi\n\trm -rf $(WPTD_PATH)api/query/cache/service/wpt.fyi\n\trm -rf $(WPTD_PATH)webapp/web/wpt.fyi\n\ncleanup_staging_versions: gcloud_login\n\t$(WPTD_PATH)/util/cleanup-versions.sh\n\ndeploy_production: deployment_state\n\tgcloud config set project wptdashboard\n\tutil/deploy.sh -r ${QUIET:+-q} $(APP_PATH)\n\trm -rf $(WPTD_PATH)api/query/cache/service/wpt.fyi\n\trm -rf $(WPTD_PATH)webapp/web/wpt.fyi\n\nwebapp_node_modules_all: node\n\tcd webapp; npm install\n\nwebapp_node_modules_prod: webapp_node_modules_all\n\tcd webapp; npm prune --production\n\nxvfb:\n\tif [[ \"$(USE_FRAME_BUFFER)\" == \"true\" && \"$$(which Xvfb)\" == \"\" ]]; then \\\n\t\tsudo apt-get install -qqy --no-install-suggests xvfb; \\\n\tfi\n\ngcloud-%: gcloud\n\tgcloud components list --only-local-state --format=\"value(id)\" 2>/dev/null | grep -q \"$*\" \\\n\t\t|| gcloud components install --quiet $*\n\nnode-%: node\n\t@ echo \"# Installing $*...\"\n\t# Hack to (more quickly) detect whether a package is already installed (available in node).\n\tcd webapp; node -p \"require('$*/package.json').version\" 2>/dev/null || npm install --no-save $*\n\napt-get-%:\n\tif [[ \"$$(which $*)\" == \"\" ]]; then sudo apt-get install -qqy --no-install-suggests $*; fi\n\nenv-%:\n\t@ if [[ \"${${*}}\" = \"\" ]]; then echo \"Environment variable $* not set\"; exit 1; fi\n\nvar-%:\n\t@ if [[ \"$($*)\" = \"\" ]]; then echo \"Make variable $* not set\"; exit 1; fi\n" }, { "path": "PULL_REQUEST_TEMPLATE.md", "content": "\n\n## Description\nTODO\n\n\n## Review Information\nTODO\n\n\n## Changes\nTODO\n\n\n## Requirements\nTODO\n\n" }, { "path": "README.md", "content": "# [web-platform-tests dashboard](https://wpt.fyi/) 📈\n\n[![GitHub Actions](https://github.com/web-platform-tests/wpt.fyi/workflows/Continuous%20Integration/badge.svg)](https://github.com/web-platform-tests/wpt.fyi/actions?query=workflow%3A%22Continuous+Integration%22+branch%3Amaster)\n\nwpt.fyi is a dashboard of cross-browser results for [web-platform-tests](https://github.com/web-platform-tests/wpt), the data for which is uploaded by external services, primarily from various CI integrations in the wpt repo.\n\n**Backend**: An [App Engine app](webapp/) for storing test run metadata and serving HTML\n\n**Frontend**: [Polymer elements](webapp/components/) for loading and visualizing test results\n\n## Using the data\n\nAll test result data is public. Please use our APIs to explore the data. For example, use the [results API](/api/README.md#apiresults) to download result summaries, and use the [runs API](/api/README.md#apiruns) to query runs and their metadata, which include links to other data like raw full reports.\n\n### Product ID\n\nThis is a tuple of browser name, browser version, os name, os version, serialized in the form of `browser[-version[-os[-version]]]` (`[]` means optional), widely used in our APIs as the `product` parameter.\n\n## Development\n\n### Setting up your environment\n\nYou'll need [Docker](https://www.docker.com/). With Docker installed, start the development container:\n\n```sh\ndocker pull webplatformtests/wpt.fyi:latest # Optional: this forces fetching the latest version, instead of using the locally cached version.\n./util/docker-dev/run.sh\n```\n\nThis starts a Docker instance named `wptd-dev-instance`.\n\n### Running locally\n\nOnce the instance is running, you can fire up the web server in another terminal:\n\n```sh\n./util/docker-dev/web_server.sh\n```\n\nThis will build dependencies and start the Google App Engine development server inside `wptd-dev-instance`.\n\nMeanwhile, you'll also need to populate the app datastore with some initial data. In another terminal,\nexecute the script which leverages `util/populate_dev_data.go` by running:\n\n```sh\n./util/docker-dev/dev_data.sh\n```\n\nSee [CONTRIBUTING.md](/CONTRIBUTING.md) for more information on local development.\n\n## Miscellaneous\n\n### WPT documentation page for each browser\n\n- Chromium: https://chromium.googlesource.com/chromium/src/+/master/docs/testing/web_platform_tests.md\n- Firefox: https://wiki.mozilla.org/Auto-tools/Projects/web-platform-tests\n- WebKit: https://trac.webkit.org/wiki/WebKitW3CTesting\n\n### Location of the WPT in each browser’s source tree\n\n- Chromium: [`src/third_party/blink/web_tests/external/wpt`](https://cs.chromium.org/chromium/src/third_party/blink/web_tests/external/wpt/)\n- Firefox: [`testing/web-platform/tests`](https://dxr.mozilla.org/mozilla-central/source/testing/web-platform/tests)\n- WebKit: [`LayoutTests/imported/w3c/web-platform-tests`](https://trac.webkit.org/browser/trunk/LayoutTests/imported/web-platform-tests/wpt)\n\n### You can run almost any WPT test on wpt.live\n\nTry out http://wpt.live/html/semantics/forms/the-input-element/checkbox.html\n\nThis doesn't work with some HTTPS tests. Also be advised that the server is not intended for frequent large-scale test runs.\n\n### Sources of inspiration\n\n- ECMAScript 6 compatibility table - https://kangax.github.io/compat-table/es6/\n- https://html5test.com/\n" }, { "path": "api/CORS_list.go", "content": "// Copyright 2020 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\n// CORSList is a list of trusted third-party origins.\n// nolint:gochecknoglobals // TODO: Fix gochecknoglobals lint error\nvar CORSList = []string{\"https://jgraham.github.io\"}\n" }, { "path": "api/README.md", "content": "# wpt.fyi API\n\nThis package defines and implements HTTP API endpoints for [wpt.fyi](https://wpt.fyi/), and this\ndocument covers usage and parameters of those endpoints.\n\n## Resource endpoints\n\nHere's a list of endpoints to query various resources. An exhaustive list of\nthe endpoints can be found in `routes.go`.\n\n - [/api/runs](#apiruns)\n - [/api/runs/{id}](#apirunsid)\n - [/api/run](#apirun)\n - [/api/shas](#apishas)\n - [/api/diff](#apidiff)\n - [/api/results](#apiresults)\n - [/api/manifest](#apimanifest)\n - [/api/search](#apisearch)\n - [/api/metadata](#apimetadata)\n - [/api/metadata/pending](#apimetadatapending)\n - [/api/metadata/triage](#apimetadatatriage)\n - [/api/bsf](#apibsf)\n - [/api/history](#apihistory)\n\nAlso see [results creation](#results-creation) for endpoints to add new data.\n\n## TestRun entities\n\n`TestRun` entities represent metadata about an execution of the [wpt](https://github.com/web-platform-tests/wpt) test suite, on a particular product. Tests are run on a regular basis, and each entry in `/api/runs` annotates when the tests were executed, which product they were executed on, and the where the results are stored.\n\n### /api/runs\n\nGets the TestRun metadata for all runs for a given SHA[0:10], sorted by `time_start` descending.\n\n__Parameters__\n\n__`sha`__ : SHA[0:10] of the runs to get, or the keyword `latest`. Defaults to `latest`.\n\n__`product`__ : Product(s) to include (repeated param), e.g. `chrome` or `firefox-60`.\n\n__`aligned`__ : boolean for whether to get only SHAs which were executed across all of the requested `product`s.\n\n__`labels`__: A comma-separated list of labels, e.g. `firefox,stable`; only runs with all\nthe given labels will be returned. There are currently two kinds of labels supported,\nbrowser names (`chrome`, `edge`, `firefox`, `safari`) and release channels (`experimental`\nor `stable`).\n\n__`from`__ : RFC3339 timestamp, for which to include runs that occured after the given time.\nNOTE: Runs are sorted by `time_start` descending, so be wary when combining this parameter\nwith the `max-count` parameter below.\n\n__`to`__ : RFC3339 timestamp, for which to include runs that occured before the given time.\n\n__`max-count`__ : Maximum number of runs to get (for each browser). Maximum of 500.\n\n#### staging.wpt.fyi only (Beta params)\n\n__`pr`__ (Beta): GitHub PR number. Shows runs for commits that belong to the PR.\n\n#### Examples\n\n- https://wpt.fyi/api/runs?product=chrome&product=safari\n- https://wpt.fyi/api/runs?product=chrome&from=2018-01-01T00:00:00Z&max-count=10\n\n
Example JSON\n\n [\n {\n \"browser_name\": \"chrome\",\n \"browser_version\": \"67.0.3396.62\",\n \"os_name\": \"linux\",\n \"os_version\": \"4.4\",\n \"revision\": \"2bd11b91d4\",\n \"full_revision_hash\": \"2bd11b91d490ddd5237bcb6d8149a7f25faaa101\",\n \"results_url\": \"https://storage.googleapis.com/wptd/2bd11b91d4/chrome-stable-linux-summary_v2.json.gz\",\n \"created_at\": \"2018-06-05T08:27:30.627865Z\",\n \"raw_results_url\": \"https://storage.googleapis.com/wptd-results/2bd11b91d490ddd5237bcb6d8149a7f25faaa101/chrome_67.0.3396.62_linux_4.4/report.json\"\n }\n ]\n\n
\n\n### /api/runs/{id}\n\nGets a specific (single) TestRun metadata by its datastore ID.\n\n#### Example\n\nhttps://wpt.fyi/api/runs/5184362994728960\n\n
Example JSON\n\n {\n \"id\": \"5164888561287168\",\n \"browser_name\": \"chrome\",\n \"browser_version\": \"67.0.3396.62\",\n \"os_name\": \"linux\",\n \"os_version\": \"4.4\",\n \"revision\": \"2bd11b91d4\",\n \"full_revision_hash\": \"2bd11b91d490ddd5237bcb6d8149a7f25faaa101\",\n \"results_url\": \"https://storage.googleapis.com/wptd/2bd11b91d4/chrome-stable-linux-summary_v2.json.gz\",\n \"created_at\": \"2018-06-05T08:27:30.627865Z\",\n \"raw_results_url\": \"https://storage.googleapis.com/wptd-results/2bd11b91d490ddd5237bcb6d8149a7f25faaa101/chrome_67.0.3396.62_linux_4.4/report.json\"\n }\n\n
\n\n### /api/run\n\nGets a specific (single) TestRun metadata by `product` and `sha`.\n\n__Parameters__\n\n__`sha`__ : SHA[0:10] of the runs to get, or the keyword `latest`. Defaults to `latest`.\n\n__`product`__ : browser[version[os[version]]]. e.g. `chrome-63.0-linux`\n\n#### Example\n\nhttps://wpt.fyi/api/run?sha=latest&product=chrome\n\n
Example JSON\n\n {\n \"id\": \"5164888561287168\",\n \"browser_name\": \"chrome\",\n \"browser_version\": \"67.0.3396.62\",\n \"os_name\": \"linux\",\n \"os_version\": \"4.4\",\n \"revision\": \"2bd11b91d4\",\n \"full_revision_hash\": \"2bd11b91d490ddd5237bcb6d8149a7f25faaa101\",\n \"results_url\": \"https://storage.googleapis.com/wptd/2bd11b91d4/chrome-stable-linux-summary_v2.json.gz\",\n \"created_at\": \"2018-06-05T08:27:30.627865Z\",\n \"raw_results_url\": \"https://storage.googleapis.com/wptd-results/2bd11b91d490ddd5237bcb6d8149a7f25faaa101/chrome_67.0.3396.62_linux_4.4/report.json\"\n }\n\n
\n\n### /api/shas\n\nGets an array of revisions (SHA[0:10]), in reverse chronological order.\nThis method behaves similarly to [/api/runs](#apiruns) above, but projects the `revision` field's value.\n\n__Parameters__\n\n__`aligned`__ : boolean for whether to get only SHAs which were executed across all of the requested `product`s.\n\n__`product`__ : Product(s) to include (repeated param), e.g. `chrome` or `firefox-60`\n\n__`from`__ : RFC3339 timestamp, for which to include runs that occured after the given time.\nNOTE: Runs are sorted by `time_start` descending, so be wary when combining this parameter\nwith the `max-count` parameter below.\n\n__`to`__ : RFC3339 timestamp, for which to include runs that occured before the given time.\n\n__`max-count`__ : Maximum number of runs to get (for each browser). Maximum of 500.\n\n#### Example\n\nhttps://wpt.fyi/api/shas?product=chrome\n\n
Example JSON\n\n [\n \"98530fb944\",\n \"2bd11b91d4\"//, ...\n ]\n\n
\n\n## Results summaries\n\nThe following methods apply to the results summaries JSON blobs, which are linked to from\n[TestRun entities](#test-run-entities).\n\n### /api/results\n\nPerforms an HTTP redirect for the results summary JSON blob of the given TestRun.\n\n__Response format__\n\nThe summary JSON format has been updated as of July 2022, and all requisite\nsummary files should now follow this newformat. Summary files with the new format\nare denoted with the `_v2` file name suffix. This change was made to\ndifferentiate a test's overall status value from the subtest passes and\ntotals.\n\nThe v2 summary JSON is in the format\n\n {\n \"/path/to/test.html\": {\n \"s\": \"O\",\n \"c\": [1, 1]\n },\n }\n\nEach test path has two properties.\n\n`s`, or status, which is an abbreviated value to the test's overall status.\n\n`c`, or counts, which is an array containing\n[`number of subtest passes`, `total subtests`].\n\n__Status abbrevations__\n\n| Status | Abbreviation |\n|---------------------|--------------|\n| OK | O |\n| PASS | P |\n| FAIL | F |\n| SKIP | S |\n| ERROR | E |\n| NOTRUN | N |\n| CRASH | C |\n| TIMEOUT | T |\n| PRECONDITION_FAILED | PF |\n\nAny summary files before this update follow the old JSON format (v1). The v1\nsummary format has no additional name suffix, unlike v2.\n\nThe v1 JSON is in the format\n\n {\n \"/path/to/test.html\": [2, 2],\n }\n\nWhere the array contains [`number of subtest passes`, `total subtests`].\nThe test's overall status is added with these subtest values. A passing status\nvalue (`OK` or `PASS`) will increment the number of subtest passes.\n\n__Parameters__\n\n__`product`__ : Product to fetch the results for, e.g. `chrome-66`\n\n__`sha`__ : SHA[0:10] of the TestRun to fetch, or the keyword `latest`. Defaults to `latest`.\n\n#### Example\n\nhttps://wpt.fyi/api/results?product=chrome\n\n
Example JSON (from the summary_v2.json.gz output)\n\n {\n \"/css/css-text/i18n/css3-text-line-break-opclns-213.html\": [1, 1],\n \"/css/css-writing-modes/table-progression-vrl-001.html\": [1, 1],\n // ...\n }\n\n
\n\n### /api/diff\n\nComputes a summary JSON blob of the differences between two TestRun summary blobs,\nin the format of an array of [improved, regressed, total-delta].\n\n__Parameters__\n\n__`run_ids`__ : Exactly two numerical IDs for the \"before\" and \"after\" runs (in\nthat order), separted by a comma. IDs associated with runs can be obtained by\nquerying the `/api/runs` API. This overrides the `before` and `after` params.\n\n__`before`__ : [product]@[sha] spec for the TestRun to use as the before state.\n\n__`after`__ : [product]@[sha] spec for the TestRun to use as the after state.\n\n__`path`__ : Test path to filter by. `path` is a repeatable query parameter.\n\n__`filter`__ : Differences to include in the summary.\n - `A` : Added - tests which are present after, but not before.\n - `D` : Deleted - tests which are present before, but not after.\n - `C` : Changed - tests which are present before and after, but the results summary is different.\n - `U` : Unchanged - tests which are present before and after, and the results summary count is not different.\n\n## Test Manifest\n\nThe following methods apply to the retrieval and filtering of the Test Manifest in [WPT](https://github.com/web-platform-tests/wpt),\nwhich contains metadata about each test.\n\n### /api/manifest\n\nGets the JSON of the WPT manifest GitHub release asset, for a given `sha` (defaults to latest).\n\n__Parameters__\n\n__`sha`__ : SHA of the [WPT](https://github.com/web-platform-tests/wpt) repo PR for which to fetch,\n the manifest, or the keyword `latest`. (Defaults to `latest`.)\n\nNOTE: The full SHA of the fetched manifest is returned in the HTTP response header `X-WPT-SHA`, e.g.\n\n X-WPT-SHA: abcdef0123456789abcdef0123456789abcdef01\n\n__Response format__\n\nThe high-level structure of the `v4` manifest is as follows:\n\n {\n \"items\": {\n \"manual\": {\n \"file/path\": [\n manifest_item,\n ...\n ],\n ...\n },\n \"reftest\": {...},\n \"testharness\": {...},\n \"visual\", {...},\n \"wdspec\": {...},\n },\n }\n\n`manifest_item` is an **array** (nested in the map's `\"file/path\"` value's array) with varying contents. Loosely,\n\n- For `testharness` entries: `[url, extras]`\n - `extras` example: `{\"timeout\": \"long\", \"testdriver\": True}`\n- For `reftest` entries: `[url, references, extras]`\n - `references` example: `[[reference_url1, \"==\"], [reference_url2, \"!=\"], ...]`\n - `extras` example: `{\"timeout\": \"long\", \"viewport_size\": ..., \"dpi\": ...}`\n\n## Results creation\n\n### /api/results/upload\n\nUploads a wptreport to the dashboard to create the test run.\n\nThis endpoint only accepts POST requests. Requests need to be authenticated via HTTP basic auth.\nPlease [file an issue](https://github.com/web-platform-tests/wpt.fyi/issues/new) if you want to\nregister as a \"test runner\", to upload results.\n\n#### File payload\n\n__Content type__: `multipart/form-data`\n\n__Parameters__\n\n__`labels`__: (Optional) A comma-separated string of labels for this test run. Currently recognized\nlabels are \"experimental\", \"stable\" (the release channel of the tested browser) and \"master\" (test run\nfrom the master branch).\n\n__`callback_url`__: (Optional) A URL that the processor should `POST` when successful, which will\ncreate the TestRun. Defaults to /api/results/create in the current project's environment (e.g. wpt.fyi for\nwptdashboard, staging.wpt.fyi for wptdashboard-staging).\n\n__`result_file`__: A **gzipped** JSON file, with the filename ending with `.gz` extension, produced by `wpt run --log-wptreport`.\nThis field can be repeated to include multiple files (for chunked reports).\n\n__`screenshot_file`__: A **gzipped** screenshot database produced by `wpt run --log-screenshot`.\nThis field can be repeated to include multiple links (for chunked reports).\n\nThe JSON file roughly looks like this:\n\n```json\n{\n \"results\": [...],\n \"time_start\": MILLISECONDS_SINCE_EPOCH,\n \"time_end\": MILLISECONDS_SINCE_EPOCH,\n \"run_info\": {\n \"revision\": \"WPT revision of the test run\",\n \"product\": \"your browser\",\n \"browser_version\": \"version of the browser\",\n \"os\": \"your os\",\n \"os_version\": \"OPTIONAL OS version\",\n ...\n }\n}\n```\n\n__Notes__\n\nThe `time_start` and `time_end` fields are numerical timestamps (in milliseconds since the UNIX epoch)\nwhen the whole test run starts and finishes. They are optional, but encouraged. `wpt run` produces\nthem in the report by default.\n\n`run_info.{revision,product,browser_version,os}` are required, and should be automatically\ngenerated by `wpt run`. If for some reason the report does not contain these fields (e.g. old WPT\nversion, Sauce Labs, or custom runners), they can be overridden with the following *optional*\nparameters in the POST payload (this is __NOT__ recommended; please include metadata in the reports\nwhenever possible):\n\n* __`revision`__ (note this should be the full revision hash, not a 10-char truncation)\n* __`browser_name`__ (note that it is not called `product` here)\n* __`browser_version`__\n* __`os_name`__ (note that it is not called `os` here)\n* __`os_version`__\n\n#### URL payload\n\n__Content type__: `application/x-www-form-urlencoded`\n\n__Parameters__\n\n__`result_url`__: A URL to a **gzipped** JSON file produced by `wpt run --log-wptreport` (see above\nfor its format). This field can be repeated to include multiple links (for chunked reports).\n\n__`screenshot_url`__: A URL to a **gzipped** screenshot database produced by `wpt run --log-screenshot`.\nThis field can be repeated to include multiple links (for chunked reports).\n\n__`archive_url`__: A URL to a ZIP archive containing files like `wpt_report*.json` and\n`wpt_screenshot*.json`, similar to `result_url` and `screenshot_url` respectively. This field can\nbe repeated to include multiple links (for chunked reports). This field cannot co-exist with\n`result_url` or `screenshot_url`.\n\n__`callback_url`__: (Optional) A URL that the processor should `POST` when successful, which will\ncreate the TestRun. Defaults to /api/results/create in the current project's environment (e.g. wpt.fyi for\nwptdashboard, staging.wpt.fyi for wptdashboard-staging).\n\n__`labels`__: (Optional) A comma-separated string of labels for this test run. Currently recognized\nlabels are \"experimental\" and \"stable\" (the release channel of the tested browser).\n\n### /api/results/create\n\nThis is an *internal* endpoint used by the results processor.\n\n## Querying test results\n\n### /api/search\n\nSearch for test results over some set of test runs. This endpoint accepts POST and GET requests.\n\n- POST requests are forwarded to the searchcache for structured queries, with\n `run_ids` and `query` fields in the JSON payload; see [search query](./query/README.md#apisearch)\n documentaton for more information.\n\n- GET requests are unstructured queries with the following parameters:\n\n\n__Parameters__\n\n__`run_ids`__ : (Optional) A comma-separated list of numerical ids associated\nwith the runs over which to search. IDs associated with runs can be obtained by\nquerying the `/api/runs` API. Defaults to the default runs returned by\n`/api/runs`. NOTE: This is not the same set of runs as is shown on wpt.fyi by\ndefault.\n\n__`q`__: (Optional) A query string for search. Only results data for tests that\ncontain the `q` value as a substring of the test name will be returned. Defaults\nto the empty string, which will yield all test results for the selected runs.\nNOTE: structured search queries are not supported.\n\n#### Examples\n\n- https://staging.wpt.fyi/api/search?run_ids=6311104602963968,5132783244541952&q=xyz\n\n
Example JSON\n\n```json\n{\n \"runs\": [\n {\n \"id\": 6.311104602964e+15,\n \"browser_name\": \"chrome\",\n \"browser_version\": \"68.0.3440.106\",\n \"os_name\": \"linux\",\n \"os_version\": \"16.04\",\n \"revision\": \"2dda7b8c10\",\n \"full_revision_hash\": \"2dda7b8c10c7566fa6167a32b09c85d51baf2a85\",\n \"results_url\": \"https:\\/\\/storage.googleapis.com\\/wptd-staging\\/2dda7b8c10c7566fa6167a32b09c85d51baf2a85\\/chrome-68.0.3440.106-linux-16.04-edf200244e-summary_v2.json.gz\",\n \"created_at\": \"2018-08-17T08:12:29.219847Z\",\n \"time_start\": \"2018-08-17T06:26:52.33Z\",\n \"time_end\": \"2018-08-17T07:50:09.155Z\",\n \"raw_results_url\": \"https:\\/\\/storage.googleapis.com\\/wptd-results-staging\\/2dda7b8c10c7566fa6167a32b09c85d51baf2a85\\/chrome-68.0.3440.106-linux-16.04-edf200244e\\/report.json\",\n \"labels\": [\n \"buildbot\",\n \"chrome\",\n \"stable\"\n ]\n },\n {\n \"id\": 5.132783244542e+15,\n \"browser_name\": \"firefox\",\n \"browser_version\": \"61.0.2\",\n \"os_name\": \"linux\",\n \"os_version\": \"16.04\",\n \"revision\": \"2dda7b8c10\",\n \"full_revision_hash\": \"2dda7b8c10c7566fa6167a32b09c85d51baf2a85\",\n \"results_url\": \"https:\\/\\/storage.googleapis.com\\/wptd-staging\\/2dda7b8c10c7566fa6167a32b09c85d51baf2a85\\/firefox-61.0.2-linux-16.04-75ff911c43-summary_v2.json.gz\",\n \"created_at\": \"2018-08-17T08:31:38.580221Z\",\n \"time_start\": \"2018-08-17T06:47:29.643Z\",\n \"time_end\": \"2018-08-17T08:15:18.612Z\",\n \"raw_results_url\": \"https:\\/\\/storage.googleapis.com\\/wptd-results-staging\\/2dda7b8c10c7566fa6167a32b09c85d51baf2a85\\/firefox-61.0.2-linux-16.04-75ff911c43\\/report.json\",\n \"labels\": [\n \"buildbot\",\n \"firefox\",\n \"stable\"\n ]\n }\n ],\n \"results\": [\n {\n \"test\": \"\\/html\\/dom\\/elements\\/global-attributes\\/lang-xyzzy.html\",\n \"legacy_status\": [\n {\n \"passes\": 1,\n \"total\": 1\n },\n {\n \"passes\": 1,\n \"total\": 1\n }\n ]\n }\n ]\n}\n```\n\n
\n\n## Metadata results\n\n### /api/metadata\n\nAPI endpoint for fetching all of the `link` metadata stored in the wpt-metadata\nrepository, with the (normally file-sharded) data all flattened into a JSON\nobject which is keyed by test name.\n\nThis endpoint accepts POST and GET requests.\n\n- GET request returns Metadata Link Information by product, and requires product parameters;\n\n- POST request searches Metadata Link by link url, and requires product parameters and payload.\n\n__URL Parameters__\n\n__`product`__ : browser[version[os[version]]]. e.g. `chrome-63.0-linux`\n\n#### JSON Request Payload\n```json\n[\n {\n \"link\": \"[pattern]\"\n }\n]\n```\n\n Where `[pattern]` is any substring of the url field of a wpt-metadata `link` node.\n\n#### Get Examples\n\n- /api/metadata?product=chrome&product=safari\n\n
Example JSON\n\n```json\n{\n \"/FileAPI/blob/Blob-constructor.html\": [\n {\n \"url\": \"https://github.com/web-platform-tests/results-collection/issues/661\",\n \"product\": \"chrome\",\n \"results:\" [\n {\n \"subtest\": \"Blob with type \\\"image/gif;\\\"\",\n \"status\": \"UNKNOWN\"\n },\n {\n \"subtest\": \"Invalid contentType (\\\"text/plain\\\")\",\n \"status\": \"UNKNOWN\"\n }\n ]\n }\n ],\n \"/service-workers/service-worker/fetch-request-css-base-url.https.html\": [\n {\n \"url\": \"https://bugzilla.mozilla.org/show_bug.cgi?id=1201160\",\n \"product\": \"firefox\",\n }\n ],\n \"/service-workers/service-worker/fetch-request-css-images.https.html\": [\n {\n \"url\": \"https://bugzilla.mozilla.org/show_bug.cgi?id=1532331\",\n \"product\": \"firefox\"\n }\n ]\n}\n```\n
\n\n#### Post Examples\n- POST /api/metadata?product=chrome\\&product=firefox \\\n exists:='[{\"link\":\"issues.chromium.org\"}]'\n\n
Example JSON\n\n```json\n{\n \"/IndexedDB/bindings-inject-key.html\": [\n {\n \"url\": \"issues.chromium.org/issues/934844\"\n }\n ],\n \"/html/browsers/history/the-history-interface/007.html\": [\n {\n \"url\": \"issues.chromium.org/issues/592874\"\n }\n ]\n}\n```\n
\n\n### /api/metadata/pending\nAPI endpoint for retrieving pending metadata whose PRs are not merged yet. This endpoint is used along with the /api/metadata endpoint to retrieve all metadata, pending or non-pending. It accepts GET requests without any parameters. It returns the same JSON response as [/api/metadata](#apimetadata).\n\nThis endpoint is a best-effort API, because in some rare cases, e.g. both the Redis server and its replica go down, pending metadata information can be lost temporarily.\n\n### /api/metadata/triage\n\nThis API is available for trusted third parties.\n\nTo use the Triage Metadata API, you first need to sign in to [wpt.fyi](https://wpt.fyi/) (top-right corner; 'Sign in with GitHub'). For more information on wpt.fyi login, see [here](https://docs.google.com/document/d/1iRkaK6cGgXp3DKbNbPMVsYGMaOHO-5CfqEuLPUR_2HM).\n\nThe logged-in user also needs to belong to the ['web-platform-tests' GitHub organization](https://github.com/orgs/web-platform-tests/people). To join, please [file an issue](https://github.com/web-platform-tests/wpt/issues/new?), including the reason you need access to the Triage Metadata API.\n\nOnce logged in, you can send a request to /api/metadata/triage to triage metadata. This endpoint only accepts PATCH requests and appends a triage JSON object to the existing Metadata YML files. The JSON object is a flattened YAML `Links` structure that is keyed by test name [Test path](https://docs.google.com/document/d/1oWYVkc2ztANCGUxwNVTQHlWV32zq6Ifq9jkkbYNbSAg/edit#heading=h.t7ysbpr8er1y); see below for an example.\n\nThis endpoint returns the URL of a PR that is created in the wpt-metadata repo.\n\n
Example JSON Body\n\n```json\n{\n \"/FileAPI/blob/Blob-constructor.html\": [\n {\n \"url\": \"https://github.com/web-platform-tests/results-collection/issues/661\",\n \"product\": \"chrome\",\n \"results:\" [\n {\n \"subtest\": \"Blob with type \\\"image/gif;\\\"\",\n \"status\": 6\n },\n {\n \"subtest\": \"Invalid contentType (\\\"text/plain\\\")\",\n \"status\": 0\n }\n ]\n }\n ],\n \"/service-workers/service-worker/fetch-request-css-base-url.https.html\": [\n {\n \"url\": \"https://bugzilla.mozilla.org/show_bug.cgi?id=1201160\",\n \"product\": \"firefox\",\n }\n ],\n \"/service-workers/service-worker/fetch-request-css-images.https.html\": [\n {\n \"url\": \"https://bugzilla.mozilla.org/show_bug.cgi?id=1532331\",\n \"product\": \"firefox\"\n }\n ]\n}\n```\n
\n\n## Browser Specific Failure\n\n### /api/bsf\nGets the BSF data of Chrome, Firefox, Safari for the home directory.\n\nThe endpoint accepts GET requests.\n\n__Parameters__\n\n__`from`__ : (Optional) RFC3339 timestamp, for which to include BSF data that occured after the given time inclusively.\n\n__`to`__ : (Optional) RFC3339 timestamp, for which to include BSF data that occured before the given time exclusively.\n\n__`experimental`__ : A boolean to return BSF data for experimental or stable runs. Defaults to false.\n\n__JSON Response__\n\nThe response has three top-level fields:\n\n`lastUpdateRevision` indicates the latest WPT Revision updated in `data`.\n\n`fields` corresponds to the fields (columns) in the `data` table and has the format of an array of:\n\n- sha, date, [product-version, product-score]+\n\n`data` returns BSF data in chronological order.\n\n
Example JSON\n\n```json\n{\n \"lastUpdateRevision\":\"eea0b54014e970a2f94f1c35ec6e18ece76beb76\",\n \"fields\":[\n \"sha\",\n \"date\",\n \"chrome-version\",\n \"chrome\",\n \"firefox-version\",\n \"firefox\",\n \"safari-version\",\n \"safari\"\n ],\n \"data\":[\n [\n \"eea0b54014e970a2f94f1c35ec6e18ece76beb76\",\n \"2018-08-07\",\n \"70.0.3510.0 dev\",\n \"602.0505256721168\",\n \"63.0a1\",\n \"1617.1788882804883\",\n \"12.1\",\n \"2900.3438625831423\"\n ],\n [\n \"203c34855f6871d6e55eaf7b55b50dad563f781f\",\n \"2018-08-18\",\n \"70.0.3521.2 dev\",\n \"605.3869030161061\",\n \"63.0a1\",\n \"1521.908686731921\",\n \"12.1\",\n \"2966.686195133767\"\n ]\n ]\n}\n```\n
\n\n## Test History\n\n### /api/history\n\nThis endpoint accepts POST requests. It returns historical test run information for a given test name.\n\n#### JSON Request Payload\n```json\n{\n \"test_name\": \"example test name\"\n}\n```\n#### JSON Response\nThe returned JSON will contain a history of test runs for each major browser: Chrome, Firefox, Edge, and Safari.\n\nEach individual subtest run will have a `date`, `status`, and `run_id`.\n\nThe first test entry for each browser is represented with an empty string. This represents the `Harness Status` if there are multiple tests, or the `Test Status` if there is only one test.\n\n
Example JSON\n\n```json\n{\n \"results\": {\n \"chrome\": {\n \"\": [\n {\n \"date\": \"2022-06-02T06:02:55.000Z\",\n \"status\": \"TIMEOUT\",\n \"run_id\": \"5074677897101312\"\n }\n ],\n \"subtest_name_1\": [\n {\n \"date\": \"2022-06-02T06:02:55.000Z\",\n \"status\": \"PASS\",\n \"run_id\": \"5074677897101312\"\n }\n ]\n },\n \"firefox\": {\n \"\": [\n {\n \"date\": \"2022-06-02T06:02:55.000Z\",\n \"status\": \"OK\",\n \"run_id\": \"5074677897101312\"\n }\n ],\n \"subtest_name_1\": [\n {\n \"date\": \"2022-06-02T06:02:55.000Z\",\n \"status\": \"PASS\",\n \"run_id\": \"5074677897101312\"\n }\n ]\n }\n }\n}\n```\n
\n" }, { "path": "api/azure/api.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n//go:generate mockgen -build_flags=--mod=mod -destination mock_azure/api_mock.go github.com/web-platform-tests/wpt.fyi/api/azure API\n\npackage azure\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// PipelinesAppID is the ID of the Azure Pipelines GitHub app.\nconst PipelinesAppID = int64(9426)\n\n// https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/get?view=azure-devops-rest-4.1\n\n// BuildArtifacts is a wrapper for multiple BuildArtifact results.\ntype BuildArtifacts struct {\n\tCount int64 `json:\"count\"`\n\tValue []BuildArtifact `json:\"value\"`\n}\n\n// BuildArtifact is an artifact published by a build.\ntype BuildArtifact struct {\n\tID int64 `json:\"id\"`\n\tName string `json:\"name\"`\n\tResource ArtifactResource `json:\"resource\"`\n}\n\n// ArtifactResource is a resource for an artifact.\ntype ArtifactResource struct {\n\tData string `json:\"data\"`\n\tDownloadURL string `json:\"downloadUrl\"`\n\tType string `json:\"type\"`\n\tURL string `json:\"url\"`\n}\n\n// Build is an Azure Pipelines build object.\ntype Build struct {\n\tSourceBranch string `json:\"sourceBranch\"`\n\tTriggerInfo BuildTriggerInfo `json:\"triggerInfo\"`\n}\n\n// BuildTriggerInfo is information about what triggered the build.\ntype BuildTriggerInfo struct {\n\tSourceBranch string `json:\"pr.sourceBranch\"`\n\tSourceSHA string `json:\"pr.sourceSha\"`\n}\n\n// IsMasterBranch returns whether the source branch for the build is the master branch.\nfunc (a *Build) IsMasterBranch() bool {\n\treturn a != nil && a.SourceBranch == \"refs/heads/master\"\n}\n\n// API is for Azure Pipelines related requests.\ntype API interface {\n\tGetBuildURL(owner, repo string, buildID int64) string\n\tGetAzureArtifactsURL(owner, repo string, buildID int64) string\n\tGetBuild(owner, repo string, buildID int64) (*Build, error)\n}\n\ntype apiImpl struct {\n\tctx context.Context // nolint:containedctx // TODO: Fix containedctx lint error\n}\n\n// NewAPI returns an implementation of azure API.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc NewAPI(ctx context.Context) API {\n\treturn apiImpl{\n\t\tctx: ctx,\n\t}\n}\n\nfunc (a apiImpl) GetBuildURL(owner, repo string, buildID int64) string {\n\t// https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get?view=azure-devops-rest-4.1#build\n\treturn fmt.Sprintf(\n\t\t\"https://dev.azure.com/%s/%s/_apis/build/builds/%v\", owner, repo, buildID)\n}\n\nfunc (a apiImpl) GetAzureArtifactsURL(owner, repo string, buildID int64) string {\n\treturn fmt.Sprintf(\n\t\t\"https://dev.azure.com/%s/%s/_apis/build/builds/%v/artifacts\",\n\t\towner,\n\t\trepo,\n\t\tbuildID)\n}\n\nfunc (a apiImpl) GetBuild(owner, repo string, buildID int64) (*Build, error) {\n\tbuildURL := a.GetBuildURL(owner, repo, buildID)\n\tclient := shared.NewAppEngineAPI(a.ctx).GetHTTPClient()\n\treq, err := http.NewRequestWithContext(a.ctx, http.MethodGet, buildURL, nil)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to create GET request: %w\", err)\n\t}\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to handle fetch build: %w\", err)\n\t}\n\tdefer resp.Body.Close()\n\tdata, err := io.ReadAll(resp.Body)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to read request response: %w\", err)\n\t}\n\tvar build Build\n\tif err := json.Unmarshal(data, &build); err != nil {\n\t\treturn nil, fmt.Errorf(\"failed to unmarshal request response: %w\", err)\n\t}\n\tlog := shared.GetLogger(a.ctx)\n\tlog.Debugf(\"Source branch: %s\", build.SourceBranch)\n\tlog.Debugf(\"Trigger PR branch: %s\", build.TriggerInfo.SourceBranch)\n\n\treturn &build, nil\n}\n" }, { "path": "api/azure/mock_azure/api_mock.go", "content": "// Code generated by MockGen. DO NOT EDIT.\n// Source: github.com/web-platform-tests/wpt.fyi/api/azure (interfaces: API)\n//\n// Generated by this command:\n//\n//\tmockgen -build_flags=--mod=mod -destination mock_azure/api_mock.go github.com/web-platform-tests/wpt.fyi/api/azure API\n//\n\n// Package mock_azure is a generated GoMock package.\npackage mock_azure\n\nimport (\n\treflect \"reflect\"\n\n\tazure \"github.com/web-platform-tests/wpt.fyi/api/azure\"\n\tgomock \"go.uber.org/mock/gomock\"\n)\n\n// MockAPI is a mock of API interface.\ntype MockAPI struct {\n\tctrl *gomock.Controller\n\trecorder *MockAPIMockRecorder\n\tisgomock struct{}\n}\n\n// MockAPIMockRecorder is the mock recorder for MockAPI.\ntype MockAPIMockRecorder struct {\n\tmock *MockAPI\n}\n\n// NewMockAPI creates a new mock instance.\nfunc NewMockAPI(ctrl *gomock.Controller) *MockAPI {\n\tmock := &MockAPI{ctrl: ctrl}\n\tmock.recorder = &MockAPIMockRecorder{mock}\n\treturn mock\n}\n\n// EXPECT returns an object that allows the caller to indicate expected use.\nfunc (m *MockAPI) EXPECT() *MockAPIMockRecorder {\n\treturn m.recorder\n}\n\n// GetAzureArtifactsURL mocks base method.\nfunc (m *MockAPI) GetAzureArtifactsURL(owner, repo string, buildID int64) string {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetAzureArtifactsURL\", owner, repo, buildID)\n\tret0, _ := ret[0].(string)\n\treturn ret0\n}\n\n// GetAzureArtifactsURL indicates an expected call of GetAzureArtifactsURL.\nfunc (mr *MockAPIMockRecorder) GetAzureArtifactsURL(owner, repo, buildID any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetAzureArtifactsURL\", reflect.TypeOf((*MockAPI)(nil).GetAzureArtifactsURL), owner, repo, buildID)\n}\n\n// GetBuild mocks base method.\nfunc (m *MockAPI) GetBuild(owner, repo string, buildID int64) (*azure.Build, error) {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetBuild\", owner, repo, buildID)\n\tret0, _ := ret[0].(*azure.Build)\n\tret1, _ := ret[1].(error)\n\treturn ret0, ret1\n}\n\n// GetBuild indicates an expected call of GetBuild.\nfunc (mr *MockAPIMockRecorder) GetBuild(owner, repo, buildID any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetBuild\", reflect.TypeOf((*MockAPI)(nil).GetBuild), owner, repo, buildID)\n}\n\n// GetBuildURL mocks base method.\nfunc (m *MockAPI) GetBuildURL(owner, repo string, buildID int64) string {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetBuildURL\", owner, repo, buildID)\n\tret0, _ := ret[0].(string)\n\treturn ret0\n}\n\n// GetBuildURL indicates an expected call of GetBuildURL.\nfunc (mr *MockAPIMockRecorder) GetBuildURL(owner, repo, buildID any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetBuildURL\", reflect.TypeOf((*MockAPI)(nil).GetBuildURL), owner, repo, buildID)\n}\n" }, { "path": "api/azure/notify.go", "content": "// Copyright 2019 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage azure\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"strconv\"\n\n\t\"github.com/gorilla/mux\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nfunc notifyHandler(w http.ResponseWriter, r *http.Request) {\n\tvars := mux.Vars(r)\n\tid := vars[\"id\"]\n\tvar buildID int64\n\tvar err error\n\tif buildID, err = strconv.ParseInt(id, 0, 0); err != nil {\n\t\thttp.Error(w, fmt.Sprintf(\"Invalid build id: %s\", id), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tctx := r.Context()\n\taeAPI := shared.NewAppEngineAPI(ctx)\n\tazureAPI := NewAPI(ctx)\n\tlog := shared.GetLogger(ctx)\n\n\tprocessed, err := processBuild(\n\t\taeAPI,\n\t\tazureAPI,\n\t\tshared.WPTRepoOwner,\n\t\tshared.WPTRepoName,\n\t\t\"\", // No sender info.\n\t\tr.FormValue(\"artifact\"), // artifact=foo will only process foo.\n\t\tbuildID)\n\n\tif err != nil {\n\t\tlog.Errorf(\"%v\", err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\tif processed {\n\t\tw.WriteHeader(http.StatusOK)\n\t\tfmt.Fprintln(w, \"Azure build artifacts retrieved successfully\")\n\t} else {\n\t\tw.WriteHeader(http.StatusNoContent)\n\t\tfmt.Fprintln(w, \"Notification of build artifacts was ignored\")\n\t}\n}\n" }, { "path": "api/azure/routes.go", "content": "// Copyright 2019 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage azure\n\nimport \"github.com/web-platform-tests/wpt.fyi/shared\"\n\n// RegisterRoutes adds all the api route handlers.\nfunc RegisterRoutes() {\n\t// notifyHandler exposes an endpoint for notifying wpt.fyi that it can collect\n\t// the results of an Azure Pipelines build (by the provided ID).\n\t// The endpoint is insecure, because we'll only try to fetch (specifically) a\n\t// web-platform-tests/wpt build with the given ID.\n\tshared.AddRoute(\"/api/checks/azure/{id:[0-9]+}\", \"azure-notify\", notifyHandler).\n\t\tMethods(\"POST\")\n}\n" }, { "path": "api/azure/webhook.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage azure\n\nimport (\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"regexp\"\n\n\tmapset \"github.com/deckarep/golang-set\"\n\n\tuc \"github.com/web-platform-tests/wpt.fyi/api/receiver/client\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nconst uploaderName = \"azure\"\n\n// Labels for runs from Azure Pipelines are determined from the artifact names.\n// For master runs, artifact name may be either just \"results\" or something\n// like \"safari-results\".\nvar (\n\tmasterRegex = regexp.MustCompile(`\\bresults$`)\n\tprHeadRegex = regexp.MustCompile(`\\baffected-tests$`)\n\tprBaseRegex = regexp.MustCompile(`\\baffected-tests-without-changes$`)\n\tepochBranchesRegex = regexp.MustCompile(\"^refs/heads/epochs/.*\")\n)\n\nfunc processBuild(\n\taeAPI shared.AppEngineAPI,\n\tazureAPI API,\n\towner,\n\trepo,\n\tsender,\n\tartifactName string,\n\tbuildID int64,\n) (bool, error) {\n\tbuild, err := azureAPI.GetBuild(owner, repo, buildID)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\tif build == nil {\n\t\treturn false, fmt.Errorf(\"cannot get build %s/%s/%d\", owner, repo, buildID)\n\t}\n\tsha := build.TriggerInfo.SourceSHA\n\n\t// https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/get?view=azure-devops-rest-4.1\n\tartifactsURL := azureAPI.GetAzureArtifactsURL(owner, repo, buildID)\n\n\tlog := shared.GetLogger(aeAPI.Context())\n\tlog.Infof(\"Fetching %s\", artifactsURL)\n\n\tclient := aeAPI.GetHTTPClient()\n\treq, err := http.NewRequestWithContext(aeAPI.Context(), http.MethodGet, artifactsURL, nil)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to create get for %s/%s/%d: %w\", owner, repo, buildID, err)\n\t}\n\tresp, err := client.Do(req)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to fetch artifacts for %s/%s/%d: %w\", owner, repo, buildID, err)\n\t}\n\n\tvar artifacts BuildArtifacts\n\tif body, err := io.ReadAll(resp.Body); err != nil {\n\t\treturn false, fmt.Errorf(\"failed to read response body: %w\", err)\n\t} else if err = json.Unmarshal(body, &artifacts); err != nil {\n\t\treturn false, fmt.Errorf(\"failed to unmarshal JSON: %w\", err)\n\t}\n\n\tuploadedAny := false\n\terrors := make(chan (error), artifacts.Count)\n\tfor _, artifact := range artifacts.Value {\n\t\tif artifactName != \"\" && artifactName != artifact.Name {\n\t\t\tlog.Infof(\"Skipping artifact %s (looking for %s)\", artifact.Name, artifactName)\n\n\t\t\tcontinue\n\t\t}\n\t\tlog.Infof(\"Uploading %s for %s/%s build %v...\", artifact.Name, owner, repo, buildID)\n\n\t\tlabels := mapset.NewSet()\n\t\tif sender != \"\" {\n\t\t\tlabels.Add(shared.GetUserLabel(sender))\n\t\t}\n\n\t\tif masterRegex.MatchString(artifact.Name) {\n\t\t\tif build.IsMasterBranch() || epochBranchesRegex.MatchString(build.SourceBranch) {\n\t\t\t\tlabels.Add(shared.MasterLabel)\n\t\t\t}\n\t\t} else if prHeadRegex.MatchString(artifact.Name) {\n\t\t\tlabels.Add(shared.PRHeadLabel)\n\t\t} else if prBaseRegex.MatchString(artifact.Name) {\n\t\t\tlabels.Add(shared.PRBaseLabel)\n\t\t}\n\n\t\tuploader, err := aeAPI.GetUploader(uploaderName)\n\t\tif err != nil {\n\t\t\treturn false, fmt.Errorf(\"failed to get uploader creds from Datastore: %w\", err)\n\t\t}\n\n\t\tuploadClient := uc.NewClient(aeAPI)\n\t\terr = uploadClient.CreateRun(\n\t\t\tsha,\n\t\t\tuploader.Username,\n\t\t\tuploader.Password,\n\t\t\tnil,\n\t\t\tnil,\n\t\t\t[]string{artifact.Resource.DownloadURL},\n\t\t\tshared.ToStringSlice(labels))\n\t\tif err != nil {\n\t\t\terrors <- fmt.Errorf(\"failed to create run: %w\", err)\n\t\t} else {\n\t\t\tuploadedAny = true\n\t\t}\n\t}\n\tclose(errors)\n\tfor err := range errors {\n\t\treturn uploadedAny, err\n\t}\n\n\treturn uploadedAny, nil\n}\n" }, { "path": "api/azure/webhook_test.go", "content": "//go:build small\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage azure\n\nimport (\n\t\"encoding/json\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nconst artifactsJSON = `{\n\t\"count\": 2,\n\t\"value\": [{\n\t\t\"id\": 1,\n\t\t\"name\": \"results-without-patch\",\n\t\t\"resource\": {\n\t\t\t\"type\": \"Container\",\n\t\t\t\"data\": \"#/1714875/results-without-patch\",\n\t\t\t\"properties\": {\n\t\t\t\t\"localpath\": \"/Users/vsts/agent/2.142.1/work/1/a/wpt_report.json\"\n\t\t\t},\n\t\t\t\"url\": \"https://dev.azure.com/lukebjerring/92272aaf-ee0f-48f4-8c22-c1fa6648843c/_apis/build/builds/4/artifacts?artifactName=results-without-patch&api-version=5.0\",\n\t\t\t\"downloadUrl\": \"https://dev.azure.com/lukebjerring/92272aaf-ee0f-48f4-8c22-c1fa6648843c/_apis/build/builds/4/artifacts?artifactName=results-without-patch&api-version=5.0&%24format=zip\"\n\t\t}\n\t}, {\n\t\t\"id\": 2,\n\t\t\"name\": \"results\",\n\t\t\"resource\": {\n\t\t\t\"type\": \"Container\",\n\t\t\t\"data\": \"#/1714875/results\",\n\t\t\t\"properties\": {\n\t\t\t\t\"localpath\": \"/Users/vsts/agent/2.142.1/work/1/a/wpt_report.json\"\n\t\t\t},\n\t\t\t\"url\": \"https://dev.azure.com/lukebjerring/92272aaf-ee0f-48f4-8c22-c1fa6648843c/_apis/build/builds/4/artifacts?artifactName=results&api-version=5.0\",\n\t\t\t\"downloadUrl\": \"https://dev.azure.com/lukebjerring/92272aaf-ee0f-48f4-8c22-c1fa6648843c/_apis/build/builds/4/artifacts?artifactName=results&api-version=5.0&%24format=zip\"\n\t\t}\n\t}]\n}`\n\nfunc TestParses(t *testing.T) {\n\tvar artifacts BuildArtifacts\n\terr := json.Unmarshal([]byte(artifactsJSON), &artifacts)\n\tassert.Nil(t, err)\n\tassert.Equal(t, int64(2), artifacts.Count)\n\tassert.Len(t, artifacts.Value, 2)\n\tfor _, artifact := range artifacts.Value {\n\t\tassert.NotEmpty(t, artifact.Resource.DownloadURL)\n\t}\n}\n\nfunc TestArtifactRegexes(t *testing.T) {\n\t// Names before https://github.com/web-platform-tests/wpt/pull/15110\n\tassert.True(t, masterRegex.MatchString(\"results\"))\n\tassert.True(t, prHeadRegex.MatchString(\"affected-tests\"))\n\tassert.True(t, prBaseRegex.MatchString(\"affected-tests-without-changes\"))\n\n\t// Names after https://github.com/web-platform-tests/wpt/pull/15110\n\tassert.True(t, masterRegex.MatchString(\"edge-results\"))\n\tassert.True(t, prHeadRegex.MatchString(\"safari-preview-affected-tests\"))\n\tassert.True(t, prBaseRegex.MatchString(\"safari-preview-affected-tests-without-changes\"))\n\n\t// Don't accept the other order\n\tassert.False(t, masterRegex.MatchString(\"results-edge\"))\n\n\t// Don't accept any string ending with the right pattern\n\tassert.False(t, masterRegex.MatchString(\"nodashresults\"))\n\n\t// Base and Head could be confused with substring matching\n\tassert.False(t, prBaseRegex.MatchString(\"affected-tests\"))\n\tassert.False(t, prHeadRegex.MatchString(\"affected-tests-without-changes\"))\n}\n\nfunc TestEpochBranchesRegex(t *testing.T) {\n\tassert.True(t, epochBranchesRegex.MatchString(\"refs/heads/epochs/twelve_hourly\"))\n\tassert.True(t, epochBranchesRegex.MatchString(\"refs/heads/epochs/six_hourly\"))\n\tassert.True(t, epochBranchesRegex.MatchString(\"refs/heads/epochs/weekly\"))\n\tassert.True(t, epochBranchesRegex.MatchString(\"refs/heads/epochs/daily\"))\n\n\tassert.False(t, epochBranchesRegex.MatchString(\"refs/heads/weekly\"))\n}\n" }, { "path": "api/bsf_handler.go", "content": "// Copyright 2020 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// BSFHandler is an http.Handler for the /api/bsf endpoint.\ntype BSFHandler struct {\n\tfetcher shared.FetchBSF\n}\n\n// apiBSFHandler fetches browser-specific failure data based on the URL params.\nfunc apiBSFHandler(w http.ResponseWriter, r *http.Request) {\n\tctx := r.Context()\n\t// Serve cached with 60-minute expiry. Delegate to BSFHandler on cache miss.\n\tshared.NewCachingHandler(\n\t\tctx,\n\t\tBSFHandler{shared.NewFetchBSF()},\n\t\tshared.NewGZReadWritable(shared.NewRedisReadWritable(ctx, 60*time.Minute)),\n\t\tshared.AlwaysCachable,\n\t\tshared.URLAsCacheKey,\n\t\tshared.CacheStatusOK).ServeHTTP(w, r)\n}\n\nfunc (b BSFHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {\n\tvar err error\n\tq := r.URL.Query()\n\n\tvar from *time.Time\n\tif from, err = shared.ParseDateTimeParam(q, \"from\"); err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tvar to *time.Time\n\tif to, err = shared.ParseDateTimeParam(q, \"to\"); err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tisExperimental := false\n\tval, _ := shared.ParseBooleanParam(q, \"experimental\")\n\tif val != nil {\n\t\tisExperimental = *val\n\t}\n\n\tlines, err := b.fetcher.Fetch(isExperimental)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tbsfData := shared.FilterandExtractBSFData(lines, from, to)\n\tmarshalled, err := json.Marshal(bsfData)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\t_, err = w.Write(marshalled)\n\t// nolint:godox // TODO: Golangci-lint found that we previously ignored the error.\n\t// We should investigate if we should return a HTTP error or not. In the meantime, we log the error.\n\tif err != nil {\n\t\tlogger := shared.GetLogger(r.Context())\n\t\tlogger.Warningf(\"Failed to write data: %s\", err.Error())\n\t}\n}\n" }, { "path": "api/bsf_handler_test.go", "content": "//go:build small\n\n// Copyright 2020 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n\t\"go.uber.org/mock/gomock\"\n)\n\nfunc TestBSFHandler_Success(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tr := httptest.NewRequest(\"GET\", \"/api/bsf?\", nil)\n\tw := httptest.NewRecorder()\n\tmockBSFFetcher := sharedtest.NewMockFetchBSF(mockCtrl)\n\n\tvar rawBSFData [][]string\n\tfieldsRow := []string{\"sha\", \"date\", \"chrome-version\", \"chrome\", \"firefox-version\", \"firefox\", \"safari-version\", \"safari\"}\n\tdataRow := []string{\"1\", \"2018-08-18\", \"70.0.3521.2 dev\", \"605.3869030161061\", \"63.0a1\", \"1521.908686731921\", \"12.1\", \"2966.686195133767\"}\n\trawBSFData = append(rawBSFData, fieldsRow)\n\trawBSFData = append(rawBSFData, dataRow)\n\tmockBSFFetcher.EXPECT().Fetch(false).Return(rawBSFData, nil)\n\n\tBSFHandler{mockBSFFetcher}.ServeHTTP(w, r)\n\n\tvar bsfData shared.BSFData\n\tassert.Equal(t, http.StatusOK, w.Code)\n\tjson.Unmarshal([]byte(w.Body.String()), &bsfData)\n\tassert.Equal(t, \"1\", bsfData.LastUpdateRevision)\n\tassert.Equal(t, fieldsRow, bsfData.Fields)\n\tassert.Equal(t, 1, len(bsfData.Data))\n\tassert.Equal(t, dataRow, bsfData.Data[0])\n}\n\nfunc TestBSFHandler_Success_WithParams(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tr := httptest.NewRequest(\"GET\", \"/api/bsf?experimental=true&from=2018-04-01T00%3A00%3A00Z&to=2018-07-01T00%3A00%3A00Z\", nil)\n\tw := httptest.NewRecorder()\n\tmockBSFFetcher := sharedtest.NewMockFetchBSF(mockCtrl)\n\n\tvar rawBSFData [][]string\n\tfieldsRow := []string{\"sha\", \"date\", \"chrome-version\", \"chrome\", \"firefox-version\", \"firefox\", \"safari-version\", \"safari\"}\n\tdataRow1 := []string{\"1\", \"2018-03-18\", \"70.0.3521.2 dev\", \"605.3869030161061\", \"63.0a1\", \"1521.908686731921\", \"12.1\", \"2966.686195133767\"}\n\tdataRow2 := []string{\"2\", \"2018-05-17\", \"70.0.3521.2 dev\", \"605.3869030161061\", \"63.0a1\", \"1521.908686731921\", \"12.1\", \"2966.686195133767\"}\n\tdataRow3 := []string{\"3\", \"2018-05-19\", \"70.0.3521.2 dev\", \"605.3869030161061\", \"63.0a1\", \"1521.908686731921\", \"12.1\", \"2966.686195133767\"}\n\tdataRow4 := []string{\"4\", \"2018-11-18\", \"70.0.3521.2 dev\", \"605.3869030161061\", \"63.0a1\", \"1521.908686731921\", \"12.1\", \"2966.686195133767\"}\n\trawBSFData = append(rawBSFData, fieldsRow)\n\trawBSFData = append(rawBSFData, dataRow1)\n\trawBSFData = append(rawBSFData, dataRow2)\n\trawBSFData = append(rawBSFData, dataRow3)\n\trawBSFData = append(rawBSFData, dataRow4)\n\tmockBSFFetcher.EXPECT().Fetch(true).Return(rawBSFData, nil)\n\n\tBSFHandler{mockBSFFetcher}.ServeHTTP(w, r)\n\n\tvar bsfData shared.BSFData\n\tassert.Equal(t, http.StatusOK, w.Code)\n\tjson.Unmarshal([]byte(w.Body.String()), &bsfData)\n\tassert.Equal(t, \"3\", bsfData.LastUpdateRevision)\n\tassert.Equal(t, fieldsRow, bsfData.Fields)\n\tassert.Equal(t, 2, len(bsfData.Data))\n\tassert.Equal(t, dataRow2, bsfData.Data[0])\n\tassert.Equal(t, dataRow3, bsfData.Data[1])\n}\n" }, { "path": "api/checks/README.md", "content": "# wpt.fyi GitHub Checks integration\n\nThis directory implements the wpt.fyi (and staging.wpt.fyi) integration with\nthe GitHub Checks API for commits made to\n[WPT](https://github.com/web-platform-tests/wpt). The goal of this integration\nis to provide summary data (reporting regressions, etc) for test-suite runs\nperformed by our CI systems (Azure Pipelines and Taskcluster).\n\nThe wpt.fyi GitHub Checks code owns only computing the summary data and pushing\nit to GitHub, not ingesting the results from the CI systems. For those, see the\n[`/api/azure`](/api/azure/) and [`/api/taskcluster`](/api/taskcluster)\ndirectories.\n\n## Links\n\n* [Design doc](https://docs.google.com/document/d/1EsMmll5s5ZA4kvaCeFUKFfdjG8DMxGANX8JDPl8rKFE/edit)\n" }, { "path": "api/checks/api.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n//go:generate mockgen -build_flags=--mod=mod -destination mock_checks/api_mock.go github.com/web-platform-tests/wpt.fyi/api/checks API\n\npackage checks\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"net/url\"\n\t\"time\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/api/checks/summaries\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nconst (\n\twptfyiCheckAppID = int64(23318) // https://github.com/apps/wpt-fyi-status-check\n\twptfyiStagingCheckAppID = int64(19965) // https://github.com/apps/staging-wpt-fyi-status-check\n\n\twptRepoInstallationID = int64(577173)\n\twptRepoStagingInstallationID = int64(449270)\n\n\twptRepoID = int64(3618133)\n\tchecksForAllUsersFeature = \"checksAllUsers\"\n)\n\n// API abstracts all the API calls used externally.\ntype API interface {\n\tshared.AppEngineAPI\n\n\tScheduleResultsProcessing(sha string, browser shared.ProductSpec) error\n\tGetSuitesForSHA(sha string) ([]shared.CheckSuite, error)\n\tIgnoreFailure(sender, owner, repo string, run *github.CheckRun, installation *github.Installation) error\n\tCancelRun(sender, owner, repo string, run *github.CheckRun, installation *github.Installation) error\n\tCreateWPTCheckSuite(appID, installationID int64, sha string, prNumbers ...int) (bool, error)\n\tGetWPTRepoAppInstallationIDs() (appID, installationID int64)\n}\n\ntype checksAPIImpl struct {\n\tshared.AppEngineAPI\n\n\tqueue string\n}\n\n// NewAPI returns a real implementation of the API.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc NewAPI(ctx context.Context) API {\n\treturn checksAPIImpl{\n\t\tAppEngineAPI: shared.NewAppEngineAPI(ctx),\n\t\tqueue: CheckProcessingQueue,\n\t}\n}\n\n// ScheduleResultsProcessing adds a URL for callback to TaskQueue for the given sha and\n// product, which will actually interpret the results and summarize the outcome.\nfunc (s checksAPIImpl) ScheduleResultsProcessing(sha string, product shared.ProductSpec) error {\n\tlog := shared.GetLogger(s.Context())\n\ttarget := fmt.Sprintf(\"/api/checks/%s\", sha)\n\tq := url.Values{}\n\tq.Set(\"product\", product.String())\n\t_, err := s.ScheduleTask(s.queue, \"\", target, q)\n\tif err != nil {\n\t\tlog.Warningf(\"Failed to queue %s @ %s: %s\", product.String(), sha[:7], err.Error())\n\t} else {\n\t\tlog.Infof(\"Added %s @ %s to checks processing queue\", product.String(), sha[:7])\n\t}\n\n\treturn err\n}\n\n// GetSuitesForSHA gets all existing check suites for the given Head SHA.\nfunc (s checksAPIImpl) GetSuitesForSHA(sha string) ([]shared.CheckSuite, error) {\n\tvar suites []shared.CheckSuite\n\tstore := shared.NewAppEngineDatastore(s.Context(), false)\n\t_, err := store.GetAll(store.NewQuery(\"CheckSuite\").Filter(\"SHA =\", sha), &suites)\n\n\treturn suites, err\n}\n\n// IgnoreFailure updates the given CheckRun's outcome to success, even if it failed.\nfunc (s checksAPIImpl) IgnoreFailure(\n\tsender,\n\towner, repo string,\n\trun *github.CheckRun,\n\tinstallation *github.Installation,\n) error {\n\tclient, err := getGitHubClient(s.Context(), run.GetApp().GetID(), installation.GetID())\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// Keep the previous output, if applicable, but prefix it with an indication that\n\t// somebody ignored the failure.\n\toutput := run.GetOutput()\n\tif output == nil {\n\t\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\toutput = &github.CheckRunOutput{}\n\t}\n\tprepend := fmt.Sprintf(\"This check was marked as a success by @%s via the _Ignore_ action.\\n\\n\", sender)\n\tsummary := prepend + output.GetSummary()\n\toutput.Summary = &summary\n\n\tsuccess := \"success\"\n\t// nolint:exhaustruct // WONTFIX: Name only required.\n\topts := github.UpdateCheckRunOptions{\n\t\tName: run.GetName(),\n\t\tOutput: output,\n\t\tConclusion: &success,\n\t\tCompletedAt: &github.Timestamp{Time: time.Now()},\n\t\tActions: []*github.CheckRunAction{\n\t\t\tsummaries.RecomputeAction(),\n\t\t},\n\t}\n\t_, _, err = client.Checks.UpdateCheckRun(s.Context(), owner, repo, run.GetID(), opts)\n\n\treturn err\n}\n\n// CancelRun updates the given CheckRun's outcome to cancelled, even if it failed.\nfunc (s checksAPIImpl) CancelRun(\n\tsender,\n\towner,\n\trepo string,\n\trun *github.CheckRun,\n\tinstallation *github.Installation,\n) error {\n\tclient, err := getGitHubClient(s.Context(), run.GetApp().GetID(), installation.GetID())\n\tif err != nil {\n\t\treturn err\n\t}\n\n\t// Keep the previous output, if applicable, but prefix it with an indication that\n\t// somebody ignored the failure.\n\tsummary := fmt.Sprintf(\"This check was cancelled by @%s via the _Cancel_ action.\", sender)\n\ttitle := run.GetOutput().GetTitle()\n\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\toutput := &github.CheckRunOutput{\n\t\tTitle: &title,\n\t\tSummary: &summary,\n\t}\n\n\tcancelled := \"cancelled\"\n\t// nolint:exhaustruct // WONTFIX: Name only required.\n\topts := github.UpdateCheckRunOptions{\n\t\tName: run.GetName(),\n\t\tOutput: output,\n\t\tConclusion: &cancelled,\n\t\tCompletedAt: &github.Timestamp{Time: time.Now()},\n\t\tActions: []*github.CheckRunAction{\n\t\t\tsummaries.RecomputeAction(),\n\t\t\tsummaries.IgnoreAction(),\n\t\t},\n\t}\n\t_, _, err = client.Checks.UpdateCheckRun(s.Context(), owner, repo, run.GetID(), opts)\n\n\treturn err\n}\n\n// CreateWPTCheckSuite creates a check_suite on the main wpt repo for the given\n// SHA. This is needed when a PR comes from a different fork of the repo.\nfunc (s checksAPIImpl) CreateWPTCheckSuite(appID, installationID int64, sha string, prNumbers ...int) (bool, error) {\n\tlog := shared.GetLogger(s.Context())\n\tlog.Debugf(\"Creating check_suite for web-platform-tests/wpt @ %s\", sha)\n\n\tclient, err := getGitHubClient(s.Context(), appID, installationID)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\t// nolint:exhaustruct // WONTFIX: HeadSHA only required.\n\topts := github.CreateCheckSuiteOptions{\n\t\tHeadSHA: sha,\n\t}\n\tsuite, _, err := client.Checks.CreateCheckSuite(s.Context(), shared.WPTRepoOwner, shared.WPTRepoName, opts)\n\tif err != nil {\n\t\tlog.Errorf(\"Failed to create GitHub check suite: %s\", err.Error())\n\t} else if suite != nil {\n\t\tlog.Infof(\"check_suite %v created\", suite.GetID())\n\t\t_, err = getOrCreateCheckSuite(\n\t\t\ts.Context(),\n\t\t\tsha,\n\t\t\tshared.WPTRepoOwner,\n\t\t\tshared.WPTRepoName,\n\t\t\tappID,\n\t\t\tinstallationID,\n\t\t\tprNumbers...,\n\t\t)\n\t\tif err != nil {\n\t\t\tlog.Infof(\"Error while getting check suite: %s\", err.Error())\n\t\t}\n\t}\n\n\treturn suite != nil, err\n}\n\nfunc (s checksAPIImpl) GetWPTRepoAppInstallationIDs() (appID, installationID int64) {\n\t// Production\n\tif s.GetHostname() == \"wpt.fyi\" {\n\t\treturn wptfyiCheckAppID, wptRepoInstallationID\n\t}\n\t// Default to staging\n\treturn wptfyiStagingCheckAppID, wptRepoStagingInstallationID\n}\n" }, { "path": "api/checks/jwt.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage checks\n\nimport (\n\t\"context\"\n\t\"crypto/x509\"\n\t\"encoding/json\"\n\t\"encoding/pem\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"time\"\n\n\tjwt \"github.com/golang-jwt/jwt\"\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"golang.org/x/oauth2\"\n)\n\nfunc getGitHubClient(ctx context.Context, appID, installationID int64) (*github.Client, error) {\n\tjwtClient, err := getJWTClient(ctx, appID, installationID)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn github.NewClient(jwtClient), nil\n}\n\n// NOTE(lukebjerring): oauth2/jwt has incorrect field-names, and doesn't allow\n// passing in an http.Client (for GitHub's Authorization header flow), so we\n// are forced to copy a little code here :(.\nfunc getJWTClient(ctx context.Context, appID, installation int64) (*http.Client, error) {\n\tss, err := getSignedJWT(ctx, appID)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\ttokenSource := oauth2.StaticTokenSource(\n\t\t&oauth2.Token{AccessToken: ss}, // nolint:exhaustruct // WONTFIX: AccessToken only required.\n\t)\n\toauthClient := oauth2.NewClient(ctx, tokenSource)\n\n\ttokenURL := fmt.Sprintf(\"https://api.github.com/app/installations/%v/access_tokens\", installation)\n\treq, _ := http.NewRequestWithContext(context.Background(), http.MethodPost, tokenURL, nil)\n\treq.Header.Set(\"Accept\", \"application/vnd.github.machine-man-preview+json\")\n\tresp, err := oauthClient.Do(req)\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"cannot fetch installation token: %w\", err)\n\t}\n\n\tdefer resp.Body.Close()\n\tbody, err := io.ReadAll(io.LimitReader(resp.Body, 1<<20))\n\tif err != nil {\n\t\treturn nil, fmt.Errorf(\"cannot fetch installation token: %w\", err)\n\t}\n\tif c := resp.StatusCode; c < 200 || c > 299 {\n\t\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\t// Investigate which error code should be returned here.\n\t\treturn nil, &oauth2.RetrieveError{\n\t\t\tResponse: resp,\n\t\t\tBody: body,\n\t\t}\n\t}\n\t// tokenResponse is the JSON response body.\n\tvar tokenResponse struct {\n\t\tAccessToken string `json:\"token\"` // nolint:gosec\n\t\tExpiresAt time.Time `json:\"expires_at\"`\n\t}\n\tif err := json.Unmarshal(body, &tokenResponse); err != nil {\n\t\treturn nil, fmt.Errorf(\"oauth2: cannot fetch token: %w\", err)\n\t}\n\t// nolint:exhaustruct // WONTFIX: AccessToken only required.\n\ttoken := &oauth2.Token{\n\t\tAccessToken: tokenResponse.AccessToken,\n\t\tExpiry: tokenResponse.ExpiresAt,\n\t}\n\n\treturn oauth2.NewClient(ctx, oauth2.StaticTokenSource(token)), nil\n}\n\n// nolint:lll // Keep hyperlink\n// https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\nfunc getSignedJWT(ctx context.Context, appID int64) (string, error) {\n\tds := shared.NewAppEngineDatastore(ctx, false)\n\tsecret, err := shared.GetSecret(ds, fmt.Sprintf(\"github-app-private-key-%v\", appID))\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tblock, _ := pem.Decode([]byte(secret))\n\tif block == nil {\n\t\treturn \"\", errors.New(\"failed to decode private key\")\n\t}\n\tkey, err := x509.ParsePKCS1PrivateKey(block.Bytes)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\n\t/* Create the jwt token */\n\tnow := time.Now()\n\tclaims := &jwt.StandardClaims{\n\t\tIssuedAt: now.Unix(),\n\t\tExpiresAt: now.Add(time.Minute * 10).Unix(),\n\t\tIssuer: fmt.Sprintf(\"%v\", appID),\n\t}\n\n\tjwtToken := jwt.NewWithClaims(jwt.SigningMethodRS256, claims)\n\n\treturn jwtToken.SignedString(key)\n}\n" }, { "path": "api/checks/mock_checks/api_mock.go", "content": "// Code generated by MockGen. DO NOT EDIT.\n// Source: github.com/web-platform-tests/wpt.fyi/api/checks (interfaces: API)\n//\n// Generated by this command:\n//\n//\tmockgen -build_flags=--mod=mod -destination mock_checks/api_mock.go github.com/web-platform-tests/wpt.fyi/api/checks API\n//\n\n// Package mock_checks is a generated GoMock package.\npackage mock_checks\n\nimport (\n\tcontext \"context\"\n\thttp \"net/http\"\n\turl \"net/url\"\n\treflect \"reflect\"\n\ttime \"time\"\n\n\tgithub \"github.com/google/go-github/v84/github\"\n\tshared \"github.com/web-platform-tests/wpt.fyi/shared\"\n\tgomock \"go.uber.org/mock/gomock\"\n)\n\n// MockAPI is a mock of API interface.\ntype MockAPI struct {\n\tctrl *gomock.Controller\n\trecorder *MockAPIMockRecorder\n\tisgomock struct{}\n}\n\n// MockAPIMockRecorder is the mock recorder for MockAPI.\ntype MockAPIMockRecorder struct {\n\tmock *MockAPI\n}\n\n// NewMockAPI creates a new mock instance.\nfunc NewMockAPI(ctrl *gomock.Controller) *MockAPI {\n\tmock := &MockAPI{ctrl: ctrl}\n\tmock.recorder = &MockAPIMockRecorder{mock}\n\treturn mock\n}\n\n// EXPECT returns an object that allows the caller to indicate expected use.\nfunc (m *MockAPI) EXPECT() *MockAPIMockRecorder {\n\treturn m.recorder\n}\n\n// CancelRun mocks base method.\nfunc (m *MockAPI) CancelRun(sender, owner, repo string, run *github.CheckRun, installation *github.Installation) error {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"CancelRun\", sender, owner, repo, run, installation)\n\tret0, _ := ret[0].(error)\n\treturn ret0\n}\n\n// CancelRun indicates an expected call of CancelRun.\nfunc (mr *MockAPIMockRecorder) CancelRun(sender, owner, repo, run, installation any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"CancelRun\", reflect.TypeOf((*MockAPI)(nil).CancelRun), sender, owner, repo, run, installation)\n}\n\n// Context mocks base method.\nfunc (m *MockAPI) Context() context.Context {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"Context\")\n\tret0, _ := ret[0].(context.Context)\n\treturn ret0\n}\n\n// Context indicates an expected call of Context.\nfunc (mr *MockAPIMockRecorder) Context() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"Context\", reflect.TypeOf((*MockAPI)(nil).Context))\n}\n\n// CreateWPTCheckSuite mocks base method.\nfunc (m *MockAPI) CreateWPTCheckSuite(appID, installationID int64, sha string, prNumbers ...int) (bool, error) {\n\tm.ctrl.T.Helper()\n\tvarargs := []any{appID, installationID, sha}\n\tfor _, a := range prNumbers {\n\t\tvarargs = append(varargs, a)\n\t}\n\tret := m.ctrl.Call(m, \"CreateWPTCheckSuite\", varargs...)\n\tret0, _ := ret[0].(bool)\n\tret1, _ := ret[1].(error)\n\treturn ret0, ret1\n}\n\n// CreateWPTCheckSuite indicates an expected call of CreateWPTCheckSuite.\nfunc (mr *MockAPIMockRecorder) CreateWPTCheckSuite(appID, installationID, sha any, prNumbers ...any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\tvarargs := append([]any{appID, installationID, sha}, prNumbers...)\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"CreateWPTCheckSuite\", reflect.TypeOf((*MockAPI)(nil).CreateWPTCheckSuite), varargs...)\n}\n\n// GetGitHubClient mocks base method.\nfunc (m *MockAPI) GetGitHubClient() (*github.Client, error) {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetGitHubClient\")\n\tret0, _ := ret[0].(*github.Client)\n\tret1, _ := ret[1].(error)\n\treturn ret0, ret1\n}\n\n// GetGitHubClient indicates an expected call of GetGitHubClient.\nfunc (mr *MockAPIMockRecorder) GetGitHubClient() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetGitHubClient\", reflect.TypeOf((*MockAPI)(nil).GetGitHubClient))\n}\n\n// GetHTTPClient mocks base method.\nfunc (m *MockAPI) GetHTTPClient() *http.Client {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetHTTPClient\")\n\tret0, _ := ret[0].(*http.Client)\n\treturn ret0\n}\n\n// GetHTTPClient indicates an expected call of GetHTTPClient.\nfunc (mr *MockAPIMockRecorder) GetHTTPClient() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetHTTPClient\", reflect.TypeOf((*MockAPI)(nil).GetHTTPClient))\n}\n\n// GetHTTPClientWithTimeout mocks base method.\nfunc (m *MockAPI) GetHTTPClientWithTimeout(arg0 time.Duration) *http.Client {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetHTTPClientWithTimeout\", arg0)\n\tret0, _ := ret[0].(*http.Client)\n\treturn ret0\n}\n\n// GetHTTPClientWithTimeout indicates an expected call of GetHTTPClientWithTimeout.\nfunc (mr *MockAPIMockRecorder) GetHTTPClientWithTimeout(arg0 any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetHTTPClientWithTimeout\", reflect.TypeOf((*MockAPI)(nil).GetHTTPClientWithTimeout), arg0)\n}\n\n// GetHostname mocks base method.\nfunc (m *MockAPI) GetHostname() string {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetHostname\")\n\tret0, _ := ret[0].(string)\n\treturn ret0\n}\n\n// GetHostname indicates an expected call of GetHostname.\nfunc (mr *MockAPIMockRecorder) GetHostname() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetHostname\", reflect.TypeOf((*MockAPI)(nil).GetHostname))\n}\n\n// GetResultsURL mocks base method.\nfunc (m *MockAPI) GetResultsURL(filter shared.TestRunFilter) *url.URL {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetResultsURL\", filter)\n\tret0, _ := ret[0].(*url.URL)\n\treturn ret0\n}\n\n// GetResultsURL indicates an expected call of GetResultsURL.\nfunc (mr *MockAPIMockRecorder) GetResultsURL(filter any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetResultsURL\", reflect.TypeOf((*MockAPI)(nil).GetResultsURL), filter)\n}\n\n// GetResultsUploadURL mocks base method.\nfunc (m *MockAPI) GetResultsUploadURL() *url.URL {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetResultsUploadURL\")\n\tret0, _ := ret[0].(*url.URL)\n\treturn ret0\n}\n\n// GetResultsUploadURL indicates an expected call of GetResultsUploadURL.\nfunc (mr *MockAPIMockRecorder) GetResultsUploadURL() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetResultsUploadURL\", reflect.TypeOf((*MockAPI)(nil).GetResultsUploadURL))\n}\n\n// GetRunsURL mocks base method.\nfunc (m *MockAPI) GetRunsURL(filter shared.TestRunFilter) *url.URL {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetRunsURL\", filter)\n\tret0, _ := ret[0].(*url.URL)\n\treturn ret0\n}\n\n// GetRunsURL indicates an expected call of GetRunsURL.\nfunc (mr *MockAPIMockRecorder) GetRunsURL(filter any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetRunsURL\", reflect.TypeOf((*MockAPI)(nil).GetRunsURL), filter)\n}\n\n// GetServiceHostname mocks base method.\nfunc (m *MockAPI) GetServiceHostname(service string) string {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetServiceHostname\", service)\n\tret0, _ := ret[0].(string)\n\treturn ret0\n}\n\n// GetServiceHostname indicates an expected call of GetServiceHostname.\nfunc (mr *MockAPIMockRecorder) GetServiceHostname(service any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetServiceHostname\", reflect.TypeOf((*MockAPI)(nil).GetServiceHostname), service)\n}\n\n// GetSuitesForSHA mocks base method.\nfunc (m *MockAPI) GetSuitesForSHA(sha string) ([]shared.CheckSuite, error) {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetSuitesForSHA\", sha)\n\tret0, _ := ret[0].([]shared.CheckSuite)\n\tret1, _ := ret[1].(error)\n\treturn ret0, ret1\n}\n\n// GetSuitesForSHA indicates an expected call of GetSuitesForSHA.\nfunc (mr *MockAPIMockRecorder) GetSuitesForSHA(sha any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetSuitesForSHA\", reflect.TypeOf((*MockAPI)(nil).GetSuitesForSHA), sha)\n}\n\n// GetUploader mocks base method.\nfunc (m *MockAPI) GetUploader(uploader string) (shared.Uploader, error) {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetUploader\", uploader)\n\tret0, _ := ret[0].(shared.Uploader)\n\tret1, _ := ret[1].(error)\n\treturn ret0, ret1\n}\n\n// GetUploader indicates an expected call of GetUploader.\nfunc (mr *MockAPIMockRecorder) GetUploader(uploader any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetUploader\", reflect.TypeOf((*MockAPI)(nil).GetUploader), uploader)\n}\n\n// GetVersion mocks base method.\nfunc (m *MockAPI) GetVersion() string {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetVersion\")\n\tret0, _ := ret[0].(string)\n\treturn ret0\n}\n\n// GetVersion indicates an expected call of GetVersion.\nfunc (mr *MockAPIMockRecorder) GetVersion() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetVersion\", reflect.TypeOf((*MockAPI)(nil).GetVersion))\n}\n\n// GetVersionedHostname mocks base method.\nfunc (m *MockAPI) GetVersionedHostname() string {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetVersionedHostname\")\n\tret0, _ := ret[0].(string)\n\treturn ret0\n}\n\n// GetVersionedHostname indicates an expected call of GetVersionedHostname.\nfunc (mr *MockAPIMockRecorder) GetVersionedHostname() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetVersionedHostname\", reflect.TypeOf((*MockAPI)(nil).GetVersionedHostname))\n}\n\n// GetWPTRepoAppInstallationIDs mocks base method.\nfunc (m *MockAPI) GetWPTRepoAppInstallationIDs() (int64, int64) {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetWPTRepoAppInstallationIDs\")\n\tret0, _ := ret[0].(int64)\n\tret1, _ := ret[1].(int64)\n\treturn ret0, ret1\n}\n\n// GetWPTRepoAppInstallationIDs indicates an expected call of GetWPTRepoAppInstallationIDs.\nfunc (mr *MockAPIMockRecorder) GetWPTRepoAppInstallationIDs() *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetWPTRepoAppInstallationIDs\", reflect.TypeOf((*MockAPI)(nil).GetWPTRepoAppInstallationIDs))\n}\n\n// IgnoreFailure mocks base method.\nfunc (m *MockAPI) IgnoreFailure(sender, owner, repo string, run *github.CheckRun, installation *github.Installation) error {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"IgnoreFailure\", sender, owner, repo, run, installation)\n\tret0, _ := ret[0].(error)\n\treturn ret0\n}\n\n// IgnoreFailure indicates an expected call of IgnoreFailure.\nfunc (mr *MockAPIMockRecorder) IgnoreFailure(sender, owner, repo, run, installation any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"IgnoreFailure\", reflect.TypeOf((*MockAPI)(nil).IgnoreFailure), sender, owner, repo, run, installation)\n}\n\n// IsFeatureEnabled mocks base method.\nfunc (m *MockAPI) IsFeatureEnabled(featureName string) bool {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"IsFeatureEnabled\", featureName)\n\tret0, _ := ret[0].(bool)\n\treturn ret0\n}\n\n// IsFeatureEnabled indicates an expected call of IsFeatureEnabled.\nfunc (mr *MockAPIMockRecorder) IsFeatureEnabled(featureName any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"IsFeatureEnabled\", reflect.TypeOf((*MockAPI)(nil).IsFeatureEnabled), featureName)\n}\n\n// ScheduleResultsProcessing mocks base method.\nfunc (m *MockAPI) ScheduleResultsProcessing(sha string, browser shared.ProductSpec) error {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"ScheduleResultsProcessing\", sha, browser)\n\tret0, _ := ret[0].(error)\n\treturn ret0\n}\n\n// ScheduleResultsProcessing indicates an expected call of ScheduleResultsProcessing.\nfunc (mr *MockAPIMockRecorder) ScheduleResultsProcessing(sha, browser any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"ScheduleResultsProcessing\", reflect.TypeOf((*MockAPI)(nil).ScheduleResultsProcessing), sha, browser)\n}\n\n// ScheduleTask mocks base method.\nfunc (m *MockAPI) ScheduleTask(queueName, taskName, target string, params url.Values) (string, error) {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"ScheduleTask\", queueName, taskName, target, params)\n\tret0, _ := ret[0].(string)\n\tret1, _ := ret[1].(error)\n\treturn ret0, ret1\n}\n\n// ScheduleTask indicates an expected call of ScheduleTask.\nfunc (mr *MockAPIMockRecorder) ScheduleTask(queueName, taskName, target, params any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"ScheduleTask\", reflect.TypeOf((*MockAPI)(nil).ScheduleTask), queueName, taskName, target, params)\n}\n" }, { "path": "api/checks/routes.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage checks\n\nimport \"github.com/web-platform-tests/wpt.fyi/shared\"\n\n// RegisterRoutes adds route handlers for webhooks.\nfunc RegisterRoutes() {\n\t// GitHub webhook for creating custom status checks.\n\tshared.AddRoute(\"/api/webhook/check\", \"api-webhook-check\", checkWebhookHandler)\n\n\t// Endpoint for computing outcome and updating any checks for the given commit.\n\t// When scheduling updates, we call this endpoint from the check-processing TaskQueue.\n\tshared.AddRoute(\"/api/checks/{commit}\", \"checks-updater\", updateCheckHandler)\n}\n" }, { "path": "api/checks/runs.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage checks\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/api/checks/summaries\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nfunc updateCheckRunSummary(ctx context.Context, summary summaries.Summary, suite shared.CheckSuite) (bool, error) {\n\tlog := shared.GetLogger(ctx)\n\tproduct := summary.GetCheckState().Product\n\ttestRun := summary.GetCheckState().TestRun\n\n\t// Attempt to update any existing check runs for this SHA.\n\tcheckRuns, err := getExistingCheckRuns(ctx, suite)\n\tif err != nil {\n\t\tlog.Warningf(\"Failed to load existing check runs for %s: %s\", suite.SHA[:7], err.Error())\n\t}\n\n\t// Update, not create, if a run name matches this completed TestRun.\n\tvar existing *github.CheckRun\n\tif testRun != nil {\n\t\tfor _, run := range checkRuns {\n\t\t\tif run.GetApp().GetID() != suite.AppID {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tif spec, _ := shared.ParseProductSpec(run.GetName()); spec.Matches(*testRun) {\n\t\t\t\tlog.Debugf(\"Found existing run %v for %s @ %s\", run.GetID(), run.GetName(), suite.SHA[:7])\n\t\t\t\texisting = run\n\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\n\tvar created bool\n\t// nolint:nestif // TODO: Fix nestif lint error\n\tif existing != nil {\n\t\tcreated, err = updateExistingCheckRunSummary(ctx, summary, suite, existing)\n\t\tif err != nil {\n\t\t\tlog.Warningf(\"Failed to update existing check run summary for %s: %s\", *existing.HeadSHA, err.Error())\n\t\t}\n\t} else {\n\t\tstate := summary.GetCheckState()\n\t\tactions := summary.GetActions()\n\n\t\tvar summaryStr string\n\t\tsummaryStr, err = summary.GetSummary()\n\t\tif err != nil {\n\t\t\tlog.Warningf(\"Failed to generate summary for %s: %s\", state.HeadSHA, err.Error())\n\n\t\t\treturn false, err\n\t\t}\n\n\t\tdetailsURLStr := state.DetailsURL.String()\n\t\ttitle := state.Title()\n\t\t// nolint:exhaustruct // WONTFIX: Name, HeadSHA only required.\n\t\topts := github.CreateCheckRunOptions{\n\t\t\tName: state.Name(),\n\t\t\tHeadSHA: state.HeadSHA,\n\t\t\tDetailsURL: &detailsURLStr,\n\t\t\tStatus: &state.Status,\n\t\t\tConclusion: state.Conclusion,\n\t\t\tOutput: &github.CheckRunOutput{\n\t\t\t\tTitle: &title,\n\t\t\t\tSummary: &summaryStr,\n\t\t\t},\n\t\t\tActions: actions,\n\t\t}\n\t\tif state.Conclusion != nil {\n\t\t\topts.CompletedAt = &github.Timestamp{Time: time.Now()}\n\t\t}\n\t\tcreated, err = createCheckRun(ctx, suite, opts)\n\t\tif err != nil {\n\t\t\tlog.Warningf(\"Failed to create check run summary for %s: %s\", suite.SHA, err.Error())\n\t\t}\n\t}\n\tif created {\n\t\tlog.Debugf(\"Check for %s/%s @ %s (%s) updated\", suite.Owner, suite.Repo, suite.SHA[:7], product.String())\n\t}\n\n\treturn created, nil\n}\n\nfunc getExistingCheckRuns(ctx context.Context, suite shared.CheckSuite) ([]*github.CheckRun, error) {\n\tlog := shared.GetLogger(ctx)\n\tclient, err := getGitHubClient(ctx, suite.AppID, suite.InstallationID)\n\tif err != nil {\n\t\tlog.Errorf(\"Failed to fetch runs for suite: %s\", err.Error())\n\n\t\treturn nil, err\n\t}\n\n\tvar runs []*github.CheckRun\n\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\toptions := github.ListCheckRunsOptions{\n\t\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\tListOptions: github.ListOptions{\n\t\t\t// 100 is the maximum allowed items per page; see\n\t\t\t// https://developer.github.com/v3/guides/traversing-with-pagination/#changing-the-number-of-items-received\n\t\t\tPerPage: 100,\n\t\t},\n\t}\n\n\t// As a safety-check, we will not do more than 10 iterations (at 100\n\t// check runs per page, this gives us a 1000 run upper limit).\n\tfor i := 0; i < 10; i++ {\n\t\tresult, response, err := client.Checks.ListCheckRunsForRef(ctx, suite.Owner, suite.Repo, suite.SHA, &options)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\truns = append(runs, result.CheckRuns...)\n\n\t\t// GitHub APIs indicate being on the last page by not returning any\n\t\t// value for NextPage, which go-github translates into zero.\n\t\t// See https://gowalker.org/github.com/google/go-github/github#Response\n\t\tif response.NextPage == 0 {\n\t\t\treturn runs, nil\n\t\t}\n\n\t\t// Setup for the next call.\n\t\toptions.Page = response.NextPage\n\t}\n\n\treturn nil, fmt.Errorf(\"more than 10 pages of CheckRuns returned for ref %s\", suite.SHA)\n}\n\nfunc updateExistingCheckRunSummary(\n\tctx context.Context,\n\tsummary summaries.Summary,\n\tsuite shared.CheckSuite,\n\trun *github.CheckRun,\n) (bool, error) {\n\tlog := shared.GetLogger(ctx)\n\n\tstate := summary.GetCheckState()\n\tactions := summary.GetActions()\n\n\tsummaryStr, err := summary.GetSummary()\n\tif err != nil {\n\t\tlog.Warningf(\"Failed to generate summary for %s: %s\", state.HeadSHA, err.Error())\n\n\t\treturn false, err\n\t}\n\n\tdetailsURLStr := state.DetailsURL.String()\n\ttitle := state.Title()\n\t// nolint:exhaustruct // WONTFIX: Name, HeadSHA only required.\n\topts := github.UpdateCheckRunOptions{\n\t\tName: state.Name(),\n\t\tDetailsURL: &detailsURLStr,\n\t\tStatus: &state.Status,\n\t\tConclusion: state.Conclusion,\n\t\tOutput: &github.CheckRunOutput{\n\t\t\tTitle: &title,\n\t\t\tSummary: &summaryStr,\n\t\t},\n\t\tActions: actions,\n\t}\n\tif state.Conclusion != nil {\n\t\topts.CompletedAt = &github.Timestamp{Time: time.Now()}\n\t}\n\n\tclient, err := getGitHubClient(ctx, suite.AppID, suite.InstallationID)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\t_, _, err = client.Checks.UpdateCheckRun(ctx, suite.Owner, suite.Repo, run.GetID(), opts)\n\tif err != nil {\n\t\tlog.Errorf(\"Failed to update run %v: %s\", run.GetID(), err.Error())\n\n\t\treturn false, err\n\t}\n\n\treturn true, err\n}\n" }, { "path": "api/checks/suites.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage checks\n\nimport (\n\t\"context\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nfunc getOrCreateCheckSuite(\n\tctx context.Context,\n\tsha,\n\towner,\n\trepo string,\n\tappID,\n\tinstallationID int64,\n\tprNumbers ...int,\n) (*shared.CheckSuite, error) {\n\tds := shared.NewAppEngineDatastore(ctx, false)\n\tquery := ds.NewQuery(\"CheckSuite\").\n\t\tFilter(\"SHA =\", sha).\n\t\tFilter(\"AppID =\", appID).\n\t\tFilter(\"InstallationID =\", installationID).\n\t\tFilter(\"Owner =\", owner).\n\t\tFilter(\"Repo =\", repo).\n\t\tKeysOnly()\n\tvar suite shared.CheckSuite\n\tif keys, err := ds.GetAll(query, nil); err != nil {\n\t\treturn nil, err\n\t} else if len(keys) > 0 {\n\t\terr := ds.Get(keys[0], &suite)\n\n\t\treturn &suite, err\n\t}\n\n\tlog := shared.GetLogger(ctx)\n\tsuite.SHA = sha\n\tsuite.Owner = owner\n\tsuite.Repo = repo\n\tsuite.AppID = appID\n\tsuite.InstallationID = installationID\n\tsuite.PRNumbers = prNumbers\n\t_, err := ds.Put(ds.NewIDKey(\"CheckSuite\", 0), &suite)\n\tif err != nil {\n\t\tlog.Debugf(\"Created CheckSuite entity for %s/%s @ %s\", owner, repo, sha)\n\t}\n\n\treturn &suite, err\n}\n" }, { "path": "api/checks/suites_medium_test.go", "content": "//go:build medium\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\npackage checks\n\nimport (\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n)\n\nfunc TestGetOrCreateCheckSuite(t *testing.T) {\n\tctx, done, err := sharedtest.NewAEContext(true)\n\tassert.Nil(t, err)\n\tdefer done()\n\n\tsha := strings.Repeat(\"abcdef012345\", 4)\n\tsuite, err := getOrCreateCheckSuite(ctx, sha, \"owner\", \"repo\", 123, 456)\n\tassert.Nil(t, err)\n\tassert.NotNil(t, suite)\n\n\tsuite2, err := getOrCreateCheckSuite(ctx, sha, \"owner\", \"repo\", 123, 456)\n\tassert.Nil(t, err)\n\tassert.NotNil(t, suite2)\n\tassert.Equal(t, *suite, *suite2)\n\tsuites := []shared.CheckSuite{}\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tstore.GetAll(store.NewQuery(\"CheckSuite\"), &suites)\n\tassert.Len(t, suites, 1)\n}\n" }, { "path": "api/checks/summaries/actions.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage summaries\n\nimport \"github.com/google/go-github/v84/github\"\n\n// RecomputeAction is an action that can be taken to\n// trigger a recompute of the diff, against the latest\n// master run's results.\nfunc RecomputeAction() *github.CheckRunAction {\n\treturn &github.CheckRunAction{\n\t\tIdentifier: \"recompute\",\n\t\tLabel: \"Recompute\",\n\t\tDescription: \"Recompute with the latest available runs\",\n\t}\n}\n\n// IgnoreAction is an action that can be taken to ignore a fail\n// outcome, marking it as passing.\nfunc IgnoreAction() *github.CheckRunAction {\n\treturn &github.CheckRunAction{\n\t\tIdentifier: \"ignore\",\n\t\tLabel: \"Ignore\",\n\t\tDescription: \"Mark results as expected (passing)\",\n\t}\n}\n\n// CancelAction is an action that can be taken to cancel a pending check run.\nfunc CancelAction() *github.CheckRunAction {\n\treturn &github.CheckRunAction{\n\t\tIdentifier: \"cancel\",\n\t\tLabel: \"Cancel\",\n\t\tDescription: \"Cancel this pending check run\",\n\t}\n}\n" }, { "path": "api/checks/summaries/actions_test.go", "content": "//go:build small\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage summaries\n\nimport (\n\t\"testing\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\n// https://developer.github.com/v3/checks/runs/#actions-object\nfunc TestActionCharacterLimits(t *testing.T) {\n\tactions := []*github.CheckRunAction{\n\t\tRecomputeAction(),\n\t\tIgnoreAction(),\n\t\tCancelAction(),\n\t}\n\tfor _, action := range actions {\n\t\tassert.True(t, len(action.Identifier) <= 20, \"Action %s's ID is too long\", action.Identifier)\n\t\tassert.True(t, len(action.Description) <= 40, \"Action %s's desc is too long\", action.Identifier)\n\t\tassert.True(t, len(action.Label) <= 20, \"Action %s's label is too long\", action.Identifier)\n\t}\n}\n" }, { "path": "api/checks/summaries/compile.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage summaries\n\nimport (\n\t\"bytes\"\n\t\"embed\"\n\t\"fmt\"\n\t\"net/url\"\n\t\"strings\"\n\t\"text/template\"\n\n\tmapset \"github.com/deckarep/golang-set\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// nolint:gochecknoglobals // TODO: Fix gochecknoglobals lint error\nvar templates *template.Template\n\n//go:embed templates/*.md\nvar mdFiles embed.FS\n\nfunc init() {\n\ttemplates = template.New(\"all.md\").\n\t\tFuncs(template.FuncMap{\n\t\t\t\"escapeMD\": escapeMD,\n\t\t})\n\t_, err := templates.ParseFS(mdFiles, \"templates/*.md\")\n\tif err != nil {\n\t\tpanic(err)\n\t}\n}\n\n// escapeMD returns the escaped MD equivalent of the plain text data s.\nfunc escapeMD(s string) string {\n\treturn strings.ReplaceAll(s, \"|\", `\\|`)\n}\n\n// Summary is the generic interface of a summary template data type.\ntype Summary interface {\n\t// GetCheckState returns the info needed to update a check.\n\tGetCheckState() CheckState\n\n\t// GetActions returns the actions that can be taken by the user.\n\tGetActions() []*github.CheckRunAction\n\n\t// GetSummary compiles the summary markdown template.\n\tGetSummary() (string, error)\n}\n\n// CheckState represents all the status fields for updating a check.\ntype CheckState struct {\n\tHostName string // The host (e.g. wpt.fyi)\n\tTestRun *shared.TestRun // The (completed) TestRun, if applicable.\n\tProduct shared.ProductSpec\n\tHeadSHA string\n\tDetailsURL *url.URL\n\t// The current status. Can be one of \"queued\", \"in_progress\", or \"completed\". Default: \"queued\". (Optional.)\n\tStatus string\n\t// Can be one of \"success\", \"failure\", \"neutral\", \"cancelled\", \"timed_out\", or \"action_required\".\n\t// (Optional. Required if you provide a status of \"completed\".)\n\tConclusion *string\n\tActions []github.CheckRunAction\n\tPRNumbers []int\n}\n\n// Name returns the check run's name, based on the product.\nfunc (c CheckState) Name() string {\n\thost := c.HostName\n\tif host == \"\" {\n\t\thost = \"wpt.fyi\"\n\t}\n\tspec := shared.ProductSpec{} // nolint:exhaustruct // TODO: Fix exhaustruct lint error\n\tspec.BrowserName = c.Product.BrowserName\n\tif c.Product.IsExperimental() {\n\t\tspec.Labels = mapset.NewSetWith(shared.ExperimentalLabel)\n\t}\n\n\treturn fmt.Sprintf(\"%s - %s\", host, spec.String())\n}\n\n// Title returns the check run's title, based on the product.\nfunc (c CheckState) Title() string {\n\treturn fmt.Sprintf(\"%s results\", c.Product.DisplayName())\n}\n\n// GetCheckState returns the info in the CheckState struct.\n// It's a dumb placeholder since we can't define fields on interfaces.\nfunc (c CheckState) GetCheckState() CheckState {\n\treturn c\n}\n\n// FileIssueURL returns a URL for filing an issue in wpt.fyi repo about checks.\nfunc (c CheckState) FileIssueURL() *url.URL {\n\tresult, _ := url.Parse(\"https://github.com/web-platform-tests/wpt.fyi/issues/new\")\n\tq := result.Query()\n\tq.Set(\"title\", \"Regression checks issue\")\n\tq.Set(\"projects\", \"web-platform-tests/wpt.fyi/6\")\n\tq.Set(\"template\", \"checks.md\")\n\tq.Set(\"labels\", \"bug\")\n\tresult.RawQuery = q.Encode()\n\n\treturn result\n}\n\nfunc compile(i interface{}, t string) (string, error) {\n\tvar dest bytes.Buffer\n\tif err := templates.ExecuteTemplate(&dest, t, i); err != nil {\n\t\treturn \"\", err\n\t}\n\n\treturn dest.String(), nil\n}\n" }, { "path": "api/checks/summaries/compile_test.go", "content": "//go:build medium\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage summaries\n\nimport (\n\t\"flag\"\n\t\"log\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// To output the rendered content during execution of the test(s), set this flag, e.g.\n// go test ./api/checks/summaries -tags=\"medium\" -print_output -test.v\nvar renderOutputToConsole = flag.Bool(\"print_output\", false, \"Whether to render compiled markdown during test execution.\")\n\nfunc TestGetSummary_Completed(t *testing.T) {\n\tmaster := shared.TestRun{}\n\tmaster.BrowserName = \"chrome\"\n\tmaster.Revision = \"abcdef0123\"\n\tmaster.FullRevisionHash = strings.Repeat(master.Revision, 4)\n\tpr := shared.TestRun{}\n\tpr.BrowserName = \"chrome\"\n\tpr.Revision = \"0123456789\"\n\tpr.FullRevisionHash = strings.Repeat(pr.Revision, 4)\n\tfoo := Completed{}\n\tfoo.BaseRun = master\n\tfoo.HeadRun = pr\n\tfoo.DiffURL = \"https://foo.com/diff?before=chrome[master]&after=chrome@0123456789\"\n\tfoo.HostName = \"foo.com\"\n\tfoo.HostURL = \"https://foo.com/\"\n\ttestName := \"/foo.html?exclude=(Document|window|HTML.*)\"\n\tfoo.Results = BeforeAndAfter{\n\t\ttestName: TestBeforeAndAfter{\n\t\t\tPassingBefore: 2,\n\t\t\tTotalBefore: 3,\n\t\t\tPassingAfter: 2,\n\t\t\tTotalAfter: 2,\n\t\t},\n\t}\n\tfoo.More = 1\n\n\ts, err := foo.GetSummary()\n\tprintOutput(s)\n\tif err != nil {\n\t\tassert.FailNow(t, err.Error())\n\t}\n\tassert.Contains(t, s, foo.HostName)\n\tassert.Contains(t, s, foo.HostURL)\n\tassert.Contains(t, s, foo.DiffURL)\n\tassert.Contains(t, s, \"2 / 3\")\n\tassert.Contains(t, s, \"And 1 others...\")\n\tassert.Contains(t, s, foo.FileIssueURL().String())\n\n\t// And with MasterDiffURL\n\tfoo.MasterDiffURL = \"https://foo.com/?products=chrome[master],chrome@0123456789&diff\"\n\ts, err = foo.GetSummary()\n\tprintOutput(s)\n\tif err != nil {\n\t\tassert.FailNow(t, err.Error())\n\t}\n\tassert.Contains(t, s, foo.MasterDiffURL)\n\n\t// With PRNumbers\n\tfoo.PRNumbers = []int{123}\n\ts, err = foo.GetSummary()\n\tprintOutput(s)\n\tif err != nil {\n\t\tassert.FailNow(t, err.Error())\n\t}\n\tassert.Contains(t, s, escapeMD(testName))\n\tassert.Contains(t, s, \"https://foo.com/runs/?pr=123\")\n\tassert.Contains(t, s, \"https://foo.com/results/?pr=123\")\n}\n\nfunc TestGetSummary_Pending(t *testing.T) {\n\tfoo := Pending{\n\t\tRunsURL: \"https://foo.com/runs?products=chrome&sha=0123456789\",\n\t}\n\tfoo.HostName = \"https://foo.com\"\n\ts, err := foo.GetSummary()\n\tprintOutput(s)\n\tif err != nil {\n\t\tassert.FailNow(t, err.Error())\n\t}\n\tassert.Contains(t, s, foo.HostName)\n\tassert.Contains(t, s, foo.RunsURL)\n\tassert.Contains(t, s, foo.FileIssueURL().String())\n}\n\nfunc TestGetSummary_Regressed(t *testing.T) {\n\tmaster := shared.TestRun{}\n\tmaster.BrowserName = \"chrome\"\n\tmaster.Revision = \"abcdef0123\"\n\tmaster.FullRevisionHash = strings.Repeat(master.Revision, 4)\n\tpr := shared.TestRun{}\n\tpr.BrowserName = \"chrome\"\n\tpr.Revision = \"0123456789\"\n\tpr.FullRevisionHash = strings.Repeat(pr.Revision, 4)\n\tfoo := Regressed{}\n\tfoo.BaseRun = master\n\tfoo.HeadRun = pr\n\tfoo.HostName = \"foo.com\"\n\tfoo.HostURL = \"https://foo.com/\"\n\tfoo.DiffURL = \"https://foo.com/?products=chrome@0000000000,chrome@0123456789&diff\"\n\ttestName := \"/foo.html?exclude=(Document|window|HTML.*)\"\n\tfoo.Regressions = BeforeAndAfter{\n\t\ttestName: TestBeforeAndAfter{\n\t\t\tPassingBefore: 1,\n\t\t\tTotalBefore: 1,\n\t\t\tPassingAfter: 0,\n\t\t\tTotalAfter: 1,\n\t\t},\n\t}\n\tfoo.More = 1\n\n\ts, err := foo.GetSummary()\n\tprintOutput(s)\n\tif err != nil {\n\t\tassert.FailNow(t, err.Error())\n\t}\n\tassert.Contains(t, s, foo.HostName)\n\tassert.Contains(t, s, foo.HostURL)\n\tassert.Contains(t, s, foo.DiffURL)\n\tassert.Contains(t, s, master.String())\n\tassert.Contains(t, s, pr.String())\n\tassert.Contains(t, s, \"0 / 1\")\n\tassert.Contains(t, s, \"1 / 1\")\n\tassert.Contains(t, s, \"And 1 others...\")\n\tassert.Contains(t, s, foo.FileIssueURL().String())\n\n\t// And with MasterDiffURL\n\tfoo.MasterDiffURL = \"https://foo.com/?products=chrome[master],chrome@0123456789&diff\"\n\ts, err = foo.GetSummary()\n\tprintOutput(s)\n\tif err != nil {\n\t\tassert.FailNow(t, err.Error())\n\t}\n\tassert.Contains(t, s, foo.MasterDiffURL)\n\n\t// With PRNumbers\n\tfoo.PRNumbers = []int{123}\n\ts, err = foo.GetSummary()\n\tprintOutput(s)\n\tif err != nil {\n\t\tassert.FailNow(t, err.Error())\n\t}\n\tassert.Contains(t, s, \"https://foo.com/runs/?pr=123\")\n\tassert.Contains(t, s, \"https://foo.com/results/?pr=123\")\n}\n\nfunc printOutput(s string) {\n\tif *renderOutputToConsole {\n\t\tlog.Printf(\"MD output:\\n-----------\\n%s\", s)\n\t}\n}\n" }, { "path": "api/checks/summaries/completed.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage summaries\n\nimport (\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// ResultsComparison is all the fields shared across summaries that\n// involve a result comparison.\ntype ResultsComparison struct {\n\tBaseRun shared.TestRun\n\tHeadRun shared.TestRun\n\tMasterDiffURL string\n\tDiffURL string // URL for the diff-view of the results\n\tHostURL string // Host environment URL, e.g. \"https://wpt.fyi\"\n}\n\n// Completed is the struct for completed.md.\ntype Completed struct {\n\tCheckState\n\tResultsComparison\n\n\tResults BeforeAndAfter\n\tMore int\n}\n\n// GetCheckState returns the info needed to update a check.\nfunc (c Completed) GetCheckState() CheckState {\n\treturn c.CheckState\n}\n\n// GetSummary executes the template for the data.\nfunc (c Completed) GetSummary() (string, error) {\n\treturn compile(&c, \"completed.md\")\n}\n\n// GetActions returns the actions that can be taken by the user.\nfunc (c Completed) GetActions() []*github.CheckRunAction {\n\treturn []*github.CheckRunAction{\n\t\tRecomputeAction(),\n\t}\n}\n" }, { "path": "api/checks/summaries/pending.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage summaries\n\nimport \"github.com/google/go-github/v84/github\"\n\n// Pending is the struct for pending.md.\ntype Pending struct {\n\tCheckState\n\n\tRunsURL string // URL for the list of test runs\n}\n\n// GetCheckState returns the info needed to update a check.\nfunc (p Pending) GetCheckState() CheckState {\n\treturn p.CheckState\n}\n\n// GetSummary executes the template for the data.\nfunc (p Pending) GetSummary() (string, error) {\n\treturn compile(&p, \"pending.md\")\n}\n\n// GetActions returns the actions that can be taken by the user.\nfunc (p Pending) GetActions() []*github.CheckRunAction {\n\treturn []*github.CheckRunAction{\n\t\tCancelAction(),\n\t}\n}\n" }, { "path": "api/checks/summaries/regressed.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage summaries\n\nimport (\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// BeforeAndAfter summarizes counts for pass/total before and after, across a\n// particular path (could be a folder, could be a test).\ntype BeforeAndAfter map[string]TestBeforeAndAfter\n\n// Add the given before/after counts to the totals.\nfunc (bna BeforeAndAfter) Add(p string, before, after shared.TestSummary) {\n\tsum := TestBeforeAndAfter{} // nolint:exhaustruct // TODO: Fix exhaustruct lint error\n\tif existing, ok := bna[p]; ok {\n\t\tsum = existing\n\t}\n\tif before != nil {\n\t\tsum.PassingBefore += before[0]\n\t\tsum.TotalBefore += before[1]\n\t}\n\tif after != nil {\n\t\tsum.PassingAfter += after[0]\n\t\tsum.TotalAfter += after[1]\n\t}\n\tbna[p] = sum\n}\n\n// TestBeforeAndAfter is a struct summarizing pass rates before and after in a diff.\ntype TestBeforeAndAfter struct {\n\tPassingBefore int\n\tPassingAfter int\n\tTotalBefore int\n\tTotalAfter int\n}\n\n// Regressed is the struct for regressed.md.\ntype Regressed struct {\n\tCheckState\n\tResultsComparison\n\n\tRegressions BeforeAndAfter\n\tMore int\n}\n\n// GetCheckState returns the info needed to update a check.\nfunc (r Regressed) GetCheckState() CheckState {\n\treturn r.CheckState\n}\n\n// GetSummary executes the template for the data.\nfunc (r Regressed) GetSummary() (string, error) {\n\treturn compile(&r, \"regressed.md\")\n}\n\n// GetActions returns the actions that can be taken by the user.\nfunc (r Regressed) GetActions() []*github.CheckRunAction {\n\treturn []*github.CheckRunAction{\n\t\tRecomputeAction(),\n\t\tIgnoreAction(),\n\t}\n}\n" }, { "path": "api/checks/summaries/templates/_file_an_issue.md", "content": "> _Note: wpt.fyi checks are still in beta!_\n>\n> See something wrong? Please [file an issue]({{ .FileIssueURL }})!\n" }, { "path": "api/checks/summaries/templates/_pr_and_master_specs.md", "content": "Run | Spec\n--- | ---\n`master` | {{ .BaseRun.String }}\n`{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}` | {{ .HeadRun.String }}\n" }, { "path": "api/checks/summaries/templates/_pr_runs_links.md", "content": "{{- range $pr := .CheckState.PRNumbers }}\n- [Latest results for PR #{{ $pr }}]({{ $.HostURL }}results/?pr={{ $pr }}&label=pr_head&max-count=1)\n- [All runs for PR #{{ $pr }}]({{ $.HostURL }}runs/?pr={{ $pr }})\n{{- end}}\n" }, { "path": "api/checks/summaries/templates/_successfully_scraped.md", "content": "Results have successfully been scraped and added to [{{ .HostName }}]({{ .HostURL }})." }, { "path": "api/checks/summaries/templates/completed.md", "content": "{{ template \"_successfully_scraped.md\" . }}\n\nThere were no regressions detected in the results.\n\n{{ template \"_pr_and_master_specs.md\" . }}\n\n### Results\n\nTest | `master` | `{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}`\n--- | --- | ---\n{{ range $test, $results := .Results -}}\n{{ escapeMD $test }} | {{ $results.PassingBefore }} / {{ $results.TotalBefore }} | {{ $results.PassingAfter }} / {{ $results.TotalAfter }}\n{{end}}\n{{ if gt .More 0 -}}\nAnd {{ .More }} others...\n{{ end }}\n\n[Visual comparison of the results]({{ .DiffURL }})\n\nOther links that might be useful:\n{{ template \"_pr_runs_links.md\" . }}\n- [`{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}` vs its merge base]({{ .DiffURL }})\n{{- if .MasterDiffURL }}\n- [`{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}` vs latest master]({{ .MasterDiffURL }})\n{{- end }}\n- [Latest results for `{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}`]({{.HostURL}}?sha={{.HeadRun.Revision}}&label=pr_head)\n\n{{ template \"_file_an_issue.md\" . }}\n" }, { "path": "api/checks/summaries/templates/pending.md", "content": "Results have been produced, and are being collected as we speak...\n\nThey'll eventually be visible on [{{ .HostName }}]({{ .RunsURL }}).\n\n{{ template \"_file_an_issue.md\" . }}\n" }, { "path": "api/checks/summaries/templates/regressed.md", "content": "{{ template \"_successfully_scraped.md\" . }}\n\nUh-oh - it looks like there are some newly-failing results when we compared the affected tests\nto the latest run against the `master` branch.\n\n{{ template \"_pr_and_master_specs.md\" . }}\n\n### Regressions\n\nTest | `master` | `{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}`\n--- | --- | ---\n{{ range $test, $results := .Regressions -}}\n{{ escapeMD $test }} | {{ $results.PassingBefore }} / {{ $results.TotalBefore }} | {{ $results.PassingAfter }} / {{ $results.TotalAfter }}\n{{end}}\n{{ if gt .More 0 -}}\nAnd {{ .More }} others...\n{{ end }}\n\n[Visual comparison of the results]({{ .DiffURL }})\n\nOther links that might be useful:\n{{ template \"_pr_runs_links.md\" . }}\n- [`{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}` vs its merge base]({{ .DiffURL }})\n{{- if .MasterDiffURL }}\n- [`{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}` vs latest master]({{ .MasterDiffURL }})\n{{- end }}\n- [Latest results for `{{ printf \"%.7s\" .HeadRun.FullRevisionHash }}`]({{.HostURL}}results/?sha={{.HeadRun.Revision}}&label=pr_head)\n\n{{ template \"_file_an_issue.md\" . }}\n" }, { "path": "api/checks/update.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage checks\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"sort\"\n\t\"strings\"\n\t\"time\"\n\n\tmapset \"github.com/deckarep/golang-set\"\n\n\t\"github.com/gorilla/mux\"\n\t\"github.com/web-platform-tests/wpt.fyi/api/checks/summaries\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// CheckProcessingQueue is the name of the TaskQueue that handles processing and\n// interpretation of TestRun results, in order to update the GitHub checks.\nconst CheckProcessingQueue = \"check-processing\"\n\nconst failChecksOnRegressionFeature = \"failChecksOnRegression\"\nconst onlyChangesAsRegressionsFeature = \"onlyChangesAsRegressions\"\n\n// updateCheckHandler handles /api/checks/[commit] POST requests.\nfunc updateCheckHandler(w http.ResponseWriter, r *http.Request) {\n\tctx := r.Context()\n\tlog := shared.GetLogger(ctx)\n\n\tvars := mux.Vars(r)\n\tsha, err := shared.ParseSHA(vars[\"commit\"])\n\tif err != nil {\n\t\tlog.Warningf(\"Failed to parse commit: %s\", err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tif err := r.ParseForm(); err != nil {\n\t\tlog.Warningf(\"Failed to parse form: %s\", err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tfilter, err := shared.ParseTestRunFilterParams(r.Form)\n\tif err != nil {\n\t\tlog.Warningf(\"Failed to parse params: %s\", err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tif len(filter.Products) != 1 {\n\t\tmsg := \"product param is missing\"\n\t\tlog.Warningf(\"%s\", msg)\n\t\thttp.Error(w, msg, http.StatusBadRequest)\n\n\t\treturn\n\t}\n\tfilter.SHAs = shared.SHAs{sha}\n\theadRun, baseRun, err := loadRunsToCompare(ctx, filter)\n\tif err != nil {\n\t\tmsg := \"Could not find runs to compare: \" + err.Error()\n\t\tlog.Warningf(\"%s\", msg)\n\t\thttp.Error(w, msg, http.StatusNotFound)\n\n\t\treturn\n\t}\n\n\tsha = headRun.FullRevisionHash\n\taeAPI := shared.NewAppEngineAPI(ctx)\n\tdiffAPI := shared.NewDiffAPI(ctx)\n\tsuites, err := NewAPI(ctx).GetSuitesForSHA(sha)\n\tif err != nil {\n\t\tlog.Warningf(\"Failed to load CheckSuites for %s: %s\", sha, err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t} else if len(suites) < 1 {\n\t\tlog.Debugf(\"No CheckSuites found for %s\", sha)\n\t}\n\n\tupdatedAny := false\n\tfor _, suite := range suites {\n\t\tvar summaryData summaries.Summary\n\t\tsummaryData, err = getDiffSummary(aeAPI, diffAPI, suite, *baseRun, *headRun)\n\t\tif errors.Is(err, shared.ErrRunNotInSearchCache) {\n\t\t\thttp.Error(w, err.Error(), http.StatusUnprocessableEntity)\n\n\t\t\treturn\n\t\t} else if err != nil {\n\t\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\t\treturn\n\t\t}\n\t\tupdated, updateErr := updateCheckRunSummary(ctx, summaryData, suite)\n\t\tif updateErr != nil {\n\t\t\terr = updateErr\n\t\t}\n\t\tupdatedAny = updatedAny || updated\n\t}\n\n\tif err != nil {\n\t\tlog.Errorf(\"Failed to update check_run(s): %s\", err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\t} else if updatedAny {\n\t\t_, err = w.Write([]byte(\"Check(s) updated\"))\n\t} else {\n\t\t_, err = w.Write([]byte(\"No check(s) updated\"))\n\t}\n\n\tif err != nil {\n\t\tlog.Warningf(\"Failed to write data in api/checks handler: %s\", err.Error())\n\t}\n}\n\nfunc loadRunsToCompare(ctx context.Context, filter shared.TestRunFilter) (\n\theadRun,\n\tbaseRun *shared.TestRun,\n\terr error,\n) {\n\tone := 1\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\truns, err := store.TestRunQuery().LoadTestRuns(\n\t\tfilter.Products,\n\t\tfilter.Labels,\n\t\tfilter.SHAs,\n\t\tfilter.From,\n\t\tfilter.To,\n\t\t&one,\n\t\tnil,\n\t)\n\tif err != nil {\n\t\treturn nil, nil, err\n\t}\n\trun := runs.First()\n\tif run == nil {\n\t\treturn nil, nil, fmt.Errorf(\"no test run found for %s @ %s\",\n\t\t\tfilter.Products[0].String(),\n\t\t\tshared.CropString(filter.SHAs.FirstOrLatest(), 7))\n\t}\n\n\tlabels := run.LabelsSet()\n\tif labels.Contains(shared.MasterLabel) {\n\t\theadRun = run\n\t\tbaseRun, err = loadMasterRunBefore(ctx, filter, headRun)\n\t} else if labels.Contains(shared.PRBaseLabel) {\n\t\tbaseRun = run\n\t\theadRun, err = loadPRRun(ctx, filter, shared.PRHeadLabel)\n\t} else if labels.Contains(shared.PRHeadLabel) {\n\t\theadRun = run\n\t\tbaseRun, err = loadPRRun(ctx, filter, shared.PRBaseLabel)\n\t} else {\n\t\treturn nil, nil, fmt.Errorf(\"test run %d doesn't have pr_base, pr_head or master label\", run.ID)\n\t}\n\n\treturn headRun, baseRun, err\n}\n\nfunc loadPRRun(ctx context.Context, filter shared.TestRunFilter, extraLabel string) (*shared.TestRun, error) {\n\t// Find the corresponding pr_base or pr_head run.\n\tone := 1\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tlabels := mapset.NewSetWith(extraLabel)\n\truns, err := store.TestRunQuery().LoadTestRuns(\n\t\tfilter.Products,\n\t\tlabels,\n\t\tfilter.SHAs,\n\t\tnil,\n\t\tnil,\n\t\t&one,\n\t\tnil,\n\t)\n\trun := runs.First()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif run == nil {\n\t\terr = fmt.Errorf(\"no test run found for %s @ %s with label %s\",\n\t\t\tfilter.Products[0].String(), filter.SHAs.FirstOrLatest(), extraLabel)\n\t}\n\n\treturn run, err\n}\n\nfunc loadMasterRunBefore(\n\tctx context.Context,\n\tfilter shared.TestRunFilter,\n\theadRun *shared.TestRun,\n) (*shared.TestRun, error) {\n\t// Get the most recent, but still earlier, master run to compare.\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tone := 1\n\tto := headRun.TimeStart.Add(-time.Millisecond)\n\tlabels := mapset.NewSetWith(headRun.Channel(), shared.MasterLabel)\n\truns, err := store.TestRunQuery().LoadTestRuns(filter.Products, labels, nil, nil, &to, &one, nil)\n\tbaseRun := runs.First()\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif baseRun == nil {\n\t\terr = fmt.Errorf(\"no master run found for %s before %s\",\n\t\t\tfilter.Products[0].String(), filter.SHAs.FirstOrLatest())\n\t}\n\n\treturn baseRun, err\n}\n\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc getDiffSummary(\n\taeAPI shared.AppEngineAPI,\n\tdiffAPI shared.DiffAPI,\n\tsuite shared.CheckSuite,\n\tbaseRun,\n\theadRun shared.TestRun,\n) (summaries.Summary, error) { // nolint:ireturn // TODO: Fix ireturn lint error\n\t// nolint:exhaustruct // TODO: Fix exhauststruct lint error\n\tdiffFilter := shared.DiffFilterParam{Added: true, Changed: true, Deleted: true}\n\tdiff, err := diffAPI.GetRunsDiff(baseRun, headRun, diffFilter, nil)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\tcheckProduct := shared.ProductSpec{\n\t\t// [browser]@[sha] is plenty specific, and avoids bad version strings.\n\t\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\tProductAtRevision: shared.ProductAtRevision{\n\t\t\tProduct: shared.Product{BrowserName: headRun.BrowserName},\n\t\t\tRevision: headRun.Revision, // nolint:staticcheck // TODO: Fix staticcheck lint error (SA1019).\n\t\t},\n\t\tLabels: mapset.NewSetWith(baseRun.Channel()),\n\t}\n\n\tdiffURL := diffAPI.GetDiffURL(baseRun, headRun, &diffFilter)\n\thost := aeAPI.GetHostname()\n\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\tcheckState := summaries.CheckState{\n\t\tHostName: host,\n\t\tTestRun: &headRun,\n\t\tProduct: checkProduct,\n\t\tHeadSHA: headRun.FullRevisionHash,\n\t\tDetailsURL: diffURL,\n\t\tStatus: \"completed\",\n\t\tPRNumbers: suite.PRNumbers,\n\t}\n\n\tvar regressions mapset.Set\n\tif aeAPI.IsFeatureEnabled(onlyChangesAsRegressionsFeature) {\n\t\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\tregressionFilter := shared.DiffFilterParam{Changed: true} // Only changed items\n\t\tchangeOnlyDiff, err := diffAPI.GetRunsDiff(baseRun, headRun, regressionFilter, nil)\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\t\tregressions = changeOnlyDiff.Differences.Regressions()\n\t} else {\n\t\tregressions = diff.Differences.Regressions()\n\t}\n\thasRegressions := regressions.Cardinality() > 0\n\tneutral := \"neutral\"\n\tcheckState.Conclusion = &neutral\n\tchecksCanBeNonNeutral := aeAPI.IsFeatureEnabled(failChecksOnRegressionFeature)\n\n\t// Set URL path to deepest shared dir.\n\tvar tests []string\n\tif hasRegressions {\n\t\ttests = shared.ToStringSlice(regressions)\n\t} else {\n\t\ttests, _ = shared.MapStringKeys(diff.AfterSummary)\n\t}\n\tsharedPath := \"/results\" + shared.GetSharedPath(tests...)\n\tdiffURL.Path = sharedPath\n\n\tvar summary summaries.Summary\n\n\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\tresultsComparison := summaries.ResultsComparison{\n\t\tBaseRun: baseRun,\n\t\tHeadRun: headRun,\n\t\tHostURL: fmt.Sprintf(\"https://%s/\", host),\n\t\tDiffURL: diffURL.String(),\n\t}\n\tif headRun.LabelsSet().Contains(shared.PRHeadLabel) {\n\t\t// Deletions are meaningless and abundant comparing to master; ignore them.\n\t\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\tmasterDiffFilter := shared.DiffFilterParam{Added: true, Changed: true, Unchanged: true}\n\t\tmasterDiffURL := diffAPI.GetMasterDiffURL(headRun, &masterDiffFilter)\n\t\tmasterDiffURL.Path = sharedPath\n\t\tresultsComparison.MasterDiffURL = masterDiffURL.String()\n\t}\n\n\t// nolint:nestif // TODO: Fix nestif lint error\n\tif !hasRegressions {\n\t\tcollapsed := collapseSummary(diff, 10)\n\t\tdata := summaries.Completed{ // nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\t\tCheckState: checkState,\n\t\t\tResultsComparison: resultsComparison,\n\t\t\tResults: make(summaries.BeforeAndAfter),\n\t\t}\n\t\ttests, _ := shared.MapStringKeys(collapsed)\n\t\tsort.Strings(tests)\n\t\tfor _, test := range tests {\n\t\t\tif len(data.Results) < 10 {\n\t\t\t\tdata.Results[test] = collapsed[test]\n\t\t\t} else {\n\t\t\t\tdata.More++\n\t\t\t}\n\t\t}\n\t\tsuccess := \"success\"\n\t\tdata.Conclusion = &success\n\t\tsummary = data\n\t} else {\n\t\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error\n\t\tdata := summaries.Regressed{\n\t\t\tCheckState: checkState,\n\t\t\tResultsComparison: resultsComparison,\n\t\t\tRegressions: make(summaries.BeforeAndAfter),\n\t\t}\n\t\ttests := shared.ToStringSlice(regressions)\n\t\tsort.Strings(tests)\n\t\tfor _, path := range tests {\n\t\t\tif len(data.Regressions) <= 10 {\n\t\t\t\tdata.Regressions.Add(path, diff.BeforeSummary[path], diff.AfterSummary[path])\n\t\t\t} else {\n\t\t\t\tdata.More++\n\t\t\t}\n\t\t}\n\t\tif checksCanBeNonNeutral {\n\t\t\tactionRequired := \"action_required\"\n\t\t\tdata.Conclusion = &actionRequired\n\t\t}\n\t\tsummary = data\n\t}\n\n\treturn summary, nil\n}\n\ntype pathKeys []string\n\nfunc (e pathKeys) Len() int { return len(e) }\nfunc (e pathKeys) Swap(i, j int) { e[i], e[j] = e[j], e[i] }\nfunc (e pathKeys) Less(i, j int) bool {\n\treturn len(strings.Split(e[i], \"/\")) > len(strings.Split(e[j], \"/\"))\n}\n\n// collapseSummary collapses a tree of file paths into a smaller tree of folders.\nfunc collapseSummary(diff shared.RunDiff, limit int) summaries.BeforeAndAfter {\n\tbeforeKeys, _ := shared.MapStringKeys(diff.BeforeSummary)\n\tafterKeys, _ := shared.MapStringKeys(diff.AfterSummary)\n\tkeys := shared.ToStringSlice(\n\t\tshared.NewSetFromStringSlice(beforeKeys).Union(shared.NewSetFromStringSlice(afterKeys)),\n\t)\n\tpaths := shared.ToStringSlice(collapsePaths(keys, limit))\n\tresult := make(summaries.BeforeAndAfter)\n\tfor _, k := range keys {\n\t\tfor _, p := range paths {\n\t\t\tif strings.HasPrefix(k, p) {\n\t\t\t\tresult.Add(p, diff.BeforeSummary[k], diff.AfterSummary[k])\n\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\n\treturn result\n}\n\nfunc collapsePaths(keys []string, limit int) mapset.Set { // nolint:ireturn // TODO: Fix ireturn lint error\n\tresult := shared.NewSetFromStringSlice(keys)\n\t// 10 iterations to avoid edge-case infinite looping risk.\n\tfor i := 0; i < 10 && result.Cardinality() > limit; i++ {\n\t\tsort.Sort(pathKeys(keys))\n\t\tcollapsed := mapset.NewSet()\n\t\tdepth := -1\n\t\tfor _, k := range keys {\n\t\t\t// Something might have already collapsed down 1 dir into this one.\n\t\t\tif collapsed.Contains(k) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\tparts := strings.Split(k, \"/\")\n\t\t\tif parts[len(parts)-1] == \"\" {\n\t\t\t\tparts = parts[:len(parts)-1]\n\t\t\t}\n\t\t\tif len(parts) < depth {\n\t\t\t\tcollapsed.Add(k)\n\n\t\t\t\tcontinue\n\t\t\t}\n\n\t\t\tpath := strings.Join(parts[:len(parts)-1], \"/\") + \"/\"\n\t\t\tcollapsed.Add(path)\n\t\t\tdepth = len(parts)\n\t\t}\n\t\tif i > 0 && depth < 3 {\n\t\t\tbreak\n\t\t}\n\t\tkeys = shared.ToStringSlice(collapsed)\n\t\tresult = collapsed\n\t}\n\n\treturn result\n}\n" }, { "path": "api/checks/update_medium_test.go", "content": "//go:build medium\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\npackage checks\n\nimport (\n\t\"strconv\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n)\n\nfunc TestLoadRunsToCompare_master(t *testing.T) {\n\tctx, done, err := sharedtest.NewAEContext(true)\n\tassert.Nil(t, err)\n\tdefer done()\n\n\ttestRun := shared.TestRun{\n\t\tProductAtRevision: shared.ProductAtRevision{\n\t\t\tProduct: shared.Product{\n\t\t\t\tBrowserName: \"chrome\",\n\t\t\t},\n\t\t},\n\t\tLabels: []string{\"master\"},\n\t}\n\tyesterday := time.Now().AddDate(0, 0, -1)\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tfor i := 0; i < 2; i++ {\n\t\ttestRun.FullRevisionHash = strings.Repeat(strconv.Itoa(i), 40)\n\t\ttestRun.Revision = testRun.FullRevisionHash[:10]\n\t\ttestRun.TimeStart = yesterday.Add(time.Duration(i) * time.Hour)\n\t\tkey := store.NewIncompleteKey(\"TestRun\")\n\t\tkey, _ = store.Put(key, &testRun)\n\t}\n\n\tchrome, _ := shared.ParseProductSpec(\"chrome\")\n\tfilter := shared.TestRunFilter{\n\t\tSHAs: shared.SHAs{\"1111111111\"},\n\t\tProducts: shared.ProductSpecs{chrome},\n\t}\n\theadRun, baseRun, err := loadRunsToCompare(ctx, filter)\n\n\tassert.Nil(t, err)\n\tassert.NotNil(t, headRun)\n\tassert.NotNil(t, baseRun)\n\tassert.Equal(t, \"0000000000\", baseRun.Revision)\n\tassert.Equal(t, \"1111111111\", headRun.Revision)\n}\n\nfunc TestLoadRunsToCompare_pr_base_first(t *testing.T) {\n\tctx, done, err := sharedtest.NewAEContext(true)\n\tassert.Nil(t, err)\n\tdefer done()\n\n\tlabelsForRuns := [][]string{{\"pr_base\"}, {\"pr_head\"}}\n\tyesterday := time.Now().AddDate(0, 0, -1)\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tfor i := 0; i < 2; i++ {\n\t\ttestRun := shared.TestRun{\n\t\t\tProductAtRevision: shared.ProductAtRevision{\n\t\t\t\tProduct: shared.Product{\n\t\t\t\t\tBrowserName: \"chrome\",\n\t\t\t\t},\n\t\t\t\tRevision: \"1234567890\",\n\t\t\t\tFullRevisionHash: \"1234567890123456789012345678901234567890\",\n\t\t\t},\n\t\t\tTimeStart: yesterday.Add(time.Duration(i) * time.Hour),\n\t\t\tLabels: labelsForRuns[i],\n\t\t}\n\t\tkey := store.NewIncompleteKey(\"TestRun\")\n\t\tkey, _ = store.Put(key, &testRun)\n\t}\n\n\tchrome, _ := shared.ParseProductSpec(\"chrome\")\n\tfilter := shared.TestRunFilter{\n\t\tSHAs: shared.SHAs{\"1234567890\"},\n\t\tProducts: shared.ProductSpecs{chrome},\n\t}\n\theadRun, baseRun, err := loadRunsToCompare(ctx, filter)\n\n\tassert.Nil(t, err)\n\tassert.NotNil(t, headRun)\n\tassert.NotNil(t, baseRun)\n\tassert.Equal(t, []string{\"pr_base\"}, baseRun.Labels)\n\tassert.Equal(t, []string{\"pr_head\"}, headRun.Labels)\n}\n\nfunc TestLoadRunsToCompare_pr_head_first(t *testing.T) {\n\tctx, done, err := sharedtest.NewAEContext(true)\n\tassert.Nil(t, err)\n\tdefer done()\n\n\tlabelsForRuns := [][]string{{\"pr_head\"}, {\"pr_base\"}}\n\tyesterday := time.Now().AddDate(0, 0, -1)\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tfor i := 0; i < 2; i++ {\n\t\ttestRun := shared.TestRun{\n\t\t\tProductAtRevision: shared.ProductAtRevision{\n\t\t\t\tProduct: shared.Product{\n\t\t\t\t\tBrowserName: \"chrome\",\n\t\t\t\t},\n\t\t\t\tRevision: \"1234567890\",\n\t\t\t\tFullRevisionHash: \"1234567890123456789012345678901234567890\",\n\t\t\t},\n\t\t\tTimeStart: yesterday.Add(time.Duration(i) * time.Hour),\n\t\t\tLabels: labelsForRuns[i],\n\t\t}\n\t\tkey := store.NewIncompleteKey(\"TestRun\")\n\t\tkey, _ = store.Put(key, &testRun)\n\t}\n\n\tchrome, _ := shared.ParseProductSpec(\"chrome\")\n\tfilter := shared.TestRunFilter{\n\t\tSHAs: shared.SHAs{\"1234567890\"},\n\t\tProducts: shared.ProductSpecs{chrome},\n\t}\n\theadRun, baseRun, err := loadRunsToCompare(ctx, filter)\n\n\tassert.Nil(t, err)\n\tassert.NotNil(t, headRun)\n\tassert.NotNil(t, baseRun)\n\tassert.Equal(t, []string{\"pr_base\"}, baseRun.Labels)\n\tassert.Equal(t, []string{\"pr_head\"}, headRun.Labels)\n}\n" }, { "path": "api/checks/update_test.go", "content": "//go:build small\n\npackage checks\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"net/url\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/api/checks/summaries\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n\t\"go.uber.org/mock/gomock\"\n)\n\nfunc TestGetDiffSummary_Regressed(t *testing.T) {\n\ttestSummary := func(enabled bool) {\n\t\tt.Run(fmt.Sprintf(\"%s=%v\", onlyChangesAsRegressionsFeature, enabled), func(t *testing.T) {\n\t\t\tmockCtrl := gomock.NewController(t)\n\t\t\tdefer mockCtrl.Finish()\n\n\t\t\tbefore, after := getBeforeAndAfterRuns()\n\t\t\trunDiff := shared.RunDiff{\n\t\t\t\tDifferences: shared.ResultsDiff{\"/foo.html\": shared.TestDiff{0, 1, 0}},\n\t\t\t}\n\n\t\t\taeAPI := sharedtest.NewMockAppEngineAPI(mockCtrl)\n\t\t\taeAPI.EXPECT().Context().AnyTimes().Return(context.Background())\n\t\t\taeAPI.EXPECT().IsFeatureEnabled(onlyChangesAsRegressionsFeature).Return(enabled)\n\t\t\taeAPI.EXPECT().IsFeatureEnabled(failChecksOnRegressionFeature).Return(false)\n\t\t\taeAPI.EXPECT().GetHostname()\n\t\t\tdiffAPI := sharedtest.NewMockDiffAPI(mockCtrl)\n\t\t\tdiffAPI.EXPECT().GetRunsDiff(before, after, sharedtest.SameDiffFilter(\"ADC\"), gomock.Any()).Return(runDiff, nil)\n\t\t\tif enabled {\n\t\t\t\tdiffAPI.EXPECT().GetRunsDiff(before, after, sharedtest.SameDiffFilter(\"C\"), gomock.Any()).Return(runDiff, nil)\n\t\t\t}\n\t\t\tdiffURL, _ := url.Parse(\"https://wpt.fyi/results?diff\")\n\t\t\tdiffAPI.EXPECT().GetDiffURL(before, after, gomock.Any()).Return(diffURL)\n\t\t\tdiffAPI.EXPECT().GetMasterDiffURL(after, sharedtest.SameDiffFilter(\"ACU\")).Return(diffURL)\n\t\t\tsuite := shared.CheckSuite{\n\t\t\t\tPRNumbers: []int{123},\n\t\t\t}\n\n\t\t\tsummary, err := getDiffSummary(aeAPI, diffAPI, suite, before, after)\n\t\t\tassert.Nil(t, err)\n\t\t\t_, ok := summary.(summaries.Regressed)\n\t\t\tassert.True(t, ok)\n\t\t\tassert.Equal(t, suite.PRNumbers, summary.GetCheckState().PRNumbers)\n\t\t})\n\t}\n\ttestSummary(false)\n\ttestSummary(true)\n}\n\nfunc TestGetDiffSummary_Completed(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tbefore, after := getBeforeAndAfterRuns()\n\trunDiff := shared.RunDiff{\n\t\tDifferences: shared.ResultsDiff{\"/foo.html\": shared.TestDiff{1, 0, 1}},\n\t}\n\n\taeAPI := sharedtest.NewMockAppEngineAPI(mockCtrl)\n\taeAPI.EXPECT().Context().AnyTimes().Return(context.Background())\n\taeAPI.EXPECT().IsFeatureEnabled(onlyChangesAsRegressionsFeature).Return(false)\n\taeAPI.EXPECT().IsFeatureEnabled(failChecksOnRegressionFeature).Return(false)\n\taeAPI.EXPECT().GetHostname()\n\tdiffAPI := sharedtest.NewMockDiffAPI(mockCtrl)\n\tdiffAPI.EXPECT().GetRunsDiff(before, after, gomock.Any(), gomock.Any()).Return(runDiff, nil)\n\tdiffURL, _ := url.Parse(\"https://wpt.fyi/results?diff\")\n\tdiffAPI.EXPECT().GetDiffURL(before, after, gomock.Any()).Return(diffURL)\n\tdiffAPI.EXPECT().GetMasterDiffURL(after, sharedtest.SameDiffFilter(\"ACU\")).Return(diffURL)\n\tsuite := shared.CheckSuite{\n\t\tPRNumbers: []int{123},\n\t}\n\n\tsummary, err := getDiffSummary(aeAPI, diffAPI, suite, before, after)\n\tassert.Nil(t, err)\n\t_, ok := summary.(summaries.Completed)\n\tassert.True(t, ok)\n\tassert.Equal(t, suite.PRNumbers, summary.GetCheckState().PRNumbers)\n}\n\nfunc getBeforeAndAfterRuns() (before, after shared.TestRun) {\n\tbefore.FullRevisionHash = strings.Repeat(\"0\", 40)\n\tbefore.BrowserName = \"chrome\"\n\tbefore.Labels = []string{shared.PRBaseLabel}\n\tafter.FullRevisionHash = strings.Repeat(\"1\", 40)\n\tafter.BrowserName = \"chrome\"\n\tafter.Labels = []string{shared.PRHeadLabel}\n\treturn before, after\n}\n\nfunc TestCollapseSummary_Nesting(t *testing.T) {\n\tdiff := shared.RunDiff{\n\t\tBeforeSummary: shared.ResultsSummary{\n\t\t\t\"/foo/test.html\": shared.TestSummary{1, 1},\n\t\t\t\"/foo/bar/test.html\": shared.TestSummary{1, 1},\n\t\t\t\"/foo/bar/baz/test.html\": shared.TestSummary{1, 1},\n\t\t\t\"/foo/bar/baz/qux/test.html\": shared.TestSummary{1, 1},\n\t\t},\n\t\tAfterSummary: shared.ResultsSummary{\n\t\t\t\"/foo/test.html\": shared.TestSummary{2, 2},\n\t\t\t\"/foo/bar/test.html\": shared.TestSummary{2, 2},\n\t\t\t\"/foo/bar/baz/test.html\": shared.TestSummary{2, 2},\n\t\t\t\"/foo/bar/baz/qux/test.html\": shared.TestSummary{2, 2},\n\t\t},\n\t}\n\tsummary := summaries.BeforeAndAfter{\n\t\t\"/foo/test.html\": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},\n\t\t\"/foo/bar/test.html\": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},\n\t\t\"/foo/bar/baz/test.html\": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},\n\t\t\"/foo/bar/baz/qux/test.html\": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},\n\t}\n\tassert.Equal(t, summary, collapseSummary(diff, 4))\n\tassert.Equal(t, summaries.BeforeAndAfter{\n\t\t\"/foo/test.html\": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},\n\t\t\"/foo/bar/test.html\": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},\n\t\t\"/foo/bar/baz/\": summaries.TestBeforeAndAfter{PassingBefore: 2, TotalBefore: 2, PassingAfter: 4, TotalAfter: 4},\n\t}, collapseSummary(diff, 3))\n\tassert.Equal(t, summaries.BeforeAndAfter{\n\t\t\"/foo/test.html\": summaries.TestBeforeAndAfter{PassingBefore: 1, TotalBefore: 1, PassingAfter: 2, TotalAfter: 2},\n\t\t\"/foo/bar/\": summaries.TestBeforeAndAfter{PassingBefore: 3, TotalBefore: 3, PassingAfter: 6, TotalAfter: 6},\n\t}, collapseSummary(diff, 2))\n\tassert.Equal(t, summaries.BeforeAndAfter{\n\t\t\"/foo/\": summaries.TestBeforeAndAfter{PassingBefore: 4, TotalBefore: 4, PassingAfter: 8, TotalAfter: 8},\n\t}, collapseSummary(diff, 1))\n}\n\nfunc TestCollapseSummary_ManyFiles(t *testing.T) {\n\tdiff := shared.RunDiff{\n\t\tBeforeSummary: make(shared.ResultsSummary),\n\t\tAfterSummary: make(shared.ResultsSummary),\n\t}\n\tfor i := 1; i <= 20; i++ {\n\t\tdiff.BeforeSummary[fmt.Sprintf(\"/foo/test%v.html\", i)] = shared.TestSummary{1, 1}\n\t\tdiff.BeforeSummary[fmt.Sprintf(\"/bar/test%v.html\", i)] = shared.TestSummary{1, 1}\n\t\tdiff.BeforeSummary[fmt.Sprintf(\"/baz/test%v.html\", i)] = shared.TestSummary{1, 1}\n\t\tdiff.AfterSummary[fmt.Sprintf(\"/foo/test%v.html\", i)] = shared.TestSummary{2, 3}\n\t\tdiff.AfterSummary[fmt.Sprintf(\"/bar/test%v.html\", i)] = shared.TestSummary{2, 3}\n\t\tdiff.AfterSummary[fmt.Sprintf(\"/baz/test%v.html\", i)] = shared.TestSummary{2, 3}\n\t}\n\tassert.Equal(t, summaries.BeforeAndAfter{\n\t\t\"/foo/\": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},\n\t\t\"/bar/\": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},\n\t\t\"/baz/\": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},\n\t}, collapseSummary(diff, 10))\n\t// A number too small still does its best to collapse.\n\tassert.Equal(t, summaries.BeforeAndAfter{\n\t\t\"/foo/\": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},\n\t\t\"/bar/\": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},\n\t\t\"/baz/\": summaries.TestBeforeAndAfter{PassingBefore: 20, TotalBefore: 20, PassingAfter: 40, TotalAfter: 60},\n\t}, collapseSummary(diff, 1))\n}\n" }, { "path": "api/checks/webhook.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage checks\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"regexp\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nconst requestedAction = \"requested\"\nconst rerequestedAction = \"rerequested\"\n\n// webhookGithubEvent represents the allowed GitHub webhook event types.\ntype webhookGithubEvent string\n\nconst (\n\teventCheckSuite webhookGithubEvent = \"check_suite\"\n\teventCheckRun webhookGithubEvent = \"check_run\"\n\teventPullRequest webhookGithubEvent = \"pull_request\"\n)\n\nvar runNameRegex = regexp.MustCompile(`^(?:(?:staging\\.)?wpt\\.fyi - )(.*)$`)\n\nfunc isWPTFYIApp(appID int64) bool {\n\treturn appID == wptfyiCheckAppID || appID == wptfyiStagingCheckAppID\n}\n\n// checkWebhookHandler handles GitHub events relating to our wpt.fyi and\n// staging.wpt.fyi GitHub Apps[0], sent to the /api/webhook/check endpoint.\n//\n// [0]: https://github.com/apps/wpt-fyi and https://github.com/apps/staging-wpt-fyi\nfunc checkWebhookHandler(w http.ResponseWriter, r *http.Request) {\n\tctx := r.Context()\n\tlog := shared.GetLogger(ctx)\n\tds := shared.NewAppEngineDatastore(ctx, false)\n\n\tcontentType := r.Header.Get(\"Content-Type\")\n\tif contentType != \"application/json\" {\n\t\tlog.Errorf(\"Invalid content-type: %s\", contentType)\n\t\tw.WriteHeader(http.StatusBadRequest)\n\n\t\treturn\n\t}\n\tevent := r.Header.Get(\"X-GitHub-Event\")\n\tinputEvent := webhookGithubEvent(event)\n\tswitch inputEvent {\n\tcase eventCheckSuite, eventCheckRun, eventPullRequest:\n\t\tbreak\n\tdefault:\n\t\tlog.Debugf(\"Ignoring %s event\", event)\n\t\tw.WriteHeader(http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tsecret, err := shared.GetSecret(ds, \"github-check-webhook-secret\")\n\tif err != nil {\n\t\tlog.Errorf(\"Missing secret: github-check-webhook-secret\")\n\t\thttp.Error(w, \"Unable to verify request: secret not found\", http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tpayload, err := github.ValidatePayload(r, []byte(secret))\n\tif err != nil {\n\t\tlog.Errorf(\"%v\", err)\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tlog.Debugf(\"GitHub Delivery: %s\", r.Header.Get(\"X-GitHub-Delivery\"))\n\n\tvar processed bool\n\tapi := NewAPI(ctx)\n\tswitch inputEvent {\n\tcase eventCheckSuite:\n\t\tprocessed, err = handleCheckSuiteEvent(api, payload)\n\tcase eventCheckRun:\n\t\tprocessed, err = handleCheckRunEvent(api, payload)\n\tcase eventPullRequest:\n\t\tprocessed, err = handlePullRequestEvent(api, payload)\n\t}\n\n\tif err != nil {\n\t\tlog.Errorf(\"%v\", err)\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\tif processed {\n\t\tw.WriteHeader(http.StatusOK)\n\t\tfmt.Fprintln(w, \"wpt.fyi check(s) scheduled successfully\")\n\t} else {\n\t\tw.WriteHeader(http.StatusNoContent)\n\t\tfmt.Fprintln(w, \"Status was ignored\")\n\t}\n}\n\n// handleCheckSuiteEvent handles a check_suite (re)requested event by ensuring\n// that a check_run exists for each product that contains results for the head SHA.\n// nolint:gocognit // TODO: Fix gocognit lint error\nfunc handleCheckSuiteEvent(api API, payload []byte) (bool, error) {\n\tlog := shared.GetLogger(api.Context())\n\tvar checkSuite github.CheckSuiteEvent\n\tif err := json.Unmarshal(payload, &checkSuite); err != nil {\n\t\treturn false, err\n\t}\n\n\taction := checkSuite.GetAction()\n\towner := checkSuite.GetRepo().GetOwner().GetLogin()\n\trepo := checkSuite.GetRepo().GetName()\n\tsha := checkSuite.GetCheckSuite().GetHeadSHA()\n\tappName := checkSuite.GetCheckSuite().GetApp().GetName()\n\tappID := checkSuite.GetCheckSuite().GetApp().GetID()\n\n\tlog.Debugf(\"Check suite %s: %s/%s @ %s (App %v, ID %v)\",\n\t\taction,\n\t\towner,\n\t\trepo,\n\t\tshared.CropString(sha, 7),\n\t\tappName,\n\t\tappID,\n\t)\n\n\tif !isWPTFYIApp(appID) {\n\t\tlog.Infof(\"Ignoring check_suite App ID %v\", appID)\n\n\t\treturn false, nil\n\t}\n\n\tlogin := checkSuite.GetSender().GetLogin()\n\tif !checksEnabledForUser(api, login) {\n\t\tlog.Infof(\"Checks not enabled for sender %s\", login)\n\n\t\treturn false, nil\n\t}\n\n\t// nolint:nestif // TODO: Fix nestif lint error\n\tif action == requestedAction || action == rerequestedAction {\n\t\tpullRequests := checkSuite.GetCheckSuite().PullRequests\n\t\tprNumbers := []int{}\n\t\tfor _, pr := range pullRequests {\n\t\t\tif pr.GetBase().GetRepo().GetID() == wptRepoID {\n\t\t\t\tprNumbers = append(prNumbers, pr.GetNumber())\n\t\t\t}\n\t\t}\n\n\t\tinstallationID := checkSuite.GetInstallation().GetID()\n\t\tif action == requestedAction {\n\t\t\tfor _, p := range pullRequests {\n\t\t\t\tdestRepoID := p.GetBase().GetRepo().GetID()\n\t\t\t\tif destRepoID == wptRepoID && p.GetHead().GetRepo().GetID() != destRepoID {\n\t\t\t\t\t// Errors are already logged by CreateWPTCheckSuite\n\t\t\t\t\t_, _ = api.CreateWPTCheckSuite(appID, installationID, sha, prNumbers...)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tsuite, err := getOrCreateCheckSuite(api.Context(), sha, owner, repo, appID, installationID, prNumbers...)\n\t\tif err != nil || suite == nil {\n\t\t\treturn false, err\n\t\t}\n\n\t\tif action == rerequestedAction {\n\t\t\treturn scheduleProcessingForExistingRuns(api.Context(), sha)\n\t\t}\n\t}\n\n\treturn false, nil\n}\n\n// handleCheckRunEvent handles a check_run rerequested events by updating\n// the status based on whether results for the check_run's product exist.\nfunc handleCheckRunEvent(\n\tapi API,\n\tpayload []byte) (bool, error) {\n\n\tlog := shared.GetLogger(api.Context())\n\tcheckRun := new(github.CheckRunEvent)\n\tif err := json.Unmarshal(payload, checkRun); err != nil {\n\t\treturn false, err\n\t}\n\n\taction := checkRun.GetAction()\n\towner := checkRun.GetRepo().GetOwner().GetLogin()\n\trepo := checkRun.GetRepo().GetName()\n\tsha := checkRun.GetCheckRun().GetHeadSHA()\n\tappName := checkRun.GetCheckRun().GetApp().GetName()\n\tappID := checkRun.GetCheckRun().GetApp().GetID()\n\n\tlog.Debugf(\"Check run %s: %s/%s @ %s (App %v, ID %v)\", action, owner, repo, shared.CropString(sha, 7), appName, appID)\n\n\tif !isWPTFYIApp(appID) {\n\t\tlog.Infof(\"Ignoring check_run App ID %v\", appID)\n\n\t\treturn false, nil\n\t}\n\n\tlogin := checkRun.GetSender().GetLogin()\n\tif !checksEnabledForUser(api, login) {\n\t\tlog.Infof(\"Checks not enabled for sender %s\", login)\n\n\t\treturn false, nil\n\t}\n\n\t// Determine whether or not we need to schedule processing the results\n\t// of a CheckRun. The 'requested_action' event occurs when a user\n\t// clicks on one of the 'action' buttons we setup as part of our\n\t// CheckRuns[0]; see summaries.Summary.GetActions().\n\t//\n\t// [0]: https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions\n\tstatus := checkRun.GetCheckRun().GetStatus()\n\tshouldSchedule := false\n\tif (action == \"created\" && status != \"completed\") || action == \"rerequested\" {\n\t\tshouldSchedule = true\n\t} else if action == \"requested_action\" {\n\t\tactionID := checkRun.GetRequestedAction().Identifier\n\t\tswitch actionID {\n\t\tcase \"recompute\":\n\t\t\tshouldSchedule = true\n\t\tcase \"ignore\":\n\t\t\terr := api.IgnoreFailure(\n\t\t\t\tlogin,\n\t\t\t\towner,\n\t\t\t\trepo,\n\t\t\t\tcheckRun.GetCheckRun(),\n\t\t\t\tcheckRun.GetInstallation())\n\n\t\t\treturn err == nil, err\n\t\tcase \"cancel\":\n\t\t\terr := api.CancelRun(\n\t\t\t\tlogin,\n\t\t\t\towner,\n\t\t\t\trepo,\n\t\t\t\tcheckRun.GetCheckRun(),\n\t\t\t\tcheckRun.GetInstallation())\n\n\t\t\treturn err == nil, err\n\t\tdefault:\n\t\t\tlog.Debugf(\"Ignoring %s action with id %s\", action, actionID)\n\n\t\t\treturn false, nil\n\t\t}\n\t}\n\n\tif shouldSchedule {\n\t\tname := checkRun.GetCheckRun().GetName()\n\t\tlog.Debugf(\"GitHub check run %v (%s @ %s) was %s\", checkRun.GetCheckRun().GetID(), name, sha, action)\n\t\t// Strip any \"wpt.fyi - \" prefix.\n\t\tif runNameRegex.MatchString(name) {\n\t\t\tname = runNameRegex.FindStringSubmatch(name)[1]\n\t\t}\n\t\tspec, err := shared.ParseProductSpec(name)\n\t\tif err != nil {\n\t\t\tlog.Errorf(\"Failed to parse \\\"%s\\\" as product spec\", name)\n\n\t\t\treturn false, err\n\t\t}\n\t\t// Errors are logged by ScheduleResultsProcessing\n\t\t_ = api.ScheduleResultsProcessing(sha, spec)\n\n\t\treturn true, nil\n\t}\n\tlog.Debugf(\"Ignoring %s action for %s check_run\", action, status)\n\n\treturn false, nil\n}\n\n// handlePullRequestEvent reaches to pull requests from forks, ensuring that a\n// GitHub check_suite is created in the main WPT repository for those. GitHub\n// automatically creates a check_suite for code pushed to the WPT repository,\n// so we don't need to do anything for same-repo pull requests.\nfunc handlePullRequestEvent(api API, payload []byte) (bool, error) {\n\tlog := shared.GetLogger(api.Context())\n\tvar pullRequest github.PullRequestEvent\n\tif err := json.Unmarshal(payload, &pullRequest); err != nil {\n\t\treturn false, err\n\t}\n\n\tlogin := pullRequest.GetPullRequest().GetUser().GetLogin()\n\tif !checksEnabledForUser(api, login) {\n\t\tlog.Infof(\"Checks not enabled for sender %s\", login)\n\n\t\treturn false, nil\n\t}\n\n\tswitch pullRequest.GetAction() {\n\tcase \"opened\", \"synchronize\":\n\t\tbreak\n\tdefault:\n\t\tlog.Debugf(\"Skipping pull request action %s\", pullRequest.GetAction())\n\n\t\treturn false, nil\n\t}\n\n\tsha := pullRequest.GetPullRequest().GetHead().GetSHA()\n\tdestRepoID := pullRequest.GetPullRequest().GetBase().GetRepo().GetID()\n\tif destRepoID == wptRepoID && pullRequest.GetPullRequest().GetHead().GetRepo().GetID() != destRepoID {\n\t\t// Pull is across forks; request a check suite on the main fork too.\n\t\tappID, installationID := api.GetWPTRepoAppInstallationIDs()\n\n\t\treturn api.CreateWPTCheckSuite(appID, installationID, sha, pullRequest.GetNumber())\n\t}\n\n\treturn false, nil\n}\n\nfunc scheduleProcessingForExistingRuns(ctx context.Context, sha string, products ...shared.ProductSpec) (bool, error) {\n\t// Jump straight to completed check_run for already-present runs for the SHA.\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tproducts = shared.ProductSpecs(products).OrDefault()\n\trunsByProduct, err := store.TestRunQuery().LoadTestRuns(products, nil, shared.SHAs{sha}, nil, nil, nil, nil)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to load test runs: %s\", err.Error())\n\t}\n\tcreatedSome := false\n\tapi := NewAPI(ctx)\n\tfor _, rbp := range runsByProduct {\n\t\tif len(rbp.TestRuns) > 0 {\n\t\t\terr := api.ScheduleResultsProcessing(sha, rbp.Product)\n\t\t\tcreatedSome = createdSome || err == nil\n\t\t\tif err != nil {\n\t\t\t\treturn createdSome, err\n\t\t\t}\n\t\t}\n\t}\n\n\treturn createdSome, nil\n}\n\n// createCheckRun submits an http POST to create the check run on GitHub, handling JWT auth for the app.\nfunc createCheckRun(ctx context.Context, suite shared.CheckSuite, opts github.CreateCheckRunOptions) (bool, error) {\n\tlog := shared.GetLogger(ctx)\n\tstatus := \"\"\n\tif opts.Status != nil {\n\t\tstatus = *opts.Status\n\t}\n\tlog.Debugf(\"Creating %s %s check_run for %s/%s @ %s\", status, opts.Name, suite.Owner, suite.Repo, suite.SHA)\n\tif suite.AppID == 0 {\n\t\tsuite.AppID = wptfyiStagingCheckAppID\n\t}\n\tclient, err := getGitHubClient(ctx, suite.AppID, suite.InstallationID)\n\tif err != nil {\n\t\tlog.Errorf(\"Failed to create JWT client: %s\", err.Error())\n\n\t\treturn false, err\n\t}\n\n\tcheckRun, resp, err := client.Checks.CreateCheckRun(ctx, suite.Owner, suite.Repo, opts)\n\tif err != nil {\n\t\tmsg := \"Failed to create check_run\"\n\t\tif resp != nil {\n\t\t\tmsg = fmt.Sprintf(\"%s: %s\", msg, resp.Status)\n\t\t}\n\t\tlog.Warningf(\"%s\", msg)\n\n\t\treturn false, err\n\t} else if checkRun != nil {\n\t\tlog.Infof(\"Created check_run %v\", checkRun.GetID())\n\t}\n\n\treturn true, nil\n}\n\n// checksEnabledForUser returns if a commit from a given GitHub username should\n// cause wpt.fyi or staging.wpt.fyi summary results to show up in the GitHub\n// UI. Currently this is enabled for all users on prod, but only for some users\n// on staging to avoid having a confusing double-set of checks appear.\nfunc checksEnabledForUser(api API, login string) bool {\n\tif api.IsFeatureEnabled(checksForAllUsersFeature) {\n\t\treturn true\n\t}\n\tenabledLogins := []string{\n\t\t\"chromium-wpt-export-bot\",\n\t\t\"gsnedders\",\n\t\t\"jgraham\",\n\t\t\"jugglinmike\",\n\t\t\"lukebjerring\",\n\t\t\"Ms2ger\",\n\t}\n\n\treturn shared.StringSliceContains(enabledLogins, login)\n}\n" }, { "path": "api/checks/webhook_test.go", "content": "//go:build small\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\npackage checks\n\nimport (\n\t\"encoding/json\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/api/checks/mock_checks\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n\t\"go.uber.org/mock/gomock\"\n)\n\nfunc TestHandleCheckRunEvent_InvalidApp(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tid := int64(123)\n\tchrome := \"chrome\"\n\tevent := github.CheckRunEvent{\n\t\tCheckRun: &github.CheckRun{\n\t\t\tApp: &github.App{\n\t\t\t\tID: &id,\n\t\t\t},\n\t\t\tName: &chrome,\n\t\t},\n\t}\n\tpayload, _ := json.Marshal(event)\n\n\tapi := mock_checks.NewMockAPI(mockCtrl)\n\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\n\tprocessed, err := handleCheckRunEvent(api, payload)\n\tassert.Nil(t, err)\n\tassert.False(t, processed)\n}\n\nfunc TestHandleCheckRunEvent_Created_Completed(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tsha := strings.Repeat(\"1234567890\", 4)\n\tevent := getCheckRunCreatedEvent(\"completed\", \"lukebjerring\", sha)\n\tpayload, _ := json.Marshal(event)\n\n\tapi := mock_checks.NewMockAPI(mockCtrl)\n\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\n\tprocessed, err := handleCheckRunEvent(api, payload)\n\tassert.Nil(t, err)\n\tassert.False(t, processed)\n}\n\nfunc TestHandleCheckRunEvent_Created_Pending_ChecksNotEnabledForUser(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tsha := strings.Repeat(\"0123456789\", 4)\n\tevent := getCheckRunCreatedEvent(\"pending\", \"user-without-checks\", sha)\n\tpayload, _ := json.Marshal(event)\n\n\tapi := mock_checks.NewMockAPI(mockCtrl)\n\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\n\tprocessed, err := handleCheckRunEvent(api, payload)\n\tassert.Nil(t, err)\n\tassert.False(t, processed)\n}\n\nfunc TestHandleCheckRunEvent_Created_Pending(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tsha := strings.Repeat(\"0123456789\", 4)\n\tevent := getCheckRunCreatedEvent(\"pending\", \"lukebjerring\", sha)\n\tpayload, _ := json.Marshal(event)\n\n\tapi := mock_checks.NewMockAPI(mockCtrl)\n\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\tapi.EXPECT().ScheduleResultsProcessing(sha, sharedtest.SameProductSpec(\"chrome\")).Return(nil)\n\n\tprocessed, err := handleCheckRunEvent(api, payload)\n\tassert.Nil(t, err)\n\tassert.True(t, processed)\n}\n\nfunc TestHandleCheckRunEvent_ActionRequested_Ignore(t *testing.T) {\n\tfor _, prefix := range []string{\"staging.wpt.fyi - \", \"wpt.fyi - \", \"\"} {\n\t\tt.Run(prefix, func(t *testing.T) {\n\t\t\tmockCtrl := gomock.NewController(t)\n\t\t\tdefer mockCtrl.Finish()\n\n\t\t\tid := int64(wptfyiStagingCheckAppID)\n\t\t\tsha := strings.Repeat(\"0123456789\", 4)\n\t\t\tname := prefix + \"chrome\"\n\t\t\trequestedAction := \"requested_action\"\n\t\t\tpending := \"pending\"\n\t\t\tusername := \"lukebjerring\"\n\t\t\towner := shared.WPTRepoOwner\n\t\t\trepo := shared.WPTRepoName\n\t\t\tappID := int64(wptfyiStagingCheckAppID)\n\t\t\tevent := github.CheckRunEvent{\n\t\t\t\tAction: &requestedAction,\n\t\t\t\tCheckRun: &github.CheckRun{\n\t\t\t\t\tApp: &github.App{ID: &id},\n\t\t\t\t\tName: &name,\n\t\t\t\t\tStatus: &pending,\n\t\t\t\t\tHeadSHA: &sha,\n\t\t\t\t},\n\t\t\t\tRepo: &github.Repository{\n\t\t\t\t\tOwner: &github.User{Login: &owner},\n\t\t\t\t\tName: &repo,\n\t\t\t\t},\n\t\t\t\tRequestedAction: &github.RequestedAction{Identifier: \"ignore\"},\n\t\t\t\tInstallation: &github.Installation{AppID: &appID},\n\t\t\t\tSender: &github.User{Login: &username},\n\t\t\t}\n\t\t\tpayload, _ := json.Marshal(event)\n\n\t\t\tapi := mock_checks.NewMockAPI(mockCtrl)\n\t\t\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\t\t\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\t\t\tapi.EXPECT().IgnoreFailure(username, owner, repo, event.GetCheckRun(), event.GetInstallation())\n\n\t\t\tprocessed, err := handleCheckRunEvent(api, payload)\n\t\t\tassert.Nil(t, err)\n\t\t\tassert.True(t, processed)\n\t\t})\n\t}\n}\n\nfunc TestHandleCheckRunEvent_ActionRequested_Recompute(t *testing.T) {\n\tfor _, prefix := range []string{\"staging.wpt.fyi - \", \"wpt.fyi - \", \"\"} {\n\t\tt.Run(prefix, func(t *testing.T) {\n\t\t\tmockCtrl := gomock.NewController(t)\n\t\t\tdefer mockCtrl.Finish()\n\n\t\t\tid := int64(wptfyiStagingCheckAppID)\n\t\t\tsha := strings.Repeat(\"0123456789\", 4)\n\t\t\tname := prefix + \"chrome[experimental]\"\n\t\t\trequestedAction := \"requested_action\"\n\t\t\tpending := \"pending\"\n\t\t\tusername := \"lukebjerring\"\n\t\t\towner := shared.WPTRepoOwner\n\t\t\trepo := shared.WPTRepoName\n\t\t\tappID := int64(wptfyiStagingCheckAppID)\n\t\t\tevent := github.CheckRunEvent{\n\t\t\t\tAction: &requestedAction,\n\t\t\t\tCheckRun: &github.CheckRun{\n\t\t\t\t\tApp: &github.App{ID: &id},\n\t\t\t\t\tName: &name,\n\t\t\t\t\tStatus: &pending,\n\t\t\t\t\tHeadSHA: &sha,\n\t\t\t\t},\n\t\t\t\tRepo: &github.Repository{\n\t\t\t\t\tOwner: &github.User{Login: &owner},\n\t\t\t\t\tName: &repo,\n\t\t\t\t},\n\t\t\t\tRequestedAction: &github.RequestedAction{Identifier: \"recompute\"},\n\t\t\t\tInstallation: &github.Installation{AppID: &appID},\n\t\t\t\tSender: &github.User{Login: &username},\n\t\t\t}\n\t\t\tpayload, _ := json.Marshal(event)\n\n\t\t\tapi := mock_checks.NewMockAPI(mockCtrl)\n\t\t\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\t\t\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\t\t\tapi.EXPECT().ScheduleResultsProcessing(sha, sharedtest.SameProductSpec(\"chrome[experimental]\")).Return(nil)\n\n\t\t\tprocessed, err := handleCheckRunEvent(api, payload)\n\t\t\tassert.Nil(t, err)\n\t\t\tassert.True(t, processed)\n\t\t})\n\t}\n}\n\nfunc TestHandleCheckRunEvent_ActionRequested_Cancel(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tsha := strings.Repeat(\"0123456789\", 4)\n\tusername := \"lukebjerring\"\n\tevent := getCheckRunCreatedEvent(\"completed\", username, sha)\n\trequestedAction := \"requested_action\"\n\tevent.Action = &requestedAction\n\tevent.RequestedAction = &github.RequestedAction{Identifier: \"cancel\"}\n\tpayload, _ := json.Marshal(event)\n\n\tapi := mock_checks.NewMockAPI(mockCtrl)\n\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\tapi.EXPECT().CancelRun(username, shared.WPTRepoOwner, shared.WPTRepoName, event.GetCheckRun(), event.GetInstallation())\n\n\tprocessed, err := handleCheckRunEvent(api, payload)\n\tassert.Nil(t, err)\n\tassert.True(t, processed)\n}\n\nfunc getCheckRunCreatedEvent(status, sender, sha string) github.CheckRunEvent {\n\tid := int64(wptfyiStagingCheckAppID)\n\tchrome := \"chrome\"\n\tcreated := \"created\"\n\trepoName := shared.WPTRepoName\n\trepoOwner := shared.WPTRepoOwner\n\treturn github.CheckRunEvent{\n\t\tAction: &created,\n\t\tCheckRun: &github.CheckRun{\n\t\t\tApp: &github.App{ID: &id},\n\t\t\tName: &chrome,\n\t\t\tStatus: &status,\n\t\t\tHeadSHA: &sha,\n\t\t},\n\t\tRepo: &github.Repository{\n\t\t\tName: &repoName,\n\t\t\tOwner: &github.User{Login: &repoOwner},\n\t\t},\n\t\tSender: &github.User{Login: &sender},\n\t}\n}\n\nfunc TestHandlePullRequestEvent_ChecksNotEnabledForUser(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tsha := strings.Repeat(\"1234567890\", 4)\n\tevent := getOpenedPREvent(\"user-without-checks\", sha)\n\tpayload, _ := json.Marshal(event)\n\n\tapi := mock_checks.NewMockAPI(mockCtrl)\n\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\n\tprocessed, err := handlePullRequestEvent(api, payload)\n\tassert.Nil(t, err)\n\tassert.False(t, processed)\n}\n\nfunc TestHandlePullRequestEvent_ChecksEnabledForUser(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tsha := strings.Repeat(\"1234567890\", 4)\n\tevent := getOpenedPREvent(\"lukebjerring\", sha)\n\tpayload, _ := json.Marshal(event)\n\n\tapi := mock_checks.NewMockAPI(mockCtrl)\n\tapi.EXPECT().Context().AnyTimes().Return(sharedtest.NewTestContext())\n\tapi.EXPECT().IsFeatureEnabled(checksForAllUsersFeature).Return(false)\n\tapi.EXPECT().GetWPTRepoAppInstallationIDs().Return(wptfyiStagingCheckAppID, wptRepoStagingInstallationID)\n\tapi.EXPECT().CreateWPTCheckSuite(wptfyiStagingCheckAppID, wptRepoStagingInstallationID, sha, 123).Return(true, nil)\n\n\tprocessed, err := handlePullRequestEvent(api, payload)\n\tassert.Nil(t, err)\n\tassert.True(t, processed)\n}\n\nfunc getOpenedPREvent(user, sha string) github.PullRequestEvent {\n\topened := \"opened\"\n\t// handlePullRequestEvent only operates on pull requests from forks, so\n\t// the head repo must be different from the base.\n\theadRepoID := wptRepoID - 1\n\tbaseRepoID := wptRepoID\n\tnumber := 123\n\treturn github.PullRequestEvent{\n\t\tNumber: &number,\n\t\tPullRequest: &github.PullRequest{\n\t\t\tUser: &github.User{Login: &user},\n\t\t\tHead: &github.PullRequestBranch{\n\t\t\t\tSHA: &sha,\n\t\t\t\tRepo: &github.Repository{ID: &headRepoID},\n\t\t\t},\n\t\t\tBase: &github.PullRequestBranch{\n\t\t\t\tRepo: &github.Repository{ID: &baseRepoID},\n\t\t\t},\n\t\t},\n\t\tAction: &opened,\n\t}\n}\n" }, { "path": "api/diff.go", "content": "package api //nolint:revive\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/url\"\n\n\tmapset \"github.com/deckarep/golang-set\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// apiDiffHandler takes 2 test-run results JSON blobs and produces JSON in the same format, with only the differences\n// between runs.\n//\n// GET takes before and after params, for historical production runs.\n// POST takes only a before param, and the after state is provided in the body of the POST request.\nfunc apiDiffHandler(w http.ResponseWriter, r *http.Request) {\n\tswitch r.Method {\n\tcase http.MethodGet:\n\t\thandleAPIDiffGet(w, r)\n\tcase http.MethodPost:\n\t\thandleAPIDiffPost(w, r)\n\tdefault:\n\t\thttp.Error(w, fmt.Sprintf(\"invalid HTTP method %s\", r.Method), http.StatusBadRequest)\n\t}\n}\n\nfunc loadDiffRuns(store shared.Datastore, q url.Values) (shared.TestRuns, error) {\n\t// nolint:nestif // TODO: Fix nestif lint error\n\tif runIDs, err := shared.ParseRunIDsParam(q); err != nil {\n\t\treturn nil, err\n\t} else if len(runIDs) > 0 {\n\t\truns, err := runIDs.LoadTestRuns(store)\n\t\t// If all errors are NoSuchEntity, we don't treat it as an error.\n\t\t// If err is nil, the type conversion will fail.\n\t\tvar multiError *shared.MultiError\n\t\tif errors.As(err, &multiError) {\n\t\t\tall404s := true\n\t\t\tfor _, err := range multiError.Errors() {\n\t\t\t\tif !errors.Is(err, shared.ErrNoSuchEntity) {\n\t\t\t\t\tall404s = false\n\n\t\t\t\t\tbreak\n\t\t\t\t}\n\t\t\t}\n\t\t\tif all404s {\n\t\t\t\treturn nil, nil\n\t\t\t}\n\t\t}\n\t\tif err != nil {\n\t\t\treturn nil, err\n\t\t}\n\n\t\treturn runs, nil\n\t}\n\n\t// NOTE: We use the same params as /results, but also support\n\t// 'before' and 'after' and 'filter'.\n\trunFilter, err := shared.ParseTestRunFilterParams(q)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\tif beforeAndAfter, err := shared.ParseBeforeAndAfterParams(q); err != nil {\n\t\treturn nil, err\n\t} else if len(beforeAndAfter) > 0 {\n\t\trunFilter.Products = beforeAndAfter\n\t}\n\trunsByProduct, err := LoadTestRunsForFilters(store, runFilter)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn runsByProduct.AllRuns(), nil\n}\n\nfunc handleAPIDiffGet(w http.ResponseWriter, r *http.Request) {\n\tctx := r.Context()\n\tstore := shared.NewAppEngineDatastore(ctx, true)\n\tq := r.URL.Query()\n\n\tdiffFilter, paths, err := shared.ParseDiffFilterParams(q)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\truns, err := loadDiffRuns(store, q)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\tif runs == nil {\n\t\thttp.NotFound(w, r)\n\n\t\treturn\n\t}\n\n\tif len(runs) != 2 {\n\t\thttp.Error(w, fmt.Sprintf(\"Diffing requires exactly 2 runs, but found %v\", len(runs)), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tdiffAPI := shared.NewDiffAPI(ctx)\n\tdiff, err := diffAPI.GetRunsDiff(runs[0], runs[1], diffFilter, paths)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tvar bytes []byte\n\tif bytes, err = json.Marshal(diff); err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\t_, err = w.Write(bytes)\n\t// nolint:godox // TODO: Golangci-lint found that we previously ignored the error.\n\t// We should investigate if we should return a HTTP error or not. In the meantime, we log the error.\n\tif err != nil {\n\t\tlogger := shared.GetLogger(r.Context())\n\t\tlogger.Warningf(\"Failed to write data in api/diff GET handler: %s\", err.Error())\n\t}\n}\n\n// handleAPIDiffPost handles POST requests to /api/diff, which allows the caller to produce the diff of an arbitrary\n// run result JSON blob against a historical production run.\nfunc handleAPIDiffPost(w http.ResponseWriter, r *http.Request) {\n\tctx := r.Context()\n\n\tparams, err := url.ParseQuery(r.URL.RawQuery)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tspecBefore := params.Get(\"before\")\n\tif specBefore == \"\" {\n\t\thttp.Error(w, \"before param missing\", http.StatusBadRequest)\n\n\t\treturn\n\t}\n\tvar beforeJSON shared.ResultsSummary\n\tif beforeJSON, err = shared.FetchRunResultsJSONForParam(ctx, r, specBefore); err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t} else if beforeJSON == nil {\n\t\thttp.Error(w, specBefore+\" not found\", http.StatusNotFound)\n\n\t\treturn\n\t}\n\n\tvar body []byte\n\tif body, err = io.ReadAll(r.Body); err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tvar afterJSON shared.ResultsSummary\n\tif err := json.Unmarshal(body, &afterJSON); err != nil {\n\t\thttp.Error(w, \"Failed to parse JSON: \"+err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tvar filter shared.DiffFilterParam\n\tvar paths mapset.Set\n\tif filter, paths, err = shared.ParseDiffFilterParams(params); err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tdiffJSON := shared.GetResultsDiff(beforeJSON, afterJSON, filter, paths, nil)\n\tvar bytes []byte\n\tif bytes, err = json.Marshal(diffJSON); err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\t_, err = w.Write(bytes)\n\tif err != nil {\n\t\tlogger := shared.GetLogger(r.Context())\n\t\tlogger.Warningf(\"Failed to write data in api/diff POST handler: %s\", err.Error())\n\t}\n}\n" }, { "path": "api/ghactions/notify.go", "content": "// Copyright 2024 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage ghactions\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"regexp\"\n\t\"strconv\"\n\n\tmapset \"github.com/deckarep/golang-set\"\n\t\"github.com/gobwas/glob\"\n\t\"github.com/google/go-github/v84/github\"\n\tuc \"github.com/web-platform-tests/wpt.fyi/api/receiver/client\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nconst uploaderName = \"github-actions\"\n\nvar (\n\tprHeadRegex = regexp.MustCompile(`\\baffected-tests$`)\n\tprBaseRegex = regexp.MustCompile(`\\baffected-tests-without-changes$`)\n\tepochBranchesRegex = regexp.MustCompile(\"^epochs/.*\")\n)\n\nfunc notifyHandler(w http.ResponseWriter, r *http.Request) {\n\trawRunID := r.FormValue(\"run_id\")\n\tvar runID int64\n\tvar err error\n\tif runID, err = strconv.ParseInt(rawRunID, 0, 0); err != nil {\n\t\thttp.Error(w, fmt.Sprintf(\"Invalid run id: %s\", rawRunID), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\towner := r.FormValue(\"owner\")\n\trepo := r.FormValue(\"repo\")\n\n\tif owner != shared.WPTRepoOwner || repo != shared.WPTRepoName {\n\t\thttp.Error(w, fmt.Sprintf(\"Invalid repo: %s/%s\", owner, repo), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tartifactName := r.FormValue(\"artifact_name\")\n\tartifactNameGlob, err := glob.Compile(artifactName)\n\tif err != nil {\n\t\thttp.Error(w, fmt.Sprintf(\"Invalid artifact name: %s\", artifactName), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tctx := r.Context()\n\taeAPI := shared.NewAppEngineAPI(ctx)\n\tlog := shared.GetLogger(ctx)\n\n\tghClient, err := aeAPI.GetGitHubClient()\n\tif err != nil {\n\t\tlog.Errorf(\"Failed to get GitHub client: %s\", err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tprocessed, err := processBuild(\n\t\tctx,\n\t\taeAPI,\n\t\tghClient,\n\t\towner,\n\t\trepo,\n\t\trunID,\n\t\tartifactNameGlob,\n\t)\n\n\tif err != nil {\n\t\tlog.Errorf(\"%v\", err.Error())\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tif processed {\n\t\tw.WriteHeader(http.StatusOK)\n\t\tfmt.Fprintln(w, \"GitHub Actions workflow run artifacts retrieved successfully\")\n\t} else {\n\t\tw.WriteHeader(http.StatusNoContent)\n\t\tfmt.Fprintln(w, \"Notification of workflow run artifacts was ignored\")\n\t}\n}\n\nfunc processBuild(\n\tctx context.Context,\n\taeAPI shared.AppEngineAPI,\n\tghClient *github.Client,\n\towner string,\n\trepo string,\n\trunID int64,\n\tartifactNameGlob glob.Glob,\n) (bool, error) {\n\tlog := shared.GetLogger(ctx)\n\n\tworkflowRun, _, err := ghClient.Actions.GetWorkflowRunByID(ctx, owner, repo, runID)\n\tif err != nil {\n\t\treturn false, err\n\t}\n\n\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\topts := &github.ListOptions{PerPage: 100}\n\n\tarchiveURLs := []string{}\n\n\tvar labels mapset.Set\n\n\tfor {\n\t\tartifacts, resp, err := ghClient.Actions.ListWorkflowRunArtifacts(ctx, owner, repo, runID, opts)\n\n\t\tif err != nil {\n\t\t\treturn false, err\n\t\t}\n\n\t\tfor _, artifact := range artifacts.Artifacts {\n\n\t\t\tif !artifactNameGlob.Match(*artifact.Name) {\n\t\t\t\tlog.Infof(\"Skipping artifact %s\", *artifact.Name)\n\n\t\t\t\tcontinue\n\t\t\t}\n\n\t\t\tlog.Infof(\"Adding %s for %s/%s run %v to upload...\", *artifact.Name, owner, repo, runID)\n\n\t\t\t// Set the labels based on the first artifact we find.\n\t\t\tif len(archiveURLs) == 0 {\n\t\t\t\tlabels = chooseLabels(workflowRun, *artifact.Name, owner, repo)\n\t\t\t}\n\n\t\t\tarchiveURLs = append(archiveURLs, *artifact.ArchiveDownloadURL)\n\t\t}\n\n\t\tif resp.NextPage == 0 {\n\t\t\tbreak\n\t\t}\n\t\topts.Page = resp.NextPage\n\t}\n\n\tvar sha string\n\tif *workflowRun.Event == \"pull_request\" {\n\t\tsha = *workflowRun.HeadSHA\n\t}\n\n\tuploader, err := aeAPI.GetUploader(uploaderName)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to get uploader creds from Datastore: %w\", err)\n\t}\n\n\tuploadClient := uc.NewClient(aeAPI)\n\terr = uploadClient.CreateRun(\n\t\tsha,\n\t\tuploader.Username,\n\t\tuploader.Password,\n\t\tnil,\n\t\tnil,\n\t\tarchiveURLs,\n\t\tshared.ToStringSlice(labels))\n\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"failed to create run: %w\", err)\n\t}\n\n\treturn true, nil\n}\n\nfunc chooseLabels( // nolint:ireturn // TODO: Fix ireturn lint error\n\tworkflowRun *github.WorkflowRun,\n\tartifactName string,\n\towner string,\n\trepo string,\n) mapset.Set {\n\tlabels := mapset.NewSet()\n\n\t// We don't actually check the event here, provided it meets\n\t// the criteria to be a run on master.\n\tif (*workflowRun.HeadRepository.Owner.Login == owner &&\n\t\t*workflowRun.HeadRepository.Name == repo) &&\n\t\t(*workflowRun.HeadBranch == \"master\" ||\n\t\t\tepochBranchesRegex.MatchString(*workflowRun.HeadBranch)) {\n\t\tlabels.Add(shared.MasterLabel)\n\t} else if *workflowRun.Event == \"pull_request\" {\n\t\tif prHeadRegex.MatchString(artifactName) {\n\t\t\tlabels.Add(shared.PRHeadLabel)\n\t\t} else if prBaseRegex.MatchString(artifactName) {\n\t\t\tlabels.Add(shared.PRBaseLabel)\n\t\t}\n\t}\n\n\treturn labels\n}\n" }, { "path": "api/ghactions/notify_test.go", "content": "//go:build small\n\n// Copyright 2024 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage ghactions\n\nimport (\n\t\"testing\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc PointerTo[T any](v T) *T {\n\treturn &v\n}\n\nfunc TestArtifactRegexes(t *testing.T) {\n\tassert.True(t, prHeadRegex.MatchString(\"safari-preview-1-affected-tests\"))\n\tassert.True(t, prBaseRegex.MatchString(\"safari-preview-1-affected-tests-without-changes\"))\n\n\t// Base and Head could be confused with substring matching\n\tassert.False(t, prBaseRegex.MatchString(\"safari-preview-1-affected-tests\"))\n\tassert.False(t, prHeadRegex.MatchString(\"safari-preview-1-affected-tests-without-changes\"))\n}\n\nfunc TestEpochBranchesRegex(t *testing.T) {\n\tassert.True(t, epochBranchesRegex.MatchString(\"epochs/twelve_hourly\"))\n\tassert.True(t, epochBranchesRegex.MatchString(\"epochs/six_hourly\"))\n\tassert.True(t, epochBranchesRegex.MatchString(\"epochs/weekly\"))\n\tassert.True(t, epochBranchesRegex.MatchString(\"epochs/daily\"))\n\n\tassert.False(t, epochBranchesRegex.MatchString(\"weekly\"))\n\tassert.False(t, epochBranchesRegex.MatchString(\"a/epochs/weekly\"))\n}\n\nfunc TestChooseLabels(t *testing.T) {\n\twptOrgUser := github.User{\n\t\tLogin: PointerTo(\"web-platform-tests\"),\n\t}\n\n\totherUser := github.User{\n\t\tLogin: PointerTo(\"xxx\"),\n\t}\n\n\twptRepo := github.Repository{\n\t\tName: PointerTo(\"wpt\"),\n\t\tFullName: PointerTo(\"web-platform-tests/wpt\"),\n\t\tOwner: &wptOrgUser,\n\t}\n\n\totherRepo := github.Repository{\n\t\tName: PointerTo(\"wpt\"),\n\t\tFullName: PointerTo(\"xxx/wpt\"),\n\t\tOwner: &otherUser,\n\t}\n\n\tmasterWorkflowRun := github.WorkflowRun{\n\t\tHeadBranch: PointerTo(\"master\"),\n\t\tEvent: PointerTo(\"push\"),\n\t\tStatus: PointerTo(\"completed\"),\n\t\tConclusion: PointerTo(\"success\"),\n\t\tHeadSHA: PointerTo(\"74dc6f6f5b2ba16940e6b6075f0faf311361dbb2\"),\n\t\tRepository: &wptRepo,\n\t\tHeadRepository: &wptRepo,\n\t}\n\n\tmasterOtherWorkflowRun := github.WorkflowRun{\n\t\tHeadBranch: PointerTo(\"master\"),\n\t\tEvent: PointerTo(\"push\"),\n\t\tStatus: PointerTo(\"completed\"),\n\t\tConclusion: PointerTo(\"success\"),\n\t\tHeadSHA: PointerTo(\"74dc6f6f5b2ba16940e6b6075f0faf311361dbb2\"),\n\t\tRepository: &otherRepo,\n\t\tHeadRepository: &otherRepo,\n\t}\n\n\tprWorkflowRun := github.WorkflowRun{\n\t\tHeadBranch: PointerTo(\"new-branch\"),\n\t\tEvent: PointerTo(\"pull_request\"),\n\t\tStatus: PointerTo(\"completed\"),\n\t\tConclusion: PointerTo(\"success\"),\n\t\tHeadSHA: PointerTo(\"74dc6f6f5b2ba16940e6b6075f0faf311361dbb2\"),\n\t\tRepository: &wptRepo,\n\t\tHeadRepository: &wptRepo,\n\t}\n\n\tprOtherWorkflowRun := github.WorkflowRun{\n\t\tHeadBranch: PointerTo(\"master\"),\n\t\tEvent: PointerTo(\"pull_request\"),\n\t\tStatus: PointerTo(\"completed\"),\n\t\tConclusion: PointerTo(\"success\"),\n\t\tHeadSHA: PointerTo(\"74dc6f6f5b2ba16940e6b6075f0faf311361dbb2\"),\n\t\tRepository: &wptRepo,\n\t\tHeadRepository: &otherRepo,\n\t}\n\n\tassert.ElementsMatch(\n\t\tt,\n\t\tchooseLabels(&masterWorkflowRun, \"results-safari-1\", \"web-platform-tests\", \"wpt\").ToSlice(),\n\t\t[]string{\"master\"},\n\t)\n\n\tassert.ElementsMatch(t,\n\t\tchooseLabels(&masterOtherWorkflowRun, \"results-safari-1\", \"web-platform-tests\", \"wpt\").ToSlice(),\n\t\t[]string{},\n\t)\n\n\tassert.ElementsMatch(t,\n\t\tchooseLabels(&prWorkflowRun, \"results-safari-1\", \"web-platform-tests\", \"wpt\").ToSlice(),\n\t\t[]string{},\n\t)\n\n\tassert.ElementsMatch(t,\n\t\tchooseLabels(&prOtherWorkflowRun, \"results-safari-1\", \"web-platform-tests\", \"wpt\").ToSlice(),\n\t\t[]string{},\n\t)\n\n\tassert.ElementsMatch(\n\t\tt,\n\t\tchooseLabels(&prWorkflowRun, \"results-safari-1-affected-tests\", \"web-platform-tests\", \"wpt\").ToSlice(),\n\t\t[]string{\"pr_head\"},\n\t)\n\n\tassert.ElementsMatch(t,\n\t\tchooseLabels(&prOtherWorkflowRun, \"results-safari-1-affected-tests-without-changes\", \"web-platform-tests\", \"wpt\").ToSlice(),\n\t\t[]string{\"pr_base\"},\n\t)\n}\n" }, { "path": "api/ghactions/routes.go", "content": "// Copyright 2024 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage ghactions\n\nimport \"github.com/web-platform-tests/wpt.fyi/shared\"\n\n// RegisterRoutes adds all the api route handlers.\nfunc RegisterRoutes() {\n\t// notifyHandler exposes an endpoint for notifying wpt.fyi that it can collect\n\t// the results of a GitHub Actions workflow run.\n\t// The endpoint is insecure, because we'll only try to fetch (specifically) a\n\t// web-platform-tests/wpt build with the given ID.\n\tshared.AddRoute(\"/api/checks/github-actions/\", \"github-actions-notify\", notifyHandler).Methods(\"POST\")\n}\n" }, { "path": "api/labels.go", "content": "// Copyright 2019 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"sort\"\n\t\"time\"\n\n\tmapset \"github.com/deckarep/golang-set\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// LabelsHandler is an http.Handler for the /api/labels endpoint.\ntype LabelsHandler struct {\n\tctx context.Context // nolint:containedctx // TODO: Fix containedctx lint error\n}\n\n// apiLabelsHandler is responsible for emitting just all labels used for test runs.\nfunc apiLabelsHandler(w http.ResponseWriter, r *http.Request) {\n\t// Serve cached with 5 minute expiry. Delegate to LabelsHandler on cache miss.\n\tctx := r.Context()\n\tshared.NewCachingHandler(\n\t\tctx,\n\t\tLabelsHandler{ctx},\n\t\tshared.NewGZReadWritable(shared.NewRedisReadWritable(ctx, 5*time.Minute)),\n\t\tshared.AlwaysCachable,\n\t\tshared.URLAsCacheKey,\n\t\tshared.CacheStatusOK,\n\t).ServeHTTP(w, r)\n}\n\nfunc (h LabelsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {\n\tstore := shared.NewAppEngineDatastore(h.ctx, false)\n\tvar runs shared.TestRuns\n\t_, err := store.GetAll(store.NewQuery(\"TestRun\").Project(\"Labels\").Distinct(), &runs)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tall := mapset.NewSet()\n\tfor _, run := range runs {\n\t\tfor _, label := range run.Labels {\n\t\t\tall.Add(label)\n\t\t}\n\t}\n\tlabels := shared.ToStringSlice(all)\n\tsort.Strings(labels)\n\tdata, err := json.Marshal(labels)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\t_, err = w.Write(data)\n\tif err != nil {\n\t\tlogger := shared.GetLogger(r.Context())\n\t\tlogger.Warningf(\"Failed to write data in api/labels handler: %s\", err.Error())\n\t}\n}\n" }, { "path": "api/labels_medium_test.go", "content": "//go:build medium\n\n// Copyright 2019 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n)\n\nfunc TestLabelsHandler(t *testing.T) {\n\tctx, done, err := sharedtest.NewAEContext(true)\n\tassert.Nil(t, err)\n\tdefer done()\n\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tkey := store.NewIncompleteKey(\"TestRun\")\n\t_, err = store.Put(key, &shared.TestRun{Labels: []string{\"b\", \"c\"}})\n\t_, err = store.Put(key, &shared.TestRun{Labels: []string{\"b\", \"a\"}})\n\tassert.Nil(t, err)\n\n\thandler := LabelsHandler{ctx: ctx}\n\tw := httptest.NewRecorder()\n\tr := httptest.NewRequest(\"GET\", \"/api/labels\", nil)\n\thandler.ServeHTTP(w, r)\n\tlabels := parseLabelsResponse(t, w)\n\tassert.Equal(t, labels, []string{\"a\", \"b\", \"c\"}) // Ordered and deduped\n}\n\nfunc parseLabelsResponse(t *testing.T, w *httptest.ResponseRecorder) []string {\n\tassert.Equal(t, http.StatusOK, w.Result().StatusCode)\n\tout, _ := io.ReadAll(w.Body)\n\tvar labels []string\n\tjson.Unmarshal(out, &labels)\n\treturn labels\n}\n" }, { "path": "api/manifest/api.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\n//go:generate mockgen -build_flags=--mod=mod -destination mock_manifest/api_mock.go github.com/web-platform-tests/wpt.fyi/api/manifest API\n\npackage manifest\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"io\"\n\t\"regexp\"\n\t\"time\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// AssetRegex is the pattern for a valid manifest filename.\n// The full sha is captured in group 1.\nvar AssetRegex = regexp.MustCompile(`^MANIFEST-([0-9a-fA-F]{40}).json.gz$`)\n\n// API handles manifest-related fetches and caching.\ntype API interface {\n\tGetManifestForSHA(string) (string, []byte, error)\n\tNewRedis(duration time.Duration) shared.ReadWritable\n}\n\ntype apiImpl struct {\n\tctx context.Context // nolint:containedctx // TODO: Fix containedctx lint error\n}\n\n// NewAPI returns an API implementation for the given context.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc NewAPI(ctx context.Context) API {\n\treturn apiImpl{\n\t\tctx: ctx,\n\t}\n}\n\n// GetManifestForSHA loads the (gzipped) contents of the manifest JSON for the release associated\n// with the given SHA, if any.\nfunc (a apiImpl) GetManifestForSHA(sha string) (fetchedSHA string, manifest []byte, err error) {\n\taeAPI := shared.NewAppEngineAPI(a.ctx)\n\tfetchedSHA, body, err := getGitHubReleaseAssetForSHA(aeAPI, sha)\n\tif err != nil {\n\t\treturn fetchedSHA, nil, err\n\t}\n\tdata, err := io.ReadAll(body)\n\tif err != nil {\n\t\treturn fetchedSHA, nil, err\n\t}\n\n\treturn fetchedSHA, data, err\n}\n\n// getGitHubReleaseAssetForSHA gets the bytes for the SHA's release's manifest json gzip asset.\n// This is done using a few hops on the GitHub API, so should be cached afterward.\nfunc getGitHubReleaseAssetForSHA(aeAPI shared.AppEngineAPI, sha string) (\n\tfetchedSHA string,\n\tmanifest io.Reader,\n\terr error,\n) {\n\tclient, err := aeAPI.GetGitHubClient()\n\tif err != nil {\n\t\treturn \"\", nil, err\n\t}\n\tvar release *github.RepositoryRelease\n\treleaseTag := \"latest\"\n\tif shared.IsLatest(sha) {\n\t\t// Use GitHub's API for latest release.\n\t\trelease, _, err = client.Repositories.GetLatestRelease(aeAPI.Context(), shared.WPTRepoOwner, shared.WPTRepoName)\n\t} else {\n\t\tq := fmt.Sprintf(\"SHA:%s repo:web-platform-tests/wpt\", sha)\n\t\tvar issues *github.IssuesSearchResult\n\t\tissues, _, err = client.Search.Issues(aeAPI.Context(), q, nil)\n\t\tif err != nil {\n\t\t\treturn \"\", nil, err\n\t\t}\n\t\tif issues == nil || len(issues.Issues) < 1 {\n\t\t\treturn \"\", nil, fmt.Errorf(\"no search results found for SHA %s\", sha)\n\t\t}\n\n\t\treleaseTag = fmt.Sprintf(\"merge_pr_%d\", issues.Issues[0].GetNumber())\n\t\trelease, _, err = client.Repositories.GetReleaseByTag(\n\t\t\taeAPI.Context(),\n\t\t\tshared.WPTRepoOwner,\n\t\t\tshared.WPTRepoName,\n\t\t\treleaseTag,\n\t\t)\n\t\tif err != nil {\n\t\t\t// nolint: godox // TODO: golangci-lint discovered that this error was being shadowed.\n\t\t\t// Review if we should actually return the error. In the meantime, ignore it.\n\t\t\tlog := shared.GetLogger(aeAPI.Context())\n\t\t\tlog.Warningf(\"GetReleaseByTag failed with error %s. Will ignore\", err.Error())\n\t\t\terr = nil\n\t\t}\n\t}\n\n\tif err != nil {\n\t\treturn \"\", nil, err\n\t} else if release == nil || len(release.Assets) < 1 {\n\t\treturn \"\", nil, fmt.Errorf(\"no assets found for %s release\", releaseTag)\n\t}\n\t// Get (and unzip) the asset with name \"MANIFEST-{sha}.json.gz\"\n\tfor _, asset := range release.Assets {\n\t\tname := asset.GetName()\n\t\tvar url string\n\t\tif matches := AssetRegex.FindStringSubmatch(name); matches != nil {\n\t\t\tfetchedSHA = matches[1]\n\t\t\turl = asset.GetBrowserDownloadURL()\n\n\t\t\tclient := aeAPI.GetHTTPClient()\n\t\t\tresp, err := client.Get(url)\n\t\t\tif err != nil {\n\t\t\t\treturn fetchedSHA, nil, err\n\t\t\t}\n\n\t\t\treturn fetchedSHA, resp.Body, err\n\t\t}\n\t}\n\n\treturn \"\", nil, fmt.Errorf(\"no manifest asset found for release %s\", releaseTag)\n}\n\n// NewRedis creates a new redisReadWritable with the given duration.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (a apiImpl) NewRedis(duration time.Duration) shared.ReadWritable {\n\treturn shared.NewRedisReadWritable(a.ctx, duration)\n}\n" }, { "path": "api/manifest/mock_manifest/api_mock.go", "content": "// Code generated by MockGen. DO NOT EDIT.\n// Source: github.com/web-platform-tests/wpt.fyi/api/manifest (interfaces: API)\n//\n// Generated by this command:\n//\n//\tmockgen -build_flags=--mod=mod -destination mock_manifest/api_mock.go github.com/web-platform-tests/wpt.fyi/api/manifest API\n//\n\n// Package mock_manifest is a generated GoMock package.\npackage mock_manifest\n\nimport (\n\treflect \"reflect\"\n\ttime \"time\"\n\n\tshared \"github.com/web-platform-tests/wpt.fyi/shared\"\n\tgomock \"go.uber.org/mock/gomock\"\n)\n\n// MockAPI is a mock of API interface.\ntype MockAPI struct {\n\tctrl *gomock.Controller\n\trecorder *MockAPIMockRecorder\n\tisgomock struct{}\n}\n\n// MockAPIMockRecorder is the mock recorder for MockAPI.\ntype MockAPIMockRecorder struct {\n\tmock *MockAPI\n}\n\n// NewMockAPI creates a new mock instance.\nfunc NewMockAPI(ctrl *gomock.Controller) *MockAPI {\n\tmock := &MockAPI{ctrl: ctrl}\n\tmock.recorder = &MockAPIMockRecorder{mock}\n\treturn mock\n}\n\n// EXPECT returns an object that allows the caller to indicate expected use.\nfunc (m *MockAPI) EXPECT() *MockAPIMockRecorder {\n\treturn m.recorder\n}\n\n// GetManifestForSHA mocks base method.\nfunc (m *MockAPI) GetManifestForSHA(arg0 string) (string, []byte, error) {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"GetManifestForSHA\", arg0)\n\tret0, _ := ret[0].(string)\n\tret1, _ := ret[1].([]byte)\n\tret2, _ := ret[2].(error)\n\treturn ret0, ret1, ret2\n}\n\n// GetManifestForSHA indicates an expected call of GetManifestForSHA.\nfunc (mr *MockAPIMockRecorder) GetManifestForSHA(arg0 any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"GetManifestForSHA\", reflect.TypeOf((*MockAPI)(nil).GetManifestForSHA), arg0)\n}\n\n// NewRedis mocks base method.\nfunc (m *MockAPI) NewRedis(duration time.Duration) shared.ReadWritable {\n\tm.ctrl.T.Helper()\n\tret := m.ctrl.Call(m, \"NewRedis\", duration)\n\tret0, _ := ret[0].(shared.ReadWritable)\n\treturn ret0\n}\n\n// NewRedis indicates an expected call of NewRedis.\nfunc (mr *MockAPIMockRecorder) NewRedis(duration any) *gomock.Call {\n\tmr.mock.ctrl.T.Helper()\n\treturn mr.mock.ctrl.RecordCallWithMethodType(mr.mock, \"NewRedis\", reflect.TypeOf((*MockAPI)(nil).NewRedis), duration)\n}\n" }, { "path": "api/manifest/util.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage manifest\n\nimport (\n\t\"encoding/json\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// Filter filters items in the the given manifest JSON, omitting anything that isn't an\n// item which has a URL beginning with one of the given paths.\nfunc Filter(body []byte, paths []string) (result []byte, err error) {\n\tvar parsed *shared.Manifest\n\tif err = json.Unmarshal(body, &parsed); err != nil {\n\t\treturn nil, err\n\t}\n\tif parsed, err = parsed.FilterByPath(paths...); err != nil {\n\t\treturn nil, err\n\t}\n\tbody, err = json.Marshal(parsed)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn body, nil\n}\n" }, { "path": "api/manifest/util_test.go", "content": "//go:build small\n\n// Copyright 2017 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage manifest\n\nimport (\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc TestFilter(t *testing.T) {\n\t// This is a smoke test; see shared/manifest_test.go for more tests.\n\tbytes := []byte(`{\n\"items\": {\n\t\"testharness\": {\n\t\t\"foo\": {\n\t\t\t\"bar\": {\n\t\t\t\t\"test.html\": [\n\t\t\t\t\t\"1d3166465cc6f2e8f9f18f53e499ca61e12d59bd\",\n\t\t\t\t\t[null, {}]\n\t\t\t\t]\n\n\t\t\t}\n\t\t},\n\t\t\"foobar\": {\n\t\t\t\"mytest.html\": [\n\t\t\t\t\"2d3166465cc6f2e8f9f18f53e499ca61e12d59bd\",\n\t\t\t\t[null, {}]\n\t\t\t]\n\t\t}\n\t},\n\t\"manual\": {\n\t\t\"foobar\": {\n\t\t\t\"test-manual.html\": [\n\t\t\t\t\"3d3166465cc6f2e8f9f18f53e499ca61e12d59bd\",\n\t\t\t\t[null, {}]\n\t\t\t]\n\t\t}\n\t}\n},\n\"version\": 8\n}`)\n\n\tfiltered, err := Filter(bytes, []string{\"/foo/bar\"})\n\tassert.Nil(t, err)\n\tassert.Equal(t, `{\"items\":{\"testharness\":{\"foo\":{\"bar\":{\"test.html\":[\"1d3166465cc6f2e8f9f18f53e499ca61e12d59bd\",[null,{}]]}}}},\"version\":8}`, string(filtered))\n}\n" }, { "path": "api/manifest.go", "content": "// Copyright 2017 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"bytes\"\n\t\"compress/gzip\"\n\t\"fmt\"\n\t\"io\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/api/manifest\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nfunc apiManifestHandler(w http.ResponseWriter, r *http.Request) {\n\tq := r.URL.Query()\n\tshas, err := shared.ParseSHAParam(q)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\tpaths := shared.ParsePathsParam(q)\n\tsha := shas.FirstOrLatest()\n\n\tctx := r.Context()\n\tlogger := shared.GetLogger(ctx)\n\tmanifestAPI := manifest.NewAPI(ctx)\n\tsha, manifest, err := getManifest(logger, manifestAPI, sha, paths)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusNotFound)\n\n\t\treturn\n\t}\n\tw.Header().Add(\"X-WPT-SHA\", sha)\n\tw.Header().Add(\"Content-Type\", \"application/json\")\n\t_, err = w.Write(manifest)\n\tif err != nil {\n\t\tlogger.Warningf(\"Failed to write data in api/manifest handler: %s\", err.Error())\n\t}\n}\n\nfunc getManifest(log shared.Logger, manifestAPI manifest.API, sha string, paths []string) (string, []byte, error) {\n\tmc := manifestAPI.NewRedis(time.Hour * 48)\n\t// Shorter expiry for latest SHA, to keep it current.\n\tlatestMC := manifestAPI.NewRedis(time.Minute * 5)\n\n\tvar body []byte\n\n\tif shared.IsLatest(sha) {\n\t\t// Attempt to find the \"latest\" SHA in cache.\n\t\tlatestSHA, err := readByKey(latestMC, \"latest\")\n\t\tif err == nil {\n\t\t\t// Found! Now delegate to get manifest for that specific SHA.\n\t\t\treturn getManifest(log, manifestAPI, string(latestSHA), paths)\n\t\t}\n\t\tlog.Debugf(\"Latest SHA not found in cache: %v\", err)\n\t} else {\n\t\t// Attempt to find the manifest for a specific SHA in cache.\n\t\tvar err error\n\t\tbody, err = readByKey(mc, sha)\n\t\tif err != nil {\n\t\t\tlog.Debugf(\"Manifest for SHA %s not found in cache: %v\", sha, err)\n\t\t}\n\t\t// Do not return here yet as we still need to filter by paths.\n\t}\n\n\tvar fetchedSHA string\n\tif body != nil {\n\t\t// Cache hit; fetchedSHA is requested SHA, which is guaranteed to be specific.\n\t\tfetchedSHA = sha\n\t} else {\n\t\t// Cache missed; download the manifest for real.\n\t\tvar err error\n\t\tif fetchedSHA, body, err = manifestAPI.GetManifestForSHA(sha); err != nil {\n\t\t\treturn fetchedSHA, nil, err\n\t\t}\n\n\t\t// Write manifest to cache.\n\t\tif err := writeByKey(mc, fetchedSHA, body); err != nil {\n\t\t\tlog.Errorf(\"Error writing manifest to cache: %v\", err)\n\t\t}\n\t}\n\n\t// Write latest SHA to cache, if needed.\n\tif shared.IsLatest(sha) {\n\t\tif err := writeByKey(latestMC, \"latest\", []byte(fetchedSHA)); err != nil {\n\t\t\tlog.Errorf(\"Error writing latest SHA to cache: %v\", err)\n\t\t}\n\t}\n\n\t// Decompress the manifest and filter it by paths if needed.\n\tgzReader, err := gzip.NewReader(bytes.NewReader(body))\n\tif err != nil {\n\t\treturn fetchedSHA, nil, err\n\t}\n\tdefer gzReader.Close()\n\tunzipped, err := io.ReadAll(gzReader)\n\tif err != nil {\n\t\treturn fetchedSHA, nil, err\n\t}\n\tif paths != nil {\n\t\tvar err error\n\t\tif unzipped, err = manifest.Filter(unzipped, paths); err != nil {\n\t\t\treturn fetchedSHA, nil, err\n\t\t}\n\t}\n\n\treturn fetchedSHA, unzipped, err\n}\n\nfunc manifestCacheKey(sha string) string {\n\treturn fmt.Sprintf(\"MANIFEST-%s\", sha)\n}\n\nfunc readByKey(readable shared.Readable, key string) ([]byte, error) {\n\tikey := manifestCacheKey(key)\n\treader, err := readable.NewReadCloser(ikey)\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\n\treturn io.ReadAll(reader)\n}\n\nfunc writeByKey(writable shared.ReadWritable, key string, body []byte) error {\n\tikey := manifestCacheKey(key)\n\twriter, err := writable.NewWriteCloser(ikey)\n\tif err != nil {\n\t\treturn err\n\t}\n\tn, err := writer.Write(body)\n\tif err != nil {\n\t\treturn err\n\t}\n\tif n != len(body) {\n\t\treturn fmt.Errorf(\"incomplete write; expected %d bytes but %d written\", len(body), n)\n\t}\n\n\treturn writer.Close()\n}\n" }, { "path": "api/manifest_test.go", "content": "//go:build small\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"bytes\"\n\t\"compress/gzip\"\n\t\"errors\"\n\t\"strings\"\n\t\"testing\"\n\t\"time\"\n\n\t\"go.uber.org/mock/gomock\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/api/manifest/mock_manifest\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n)\n\nfunc TestGetGitHubReleaseAsset_Caches(t *testing.T) {\n\tctx := sharedtest.NewTestContext()\n\tlog := shared.GetLogger(ctx)\n\terrNotFound := errors.New(\"not found\")\n\n\tfullSHA := strings.Repeat(\"1234567890\", 4)\n\tcontent := \"latest data\"\n\tdata := getManifestPayload(content)\n\n\tt.Run(\"cache missed\", func(t *testing.T) {\n\t\tmockCtrl := gomock.NewController(t)\n\t\tdefer mockCtrl.Finish()\n\n\t\tmockMC := sharedtest.NewMockReadWritable(mockCtrl)\n\t\tmockWC := sharedtest.NewMockWriteCloser(t)\n\t\tmockLatestMC := sharedtest.NewMockReadWritable(mockCtrl)\n\t\tmockLatestWC := sharedtest.NewMockWriteCloser(t)\n\t\tmanifestAPI := mock_manifest.NewMockAPI(mockCtrl)\n\t\tmanifestAPI.EXPECT().NewRedis(time.Hour * 48).Return(mockMC)\n\t\tmanifestAPI.EXPECT().NewRedis(time.Minute * 5).Return(mockLatestMC)\n\t\tgomock.InOrder(\n\t\t\tmockLatestMC.EXPECT().NewReadCloser(\"MANIFEST-latest\").Return(nil, errNotFound),\n\t\t\tmanifestAPI.EXPECT().GetManifestForSHA(\"\").Return(fullSHA, data, nil),\n\t\t\tmockMC.EXPECT().NewWriteCloser(\"MANIFEST-\"+fullSHA).Return(mockWC, nil),\n\t\t\tmockLatestMC.EXPECT().NewWriteCloser(\"MANIFEST-latest\").Return(mockLatestWC, nil),\n\t\t)\n\n\t\tsha, latestManifest, err := getManifest(log, manifestAPI, \"\", nil)\n\t\tassert.Nil(t, err)\n\t\tassert.Equal(t, fullSHA, sha)\n\t\tassert.Equal(t, content, string(latestManifest))\n\t\t// Should be added to cache\n\t\tassert.True(t, mockLatestWC.IsClosed())\n\t\tassert.Equal(t, fullSHA, string(mockLatestWC.Bytes()))\n\t\tassert.True(t, mockWC.IsClosed())\n\t\tassert.Equal(t, data, mockWC.Bytes())\n\t})\n\n\tt.Run(\"cache hit (latest)\", func(t *testing.T) {\n\t\tmockCtrl := gomock.NewController(t)\n\t\tdefer mockCtrl.Finish()\n\n\t\tmockMC := sharedtest.NewMockReadWritable(mockCtrl)\n\t\tmockRC := sharedtest.NewMockReadCloser(t, []byte(data))\n\t\tmockLatestMC := sharedtest.NewMockReadWritable(mockCtrl)\n\t\tmockLatestRC := sharedtest.NewMockReadCloser(t, []byte(fullSHA))\n\t\tmanifestAPI := mock_manifest.NewMockAPI(mockCtrl)\n\t\tmanifestAPI.EXPECT().NewRedis(time.Hour * 48).AnyTimes().Return(mockMC)\n\t\tmanifestAPI.EXPECT().NewRedis(time.Minute * 5).AnyTimes().Return(mockLatestMC)\n\t\tgomock.InOrder(\n\t\t\tmockLatestMC.EXPECT().NewReadCloser(\"MANIFEST-latest\").Return(mockLatestRC, nil),\n\t\t\tmockMC.EXPECT().NewReadCloser(\"MANIFEST-\"+fullSHA).Return(mockRC, nil),\n\t\t)\n\n\t\t// Load from cache without touching API.\n\t\tsha, latestManifest, err := getManifest(log, manifestAPI, \"latest\", nil)\n\t\tassert.Nil(t, err)\n\t\tassert.Equal(t, fullSHA, sha)\n\t\tassert.Equal(t, content, string(latestManifest))\n\t})\n\n\tt.Run(\"cache hit (full SHA)\", func(t *testing.T) {\n\t\tmockCtrl := gomock.NewController(t)\n\t\tdefer mockCtrl.Finish()\n\n\t\tmockMC := sharedtest.NewMockReadWritable(mockCtrl)\n\t\tmockRC := sharedtest.NewMockReadCloser(t, []byte(data))\n\t\tmockLatestMC := sharedtest.NewMockReadWritable(mockCtrl)\n\t\tmanifestAPI := mock_manifest.NewMockAPI(mockCtrl)\n\t\tmanifestAPI.EXPECT().NewRedis(time.Hour * 48).Return(mockMC)\n\t\tmanifestAPI.EXPECT().NewRedis(time.Minute * 5).Return(mockLatestMC)\n\t\tmockMC.EXPECT().NewReadCloser(\"MANIFEST-\"+fullSHA).Return(mockRC, nil)\n\n\t\t// Load from cache without touching API.\n\t\tsha, latestManifest, err := getManifest(log, manifestAPI, fullSHA, nil)\n\t\tassert.Nil(t, err)\n\t\tassert.Equal(t, fullSHA, sha)\n\t\tassert.Equal(t, content, string(latestManifest))\n\t})\n}\n\nfunc getManifestPayload(data string) []byte {\n\tvar buf bytes.Buffer\n\tzw := gzip.NewWriter(&buf)\n\tzw.Write([]byte(data))\n\tzw.Close()\n\treturn buf.Bytes()\n}\n" }, { "path": "api/metadata_cache.go", "content": "// Copyright 2020 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"context\"\n\t\"errors\"\n\t\"net/http\"\n\t\"time\"\n\n\t\"github.com/google/go-github/v84/github\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\nconst metadataCacheKey = \"WPT-METADATA\"\nconst metadataCacheExpiry = time.Minute * 10\n\ntype webappMetadataFetcher struct {\n\tctx context.Context // nolint:containedctx // TODO: Fix containedctx lint error\n\thttpClient *http.Client\n\tgitHubClient *github.Client\n\tforceUpdate bool\n}\n\nfunc (f webappMetadataFetcher) Fetch() (sha *string, res map[string][]byte, err error) {\n\tlog := shared.GetLogger(f.ctx)\n\tmCache := shared.NewJSONObjectCache(f.ctx, shared.NewRedisReadWritable(f.ctx, metadataCacheExpiry))\n\tif !f.forceUpdate {\n\t\tsha, metadataMap, err := getMetadataFromRedis(mCache)\n\t\tif err == nil {\n\t\t\treturn sha, metadataMap, nil\n\t\t}\n\t\tlog.Debugf(\"Metadata cache missed: %v\", err)\n\t}\n\n\tsha, err = shared.GetWPTMetadataMasterSHA(f.ctx, f.gitHubClient)\n\tif err != nil {\n\t\tlog.Errorf(\"Error getting HEAD SHA of wpt-metadata: %v\", err)\n\n\t\treturn nil, nil, err\n\t}\n\n\tres, err = shared.GetWPTMetadataArchive(f.httpClient, sha)\n\tif err != nil {\n\t\tlog.Errorf(\"Error getting archive of wpt-metadata: %v\", err)\n\n\t\treturn nil, nil, err\n\t}\n\n\tif err := fillMetadataToRedis(mCache, *sha, res); err != nil {\n\t\t// This is not a fatal failure.\n\t\tlog.Errorf(\"Error storing metadata to cache: %v\", err)\n\t}\n\n\treturn sha, res, nil\n}\n\nfunc getMetadataFromRedis(cache shared.ObjectCache) (sha *string, res map[string][]byte, err error) {\n\tvar metadataSHAMap map[string]map[string][]byte\n\terr = cache.Get(metadataCacheKey, &metadataSHAMap)\n\tif err != nil {\n\t\treturn nil, nil, err\n\t}\n\n\t// Caches hit; update Metadata.\n\tkeys := make([]string, 0, len(metadataSHAMap))\n\tfor key := range metadataSHAMap {\n\t\tkeys = append(keys, key)\n\t}\n\n\tif len(keys) != 1 {\n\t\treturn nil, nil, errors.New(\"error from getting the wpt-metadata SHA in metadataSHAMap\")\n\t}\n\n\tsha = &keys[0]\n\n\treturn sha, metadataSHAMap[*sha], nil\n}\n\nfunc fillMetadataToRedis(cache shared.ObjectCache, sha string, metadataByteMap map[string][]byte) error {\n\tmetadataSHAMap := make(map[string]map[string][]byte)\n\tmetadataSHAMap[sha] = metadataByteMap\n\n\treturn cache.Put(metadataCacheKey, metadataSHAMap)\n}\n" }, { "path": "api/metadata_handler.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\t\"strings\"\n\t\"time\"\n\n\t\"github.com/web-platform-tests/wpt.fyi/api/query\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// MetadataHandler is an http.Handler for /api/metadata endpoint.\ntype MetadataHandler struct {\n\tlogger shared.Logger\n\tfetcher shared.MetadataFetcher\n}\n\n// apiMetadataHandler searches Metadata for given products.\nfunc apiMetadataHandler(w http.ResponseWriter, r *http.Request) {\n\tif r.Method != http.MethodGet && r.Method != http.MethodPost {\n\t\thttp.Error(w, \"Invalid HTTP method\", http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tctx := r.Context()\n\taeAPI := shared.NewAppEngineAPI(ctx)\n\tlogger := shared.GetLogger(ctx)\n\tclient := aeAPI.GetHTTPClient()\n\tgitHubClient, err := shared.NewAppEngineAPI(ctx).GetGitHubClient()\n\tif err != nil {\n\t\tlogger.Errorf(\"Unable to get GitHub client: %s\", err.Error())\n\t\thttp.Error(w, \"Unable to get GitHub client\", http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\t// nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\tfetcher := webappMetadataFetcher{ctx: ctx, httpClient: client, gitHubClient: gitHubClient}\n\tMetadataHandler{logger, fetcher}.ServeHTTP(w, r)\n}\n\nfunc apiMetadataTriageHandler(w http.ResponseWriter, r *http.Request) {\n\tctx := r.Context()\n\tds := shared.NewAppEngineDatastore(ctx, false)\n\n\tuser, token := shared.GetUserFromCookie(ctx, ds, r)\n\tif user == nil {\n\t\thttp.Error(w, \"User is not logged in\", http.StatusUnauthorized)\n\n\t\treturn\n\t}\n\n\taeAPI := shared.NewAppEngineAPI(ctx)\n\tlogger := shared.GetLogger(ctx)\n\tbotClient, err := aeAPI.GetGitHubClient()\n\tif err != nil {\n\t\tlogger.Errorf(\"Unable to get GitHub client: %s\", err.Error())\n\t\thttp.Error(w, \"Unable to get GitHub client\", http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tfetcher := webappMetadataFetcher{\n\t\tctx: ctx,\n\t\thttpClient: aeAPI.GetHTTPClient(),\n\t\tgitHubClient: botClient,\n\t\tforceUpdate: true}\n\ttm := shared.NewTriageMetadata(ctx, botClient, user.GitHubHandle, user.GitHubEmail, fetcher)\n\n\tgac, err := shared.NewGitHubAccessControl(ctx, ds, botClient, user, token)\n\tif err != nil {\n\t\thttp.Error(w, \"Unable to create GitHub OAuth client: \"+err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tcacheSet := shared.NewRedisSet()\n\t// jsonCache writes pending metadata to Redis, with a 7-day TTL.\n\tjsonCache := shared.NewJSONObjectCache(ctx, shared.NewRedisReadWritable(ctx, 24*7*time.Hour))\n\thandleMetadataTriage(ctx, gac, tm, jsonCache, cacheSet, w, r)\n}\n\nfunc handleMetadataTriage(\n\tctx context.Context,\n\tgac shared.GitHubAccessControl,\n\ttm shared.TriageMetadata,\n\tjsonCache shared.ObjectCache,\n\tcacheSet shared.RedisSet,\n\tw http.ResponseWriter,\n\tr *http.Request,\n) {\n\tif r.Method != http.MethodPatch {\n\t\thttp.Error(w, \"Invalid HTTP method; only accept PATCH\", http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tcontentType := r.Header.Get(\"Content-Type\")\n\tif contentType != \"application/json\" {\n\t\thttp.Error(w, \"Invalid content-type: %s\"+contentType, http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tdata, err := io.ReadAll(r.Body)\n\tif err != nil {\n\t\thttp.Error(w, \"Failed to read PATCH request body\", http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\terr = r.Body.Close()\n\tif err != nil {\n\t\thttp.Error(w, \"Failed to finish reading request body\", http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tvar metadata shared.MetadataResults\n\terr = json.Unmarshal(data, &metadata)\n\tif err != nil {\n\t\thttp.Error(w, \"Failed to parse JSON: \"+err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tvalid, err := gac.IsValidWPTMember()\n\tif err != nil {\n\t\thttp.Error(w, \"Failed to validate web-platform-tests membership: \"+err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tif !valid {\n\t\thttp.Error(\n\t\t\tw,\n\t\t\t\"Logged-in user must be a member of the web-platform-tests GitHub organization.\"+\n\t\t\t\t\"To join, please contact wpt.fyi team members.\",\n\t\t\thttp.StatusForbidden,\n\t\t)\n\n\t\treturn\n\t}\n\n\tfor _, links := range metadata {\n\t\tfor _, link := range links {\n\t\t\tif link.URL != \"\" && !shared.IsValidURL(link.URL) {\n\t\t\t\thttp.Error(w, \"Invalid URL: \"+link.URL, http.StatusBadRequest)\n\n\t\t\t\treturn\n\t\t\t}\n\t\t}\n\t}\n\n\t// nolint:godox // TODO(kyleju): Check github client permission levels for auto merge.\n\tprURL, err := tm.Triage(metadata)\n\tif err != nil {\n\t\thttp.Error(w, \"Unable to triage metadata: \"+err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tprArray := strings.Split(prURL, \"/\")\n\tif len(prArray) == 0 {\n\t\thttp.Error(w, \"Invalid PR URL format: \"+prURL, http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\tprNum := prArray[len(prArray)-1]\n\t// Stores the PR number and its pending metadata to Redis.\n\terr = cacheSet.Add(shared.PendingMetadataCacheKey, prNum)\n\tif err == nil {\n\t\tpendingMetadataKey := shared.PendingMetadataCachePrefix + prNum\n\t\terr = jsonCache.Put(pendingMetadataKey, metadata)\n\t}\n\n\tif err != nil {\n\t\tlogger := shared.GetLogger(ctx)\n\t\tlogger.Errorf(\"Unable to cache %s to Redis: %s\", prURL, err.Error())\n\t}\n\n\t_, err = w.Write([]byte(prURL))\n\tif err != nil {\n\t\tlogger := shared.GetLogger(r.Context())\n\t\tlogger.Warningf(\"Failed to write data in metadata handler: %s\", err.Error())\n\t}\n}\n\nfunc (h MetadataHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {\n\tvar abstractLink query.AbstractLink\n\t// nolint:nestif // TODO: Fix nestif lint error\n\tif r.Method == http.MethodPost {\n\t\tdata, err := io.ReadAll(r.Body)\n\t\tif err != nil {\n\t\t\thttp.Error(w, \"Failed to read request body\", http.StatusInternalServerError)\n\n\t\t\treturn\n\t\t}\n\n\t\terr = r.Body.Close()\n\t\tif err != nil {\n\t\t\thttp.Error(w, \"Failed to finish reading request body\", http.StatusInternalServerError)\n\n\t\t\treturn\n\t\t}\n\n\t\tvar ae query.AbstractExists\n\t\terr = json.Unmarshal(data, &ae)\n\t\tif err != nil {\n\t\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\t\treturn\n\t\t}\n\n\t\tvar isLinkQuery = false\n\t\tif len(ae.Args) == 1 {\n\t\t\tabstractLink, isLinkQuery = ae.Args[0].(query.AbstractLink)\n\t\t}\n\n\t\tif !isLinkQuery {\n\t\t\th.logger.Errorf(\"Error from request: non Link search query %s for api/metadata\", ae)\n\t\t\thttp.Error(w, \"Error from request: non Link search query for api/metadata\", http.StatusBadRequest)\n\n\t\t\treturn\n\t\t}\n\t}\n\n\tq := r.URL.Query()\n\tproductSpecs, err := shared.ParseProductOrBrowserParams(q)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusBadRequest)\n\n\t\treturn\n\t} else if len(productSpecs) == 0 {\n\t\thttp.Error(w, \"Missing required 'product' param\", http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tval, _ := shared.ParseBooleanParam(q, \"includeTestLevel\")\n\tincludeTestLevel := val != nil && *val\n\n\tmetadataResponse, err := shared.GetMetadataResponseOnProducts(productSpecs, includeTestLevel, h.logger, h.fetcher)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\tif r.Method == http.MethodPost {\n\t\tmetadataResponse = filterMetadata(abstractLink, metadataResponse)\n\t}\n\tmarshalled, err := json.Marshal(metadataResponse)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\t_, err = w.Write(marshalled)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n}\n\n// filterMetadata filters the given metadata down to entries where the value (links) contain\n// at least one link where the URL contains the substring provided in the \"link\" search atom.\nfunc filterMetadata(linkQuery query.AbstractLink, metadata shared.MetadataResults) shared.MetadataResults {\n\tres := make(shared.MetadataResults)\n\tfor test, links := range metadata {\n\t\tfor _, link := range links {\n\t\t\tif strings.Contains(link.URL, linkQuery.Pattern) {\n\t\t\t\tres[test] = links\n\n\t\t\t\tbreak\n\t\t\t}\n\t\t}\n\t}\n\n\treturn res\n}\n\n// apiPendingMetadataHandler searches pending Metadata stored in memory.\nfunc apiPendingMetadataHandler(w http.ResponseWriter, r *http.Request) {\n\tif r.Method != http.MethodGet {\n\t\thttp.Error(w, \"Invalid HTTP method\", http.StatusBadRequest)\n\n\t\treturn\n\t}\n\n\tctx := r.Context()\n\tcacheSet := shared.NewRedisSet()\n\tjsonObjectCache := shared.NewJSONObjectCache(ctx, shared.NewRedisReadWritable(ctx, 0))\n\thandlePendingMetadata(ctx, jsonObjectCache, cacheSet, w, r)\n}\n\nfunc handlePendingMetadata(\n\tctx context.Context,\n\tjsonObjectCache shared.ObjectCache,\n\tcacheSet shared.RedisSet,\n\tw http.ResponseWriter,\n\t_ *http.Request,\n) {\n\tlogger := shared.GetLogger(ctx)\n\tprs, err := cacheSet.GetAll(shared.PendingMetadataCacheKey)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\t// nolint:godox // TODO(kyleju): Check if a PR has been merged or closed; if so, remove them from Redis.\n\tallPendingResults := make(shared.MetadataResults)\n\tfor _, pr := range prs {\n\t\tvar pendingMetadata shared.MetadataResults\n\t\tpendingMetadataKey := shared.PendingMetadataCachePrefix + pr\n\t\terr = jsonObjectCache.Get(pendingMetadataKey, &pendingMetadata)\n\t\tif err != nil {\n\t\t\tlogger.Errorf(\"Unable to get %s from Redis: %s\", pendingMetadataKey, err.Error())\n\n\t\t\tcontinue\n\t\t}\n\n\t\t// Merge pending MetadataResults into allPendingResults.\n\t\tfor testName, links := range pendingMetadata {\n\t\t\tif _, ok := allPendingResults[testName]; !ok {\n\t\t\t\tallPendingResults[testName] = links\n\t\t\t} else {\n\t\t\t\tallPendingResults[testName] = append(allPendingResults[testName], links...)\n\t\t\t}\n\t\t}\n\t}\n\n\tmarshalled, err := json.Marshal(allPendingResults)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\n\t_, err = w.Write(marshalled)\n\tif err != nil {\n\t\tlogger.Warningf(\"Failed to write data in pending metadata handler: %s\", err.Error())\n\t}\n}\n" }, { "path": "api/metadata_handler_test.go", "content": "//go:build small\n\n// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"strings\"\n\t\"testing\"\n\n\t\"github.com/stretchr/testify/assert\"\n\t\"github.com/web-platform-tests/wpt.fyi/api/query\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n\t\"go.uber.org/mock/gomock\"\n)\n\nfunc TestHandleMetadataTriage_Success(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\tctx := sharedtest.NewTestContext()\n\tw := httptest.NewRecorder()\n\n\tbody :=\n\t\t`{\n \"/bar/foo.html\": [\n {\n \"product\":\"chrome\",\n \"url\":\"https://bugs.bar\",\n \"results\":[{\"status\":6}]\n }\n ]}`\n\tbodyReader := strings.NewReader(body)\n\treq := httptest.NewRequest(\"PATCH\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\tmockgac := sharedtest.NewMockGitHubAccessControl(mockCtrl)\n\tmockgac.EXPECT().IsValidWPTMember().Return(true, nil)\n\n\tmocktm := sharedtest.NewMockTriageMetadata(mockCtrl)\n\tmocktm.EXPECT().Triage(gomock.Any()).Return(\"https://github.com/web-platform-tests/wpt-metadata/pull/1\", nil)\n\n\tmockSet := sharedtest.NewMockRedisSet(mockCtrl)\n\tmockSet.EXPECT().Add(shared.PendingMetadataCacheKey, \"1\").Return(nil)\n\n\tmockCache := sharedtest.NewMockObjectCache(mockCtrl)\n\tmockCache.EXPECT().Put(shared.PendingMetadataCachePrefix+\"1\", gomock.Any()).Return(nil)\n\n\thandleMetadataTriage(ctx, mockgac, mocktm, mockCache, mockSet, w, req)\n\n\tassert.Equal(t, http.StatusOK, w.Code)\n}\n\nfunc TestHandleMetadataTriage_FailToCachePr(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\tctx := sharedtest.NewTestContext()\n\tw := httptest.NewRecorder()\n\n\tbody :=\n\t\t`{\n \"/bar/foo.html\": [\n {\n \"product\":\"chrome\",\n \"url\":\"https://bugs.bar\",\n \"results\":[{\"status\":6}]\n }\n ]}`\n\tbodyReader := strings.NewReader(body)\n\treq := httptest.NewRequest(\"PATCH\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\tmockgac := sharedtest.NewMockGitHubAccessControl(mockCtrl)\n\tmockgac.EXPECT().IsValidWPTMember().Return(true, nil)\n\n\tmocktm := sharedtest.NewMockTriageMetadata(mockCtrl)\n\tmocktm.EXPECT().Triage(gomock.Any()).Return(\"https://github.com/web-platform-tests/wpt-metadata/pull/1\", nil)\n\n\tmockSet := sharedtest.NewMockRedisSet(mockCtrl)\n\tmockSet.EXPECT().Add(shared.PendingMetadataCacheKey, \"1\").Return(errors.New(\"cache failed\"))\n\n\thandleMetadataTriage(ctx, mockgac, mocktm, nil, mockSet, w, req)\n\n\tassert.Equal(t, http.StatusOK, w.Code)\n}\n\nfunc TestHandleMetadataTriage_FailToCacheMetadata(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\tctx := sharedtest.NewTestContext()\n\tw := httptest.NewRecorder()\n\n\tbody :=\n\t\t`{\n \"/bar/foo.html\": [\n {\n \"product\":\"chrome\",\n \"url\":\"https://bugs.bar\",\n \"results\":[{\"status\":6}]\n }\n ]}`\n\tbodyReader := strings.NewReader(body)\n\treq := httptest.NewRequest(\"PATCH\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\tmockgac := sharedtest.NewMockGitHubAccessControl(mockCtrl)\n\tmockgac.EXPECT().IsValidWPTMember().Return(true, nil)\n\n\tmocktm := sharedtest.NewMockTriageMetadata(mockCtrl)\n\tmocktm.EXPECT().Triage(gomock.Any()).Return(\"https://github.com/web-platform-tests/wpt-metadata/pull/1\", nil)\n\n\tmockSet := sharedtest.NewMockRedisSet(mockCtrl)\n\tmockSet.EXPECT().Add(shared.PendingMetadataCacheKey, \"1\").Return(nil)\n\n\tmockCache := sharedtest.NewMockObjectCache(mockCtrl)\n\tmockCache.EXPECT().Put(shared.PendingMetadataCachePrefix+\"1\", gomock.Any()).Return(errors.New(\"cache failed\"))\n\n\thandleMetadataTriage(ctx, mockgac, mocktm, mockCache, mockSet, w, req)\n\n\tassert.Equal(t, http.StatusOK, w.Code)\n}\n\nfunc TestHandleMetadataTriage_InvalidURL(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\tctx := sharedtest.NewTestContext()\n\tw := httptest.NewRecorder()\n\n\tbody :=\n\t\t`{\n \"/bar/foo.html\": [\n {\n \"product\":\"chrome\",\n \"url\":\"not-a-url\",\n \"results\":[{\"status\":6}]\n }\n ]}`\n\tbodyReader := strings.NewReader(body)\n\treq := httptest.NewRequest(\"PATCH\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\tmockgac := sharedtest.NewMockGitHubAccessControl(mockCtrl)\n\tmockgac.EXPECT().IsValidWPTMember().Return(true, nil)\n\n\tmocktm := sharedtest.NewMockTriageMetadata(mockCtrl)\n\n\thandleMetadataTriage(ctx, mockgac, mocktm, nil, nil, w, req)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestHandleMetadataTriage_NonSimpleRequests(t *testing.T) {\n\tw := httptest.NewRecorder()\n\tbody :=\n\t\t`{\n \"/bar/foo.html\": [\n {\n \"product\":\"chrome\",\n \"url\":\"https://bugs.bar\",\n \"results\":[{\"status\":6}]\n }\n ]}`\n\tbodyReader := strings.NewReader(body)\n\treq := httptest.NewRequest(\"GET\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\thandleMetadataTriage(nil, nil, nil, nil, nil, w, req)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n\n\tw = httptest.NewRecorder()\n\treq = httptest.NewRequest(\"POST\", \"https://foo/metadata\", bodyReader)\n\n\thandleMetadataTriage(nil, nil, nil, nil, nil, w, req)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestHandleMetadataTriage_WrongContentType(t *testing.T) {\n\tw := httptest.NewRecorder()\n\tbody :=\n\t\t`{\n \"/bar/foo.html\": [\n {\n \"product\":\"chrome\",\n \"url\":\"https://bugs.bar\",\n \"results\":[{\"status\":6}]\n }\n ]}`\n\tbodyReader := strings.NewReader(body)\n\treq := httptest.NewRequest(\"PATCH\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/x-www-form-urlencoded\")\n\n\thandleMetadataTriage(nil, nil, nil, nil, nil, w, req)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestHandleMetadataTriage_InvalidBody(t *testing.T) {\n\tw := httptest.NewRecorder()\n\tbodyReader := strings.NewReader(\"abc\")\n\treq := httptest.NewRequest(\"PATCH\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\thandleMetadataTriage(nil, nil, nil, nil, nil, w, req)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestHandleMetadataTriage_InvalidProduct(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\tctx := sharedtest.NewTestContext()\n\tw := httptest.NewRecorder()\n\n\tbody :=\n\t\t`{\n \"/bar/foo.html\": [\n {\n \"product\":\"foobar\",\n \"url\":\"https://bugs.bar\",\n \"results\":[{\"status\":6, \"label\":labelA}]\n }\n ]}`\n\tbodyReader := strings.NewReader(body)\n\treq := httptest.NewRequest(\"PATCH\", \"https://foo/metadata\", bodyReader)\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\thandleMetadataTriage(ctx, nil, nil, nil, nil, w, req)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestMetadataHanlder_GET_Success(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tr := httptest.NewRequest(\"GET\", \"/abd/api/metadata?product=firefox\", nil)\n\tw := httptest.NewRecorder()\n\tsha := \"sha\"\n\tmockFetcher := sharedtest.NewMockMetadataFetcher(mockCtrl)\n\tmockFetcher.EXPECT().Fetch().Return(&sha, getMetadataTestData(), nil)\n\n\tmetadataHandler := MetadataHandler{shared.NewNilLogger(), mockFetcher}\n\tmetadataHandler.ServeHTTP(w, r)\n\n\tassert.Equal(t, http.StatusOK, w.Code)\n\tres := w.Body.String()\n\n\tvar expected, actual shared.MetadataResults\n\tjson.Unmarshal([]byte(`{\n \"/testB/b.html\": [\n {\n \"product\": \"firefox\",\n \"url\":\"bar.com\",\n \"results\":[{\"status\":6}]\n }\n ]}`), &expected)\n\tjson.Unmarshal([]byte(res), &actual)\n\tassert.Equal(t, expected, actual)\n}\n\nfunc TestMetadataHanlder_GET_MissingProducts(t *testing.T) {\n\tr := httptest.NewRequest(\"GET\", \"/abd/api/metadata?\", nil)\n\tw := httptest.NewRecorder()\n\n\tmetadataHandler := MetadataHandler{shared.NewNilLogger(), nil}\n\tmetadataHandler.ServeHTTP(w, r)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestMetadataHandler_POST_Success(t *testing.T) {\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tbody :=\n\t\t`{\n \"exists\": [{\n \"link\": \"foo\"\n }]\n }`\n\tbodyReader := strings.NewReader(body)\n\tr := httptest.NewRequest(\"POST\", \"/abd/api/metadata?product=chrome&product=safari\", bodyReader)\n\tw := httptest.NewRecorder()\n\n\tsha := \"shaA\"\n\tmockFetcher := sharedtest.NewMockMetadataFetcher(mockCtrl)\n\tmockFetcher.EXPECT().Fetch().Return(&sha, getMetadataTestData(), nil)\n\n\tmetadataHandler := MetadataHandler{shared.NewNilLogger(), mockFetcher}\n\tmetadataHandler.ServeHTTP(w, r)\n\n\tassert.Equal(t, http.StatusOK, w.Code)\n\tres := w.Body.String()\n\n\tvar expected, actual shared.MetadataResults\n\tjson.Unmarshal([]byte(`{\n \"/root/testA/a.html\": [\n {\n \"product\":\"chrome\",\n \"url\":\"foo.com\",\n \"results\":[\n { \"status\":6 }\n ]\n }\n ]\n }`), &expected)\n\tjson.Unmarshal([]byte(res), &actual)\n\tassert.EqualValues(t, expected, actual)\n}\n\nfunc TestMetadataHandler_POST_MissingProducts(t *testing.T) {\n\tbody :=\n\t\t`{\n \"exists\": [{\n \"link\": \"issues.chromium.org\"\n }]\n }`\n\tbodyReader := strings.NewReader(body)\n\tr := httptest.NewRequest(\"GET\", \"/abd/api/metadata?\", bodyReader)\n\tw := httptest.NewRecorder()\n\n\tmetadataHandler := MetadataHandler{shared.NewNilLogger(), nil}\n\tmetadataHandler.ServeHTTP(w, r)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestMetadataHandler_POST_NotLink(t *testing.T) {\n\tbody :=\n\t\t`{\n \"exists\": [{\n \"pattern\": \"issues.chromium.org/\"\n }]\n }`\n\tbodyReader := strings.NewReader(string(body))\n\tr := httptest.NewRequest(\"POST\", \"/abd/api/metadata?product=chrome&product=safari\", bodyReader)\n\tw := httptest.NewRecorder()\n\n\tmetadataHandler := MetadataHandler{shared.NewNilLogger(), nil}\n\tmetadataHandler.ServeHTTP(w, r)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestMetadataHandler_POST_NotJustLink(t *testing.T) {\n\tbody :=\n\t\t`{\n \"exists\": [{\n \"and\": [\n {\"pattern\": \"issues.chromium.org\"},\n {\"link\": \"abc\"}\n ]\n }]\n }`\n\tbodyReader := strings.NewReader(string(body))\n\tr := httptest.NewRequest(\"POST\", \"/abd/api/metadata?product=chrome&product=safari\", bodyReader)\n\tw := httptest.NewRecorder()\n\n\tmetadataHandler := MetadataHandler{shared.NewNilLogger(), nil}\n\tmetadataHandler.ServeHTTP(w, r)\n\n\tassert.Equal(t, http.StatusBadRequest, w.Code)\n}\n\nfunc TestFilterMetadata(t *testing.T) {\n\tmetadata := shared.MetadataResults(shared.MetadataResults{\n\t\t\"/foo/bar/b.html\": shared.MetadataLinks{\n\t\t\tshared.MetadataLink{\n\t\t\t\tURL: \"https://aa.com/item\",\n\t\t\t},\n\t\t\tshared.MetadataLink{\n\t\t\t\tURL: \"https://bug.com/item\",\n\t\t\t},\n\t\t},\n\t\t\"bar\": shared.MetadataLinks{\n\t\t\tshared.MetadataLink{\n\t\t\t\tURL: \"https://external.com/item\",\n\t\t\t},\n\t\t},\n\t})\n\tabstractLink := query.AbstractLink{Pattern: \"bug.com\"}\n\n\tres := filterMetadata(abstractLink, metadata)\n\n\tassert.Equal(t, 1, len(res))\n\tassert.Equal(t, \"https://aa.com/item\", res[\"/foo/bar/b.html\"][0].URL)\n}\n\nfunc getMetadataTestData() map[string][]byte {\n\tmetadataMap := make(map[string][]byte)\n\tmetadataMap[\"root/testA\"] = []byte(`\n links:\n - product: chrome\n url: foo.com\n results:\n - test: a.html\n status: FAIL\n `)\n\n\tmetadataMap[\"testB\"] = []byte(`\n links:\n - product: firefox\n url: bar.com\n results:\n - test: b.html\n status: FAIL\n `)\n\treturn metadataMap\n}\n\nfunc TestPendingMetadataHandler_Success(t *testing.T) {\n\tctx := sharedtest.NewTestContext()\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tr := httptest.NewRequest(\"GET\", \"/api/metadata/pending\", nil)\n\tw := httptest.NewRecorder()\n\n\tmockSet := sharedtest.NewMockRedisSet(mockCtrl)\n\tmockSet.EXPECT().GetAll(shared.PendingMetadataCacheKey).Return([]string{\"123\", \"456\"}, nil)\n\n\tvar expected, result1, result2, actual shared.MetadataResults\n\tjson.Unmarshal([]byte(`{\n \"/testB/b.html\": [\n {\n \"product\": \"firefox\",\n \"url\":\"bar.com\",\n \"results\":[{\"status\":6}]\n }\n ],\n \"/foo1/bar1.html\": [\n {\n \"product\": \"chrome\",\n \"url\": \"https://bugs.bar\",\n \"results\": [\n {\"status\": 6, \"subtest\": \"sub-bar1\" },\n {\"status\": 3 }\n ]}\n ]\n }`), &expected)\n\n\tjson.Unmarshal([]byte(`{\n \"/testB/b.html\": [\n {\n \"product\": \"firefox\",\n \"url\":\"bar.com\",\n \"results\":[{\"status\":6}]\n }\n ]\n }`), &result1)\n\n\tjson.Unmarshal([]byte(`{\n \"/foo1/bar1.html\": [\n {\n \"product\": \"chrome\",\n \"url\": \"https://bugs.bar\",\n \"results\": [\n {\"status\": 6, \"subtest\": \"sub-bar1\" },\n {\"status\": 3 }\n ]}\n ]\n }`), &result2)\n\n\tresults := []shared.MetadataResults{\n\t\tresult1,\n\t\tresult2,\n\t}\n\tbindMetadataResults := func(i int) func(_, _ interface{}) {\n\t\treturn func(cid, ms interface{}) {\n\t\t\tptr := ms.(*shared.MetadataResults)\n\t\t\t*ptr = results[i]\n\t\t}\n\t}\n\n\tmockCache := sharedtest.NewMockObjectCache(mockCtrl)\n\tkeys := []string{\n\t\tshared.PendingMetadataCachePrefix + \"123\",\n\t\tshared.PendingMetadataCachePrefix + \"456\",\n\t}\n\tfor i, key := range keys {\n\t\tmockCache.EXPECT().Get(key, gomock.Any()).Do(bindMetadataResults(i)).Return(nil)\n\t}\n\n\thandlePendingMetadata(ctx, mockCache, mockSet, w, r)\n\n\tassert.Equal(t, http.StatusOK, w.Code)\n\n\tres := w.Body.String()\n\tjson.Unmarshal([]byte(res), &actual)\n\tassert.Equal(t, expected, actual)\n}\n\nfunc TestPendingMetadataHandler_EmptyObjectCache(t *testing.T) {\n\tctx := sharedtest.NewTestContext()\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tr := httptest.NewRequest(\"GET\", \"/api/metadata/pending\", nil)\n\tw := httptest.NewRecorder()\n\n\tmockSet := sharedtest.NewMockRedisSet(mockCtrl)\n\tmockSet.EXPECT().GetAll(shared.PendingMetadataCacheKey).Return([]string{\"123\", \"456\"}, nil)\n\n\tmockCache := sharedtest.NewMockObjectCache(mockCtrl)\n\tkeys := []string{\n\t\tshared.PendingMetadataCachePrefix + \"123\",\n\t\tshared.PendingMetadataCachePrefix + \"456\",\n\t}\n\tfor _, key := range keys {\n\t\tmockCache.EXPECT().Get(key, gomock.Any()).Return(errors.New(\"cache miss\"))\n\t}\n\n\thandlePendingMetadata(ctx, mockCache, mockSet, w, r)\n\n\tassert.Equal(t, http.StatusOK, w.Code)\n\n\tvar actual shared.MetadataResults\n\tres := w.Body.String()\n\tjson.Unmarshal([]byte(res), &actual)\n\tassert.Equal(t, shared.MetadataResults{}, actual)\n}\n\nfunc TestPendingMetadataHandler_Fail(t *testing.T) {\n\tctx := sharedtest.NewTestContext()\n\tmockCtrl := gomock.NewController(t)\n\tdefer mockCtrl.Finish()\n\n\tr := httptest.NewRequest(\"GET\", \"/api/metadata/pending\", nil)\n\tw := httptest.NewRecorder()\n\n\tmockCache := sharedtest.NewMockObjectCache(mockCtrl)\n\tmockSet := sharedtest.NewMockRedisSet(mockCtrl)\n\tmockSet.EXPECT().GetAll(shared.PendingMetadataCacheKey).Return(nil, errors.New(\"cache miss\"))\n\n\thandlePendingMetadata(ctx, mockCache, mockSet, w, r)\n\n\tassert.Equal(t, http.StatusInternalServerError, w.Code)\n}\n" }, { "path": "api/pending_test_runs.go", "content": "// Copyright 2019 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage api //nolint:revive\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"net/http\"\n\t\"sort\"\n\t\"strings\"\n\n\t\"github.com/gorilla/mux\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// apiPendingTestRunsHandler is responsible for emitting JSON for\n// all the non-completed PendingTestRun entities.\nfunc apiPendingTestRunsHandler(w http.ResponseWriter, r *http.Request) {\n\tctx := r.Context()\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\n\tfilter := strings.ToLower(mux.Vars(r)[\"filter\"])\n\tq := store.NewQuery(\"PendingTestRun\")\n\tswitch filter {\n\tcase \"pending\":\n\t\tq = q.Order(\"-Stage\").Filter(\"Stage < \", int(shared.StageValid))\n\tcase \"invalid\":\n\t\tq = q.Filter(\"Stage = \", int(shared.StageInvalid))\n\tcase \"empty\":\n\t\tq = q.Filter(\"Stage = \", int(shared.StageEmpty))\n\tcase \"duplicate\":\n\t\tq = q.Filter(\"Stage = \", int(shared.StageDuplicate))\n\tcase \"\":\n\t\t// No-op\n\tdefault:\n\t\thttp.Error(w, \"Invalid filter: \"+filter, http.StatusBadRequest)\n\n\t\treturn\n\t}\n\t// nolint:godox // TODO(Hexcles): Support pagination.\n\tq = q.Order(\"-Updated\").Limit(shared.MaxCountMaxValue)\n\n\tvar runs []shared.PendingTestRun\n\tkeys, err := store.GetAll(q, &runs)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\tfor i, key := range keys {\n\t\truns[i].ID = key.IntID()\n\t}\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\t// When we filter by status (pending) we need to re-sort.\n\tsort.Sort(sort.Reverse(shared.PendingTestRunByUpdated(runs)))\n\temit(r.Context(), w, runs)\n}\n\n// emit to the given writer the JSON marshalled output of the given interface.\nfunc emit(ctx context.Context, w http.ResponseWriter, i interface{}) {\n\tdata, err := json.Marshal(i)\n\tif err != nil {\n\t\thttp.Error(w, err.Error(), http.StatusInternalServerError)\n\n\t\treturn\n\t}\n\t_, err = w.Write(data)\n\tif err != nil {\n\t\tlogger := shared.GetLogger(ctx)\n\t\tlogger.Warningf(\"Failed to write data in api/status handler: %s\", err.Error())\n\t}\n}\n" }, { "path": "api/pending_test_runs_medium_test.go", "content": "//go:build medium\n\npackage api //nolint:revive\n\nimport (\n\t\"context\"\n\t\"encoding/json\"\n\t\"io\"\n\t\"net/http\"\n\t\"net/http/httptest\"\n\t\"testing\"\n\t\"time\"\n\n\t\"github.com/gorilla/mux\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared/sharedtest\"\n\n\t\"github.com/stretchr/testify/assert\"\n)\n\nfunc createPendingRun(ctx context.Context, run *shared.PendingTestRun) error {\n\tstore := shared.NewAppEngineDatastore(ctx, false)\n\tkey := store.NewIncompleteKey(\"PendingTestRun\")\n\tkey, err := store.Put(key, run)\n\trun.ID = key.IntID()\n\treturn err\n}\n\nfunc TestAPIPendingTestHandler(t *testing.T) {\n\ti, err := sharedtest.NewAEInstance(true)\n\tassert.Nil(t, err)\n\tdefer i.Close()\n\tr, err := i.NewRequest(\"GET\", \"/api/status\", nil)\n\tassert.Nil(t, err)\n\n\tctx := r.Context()\n\n\tnow := time.Now().Truncate(time.Minute).In(time.UTC)\n\tyesterday := now.Add(time.Hour * -24)\n\n\tinvalid := shared.PendingTestRun{\n\t\tCreated: yesterday,\n\t\tUpdated: now,\n\t\tStage: shared.StageInvalid,\n\t}\n\tassert.Nil(t, createPendingRun(ctx, &invalid))\n\n\tempty := shared.PendingTestRun{\n\t\tCreated: yesterday,\n\t\tUpdated: now.Add(time.Minute * -1),\n\t\tStage: shared.StageEmpty,\n\t}\n\tassert.Nil(t, createPendingRun(ctx, &empty))\n\n\tduplicate := shared.PendingTestRun{\n\t\tCreated: yesterday,\n\t\tUpdated: now.Add(time.Minute * -2),\n\t\tStage: shared.StageDuplicate,\n\t}\n\tassert.Nil(t, createPendingRun(ctx, &duplicate))\n\n\treceived := shared.PendingTestRun{\n\t\tCreated: yesterday.Add(time.Hour),\n\t\tUpdated: now.Add(time.Minute * -10),\n\t\tStage: shared.StageWptFyiReceived,\n\t}\n\tassert.Nil(t, createPendingRun(ctx, &received))\n\n\trunning := shared.PendingTestRun{\n\t\tCreated: yesterday.Add(time.Hour),\n\t\tUpdated: now.Add(time.Minute * -5),\n\t\tStage: shared.StageCIRunning,\n\t}\n\tassert.Nil(t, createPendingRun(ctx, &running))\n\n\tt.Run(\"/api/status\", func(t *testing.T) {\n\t\tr, _ = i.NewRequest(\"GET\", \"/api/status\", nil)\n\t\tresp := httptest.NewRecorder()\n\t\tapiPendingTestRunsHandler(resp, r)\n\t\tbody, _ := io.ReadAll(resp.Result().Body)\n\t\tassert.Equal(t, http.StatusOK, resp.Code, string(body))\n\t\tvar results []shared.PendingTestRun\n\t\tjson.Unmarshal(body, &results)\n\t\tassert.Len(t, results, 5)\n\t\t// Sorted by Update.\n\t\tassert.Equal(t, results[0].ID, invalid.ID)\n\t\tassert.Equal(t, results[1].ID, empty.ID)\n\t\tassert.Equal(t, results[2].ID, duplicate.ID)\n\t\tassert.Equal(t, results[3].ID, running.ID)\n\t\tassert.Equal(t, results[4].ID, received.ID)\n\t})\n\n\tt.Run(\"/api/status/pending\", func(t *testing.T) {\n\t\tr, _ = i.NewRequest(\"GET\", \"/api/status/pending\", nil)\n\t\tr = mux.SetURLVars(r, map[string]string{\"filter\": \"pending\"})\n\t\tresp := httptest.NewRecorder()\n\t\tapiPendingTestRunsHandler(resp, r)\n\t\tbody, _ := io.ReadAll(resp.Result().Body)\n\t\tassert.Equal(t, http.StatusOK, resp.Code, string(body))\n\t\tvar results []shared.PendingTestRun\n\t\tjson.Unmarshal(body, &results)\n\t\tassert.Len(t, results, 2)\n\t\tassert.Equal(t, results[0].ID, running.ID)\n\t\tassert.Equal(t, results[1].ID, received.ID)\n\t})\n\n\tfilters := []string{\"invalid\", \"empty\", \"duplicate\"}\n\truns := []*shared.PendingTestRun{&invalid, &empty, &duplicate}\n\n\tfor index, filter := range filters {\n\t\turl := \"/api/status/\" + filter\n\t\tt.Run(url, func(t *testing.T) {\n\t\t\tr, _ = i.NewRequest(\"GET\", url, nil)\n\t\t\tr = mux.SetURLVars(r, map[string]string{\"filter\": filter})\n\t\t\tresp := httptest.NewRecorder()\n\t\t\tapiPendingTestRunsHandler(resp, r)\n\t\t\tbody, _ := io.ReadAll(resp.Result().Body)\n\t\t\tassert.Equal(t, http.StatusOK, resp.Code, string(body))\n\t\t\tvar results []shared.PendingTestRun\n\t\t\tjson.Unmarshal(body, &results)\n\t\t\tassert.Len(t, results, 1)\n\t\t\tassert.Equal(t, results[0].ID, runs[index].ID)\n\t\t})\n\t}\n}\n\nfunc TestAPIPendingTestHandler_invalidFilter(t *testing.T) {\n\ti, err := sharedtest.NewAEInstance(true)\n\tassert.Nil(t, err)\n\tdefer i.Close()\n\n\tr, _ := i.NewRequest(\"GET\", \"/api/status/foobar\", nil)\n\tr = mux.SetURLVars(r, map[string]string{\"filter\": \"foobar\"})\n\tresp := httptest.NewRecorder()\n\tapiPendingTestRunsHandler(resp, r)\n\tassert.Equal(t, http.StatusBadRequest, resp.Code)\n}\n" }, { "path": "api/query/README.md", "content": "# wpt.fyi Search queries\n\nwpt.fyi supports a structured search syntax, allowing the user to filter specific results.\n\n## wpt.fyi search syntax\n\nAs outlined below, the `/api/search` endpoint takes a structured query object. wpt.fyi's\nUI contains a search-box that converts a search syntax into the required structured query.\nListed below are the \"atoms\" that can be used in a search.\n\n### Root queries\n\nBy default, a search query will be implicitly treated as an `exists` query (a disjunction\nacross each of the runs separately). However, there are several other root query types that\ncan be invoked by wrapping the query(s), including explicitly wrapping with `exists`.\n\nIf multiple root queries are used, they are implicitly combined with `AND`, i.e. each query\nmust separately be true. e.g.\n\n count>1(status:!pass) none(status:missing)\n\nRequires that more than one non-pass result is present, and none of the results are missing.\nYou can also explicitly combine the root queries with `and`, e.g.\n\n count<3(status:pass) and none(status:missing)\n\nAlternatively, root queries can be combined using `or`, e.g.\n\n none(status:pass) or all(status:pass)\n\nNote that the `and` conjunction takes precedence over the `or` conjunction.\n\n#### Exists\n\nAs stated above, exists is the implicit default.\n\n exists([query1] [query2])\n\nCombines the filters such that there exists some result in the row that satisfies each query.\n\n#### All and None\n\n all([query1] [query2])\n\nCombines filters such that they must all apply to all runs.\n\n none([query1] [query2])\n\nCombines filters such that they must not _all_ apply to _any_ single run.\n\n#### Sequential\n\n seq([query1] [query2] [...])\n\nCombines filters such that they must apply to runs sequentially. This is mainly\nuseful when there are multiple runs with the same product, e.g. to find a regression\n\n seq(status:pass status:fail)\n\n#### Count\n\n count:[number]([query1] [query2])\n\nRequires that the number of results matching the given query/queries is precisely\nthe given count. For example, this search atom can be used to find cases where\nexactly one result is a failure:\n\n count:1(status:fail)\n\nNote that there are some special keywords for count:1, count:2, and count:3\n(`one`, `two` and `three` respectively). For example, to find results where\nSafari is the only one missing a result:\n\n three(status:!missing) safari:missing\n\n##### Count inequality\n\n count[inequality][number]([query1])\n\nRequires that the number of results matching the given query satisfies the given\ninequality comparator.\n\n count=1(status:PASS)\n count>1(status:PASS)\n count<3(status:!FAIL)\n count<=1(status:FAIL)\n count>=1(status:MISSING)\n\n> NOTE: The colon after the `count` is optional for inequalities. Queries like\n> `count:>1(status:missing)`, with a syntax similar to GitHub's search, will work.\n\n### Query atoms\n\nWithin a root query, there are several search atoms that can be used to\nfilter the results (according to the root query).\n\n#### Path\n\n path:[path]\n\nFilters results to a specific path prefix. For example, this search atom can be\nused to list only results for the `/dom/` directory:\n\n path:/dom/\n\nNote that without the trailing `/`, the `/domparsing/` and `/domxpath`\ndirectories would also be included.\n\n#### Status\n\nFilters to results with a specific status (or, _not_ a specific status).\n\nValid statuses are:\n\n - `unknown` (a.k.a. `missing`)\n - `pass`\n - `ok`\n - `error`\n - `timeout`\n - `notrun`\n - `fail`\n - `crash`\n - `skip`\n - `assert`\n - `precondition_failed`\n\n> NOTE: `ok` is the status of the test harness setup. Individual subtests will have\n> a status of `pass` - it may be necessary to search for both.\n\nThere are a couple of different ways to filter by status.\n\n##### Status for any product\n\n status:[status]\n\nor, negation,\n\n status:![status]\n\n\n##### Status for a specific product\n\n [product]:[status]\n\nWhere `[product]` is a product specification (e.g. `safari`, `chrome-69`).\n\n#### Meta qualities\n\nFilters the results to values which possess/exhibit a given quality.\n\n is:[quality]\n\n##### `is:different`\n\nFilters to rows where there is more than one resulting status for a test\nacross the runs.\n\n##### `is:tentative`\n\nFilters to tests that are marked as tentative (currently based on [file\nname](https://web-platform-tests.org/writing-tests/file-names.html)).\n\n##### `is:optional`\n\nFilters to tests that are marked as optional (currently based on [file\nname](https://web-platform-tests.org/writing-tests/file-names.html)).\n\n**Note**: At this time, the `may` and `should` [metadata\nflags](https://web-platform-tests.org/writing-tests/css-metadata.html#requirement-flags)\nare not supported.\n\n#### And-conjuction\n\n [query1] and [query2] [and ...]\n\nCombines filters, such that they must all apply, e.g.\n\n chrome:pass and firefox:!pass\n\n#### Or-conjuction\n\n [query1] or [query2] [or ...]\n\nCombines filters, such that any must apply, e.g.\n\n chrome:pass or chrome:ok\n\n> NOTE: Or-conjuction takes less precedence than `and`. Precedence can be modified\n> using parens, e.g. `chrome:pass and (firefox:!pass or safari:!pass)`\n\n## /api/search\n\nThe `/api/search` endpoint takes an HTTP `POST` method, where the body is of the format\n\n {\n \"run_ids\": [123, 456, ...],\n \"query\": {\n [Structured query]\n }\n }\n\n### Structured query objects\n\nStructured query objects are produced by the syntax parser on wpt.fyi.\n\nThe easiest way to build the query you need is to use the syntax above, and inspect\nthe outgoing HTTP `POST` body.\n\n#### exists\n\n`exists` query objects perform a disjunction of all of the runs, in order to ensure\nthat each of its queries is satisfied _by the same run_. This matters for the case\nthat there are multiple runs with the same product.\n\n {\"exists\": [query1, query2, ...]}\n\n#### all\n\n`all` query objects perform a conjunction of all of the runs, in order to ensure\nthat each of its queries is satisfied by all of the runs.\n\n {\"all\": [query1, query2, ...]}\n\n#### none\n\n`none` query objects perform a disjunction of all of the runs, in order to ensure\nthat no single run satisfies all of its queries. `none` queries are a simplification for\n`{\"not\": {\"exists\": [...] }}` queries.\n\n {\"none\": [query1, query2, ...]}\n\n#### sequential\n\n`sequential` query objects perform an ordered disjunction of all of the runs.\nLike exists, the queries must be satisfied by the same run, but in addition, the order\nof the queries must be satisfied by the runs, in order.\n\n {\"sequential\": [query1, query2, ...]}\n\n#### count\n\n`count` query objects perform a count across all the runs, returning rows which have\na count of exactly the given number.\n\n {\n \"count\": 2,\n \"where\": {\n // query object\n }\n }\n\n#### moreThan and lessThan\n\n`moreThan` and `lessThan` are similar to count, but perform an inequality instead of\nequality (exact count).\n\n {\n \"moreThan\": 2,\n \"where\": {\n // query object\n }\n }\n\n#### and\n\n {\"and\": [query1, query2, ...]}\n\n#### or\n\n {\"or\": [query1, query2, ...]}\n\n#### path\n\nTakes a string of the path prefix to match.\n\n {\"path\": \"/dom/\"}\n\n#### status\n\nTakes a string of the status to match.\n\n {\"status\": \"ok\"}\n\n#### status not\n\nA not-clause for the given status.\n\n {\"status\": {\"not\": \"fail\"} }\n\n#### product status\n\nSame as satuts, but with a specific product-spec.\n\n {\n \"product\": \"chrome-69\",\n \"status\": \"ok\",\n }\n\n#### link\n\n`link` query atoms perform a search for tests that have some matching link metadata.\n\n {\"link\": pattern}\n\n E.g.\n\nSearch untriaged issues -\n\n chrome:fail and !link:issues.chromium.org\n\nSearch triaged issues -\n\n chrome:pass and link:issues.chromium.org\n\n#### triaged\n\n`triaged` query atoms perform a search for tests of a specific browser that have link metadata.\n\n {\"triaged\": [browsername]}\n\nWhere [browsername] is a browser specification (e.g. safari, chrome).\n\n E.g.\n\nSearch untriaged Chrome failures -\n\n chrome:fail and none(triaged:chrome)\n\nSearch triaged Chrome tests -\n\n chrome:pass and triaged:chrome\n\n#### label\n\n`label` query atoms perform a search for tests that have a matching metadata label,\nregardless of browsers.\n\n {\"label\": label}\n\nWhere label is a string and case-insensitive.\n\n E.g.\n\nSearch triaged tests with a label interop-2022:\n\n label:interop-2022\n\n#### is\n\n`is` query atoms perform a search for tests that possess some meta quality.\n\n {\"is\": \"different\"}\n\n\n\nSee [Meta qualities](#meta-qualities) above for more information on other\nmeta qualities than `\"different\"`.\n\n#### feature\n\n`feature` query atoms perform a search for tests that have a matching\nfeature label, regardless of browsers.\n\n {\"feature\": [web-feature-name]}\n\nWhere web-feature-name is a string, case-insensitive and matches the filename base\nfor any of the .yml files in the\n[features](https://github.com/web-platform-dx/web-features/blob/main/features/) directory.\n\n E.g.\n\nSearch the [nesting](https://github.com/web-platform-dx/web-features/blob/main/features/nesting.yml) feature:\n\n feature:nesting\n" }, { "path": "api/query/atoms.go", "content": "// Copyright 2018 The WPT Dashboard Project. All rights reserved.\n// Use of this source code is governed by a BSD-style license that can be\n// found in the LICENSE file.\n\npackage query\n\n// This file defines search atoms on the backend. All wpt.fyi search queries\n// are broken down into a tree of search atoms, which is then traversed by the\n// searchcache to find matching tests to include.\n//\n// All search atoms must define two methods:\n// i. BindToRuns\n// ii. UnmarshalJSON\n//\n// These are best understood in reverse, as that is also the order they are\n// called in. UnmarshalJSON is used to convert from the original JSON search\n// query into the tree of abstract search atoms. The atoms are referred to as\n// abstract as they do not yet relate to any underlying data (i.e. any test\n// runs). Many types of atom (such as AbstractExists) perform this\n// unmarshalling recursively, which is how we end up with a tree.\n//\n// Once we have an abstract search tree, BindToRuns will convert it to a\n// concrete search tree (that is, a tree of ConcreteQuery atoms). This gives\n// the search atoms access to the specific runs that are being searched over,\n// to pull any specific information needed. For example, this allows\n// TestStatusEq to only produce results for test runs that match the specified\n// product (and short-circuit entirely if no test runs match).\n//\n// Some abstract search atoms may produce more than one concrete search atom\n// (e.g. AbstractExists, which produces a disjunction), whilst others may\n// ignore the test runs entirely if they aren't relevant (e.g.\n// TestNamePattern, which only cares about the test name and not the results).\n//\n// Note that this file does not perform the actual filtering of tests from the\n// test runs to produce the search response; for that see the `filter` type in\n// api/query/cache/index/filter.go\n\nimport (\n\t\"encoding/json\"\n\t\"errors\"\n\t\"fmt\"\n\t\"strings\"\n\n\t\"github.com/sirupsen/logrus\"\n\t\"github.com/web-platform-tests/wpt.fyi/shared\"\n)\n\n// AbstractQuery is an intermetidate representation of a test results query that\n// has not been bound to specific shared.TestRun specs for processing.\ntype AbstractQuery interface {\n\tBindToRuns(runs ...shared.TestRun) ConcreteQuery\n}\n\n// RunQuery is the internal representation of a query received from an HTTP\n// client, including the IDs of the test runs to query, and the structured query\n// to run.\ntype RunQuery struct {\n\tRunIDs []int64\n\tAbstractQuery\n}\n\n// True is a true-valued ConcreteQuery.\ntype True struct{}\n\n// BindToRuns for True is a no-op; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (t True) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\treturn t\n}\n\n// False is a false-valued ConcreteQuery.\ntype False struct{}\n\n// BindToRuns for False is a no-op; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (f False) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\treturn f\n}\n\n// TestNamePattern is a query atom that matches test names to a pattern string.\ntype TestNamePattern struct {\n\tPattern string\n}\n\n// BindToRuns for TestNamePattern is a no-op; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (tnp TestNamePattern) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\treturn tnp\n}\n\n// SubtestNamePattern is a query atom that matches subtest names to a pattern string.\ntype SubtestNamePattern struct {\n\tSubtest string\n}\n\n// BindToRuns for SubtestNamePattern is a no-op; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (tnp SubtestNamePattern) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\treturn tnp\n}\n\n// TestPath is a query atom that matches exact test path prefixes.\n// It is an inflexible equivalent of TestNamePattern.\ntype TestPath struct {\n\tPath string\n}\n\n// BindToRuns for TestNamePattern is a no-op; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (tp TestPath) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\treturn tp\n}\n\n// AbstractExists represents an array of abstract queries, each of which must be\n// satifisfied by some run. It represents the root of a structured query.\ntype AbstractExists struct {\n\tArgs []AbstractQuery\n}\n\n// BindToRuns binds each abstract query to an or-combo of that query against\n// each specific/individual run.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (e AbstractExists) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tqueries := make([]ConcreteQuery, len(e.Args))\n\t// When the nested query is a single query, e.g. And/Or, bind that query directly.\n\tif len(e.Args) == 1 {\n\t\treturn e.Args[0].BindToRuns(runs...)\n\t}\n\n\tfor i, arg := range e.Args {\n\t\tvar query ConcreteQuery\n\t\t// Exists queries are split; one run must satisfy the whole tree.\n\t\tbyRun := make([]ConcreteQuery, 0, len(runs))\n\t\tfor _, run := range runs {\n\t\t\tbound := arg.BindToRuns(run)\n\t\t\tif _, ok := bound.(False); !ok {\n\t\t\t\tbyRun = append(byRun, bound)\n\t\t\t}\n\t\t}\n\t\tquery = Or{Args: byRun}\n\t\tqueries[i] = query\n\t}\n\t// And the overall node is true if all its exists queries are true.\n\treturn And{\n\t\tArgs: queries,\n\t}\n}\n\n// AbstractAll represents an array of abstract queries, each of which must be\n// satifisfied by all runs. It represents the root of a structured query.\ntype AbstractAll struct {\n\tArgs []AbstractQuery\n}\n\n// BindToRuns binds each abstract query to an and-combo of that query against\n// each specific/individual run.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (e AbstractAll) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tqueries := make([]ConcreteQuery, len(e.Args))\n\tfor i, arg := range e.Args {\n\t\tvar query ConcreteQuery\n\t\tbyRun := make([]ConcreteQuery, 0, len(runs))\n\t\tfor _, run := range runs {\n\t\t\tbound := arg.BindToRuns(run)\n\t\t\tif _, ok := bound.(True); !ok { // And with True is pointless.\n\t\t\t\tbyRun = append(byRun, bound)\n\t\t\t}\n\t\t}\n\t\tquery = And{Args: byRun}\n\t\tqueries[i] = query\n\t}\n\t// And the overall node is true if all its exists queries are true.\n\treturn And{\n\t\tArgs: queries,\n\t}\n}\n\n// AbstractNone represents an array of abstract queries, each of which must not be\n// satifisfied by any run. It represents the root of a structured query.\ntype AbstractNone struct {\n\tArgs []AbstractQuery\n}\n\n// BindToRuns binds to a not-exists for the same query(s).\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (e AbstractNone) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\treturn Not{\n\t\tAbstractExists(e).BindToRuns(runs...),\n\t}\n}\n\n// AbstractSequential represents the root of a sequential queries, where the first\n// query must be satisfied by some run such that the next run, sequentially, also\n// satisfies the next query, and so on.\ntype AbstractSequential struct {\n\tArgs []AbstractQuery\n}\n\n// BindToRuns binds each sequential query to an and-combo of those queries against\n// specific sequential runs, for each combination of sequential runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (e AbstractSequential) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tnumSeqQueries := len(e.Args)\n\tbyRuns := []ConcreteQuery{}\n\tfor i := 0; i+numSeqQueries-1 < len(runs); i++ {\n\t\tall := And{} // nolint:exhaustruct // TODO: Fix exhaustruct lint error.\n\t\tfor j, arg := range e.Args {\n\t\t\tall.Args = append(all.Args, arg.BindToRuns(runs[i+j]))\n\t\t}\n\t\tbyRuns = append(byRuns, all)\n\t}\n\n\treturn Or{\n\t\tArgs: byRuns,\n\t}\n}\n\n// AbstractCount represents the root of a count query, where the exact number of\n// runs that satisfy the query must match the expected count.\ntype AbstractCount struct {\n\tCount int\n\tWhere AbstractQuery\n}\n\n// BindToRuns binds each count query to all of the runs, so that it can count the\n// number of runs that match the criteria.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (c AbstractCount) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tbyRun := make([]ConcreteQuery, 0, len(runs))\n\tfor _, run := range runs {\n\t\tbyRun = append(byRun, c.Where.BindToRuns(run))\n\t}\n\n\treturn Count{\n\t\tCount: c.Count,\n\t\tArgs: byRun,\n\t}\n}\n\n// AbstractMoreThan is the root of a moreThan query, where the number of runs\n// that satisfy the query must be more than the given count.\ntype AbstractMoreThan struct {\n\tAbstractCount\n}\n\n// BindToRuns binds each count query to all of the runs, so that it can count the\n// number of runs that match the criteria.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (m AbstractMoreThan) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tc := m.AbstractCount.BindToRuns(runs...).(Count)\n\n\treturn MoreThan{c}\n}\n\n// AbstractLessThan is the root of a lessThan query, where the number of runs\n// that satisfy the query must be less than the given count.\ntype AbstractLessThan struct {\n\tAbstractCount\n}\n\n// BindToRuns binds each count query to all of the runs, so that it can count the\n// number of runs that match the criteria.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (l AbstractLessThan) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tc := l.AbstractCount.BindToRuns(runs...).(Count)\n\n\treturn LessThan{c}\n}\n\n// AbstractLink is represents the root of a link query, which matches Metadata\n// URLs to a pattern string.\ntype AbstractLink struct {\n\tPattern string\n\tmetadataFetcher shared.MetadataFetcher\n}\n\n// BindToRuns for AbstractLink fetches metadata for either test-level issues or\n// issues associated with the given runs. It does not filter the metadata by\n// the pattern yet.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (l AbstractLink) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tif l.metadataFetcher == nil {\n\t\tl.metadataFetcher = searchcacheMetadataFetcher{}\n\t}\n\tincludeTestLevel := true\n\tmetadata, _ := shared.GetMetadataResponse(runs, includeTestLevel, logrus.StandardLogger(), l.metadataFetcher)\n\tmetadataMap := shared.PrepareLinkFilter(metadata)\n\n\treturn Link{\n\t\tPattern: l.Pattern,\n\t\tMetadata: metadataMap,\n\t}\n}\n\n// AbstractTriaged represents the root of a triaged query that matches\n// tests where the test of a specific browser has been triaged through Metadata.\ntype AbstractTriaged struct {\n\tProduct *shared.ProductSpec\n\tmetadataFetcher shared.MetadataFetcher\n}\n\n// BindToRuns for AbstractTriaged binds each run matching the AbstractTriaged\n// ProductSpec to a triaged object.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (t AbstractTriaged) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tcq := make([]ConcreteQuery, 0)\n\n\tif t.metadataFetcher == nil {\n\t\tt.metadataFetcher = searchcacheMetadataFetcher{}\n\t}\n\tfor _, run := range runs {\n\t\tif t.Product == nil || t.Product.Matches(run) {\n\t\t\t// We only want to fetch metadata for this specific run (or for no runs, if\n\t\t\t// the search is for test-level issues).\n\t\t\tincludeTestLevel := false\n\t\t\tmetadataRuns := []shared.TestRun{run}\n\n\t\t\t// Product being nil means that we want test-level issues.\n\t\t\tif t.Product == nil {\n\t\t\t\tincludeTestLevel = true\n\t\t\t\tmetadataRuns = []shared.TestRun{}\n\t\t\t}\n\t\t\tmetadata, _ := shared.GetMetadataResponse(metadataRuns, includeTestLevel, logrus.StandardLogger(), t.metadataFetcher)\n\t\t\tmetadataMap := shared.PrepareLinkFilter(metadata)\n\t\t\tif len(metadataMap) > 0 {\n\t\t\t\tcq = append(cq, Triaged{run.ID, metadataMap})\n\t\t\t}\n\t\t}\n\t}\n\n\tif len(cq) == 0 {\n\t\treturn False{}\n\t}\n\n\treturn Or{cq}\n}\n\n// AbstractTestLabel represents the root of a testlabel query, which matches test-level metadata\n// labels to a searched label.\ntype AbstractTestLabel struct {\n\tLabel string\n\tmetadataFetcher shared.MetadataFetcher\n}\n\n// BindToRuns for AbstractTestLabel fetches test-level metadata; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (t AbstractTestLabel) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\tif t.metadataFetcher == nil {\n\t\tt.metadataFetcher = searchcacheMetadataFetcher{}\n\t}\n\n\tincludeTestLevel := true\n\t// Passing []shared.TestRun{} means that we want test-level issues.\n\tmetadata, _ := shared.GetMetadataResponse(\n\t\t[]shared.TestRun{},\n\t\tincludeTestLevel,\n\t\tlogrus.StandardLogger(),\n\t\tt.metadataFetcher,\n\t)\n\tmetadataMap := shared.PrepareTestLabelFilter(metadata)\n\n\treturn TestLabel{\n\t\tLabel: t.Label,\n\t\tMetadata: metadataMap,\n\t}\n}\n\n// webFeaturesManifestFetcher describes the behavior to fetch Web Features data.\ntype webFeaturesManifestFetcher interface {\n\tFetch() (shared.WebFeaturesData, error)\n}\n\n// AbstractTestWebFeature represents the root of a web_feature query, which matches test-level\n// metadata to a searched web feature.\ntype AbstractTestWebFeature struct {\n\tTestWebFeatureAtom\n\tmanifestFetcher webFeaturesManifestFetcher\n}\n\n// BindToRuns for AbstractTestWebFeature fetches test-level metadata; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (t AbstractTestWebFeature) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\tdata, _ := t.manifestFetcher.Fetch()\n\n\treturn TestWebFeature{\n\t\tWebFeature: t.WebFeature,\n\t\tWebFeaturesData: data,\n\t}\n}\n\n// MetadataQuality represents the root of an \"is\" query, which asserts known\n// metadata qualities to the results.\ntype MetadataQuality int\n\nconst (\n\t// MetadataQualityUnknown is a placeholder for unrecognized values.\n\tMetadataQualityUnknown MetadataQuality = iota\n\t// MetadataQualityDifferent represents an is:different atom.\n\t// \"different\" ensures that one or more results differs from the other results.\n\tMetadataQualityDifferent\n\t// MetadataQualityTentative represents an is:tentative atom.\n\t// \"tentative\" ensures that the results are from a tentative test.\n\tMetadataQualityTentative\n\t// MetadataQualityOptional represents an is:optional atom.\n\t// \"optional\" ensures that the results are from an optional test.\n\tMetadataQualityOptional\n)\n\n// BindToRuns for MetadataQuality is a no-op; it is independent of test runs.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (q MetadataQuality) BindToRuns(_ ...shared.TestRun) ConcreteQuery {\n\treturn q\n}\n\n// TestStatusEq is a query atom that matches tests where the test status/result\n// from at least one test run matches the given status value, optionally filtered\n// to a specific browser name.\ntype TestStatusEq struct {\n\tProduct *shared.ProductSpec\n\tStatus shared.TestStatus\n}\n\n// TestStatusNeq is a query atom that matches tests where the test status/result\n// from at least one test run does not match the given status value, optionally\n// filtered to a specific browser name.\ntype TestStatusNeq struct {\n\tProduct *shared.ProductSpec\n\tStatus shared.TestStatus\n}\n\n// BindToRuns for TestStatusEq expands to a disjunction of RunTestStatusEq\n// values.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (tse TestStatusEq) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tids := make([]int64, 0, len(runs))\n\tfor _, run := range runs {\n\t\tif tse.Product == nil || tse.Product.Matches(run) {\n\t\t\tids = append(ids, run.ID)\n\t\t}\n\t}\n\tif len(ids) == 0 {\n\t\treturn False{}\n\t}\n\tif len(ids) == 1 {\n\t\treturn RunTestStatusEq{ids[0], tse.Status}\n\t}\n\n\tq := Or{make([]ConcreteQuery, len(ids))}\n\tfor i := range ids {\n\t\tq.Args[i] = RunTestStatusEq{ids[i], tse.Status}\n\t}\n\n\treturn q\n}\n\n// BindToRuns for TestStatusNeq expands to a disjunction of RunTestStatusNeq\n// values.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (tsn TestStatusNeq) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\tids := make([]int64, 0, len(runs))\n\tfor _, run := range runs {\n\t\tif tsn.Product == nil || tsn.Product.Matches(run) {\n\t\t\tids = append(ids, run.ID)\n\t\t}\n\t}\n\tif len(ids) == 0 {\n\t\treturn False{}\n\t}\n\tif len(ids) == 1 {\n\t\treturn RunTestStatusNeq{ids[0], tsn.Status}\n\t}\n\n\tq := Or{make([]ConcreteQuery, len(ids))}\n\tfor i := range ids {\n\t\tq.Args[i] = RunTestStatusNeq{ids[i], tsn.Status}\n\t}\n\n\treturn q\n}\n\n// AbstractNot is the AbstractQuery for negation.\ntype AbstractNot struct {\n\tArg AbstractQuery\n}\n\n// BindToRuns for AbstractNot produces a Not with a bound argument.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (n AbstractNot) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\treturn Not{n.Arg.BindToRuns(runs...)}\n}\n\n// AbstractOr is the AbstractQuery for disjunction.\ntype AbstractOr struct {\n\tArgs []AbstractQuery\n}\n\n// BindToRuns for AbstractOr produces an Or with bound arguments.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (o AbstractOr) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\targs := make([]ConcreteQuery, 0, len(o.Args))\n\tfor i := range o.Args {\n\t\tsub := o.Args[i].BindToRuns(runs...)\n\t\tif t, ok := sub.(True); ok {\n\t\t\treturn t\n\t\t}\n\t\tif _, ok := sub.(False); ok {\n\t\t\tcontinue\n\t\t}\n\t\targs = append(args, sub)\n\t}\n\tif len(args) == 0 {\n\t\treturn False{}\n\t}\n\tif len(args) == 1 {\n\t\treturn args[0]\n\t}\n\n\treturn Or{\n\t\tArgs: args,\n\t}\n}\n\n// AbstractAnd is the AbstractQuery for conjunction.\ntype AbstractAnd struct {\n\tArgs []AbstractQuery\n}\n\n// BindToRuns for AbstractAnd produces an And with bound arguments.\n// nolint:ireturn // TODO: Fix ireturn lint error\nfunc (a AbstractAnd) BindToRuns(runs ...shared.TestRun) ConcreteQuery {\n\targs := make([]ConcreteQuery, 0, len(a.Args))\n\tfor i := range a.Args {\n\t\tsub := a.Args[i].BindToRuns(runs...)\n\t\tif _, ok := sub.(False); ok {\n\t\t\treturn False{}\n\t\t}\n\t\tif _, ok := sub.(True); ok {\n\t\t\tcontinue\n\t\t}\n\t\targs = append(args, sub)\n\t}\n\tif len(args) == 0 {\n\t\treturn False{}\n\t}\n\tif len(args) == 1 {\n\t\treturn args[0]\n\t}\n\n\treturn And{\n\t\tArgs: args,\n\t}\n}\n\n// UnmarshalJSON interprets the JSON representation of a RunQuery, instantiating\n// (an) appropriate Query implementation(s) according to the JSON structure.\nfunc (rq *RunQuery) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tRunIDs []int64 `json:\"run_ids\"`\n\t\tQuery json.RawMessage `json:\"query\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.RunIDs) == 0 {\n\t\treturn errors.New(`missing run query property: \"run_ids\"`)\n\t}\n\trq.RunIDs = data.RunIDs\n\n\tif len(data.Query) > 0 {\n\t\tq, err := unmarshalQ(data.Query)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\trq.AbstractQuery = q\n\t} else {\n\t\trq.AbstractQuery = True{}\n\t}\n\n\treturn nil\n}\n\n// UnmarshalJSON for TestNamePattern attempts to interpret a query atom as\n// {\"pattern\":}.\nfunc (tnp *TestNamePattern) UnmarshalJSON(b []byte) error {\n\tvar data map[string]*json.RawMessage\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tpatternMsg, ok := data[\"pattern\"]\n\tif !ok {\n\t\treturn errors.New(`missing test name pattern property: \"pattern\"`)\n\t}\n\tvar pattern string\n\tif err := json.Unmarshal(*patternMsg, &pattern); err != nil {\n\t\treturn errors.New(`test name pattern property \"pattern\" is not a string`)\n\t}\n\n\ttnp.Pattern = pattern\n\n\treturn nil\n}\n\n// UnmarshalJSON for SubtestNamePattern attempts to interpret a query atom as\n// {\"subtest\":}.\nfunc (tnp *SubtestNamePattern) UnmarshalJSON(b []byte) error {\n\tvar data map[string]*json.RawMessage\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tsubtestMsg, ok := data[\"subtest\"]\n\tif !ok {\n\t\treturn errors.New(`missing subtest name pattern property: \"subtest\"`)\n\t}\n\tvar subtest string\n\tif err := json.Unmarshal(*subtestMsg, &subtest); err != nil {\n\t\treturn errors.New(`subtest name property \"subtest\" is not a string`)\n\t}\n\ttnp.Subtest = subtest\n\n\treturn nil\n}\n\n// UnmarshalJSON for TestPath attempts to interpret a query atom as\n// {\"path\":}.\nfunc (tp *TestPath) UnmarshalJSON(b []byte) error {\n\tvar data map[string]*json.RawMessage\n\tif err := json.Unmarshal(b, &data); err != nil {\n\n\t\treturn err\n\t}\n\tpathMsg, ok := data[\"path\"]\n\tif !ok {\n\t\treturn errors.New(`missing test name path property: \"path\"`)\n\t}\n\tvar path string\n\tif err := json.Unmarshal(*pathMsg, &path); err != nil {\n\t\treturn errors.New(`missing test name path property \"path\" is not a string`)\n\t}\n\n\ttp.Path = path\n\n\treturn nil\n}\n\n// UnmarshalJSON for TestStatusEq attempts to interpret a query atom as\n// {\"product\": , \"status\": }.\nfunc (tse *TestStatusEq) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tBrowserName string `json:\"browser_name\"` // Legacy\n\t\tProduct string `json:\"product\"`\n\t\tStatus string `json:\"status\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif data.Product == \"\" && data.BrowserName != \"\" {\n\t\tdata.Product = data.BrowserName\n\t}\n\tif len(data.Status) == 0 {\n\t\treturn errors.New(`missing test status constraint property: \"status\"`)\n\t}\n\n\tvar product *shared.ProductSpec\n\tif data.Product != \"\" {\n\t\tp, err := shared.ParseProductSpec(data.Product)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tproduct = &p\n\t}\n\n\tstatusStr := strings.ToUpper(data.Status)\n\tstatus := shared.TestStatusValueFromString(statusStr)\n\tstatusStr2 := status.String()\n\tif statusStr != statusStr2 {\n\t\treturn fmt.Errorf(`invalid test status: \"%s\"`, data.Status)\n\t}\n\n\ttse.Product = product\n\ttse.Status = status\n\n\treturn nil\n}\n\n// UnmarshalJSON for TestStatusNeq attempts to interpret a query atom as\n// {\"product\": , \"status\": {\"not\": }}.\nfunc (tsn *TestStatusNeq) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tBrowserName string `json:\"browser_name\"` // Legacy\n\t\tProduct string `json:\"product\"`\n\t\tStatus struct {\n\t\t\tNot string `json:\"not\"`\n\t\t} `json:\"status\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif data.Product == \"\" && data.BrowserName != \"\" {\n\t\tdata.Product = data.BrowserName\n\t}\n\tif len(data.Status.Not) == 0 {\n\t\treturn errors.New(`missing test status constraint property: \"status.not\"`)\n\t}\n\n\tvar product *shared.ProductSpec\n\tif data.Product != \"\" {\n\t\tp, err := shared.ParseProductSpec(data.Product)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tproduct = &p\n\t}\n\n\tstatusStr := strings.ToUpper(data.Status.Not)\n\tstatus := shared.TestStatusValueFromString(statusStr)\n\tstatusStr2 := status.String()\n\tif statusStr != statusStr2 {\n\t\treturn fmt.Errorf(`invalid test status: \"%s\"`, data.Status)\n\t}\n\n\ttsn.Product = product\n\ttsn.Status = status\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractNot attempts to interpret a query atom as\n// {\"not\": }.\nfunc (n *AbstractNot) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tNot json.RawMessage `json:\"not\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.Not) == 0 {\n\t\treturn errors.New(`missing negation property: \"not\"`)\n\t}\n\n\tq, err := unmarshalQ(data.Not)\n\tn.Arg = q\n\n\treturn err\n}\n\n// UnmarshalJSON for AbstractOr attempts to interpret a query atom as\n// {\"or\": []}.\nfunc (o *AbstractOr) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tOr []json.RawMessage `json:\"or\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.Or) == 0 {\n\t\treturn errors.New(`missing disjunction property: \"or\"`)\n\t}\n\n\tqs := make([]AbstractQuery, 0, len(data.Or))\n\tfor _, msg := range data.Or {\n\t\tq, err := unmarshalQ(msg)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tqs = append(qs, q)\n\t}\n\to.Args = qs\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractAnd attempts to interpret a query atom as\n// {\"and\": []}.\nfunc (a *AbstractAnd) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tAnd []json.RawMessage `json:\"and\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.And) == 0 {\n\t\treturn errors.New(`missing conjunction property: \"and\"`)\n\t}\n\n\tqs := make([]AbstractQuery, 0, len(data.And))\n\tfor _, msg := range data.And {\n\t\tq, err := unmarshalQ(msg)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tqs = append(qs, q)\n\t}\n\ta.Args = qs\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractExists attempts to interpret a query atom as\n// {\"exists\": []}.\nfunc (e *AbstractExists) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tExists []json.RawMessage `json:\"exists\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.Exists) == 0 {\n\t\treturn errors.New(`missing conjunction property: \"exists\"`)\n\t}\n\n\tqs := make([]AbstractQuery, 0, len(data.Exists))\n\tfor _, msg := range data.Exists {\n\t\tq, err := unmarshalQ(msg)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tqs = append(qs, q)\n\t}\n\te.Args = qs\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractAll attempts to interpret a query atom as\n// {\"all\": []}.\nfunc (e *AbstractAll) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tAll []json.RawMessage `json:\"all\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.All) == 0 {\n\t\treturn errors.New(`missing conjunction property: \"all\"`)\n\t}\n\n\tqs := make([]AbstractQuery, 0, len(data.All))\n\tfor _, msg := range data.All {\n\t\tq, err := unmarshalQ(msg)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tqs = append(qs, q)\n\t}\n\te.Args = qs\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractNone attempts to interpret a query atom as\n// {\"none\": []}.\nfunc (e *AbstractNone) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tNone []json.RawMessage `json:\"none\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.None) == 0 {\n\t\treturn errors.New(`missing conjunction property: \"none\"`)\n\t}\n\n\tqs := make([]AbstractQuery, 0, len(data.None))\n\tfor _, msg := range data.None {\n\t\tq, err := unmarshalQ(msg)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tqs = append(qs, q)\n\t}\n\te.Args = qs\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractSequential attempts to interpret a query atom as\n// {\"exists\": []}.\nfunc (e *AbstractSequential) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tSequential []json.RawMessage `json:\"sequential\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.Sequential) == 0 {\n\t\treturn errors.New(`missing conjunction property: \"sequential\"`)\n\t}\n\n\tqs := make([]AbstractQuery, 0, len(data.Sequential))\n\tfor _, msg := range data.Sequential {\n\t\tq, err := unmarshalQ(msg)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tqs = append(qs, q)\n\t}\n\te.Args = qs\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractCount attempts to interpret a query atom as\n// {\"count\": int, \"where\": query}.\nfunc (c *AbstractCount) UnmarshalJSON(b []byte) (err error) {\n\tvar data struct {\n\t\tCount json.RawMessage `json:\"count\"`\n\t\tWhere json.RawMessage `json:\"where\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.Count) == 0 {\n\t\treturn errors.New(`missing count property: \"count\"`)\n\t}\n\tif len(data.Where) == 0 {\n\t\treturn errors.New(`missing count property: \"where\"`)\n\t}\n\n\tif err := json.Unmarshal(data.Count, &c.Count); err != nil {\n\t\treturn err\n\t}\n\tc.Where, err = unmarshalQ(data.Where)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractLessThan attempts to interpret a query atom as\n// {\"count\": int, \"where\": query}.\nfunc (l *AbstractLessThan) UnmarshalJSON(b []byte) error {\n\tvar data struct {\n\t\tCount json.RawMessage `json:\"lessThan\"`\n\t\tWhere json.RawMessage `json:\"where\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.Count) == 0 {\n\t\treturn errors.New(`missing lessThan property: \"lessThan\"`)\n\t}\n\tif len(data.Where) == 0 {\n\t\treturn errors.New(`missing count property: \"where\"`)\n\t}\n\n\terr := json.Unmarshal(data.Count, &l.Count)\n\tif err != nil {\n\t\treturn err\n\t}\n\tl.Where, err = unmarshalQ(data.Where)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractMoreThan attempts to interpret a query atom as\n// {\"count\": int, \"where\": query}.\nfunc (m *AbstractMoreThan) UnmarshalJSON(b []byte) (err error) {\n\tvar data struct {\n\t\tCount json.RawMessage `json:\"moreThan\"`\n\t\tWhere json.RawMessage `json:\"where\"`\n\t}\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tif len(data.Count) == 0 {\n\t\treturn errors.New(`missing moreThan property: \"moreThan\"`)\n\t}\n\tif len(data.Where) == 0 {\n\t\treturn errors.New(`missing count property: \"where\"`)\n\t}\n\n\tif err := json.Unmarshal(data.Count, &m.Count); err != nil {\n\t\treturn err\n\t}\n\tm.Where, err = unmarshalQ(data.Where)\n\tif err != nil {\n\t\treturn err\n\t}\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractLink attempts to interpret a query atom as\n// {\"link\":}.\nfunc (l *AbstractLink) UnmarshalJSON(b []byte) error {\n\tvar data map[string]*json.RawMessage\n\tif err := json.Unmarshal(b, &data); err != nil {\n\t\treturn err\n\t}\n\tpatternMsg, ok := data[\"link\"]\n\tif !ok {\n\t\treturn errors.New(`missing Link pattern property: \"link\"`)\n\t}\n\tvar pattern string\n\tif err := json.Unmarshal(*patternMsg, &pattern); err != nil {\n\t\treturn errors.New(`missing link pattern property \"pattern\" is not a string`)\n\t}\n\n\tl.Pattern = pattern\n\n\treturn nil\n}\n\n// UnmarshalJSON for AbstractTestLabel attempts to interpret a query atom as\n// {\"label\":