Merge branch 'release-v1.0.0' into release

Author: brizental

.circleci/config.yml

@@ -5,7 +5,18 @@
 ---
 
 version: 2.1
-
+commands:
+  install-node:
+    steps:
+      - run:
+          name: Install Node.js
+          command: |
+            curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
+            sudo apt-get install -y nodejs
+parameters:
+  python-version:
+    type: string
+    default: "3.9.4"
 jobs:
   spellcheck:
     docker:
@@ -25,19 +36,10 @@ jobs:
           command: bin/spellcheck.sh list
   lint:
     docker:
-      - image: cimg/python:3.9.4
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
-      - run:
-          name: Install NVM
-          command: |
-            curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
-            export NVM_DIR="$HOME/.nvm"
-            echo 'export NVM_DIR=$HOME/.nvm' >> $BASH_ENV
-            echo 'source $NVM_DIR/nvm.sh' >> $BASH_ENV
-      - run:
-          name: Install Node.js
-          command: nvm install 16.5.0
+      - install-node
       - run:
           name: Check that package-lock.json is updated as needed
           command: |
@@ -63,9 +65,10 @@ jobs:
 
   test:
     docker:
-      - image: cimg/python:3.9.4-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Install Firefox related dependencies
           command: |
@@ -84,9 +87,10 @@ jobs:
 
   build:
     docker:
-      - image: cimg/python:3.9.4-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Install JavaScript dependencies
           command: npm --prefix ./glean install
@@ -99,9 +103,10 @@ jobs:
 
   sample-webext-test:
     docker:
-      - image: cimg/python:3.8.8-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Install JavaScript dependencies for Glean
           command: npm --prefix ./glean install
@@ -121,9 +126,10 @@ jobs:
 
   sample-node-test:
     docker:
-      - image: cimg/python:3.8.8-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Install JavaScript dependencies for Glean
           command: npm --prefix ./glean install
@@ -143,9 +149,10 @@ jobs:
 
   sample-qt-test:
     docker:
-      - image: cimg/python:3.8.8-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Install JavaScript dependencies for Glean
           command: npm --prefix ./glean install
@@ -172,7 +179,7 @@ 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.32"
+              --option platform=qt --option version="1.0"
       - run:
           name: Run Qt sample tests
           command: |
@@ -182,9 +189,10 @@ jobs:
 
   browser-compat-smoke-tests:
     docker:
-      - image: cimg/python:3.9.4-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Run browser comapt smoke tests
           command: |
@@ -207,9 +215,10 @@ jobs:
   # via https://circleci.com/blog/deploying-documentation-to-github-pages-with-continuous-integration/
   docs-deploy:
     docker:
-      - image: cimg/python:3.9.4-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Install JavaScript dependencies
           command: npm --prefix ./glean install
@@ -234,9 +243,10 @@ jobs:
 
   publish:
     docker:
-      - image: cimg/python:3.9.4-node
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     steps:
       - checkout
+      - install-node
       - run:
           name: Install JavaScript dependencies
           command: npm --prefix ./glean install

.dictionary

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 70 
+personal_ws-1.1 en 72 
 API's
 APIs
 BUGFIX
@@ -46,6 +46,7 @@ falsy
 firefox
 gzip
 gzipping
+init
 instantiation
 janerik
 js
@@ -66,6 +67,7 @@ unminified
 uploader
 uploaders
 url
+uuid
 virtualenv
 webext
 webpack

.github/auto_assign.yml

@@ -5,7 +5,6 @@ reviewers:
   - Dexterp37
   - travis79
   - brizental
-  - mdboom
   - chutten
 numberOfReviewers: 1
 skipKeywords:

.github/dependabot.yml

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

CHANGELOG.md

@@ -1,13 +1,22 @@
 # Unreleased changes
 
-[Full changelog](https://github.com/mozilla/glean.js/compare/v0.32.0...main)
+[Full changelog](https://github.com/mozilla/glean.js/compare/v1.0.0...main)
+
+# v1.0.0 (2022-03-17)
+
+[Full changelog](https://github.com/mozilla/glean.js/compare/v0.32.0...v1.0.0)
+
+* [#1154](https://github.com/mozilla/glean.js/pull/1130): BUGFIX: Implemented initialize and set_upload_enabled reasons for deletion-request ping.
+* [#1233](https://github.com/mozilla/glean.js/pull/1233): Add optional `buildDate` argument to `initialize` configuration. The build date can be generated by glean_parser.
+* [#1233](https://github.com/mozilla/glean.js/pull/1233): Update glean_parser to version 5.1.0.
+* [#1217](https://github.com/mozilla/glean.js/pull/1217): Record `InvalidType` error when incorrectly type values are passed to metric recording functions.
+* [#1267](https://github.com/mozilla/glean.js/pull/1267): Implement the 'events' ping.
 
 # 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.

automation/package-lock.json

@@ -20,10 +20,10 @@
   "license": "MPL-2.0",
   "devDependencies": {
     "@octokit/request": "^5.6.3",
-    "browserstack-local": "^1.4.8",
+    "browserstack-local": "^1.4.9",
     "geckodriver": "^3.0.1",
     "selenium-webdriver": "^4.1.1",
-    "webpack": "^5.69.1",
+    "webpack": "^5.70.0",
     "webpack-cli": "^4.9.2",
     "webpack-dev-server": "^4.7.4"
   }

automation/package.json

@@ -71,7 +71,7 @@ try {
     const fullIncrease = build.max - build.main.max;
     return `| **${build.name}** |
 | core only | ${formatBytes(build.main.min)} | ${formatBytes(build.min)} | ${coreIncrease > 0 ? "📈" : "📉"} ${formatBytes(Math.abs(coreIncrease))} |
-| full bundle | ${formatBytes(build.main.max)} | ${formatBytes(build.max)} | ${coreIncrease > 0 ? "📈" : "📉"} ${formatBytes(Math.abs(fullIncrease))} |`
+| full bundle | ${formatBytes(build.main.max)} | ${formatBytes(build.max)} | ${fullIncrease > 0 ? "📈" : "📉"} ${formatBytes(Math.abs(fullIncrease))} |`
   });
 
   const report =  `

automation/size/report.js

@@ -94,9 +94,9 @@ Once you have your `Metric` subclass, include it in Glean.js'
 [`METRIC_MAP`](https://github.com/mozilla/glean.js/blob/main/glean/src/core/metrics/utils.ts#L17).
 This map will be used as a template for creating metric instances from the metrics database.
 
-### The `MetricType` class
+### The `InternalMetricType` class
 
-Now you are ready to implement the `MetricType` class for your new metric type.
+Now you are ready to implement the `InternalMetricType` class for your new metric type.
 This class will hold all the metadata related to a specific user defined metric and
 expose the recording and testing APIs of your new metric type.
 
@@ -106,15 +106,11 @@ This API's design should have been discussed and decided upon during the metric
 
 Still, metric type classes will always have at least one recording function and one testing function.
 
-> **Note** The `type` property on the `MetricType` subclass is a constant. It will be used
+> **Note** The `type` property on the `InternalMetricType` subclass is a constant. It will be used
 > to determine in which section of the ping the recorded metrics for this type should be placed.
 > It's value is the name of the section for this metric type on the ping payload.
 > Make sure that, when you included your `Metric` class on the `METRIC_MAP` the property has the
-> same value as the `type` property on the corresponding `MetricType`.
-
-Once you are done implementing the `MetricType` class for your new metric type,
-make sure to manually expose it for Qt platforms by adding it to
-[the Qt entry point file](https://github.com/mozilla/glean.js/blob/main/glean/src/index/qt.ts).
+> same value as the `type` property on the corresponding `InternalMetricType`.
 
 #### Recording functions
 
@@ -172,6 +168,16 @@ async function testGetValue(ping: string = this.sendInPings[0]): Promise<string
 The `testGetNumRecordedErrors` function does not need to be implemented individually per metric
 type as it is already implemented on the `MetricType` super class.
 
+### The `MetricType` class
+
+The `MetricType` class is the default export on each metric type file. It exposes **only** the APIs
+users will interact with and contains the `InternalMetricType` instance as a [private field](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Private_class_fields).
+It is a wrapper around the `InternalMetricType`.
+
+Once you are done implementing the `MetricType` class for your new metric type,
+make sure to manually expose it for Qt platforms by adding it to
+[the Qt entry point file](https://github.com/mozilla/glean.js/blob/main/glean/src/index/qt.ts).
+
 ## Testing
 
 Tests for metric type implementations live under the `glean/tests/unit/core/metrics/types` folder. Create a new

docs/guides/adding_a_new_metric_type.md

@@ -4,7 +4,7 @@ This guide is for developers who want to develop on Glean.js.
 Glean.js uses [Node.js](https://nodejs.org/).
 Follow the [official guide](https://nodejs.dev/) to install it.
 ### Version requirements
-* `node` >= 12.0.0
+* `node` >= 16.0.0
 * `npm`  >=  7.0.0
 
 ## Building Glean.js