Skip to content

Commit 4e5207e

Browse files
committed
Merge branch 'release-v3.0.0-pre.1' into release
2 parents 1ac7ab7 + a3bdbd8 commit 4e5207e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1562
-19496
lines changed

.circleci/config.yml

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -101,52 +101,6 @@ jobs:
101101
name: Build docs
102102
command: npm --prefix ./glean run build:docs
103103

104-
sample-webext-test:
105-
docker:
106-
- image: cimg/python:<< pipeline.parameters.python-version >>
107-
steps:
108-
- checkout
109-
- install-node
110-
- run:
111-
name: Install JavaScript dependencies for Glean
112-
command: npm --prefix ./glean install
113-
- run:
114-
name: Install Typescript dependencies for the TS web extension sample
115-
command: |
116-
npm --prefix ./samples/browser/webext install
117-
npm --prefix ./samples/browser/webext run link:glean
118-
- run:
119-
name: Build the TS web extension sample
120-
command: |
121-
npm --prefix ./samples/browser/webext run build
122-
- run:
123-
name: Run TS web extension sample test
124-
command: |
125-
export PATH=.:$PATH && npm --prefix ./samples/browser/webext run test
126-
127-
sample-node-test:
128-
docker:
129-
- image: cimg/python:<< pipeline.parameters.python-version >>
130-
steps:
131-
- checkout
132-
- install-node
133-
- run:
134-
name: Install JavaScript dependencies for Glean
135-
command: npm --prefix ./glean install
136-
- run:
137-
name: Install JavaScript dependencies for the Node.js sample
138-
command: |
139-
npm --prefix ./samples/node install
140-
npm --prefix ./samples/node run link:glean
141-
- run:
142-
name: Build the Node.js Glean generated files sample
143-
command: |
144-
npm --prefix ./samples/node run glean
145-
- run:
146-
name: Run Node.js sample test
147-
command: |
148-
export PATH=.:$PATH && npm --prefix ./samples/node run test
149-
150104
browser-compat-smoke-tests:
151105
docker:
152106
- image: cimg/python:<< pipeline.parameters.python-version >>
@@ -258,20 +212,12 @@ workflows:
258212
- test:
259213
requires:
260214
- build
261-
- sample-webext-test:
262-
requires:
263-
- test
264-
- sample-node-test:
265-
requires:
266-
- test
267215
- hold:
268216
type: approval
269217
requires:
270218
- lint
271219
- build
272220
- test
273-
- sample-webext-test
274-
- sample-node-test
275221
filters:
276222
branches:
277223
ignore:

.github/dependabot.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,7 @@ updates:
88
directory: "/automation"
99
schedule:
1010
interval: "monthly"
11-
- package-ecosystem: "npm"
12-
directory: "/samples/browser/webext"
13-
schedule:
14-
interval: "monthly"
1511
- package-ecosystem: "npm"
1612
directory: "/samples/browser/web"
1713
schedule:
1814
interval: "monthly"
19-
- package-ecosystem: "npm"
20-
directory: "/samples/node"
21-
schedule:
22-
interval: "monthly"
23-
- package-ecosystem: "npm"
24-
directory: "/glean/tests/unit/platform/utils/webext/sample"
25-
schedule:
26-
interval: "monthly"

ARCHITECTURE.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ An end-to-end data collection platform developed by Mozilla and primarily target
1515

1616
Glean provides multiple client SDKs for different programming languages and platforms.
1717
One of the aspects that guide Glean SDK development is cross-platform consistency and the Glean
18-
JavaScript SDK is no exception to that. It is built to work on multiple JavaScript platforms --
19-
websites, web extensions, Node.js and QML as of the time of writing -- and to be easily extendable
18+
JavaScript SDK is no exception to that. It is built to work on websites -- and to be easily extendable
2019
to other platforms as well.
2120

2221
The Glean JavaScript SDK is the latest addition to the family of Glean SDKs. The other Glean SDKs,
@@ -39,11 +38,9 @@ When data is submitted, the Glean SDK is responsible for assembling the correct
3938
storage. Each metric can have different [lifetimes](https://mozilla.github.io/glean/book/user/metrics/adding-new-metrics.html#a-lifetime-example)
4039
and the SDK will manage its storage so that data does not remain in storage after it's lifetime is expired.
4140

42-
The Glean SDK tries to do all of this is the least disruptive way possible to users. There are two separate
43-
implementations for the SDK based on the platform: async (node, web extensions) and sync (browser). The implementation
44-
is set inside of Glean itself and is not configurable by the user.
41+
The Glean SDK tries to do all of this is the least disruptive way possible to users.
4542

46-
### async (Web Extensions, Node)
43+
### async (Web Extensions)
4744

4845
All of the SDKs tasks are queued and executed asynchronously. The APIs exposed by the Glean SDK will only do
4946
the en-queuing of tasks, a quick synchronous operation. Internally, the Glean SDK will handle the
@@ -104,7 +101,7 @@ To see all the exposed entry points, check out Glean.js' `package.json` file.
104101
### `entry/`
105102

106103
The `entry/` folder contains the main entry points for the Glean.js package per platform.
107-
For example, when a user does `import Glean from @mozilla/glean/webext` it's the `entry/webext.ts`
104+
For example, when a user does `import Glean from @mozilla/glean/web` it's the `entry/web.ts`
108105
file that they are getting and not `core/glean.ts`.
109106

110107
The main difference between each platform's file is that a different `Platform` implementation is
@@ -123,8 +120,6 @@ It also makes testing easier, because the exact same suite of tests can be run f
123120

124121
The storage module varies for each platform. The storage mechanism used by each platform is as follows:
125122
- `web` - [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
126-
- `webext` - [`storage`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage)
127-
- `Node` - None, everything is stored in memory
128123

129124
### `plugins/`
130125

CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Unreleased changes
22

3-
[Full changelog](https://github.com/mozilla/glean.js/compare/v3.0.0-pre.0...main)
3+
[Full changelog](https://github.com/mozilla/glean.js/compare/v3.0.0-pre.1...main)
4+
5+
# v3.0.0-pre.1 (2023-11-15)
6+
7+
[Full changelog](https://github.com/mozilla/glean.js/compare/v3.0.0-pre.0...v3.0.0-pre.1)
8+
9+
* [#1814](https://github.com/mozilla/glean.js/pull/1814): **BREAKING CHANGE**: Temporarily drop support for web extensions. This platform will be added again once we complete the Glean.js platform refactoring.
410

511
# v3.0.0-pre.0 (2023-11-10)
612

0 commit comments

Comments
 (0)