Merge branch 'release-v0.32.0' into release

Author: brizental

.circleci/config.yml

@@ -7,6 +7,22 @@
 version: 2.1
 
 jobs:
+  spellcheck:
+    docker:
+      # Use Ubuntu Focal (20.04) so we get aspell 0.60.8 or later
+      # (which contains markdown support)
+      - image: circleci/buildpack-deps:focal
+    steps:
+      - checkout
+      - run:
+          name: Upgrade packages
+          command: sudo apt update
+      - run:
+          name: Install aspell
+          command: sudo apt install aspell aspell-en
+      - run:
+          name: Check documentation spelling
+          command: bin/spellcheck.sh list
   lint:
     docker:
       - image: cimg/python:3.9.4
@@ -156,14 +172,26 @@ jobs:
             pip install -r requirements.txt
             glean_parser translate src/App/metrics.yaml src/App/pings.yaml \
               -f javascript -o src/App/generated \
-              --option platform=qt --option version="0.31"
+              --option platform=qt --option version="0.32"
       - run:
           name: Run Qt sample tests
           command: |
             cd samples/qt
             qmake -r
             QML_IMPORT_TRACE=1 xvfb-run make check
 
+  browser-compat-smoke-tests:
+    docker:
+      - image: cimg/python:3.9.4-node
+    steps:
+      - checkout
+      - run:
+          name: Run browser comapt smoke tests
+          command: |
+            npm --prefix ./automation install
+            npm --prefix ./automation run link:glean
+            npm --prefix ./automation run compat:test:browserstack
+
   check-size:
     docker:
       - image: cimg/node:16.1.0
@@ -172,7 +200,9 @@ jobs:
       - run:
           name: Get and post build sizes to GitHub PR
           command: |
-            ./benchmarks/run.sh
+            npm --prefix ./automation install
+            npm --prefix ./automation run link:glean
+            npm --prefix ./automation run size:report
 
   # via https://circleci.com/blog/deploying-documentation-to-github-pages-with-continuous-integration/
   docs-deploy:
@@ -237,6 +267,7 @@ jobs:
 workflows:
   ci:
     jobs:
+      - spellcheck
       - lint
       - build:
           requires:
@@ -267,11 +298,19 @@ workflows:
               ignore:
                 - main
                 - release
-                - /^release-*/
+                - /^release-.*/
       - check-size:
           context: data-eng-gleanjs-gh
           requires:
             - hold
+      - browser-compat-smoke-tests:
+          context: data-eng-gleanjs-gh
+          filters:
+            branches:
+              only:
+                - main
+                - release
+                - /^release-.*/
       - docs-deploy:
           context: data-eng-gleanjs-gh
           filters:

.dictionary

@@ -0,0 +1,71 @@
+personal_ws-1.1 en 70 
+API's
+APIs
+BUGFIX
+BrowserStack
+CLI
+Changelog
+CircleCI
+Ciufo
+CommonJS
+Glean's
+Gzip
+HTTPS
+JSDoc
+JWK
+MPL
+PingType
+PlatformInfo
+QML
+QuantityMetricType
+README
+SDK
+SDK's
+SDKs
+TODO
+TimespanMetricType
+TypeScript
+UI
+UUID
+UploadResult
+UploadResultStatus
+benchmarking
+boolean
+booleans
+brizental
+changelog
+chutten
+compat
+datetime
+deserialize
+deserializing
+dexter
+enqueued
+enum
+falsy
+firefox
+gzip
+gzipping
+instantiation
+janerik
+js
+json
+linter
+linters
+md
+mdroettboom
+mozilla
+npm
+runtime
+schemas
+setRawNanos
+setUploadEnabled
+timespan
+travis
+unminified
+uploader
+uploaders
+url
+virtualenv
+webext
+webpack

.github/dependabot.yml

@@ -5,7 +5,7 @@ updates:
     schedule:
       interval: "daily"
   - package-ecosystem: "npm"
-    directory: "/benchmarks"
+    directory: "/automation"
     schedule:
       interval: "weekly"
   - package-ecosystem: "npm"

.gitignore

@@ -125,5 +125,8 @@ generated/
 # This is the name of the Glean virtual environment
 .venv
 
-# Temporary folder used on the benchmarks scripts
-benchmarks/size/tmp/
+# Temporary folder used on the automation scripts
+automation/size/tmp/
+
+# Browserstack Local generated files
+*.err

CHANGELOG.md

@@ -1,18 +1,38 @@
 # Unreleased changes
 
-[Full changelog](https://github.com/mozilla/glean.js/compare/v0.31.0...main)
+[Full changelog](https://github.com/mozilla/glean.js/compare/v0.32.0...main)
+
+# v0.32.0 (2022-03-01)
+
+[Full changelog](https://github.com/mozilla/glean.js/compare/v0.31.0...v0.32.0)
+
+* [#1220](https://github.com/mozilla/glean.js/pull/1220): Refactor virtual environment behavior to support virtual environments that aren't in the project root.
+  * This means it's possible to run Glean with a virtual environment created by `virtualenv` or `pyenv-virtualenv` without causing a Glean-specific `.venv` directory to be created in a project that is using Glean.
+* [#1130](https://github.com/mozilla/glean.js/pull/1130): BUGFIX: Guarantee event timestamps
+cannot be negative numbers.
+  * Timestamps were observed to be negative in a few occurrences, for platforms that do not provide the `performance.now` API, namely QML, and in which we fallback to the `Date.now` API.
+  * If event timestamps are negative pings are rejected by the pipeline.
+* [#1132](https://github.com/mozilla/glean.js/pull/1132): Retry ping request on network error with `keepalive: false`. This is sometimes an issue on Chrome browsers below v81.
+* [#1170](https://github.com/mozilla/glean.js/pull/1170): Update glean_parser to version 5.0.0.
+* [#1178](https://github.com/mozilla/glean.js/pull/1178): Enable running the `glean` command offline.
+  * When offline Glean will not attempt to install glean_parser.
+* [#1178](https://github.com/mozilla/glean.js/pull/1178): Enable running the `glean` command with as many or as little arguments as wanted.
+  * Previously the command could only be run with 3 commands, even though all glean_parser commands would have been valid commands for the `glean` CLI.
+* [#1210](https://github.com/mozilla/glean.js/pull/1210): Show comprehensive error message when missing `storage` permissions for Glean on web extensions.
+* [#1223](https://github.com/mozilla/glean.js/pull/1223): Add `--glean-parser-version` command to CLI to allow users to retrieve the glean_parser version without installing glean_parser.
+* [#1228](https://github.com/mozilla/glean.js/pull/1228): BUGFIX: Apply debug features before sending pings at initialize.
 
 # v0.31.0 (2022-01-25)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.30.0...v0.31.0)
 
 * [#1065](https://github.com/mozilla/glean.js/pull/1065): Delete minimal amount of data when invalid data is found while collecting ping.
-  * Previous behaviour was to delete the whole ping when invalid data was found on the database,
-  new behaviour only deletes the actually invalid data and leave the rest of the ping intact.
+  * Previous behavior was to delete the whole ping when invalid data was found on the database,
+  new behavior only deletes the actually invalid data and leave the rest of the ping intact.
 * [#1065](https://github.com/mozilla/glean.js/pull/1065): Only import metric types into the library when they are used either by the user or Glean itself.
   * Previously the code required to deserialize metric data from the database was always imported by the library even if the metric type was never used by the client. This effort will decrease the size of the Glean.js bundles that don't import all the metric types.
 * [#1046](https://github.com/mozilla/glean.js/pull/1046): Remove legacy X-Client-Type X-Client-Version from Glean pings.
-* [#1071](https://github.com/mozilla/glean.js/pull/1071): **BREAKING CHANGE**: Move the `testResetGlean` API from the Glean singletion and into it's own entry point `@mozilla/glean/testing`.
+* [#1071](https://github.com/mozilla/glean.js/pull/1071): **BREAKING CHANGE**: Move the `testResetGlean` API from the Glean singleton and into it's own entry point `@mozilla/glean/testing`.
   * In order to use this API one must import it through `import { testResetGlean } from "@mozilla/glean/testing"` instead of using it from the Glean singleton directly.
   * This lower the size of the Glean library, because testing functionality is not imported unless in a testing environment.
   * This change does not apply to QML. In this environment the API remains the same.
@@ -62,7 +82,7 @@
   * Users may provide a folder name through the `VIRTUAL_ENV` environment variable.
   * If the user is inside an active virtualenv the `VIRTUAL_ENV` environment variable is already set by Python. See: https://docs.python.org/3/library/venv.html.
 * [#968](https://github.com/mozilla/glean.js/pull/968): Add runtime arguments type checking to `Glean.setUploadEnabled` API.
-* [#970](https://github.com/mozilla/glean.js/pull/970): BUGFIX: Guarantee uploading is immediatelly resumed if the uploader has been stopped due to any of the uploading limits being hit.
+* [#970](https://github.com/mozilla/glean.js/pull/970): BUGFIX: Guarantee uploading is immediately resumed if the uploader has been stopped due to any of the uploading limits being hit.
 
 # v0.25.0 (2021-11-15)
 
@@ -79,10 +99,10 @@
 
 * [#856](https://github.com/mozilla/glean.js/pull/856): Expose the `@mozilla/glean/web` entry point for using Glean.js in websites.
 * [#856](https://github.com/mozilla/glean.js/pull/860): Implement the `PlatformInfo` module for the web platform.
-  * Out of `os`, `os_version`, `architecture` and `locale`, on the web platform, we can only retrive `os` and `locale` information. The other information will default to the known value `Unknown` for all pings coming from this platform.
+  * Out of `os`, `os_version`, `architecture` and `locale`, on the web platform, we can only retrieve `os` and `locale` information. The other information will default to the known value `Unknown` for all pings coming from this platform.
 * [#856](https://github.com/mozilla/glean.js/pull/856): Expose the `@mozilla/glean/web` entry point for using Glean.js in websites.
 * [#908](https://github.com/mozilla/glean.js/pull/908): BUGFIX: Guarantee internal `uploadEnabled` state always has a value.
-  * When `uploadEnabled` was set to `false` and then Glean was restarted with it still `false`, the internal `uploadEnabled` state was not being set. That should not cause particularly harmful behaviour, since `undefined` is still a "falsy" value. However, this would create a stream of loud and annoying log messages.
+  * When `uploadEnabled` was set to `false` and then Glean was restarted with it still `false`, the internal `uploadEnabled` state was not being set. That should not cause particularly harmful behavior, since `undefined` is still a "falsy" value. However, this would create a stream of loud and annoying log messages.
 * [#898](https://github.com/mozilla/glean.js/pull/898): Implement the `Storage` module for the web platform.
 
 # v0.23.0 (2021-10-12)
@@ -120,7 +140,7 @@
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.20.0...v0.21.0)
 
 * [#754](https://github.com/mozilla/glean.js/pull/754): Change target ECMAScript target from 2015 to 2016 when building for Qt.
-* [#779](https://github.com/mozilla/glean.js/pull/779): Add a number of workarounds for the Qt Javascript engine.
+* [#779](https://github.com/mozilla/glean.js/pull/779): Add a number of workarounds for the Qt JavaScript engine.
 
 * [#775](https://github.com/mozilla/glean.js/pull/775): Disallow calling test only methods outside of test mode.
   * NOTE: Test mode is set once the API `Glean.testResetGlean` is called.
@@ -182,9 +202,9 @@ logic, which allows for reliable sorting of events throughout restarts.
 
 * [#346](https://github.com/mozilla/glean.js/pull/346): Provide default HTTP client for Qt/QML platform.
 * [#399](https://github.com/mozilla/glean.js/pull/399): Check if there are ping data before attempting to delete it.
-  * This change lowers the amount of log messages related to attempting to delete inexistent data.
+  * This change lowers the amount of log messages related to attempting to delete nonexistent data.
 * [#411](https://github.com/mozilla/glean.js/pull/411): Tag all messages logged by Glean with the component they are coming from.
-* [#415](https://github.com/mozilla/glean.js/pull/415), [#430](https://github.com/mozilla/glean.js/pull/430): Gzip ping paylod before upload
+* [#415](https://github.com/mozilla/glean.js/pull/415), [#430](https://github.com/mozilla/glean.js/pull/430): Gzip ping payload before upload
   * This changes the signature of `Uploader.post` to accept `string | Uint8Array` for the `body` parameter, instead of only `string`.
 * [#431](https://github.com/mozilla/glean.js/pull/431): BUGFIX: Record the timestamp for events before dispatching to the internal task queue.
 * [#462](https://github.com/mozilla/glean.js/pull/462): Implement persistent storage for Qt/QML platform.
@@ -202,7 +222,7 @@ logic, which allows for reliable sorting of events throughout restarts.
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.14.0...v0.14.1)
 
-* [#342](https://github.com/mozilla/glean.js/pull/342): BUGFIX: Fix timespan payload representatin to match exactly the payload expected according to the Glean schema.
+* [#342](https://github.com/mozilla/glean.js/pull/342): BUGFIX: Fix timespan payload representation to match exactly the payload expected according to the Glean schema.
 * [#343](https://github.com/mozilla/glean.js/pull/343): BUGFIX: Report the correct failure exit code when the Glean command line tool fails.
 
 # v0.14.0 (2021-05-19)
@@ -314,7 +334,7 @@ logic, which allows for reliable sorting of events throughout restarts.
 
 * [#123](https://github.com/mozilla/glean.js/pull/123): BUGFIX: Fix support for ES6 environments.
   * Include `.js` extensions in all local import statements.
-    * ES6' module resolution algorithm does not currently support automatic resolution of file extensions and does not have the hability to import directories that have an index file. The extension and the name of the file being import need to _always_ be specified. See: https://nodejs.org/api/esm.html#esm_customizing_esm_specifier_resolution_algorithm
+    * ES6' module resolution algorithm does not currently support automatic resolution of file extensions and does not have the ability to import directories that have an index file. The extension and the name of the file being import need to _always_ be specified. See: https://nodejs.org/api/esm.html#esm_customizing_esm_specifier_resolution_algorithm
   * Add a `type: module` declaration to the main `package.json`.
     * Without this statement, ES6 support is disabled. See: https://nodejs.org/docs/latest-v13.x/api/esm.html#esm_enabling.:
     * To keep support for CommonJS, in our CommonJS build we include a `package.json` that overrides the `type: module` of the main `package.json` with a `type: commonjs`.
@@ -327,7 +347,7 @@ logic, which allows for reliable sorting of events throughout restarts.
   * This plugin listens to the `afterPingCollection` event. It receives the collected payload of a ping and returns an encrypted version of it using a JWK provided upon instantiation.
 * [#95](https://github.com/mozilla/glean.js/pull/95): Add a `plugins` property to the configuration options and create an event abstraction for triggering internal Glean events.
   * The only internal event triggered at this point is the `afterPingCollection` event, which is triggered after ping collection and logging, and before ping storing.
-  * Plugins are built to listen to a specific Glean event. Each plugin must define an `action`, which is executed everytime the event they are listening to is triggered.
+  * Plugins are built to listen to a specific Glean event. Each plugin must define an `action`, which is executed every time the event they are listening to is triggered.
 * [#101](https://github.com/mozilla/glean.js/pull/101): BUGFIX: Only validate Debug View Tag and Source Tags when they are present.
 * [#102](https://github.com/mozilla/glean.js/pull/102): BUGFIX: Include a Glean User-Agent header in all pings.
 * [#97](https://github.com/mozilla/glean.js/pull/97): Add support for labeled metric types (string, boolean and counter).
@@ -345,8 +365,8 @@ logic, which allows for reliable sorting of events throughout restarts.
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.2.0...v0.3.0)
 
-* [#90](https://github.com/mozilla/glean.js/pull/90): Provide exports for CommonJS and browser environemnts.
-* [#90](https://github.com/mozilla/glean.js/pull/90): BUGIFX: Accept lifetimes as strings when instantiating metric types.
+* [#90](https://github.com/mozilla/glean.js/pull/90): Provide exports for CommonJS and browser environments.
+* [#90](https://github.com/mozilla/glean.js/pull/90): BUGFIX: Accept lifetimes as strings when instantiating metric types.
 * [#90](https://github.com/mozilla/glean.js/pull/90): BUGFIX: Fix type declaration paths.
 * [#90](https://github.com/mozilla/glean.js/pull/90): BUGFIX: Make web-ext-types a peer dependency.
   * This is quick fix until [Bug 1694701](https://bugzilla.mozilla.org/show_bug.cgi?id=1694701) is fixed.
@@ -376,7 +396,7 @@ logic, which allows for reliable sorting of events throughout restarts.
   * `initialize` and `setUploadEnabled`.
 * [#36](https://github.com/mozilla/glean.js/pull/36): Implement the event metric type.
 * [#31](https://github.com/mozilla/glean.js/pull/31): Implement a task Dispatcher to help in executing Promises in a deterministic order.
-* [#26](https://github.com/mozilla/glean.js/pull/26): Implement the setUploadEnable API.
+* [#26](https://github.com/mozilla/glean.js/pull/26): Implement the setUploadEnabled API.
 * [#25](https://github.com/mozilla/glean.js/pull/25): Implement an adapter that leverages browser APIs to upload pings.
 * [#24](https://github.com/mozilla/glean.js/pull/24): Implement a ping upload manager.
 * [#23](https://github.com/mozilla/glean.js/pull/23): Implement the initialize API and glean internal metrics.

CONTRIBUTING.md

@@ -28,8 +28,8 @@ As mentioned, Glean.js bugs are filed in Bugzilla. Anything on the Glean.js comp
 with the tag [`[good first bug]`](https://bugzilla.mozilla.org/buglist.cgi?f1=status_whiteboard&v1=%5Bgood%20first%20bug%5D&o1=substring&resolution=---&query_format=advanced&f2=component&v2=Glean.js&list_id=15653400&o2=equals&classification=Client%20Software&classification=Developer%20Infrastructure&classification=Components&classification=Server%20Software&classification=Other)
 is a good place to start.
 
-These bugs will usually have a comment explaning the steps to get started working on them.
-(If you find a `[good first bug]` that doesn't have an explainer comment, please ask for one).
+These bugs will usually have a comment explaining the steps to get started working on them.
+(If you find a `[good first bug]` that doesn't have an explanation comment, please ask for one).
 
 If you are picking a good first bug or not, make sure you are assigned to the bug before sending a Pull Request for it.
 

README.md

@@ -21,7 +21,7 @@ If you want to contribute to the Glean.js code base this is the place to go.
 
 If you are looking for detailed documentation on the Glean APIs (internal or external) this is the place to go.
 
-_This documentation is autogenererated from the doc comments throughout the Glean.js codebase and
+_This documentation is auto generated from the doc comments throughout the Glean.js code base and
 the Glean book should be preferred over this documentation whenever possible._
 
 ## Contact