github.com/web-platform-tests/wpt.fyi@v0.0.0-20240530210107-70cf978996f1/docs/gcs.md (about)

     1  # Google Cloud Storage
     2  
     3  **Note:** to apply the all permissive CORS policy to a new bucket, run:
     4  `gsutil cors set util/gs-cors.json gs://[BUCKET]`
     5  
     6  Here are the buckets used by this project. Most of them have a `*-staging`
     7  counterpart for the `wptdashboard-staging` project.
     8  
     9  ## wptd
    10  
    11  This is a publicly readable bucket (with an all-permissive CORS policy) that
    12  serves the test results on wpt.fyi. The bucket has wpt.fyi-internal result
    13  summary files and results for individual tests for each test run. Generally, you
    14  shouldn't directly consume this bucket. Please see the
    15  [wptd-results](#wptdresults) bucket below if you want to fetch the raw results.
    16  
    17  The directory schema is roughly:
    18  
    19  * `[SHA] (full or short)`
    20      * `[product-id]-summary_v2.json.gz`
    21      * `[product-id]`
    22          * Split JSONs with the same directory hierarchy as tests in WPT...
    23  
    24  (See [wptd-results](#wptdresults) for the definition of `[product-id]`.)
    25  
    26  ## wptd-results
    27  
    28  This is a publicly readable bucket (with an all-permissive CORS policy) that
    29  contains full raw results (`wptreport.json` generated by `wpt run`). The wpt.fyi
    30  frontend currently doesn't serve files from this bucket, but various APIs
    31  return `raw_results_url` pointing to this bucket.
    32  
    33  The directory schema is roughly:
    34  
    35  * `[Full SHA]`
    36      * `[product-id]`
    37          * `report.json`
    38  
    39  where
    40  * `[product-id] := [browser]-[version]-[os]{-[os_version]}{-[checksum]}`
    41  * `[browser] := {chrome, edge, firefox, safari, …}`
    42  * `[version]`, a version string, preferably output by `browser-binary --version`,
    43     with anything other than `[A-Za-z0-9_.-]` replaced by underscores (e.g.
    44     "61.0a1", "68.0.3409.2_dev")
    45  * `[os] := {linux, windows, macos, android, ios}`
    46  * `[os_version]`, a version string similarly sanitized as `[version]`
    47  * `[checksum]`, some checksum of the wptreport.json served as a UID to
    48     differentiate multiple runs of the same version of a browser at the same sha;
    49     currently, it's a prefix of the SHA1 of the report.
    50  
    51  Users who want to fetch the raw history results should not try to construct the
    52  URL themselves, as `[product-id]` has many optional parts and even a checksum.
    53  Instead, please use the [APIs](../api/README.md) to query test runs and download
    54  the `raw_results_url` of the test runs.