Merge branch 'release-v5.0.4' into release

Author: root

ARCHITECTURE.md

@@ -40,18 +40,19 @@ and the SDK will manage its storage so that data does not remain in storage afte
 
 The Glean SDK tries to do all of this is the least disruptive way possible to users.
 
-### async (Web Extensions)
+### Browser
+
+All of the SDKs tasks are executed synchronously, immediately as they are called. Errors will be caught without ever crashing the application.
+
+### Web Extensions
 
 All of the SDKs tasks are queued and executed asynchronously. The APIs exposed by the Glean SDK will only do
 the en-queuing of tasks, a quick synchronous operation. Internally, the Glean SDK will handle the
 queued tasks asynchronously, catching any errors thrown along the way so that Glean never
 crashes a users application.
 
-### sync (Browser)
-
-All of the SDKs tasks are executed synchronously, immediately as they are called. The APIs exposed by Glean
-are the same as the async implementation, but without queueing of any tasks. Errors will be caught without
-ever crashing the application.
+The web extension SDK is currently not being developed. If you want to use the SDK in your web extension
+please reference the [Glean.js user docs](https://mozilla.github.io/glean.js/getting_started/platforms/#deprecated-platforms).
 
 ## Code Map
 
@@ -88,9 +89,6 @@ created to mitigate that issue. This file houses the `Context` structure, a sing
 setters and getters to all of Glean's internal state. This file should avoid any imports that are
 not `import type`.
 
-`dispatcher.ts` is where Glean's dispatcher implementation lives. The dispatcher is the structure
-that manages Glean's task queue.
-
 `metrics/types` is where all of the specific metric type implementations are. Each metric type
 should be implemented in a single file and no other file types should be added to this folder,
 because the files under this folder are exposed through the `@mozilla/glean/private/metrics/*`
@@ -132,15 +130,3 @@ exposed through the `@mozilla/glean/plugins/*` entry point.
 
 This file is what gets executed when a user that has installed Glean through npm invokes the `glean`
 command. It serves as a wrapper to call `glean_parser` commands more easily from JavaScript projects.
-
-### `async`/`sync` files
-
-There are certain places where we need different implementations for internal services based on the
-platform. In these instances, the service will have its own folder with the following folder structure:
-
-```
-├── service/
-├──── async.ts
-├──── shared.ts # Shared base class defining all available methods AND any reusable helper functions
-└──── sync.ts
-```

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Unreleased changes
 
-[Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.3...main)
+[Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.4...main)
+
+# v5.0.4 (2025-04-02)
+
+* [#1977](https://github.com/mozilla/glean.js/pull/1977): Add try-catch around window.sessionStorage access to prevent uncaught error upon `import`.
+
+[Full changelog](https://github.com/mozilla/glean.js/compare/v5.0.3...v5.0.4)
 
 # v5.0.3 (2024-08-02)
 

CONTRIBUTING.md

@@ -10,8 +10,8 @@ Before you dive into technical details, take a moment to read our
 Any form of communication from chat rooms and mailing lists to code comments
 is expected to follow this code of conduct, so that all can enjoy working on Glean.js.
 
-Glean.js' developer document lives in the [`docs/`](https://github.com/mozilla/glean.js/tree/main/docs/index.md)
-folder in this repository and Glean.js' user documentation lives in [The Glean Book](https://mozilla.github.io/glean/book/index.html).
+Glean.js' developer document lives in the [`docs/`](https://github.com/mozilla/glean.js/tree/main/docs/README.md)
+folder in this repository and Glean.js' user documentation can be found at [mozilla.github.io/glean.js/](https://mozilla.github.io/glean.js/).
 
 Here's the [guide](https://github.com/mozilla/glean.js/blob/main/docs/guides/getting_started.md) to get you started!
 

docs/reference/metrics.md

@@ -1,4 +1,4 @@
-<!-- AUTOGENERATED BY glean_parser v14.5.0. DO NOT EDIT. -->
+<!-- AUTOGENERATED BY glean_parser v14.5.2. DO NOT EDIT. -->
 
 # Metrics
 
@@ -107,5 +107,5 @@ In addition to those built-in metrics, the following metrics are added to the pi
 
 Data categories are [defined here](https://wiki.mozilla.org/Firefox/Data_Collection).
 
-<!-- AUTOGENERATED BY glean_parser v14.5.0. DO NOT EDIT. -->
+<!-- AUTOGENERATED BY glean_parser v14.5.2. DO NOT EDIT. -->
 

glean/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mozilla/glean",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "An implementation of the Glean SDK, a modern cross-platform telemetry client, for JavaScript environments.",
   "type": "module",
   "sideEffects": false,
@@ -117,7 +117,6 @@
     "ts-loader": "^9.0.1",
     "ts-mocha": "^10.0.0",
     "ts-node": "^10.8.0",
-    "typedoc": "^0.25.1",
     "typescript": "^4.3.5",
     "web-ext-types": "^3.2.1",
     "webpack": "^5.42.1",

glean/package.json

@@ -8,7 +8,7 @@ export const GLEAN_SCHEMA_VERSION = 1;
 //
 // PACKAGE_VERSION is defined as a global by webpack,
 // we need a default here for testing when the app is not build with webpack.
-export const GLEAN_VERSION = "5.0.3";
+export const GLEAN_VERSION = "5.0.4";
 
 // The name of a "ping" that will include Glean ping_info metrics,
 // such as ping sequence numbers.