Bug 1736346 - Expose the @mozilla/glean/web entry point

.circleci/config.yml

@@ -93,30 +93,30 @@ jobs:
       - run:
           name: Install JavaScript dependencies for the JS web extension sample
           command: |
-            npm --prefix ./samples/web-extension/javascript install
-            npm --prefix ./samples/web-extension/javascript run link:glean
+            npm --prefix ./samples/browser/webext/javascript install
+            npm --prefix ./samples/browser/webext/javascript run link:glean
       - run:
           name: Build the JS web extension sample
           command: |
-            npm --prefix ./samples/web-extension/javascript run build
+            npm --prefix ./samples/browser/webext/javascript run build
       - run:
           name: Run JS web extension sample test
           command: |
-            export PATH=.:$PATH && npm --prefix ./samples/web-extension/javascript run test
+            export PATH=.:$PATH && npm --prefix ./samples/browser/webext/javascript run test
       # TS sample related jobs
       - run:
           name: Install Typescript dependencies for the TS web extension sample
           command: |
-            npm --prefix ./samples/web-extension/typescript install
-            npm --prefix ./samples/web-extension/typescript run link:glean
+            npm --prefix ./samples/browser/webext/typescript install
+            npm --prefix ./samples/browser/webext/typescript run link:glean
       - run:
           name: Build the TS web extension sample
           command: |
-            npm --prefix ./samples/web-extension/typescript run build
+            npm --prefix ./samples/browser/webext/typescript run build
       - run:
           name: Run TS web extension sample test
           command: |
-            export PATH=.:$PATH && npm --prefix ./samples/web-extension/typescript run test
+            export PATH=.:$PATH && npm --prefix ./samples/browser/webext/typescript run test
 
   node-sample-tests:
     docker:

.github/dependabot.yml

@@ -5,11 +5,11 @@ updates:
     schedule:
       interval: "daily"
   - package-ecosystem: "npm"
-    directory: "/samples/web-extension/typescript"
+    directory: "/samples/browser/webext/typescript"
     schedule:
       interval: "daily"
   - package-ecosystem: "npm"
-    directory: "/samples/web-extension/javascript"
+    directory: "/samples/browser/webext/javascript"
     schedule:
       interval: "daily"
   - package-ecosystem: "npm"

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.23.0...main)
 
+* [#856](https://github.com/mozilla/glean.js/pull/856): Expose the `@mozilla/glean/web` entry point for using Glean.js in websites.
+
 # v0.23.0 (2021-10-12)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.22.0...v0.23.0)

glean/package.json

@@ -11,7 +11,8 @@
     "./plugins/*": "./dist/plugins/*.js",
     "./uploader": "./dist/core/upload/uploader.js",
     "./node": "./dist/index/node.js",
-    "./webext": "./dist/index/webext.js"
+    "./webext": "./dist/index/webext.js",
+    "./web": "./dist/index/web.js"
   },
   "typesVersions": {
     "*": {
@@ -21,6 +22,9 @@
       "node": [
         "./dist/types/index/node.d.ts"
       ],
+      "web": [
+        "./dist/types/index/web.d.ts"
+      ],
       "private/ping": [
         "./dist/types/core/pings/ping_type.d.ts"
       ],

glean/src/core/upload/index.ts

@@ -179,7 +179,7 @@ class PingUploader implements PingsDatabaseObserver {
       if (ping.retries >= this.policy.maxRecoverableFailures) {
         log(
           LOG_TAG,
-          `Reached maximum recoverable failures for ping "${JSON.stringify(ping.name)}". You are done.`,
+          `Reached maximum recoverable failures for ping "${ping.identifier}". You are done.`,
           LoggingLevel.Info
         );
         this.rateLimiter.stop();

glean/src/index/web.ts

@@ -0,0 +1,9 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import platform from "../platform/browser/web/index.js";
+import base from "./base.js";
+
+export { ErrorType } from "../core/error/error_type.js";
+export default base(platform);

glean/src/index/webext.ts

@@ -2,7 +2,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import platform from "../platform/webext/index.js";
+import platform from "../platform/browser/webext/index.js";
 import base from "./base.js";
 
 export { ErrorType } from "../core/error/error_type.js";

glean/src/platform/browser/web/index.ts

@@ -0,0 +1,19 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import type Platform from "../../index.js";
+import uploader from "../uploader.js";
+
+// We will still use the TestPlatform as a placeholder
+// for the other web modules that have not been implemented yet.
+// See Bug 1726726 (Storage).
+import TestPlatform from "../../test/index.js";
+
+const WebPlaftorm: Platform = {
+  ...TestPlatform,
+  uploader,
+  name: "web"
+};
+
+export default WebPlaftorm;

glean/src/platform/webext/index.ts → glean/src/platform/browser/webext/index.ts

@@ -3,10 +3,10 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import Storage from "./storage.js";
-import uploader from "./uploader.js";
+import uploader from "../uploader.js";
 import info from "./platform_info.js";
 
-import type Platform from "../index.js";
+import type Platform from "../../index.js";
 
 const WebExtPlatform: Platform = {
   Storage,

glean/src/platform/webext/platform_info.ts → glean/src/platform/browser/webext/platform_info.ts

@@ -2,8 +2,8 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import type PlatformInfo from "../../core/platform_info.js";
-import { KnownOperatingSystems } from "../../core/platform_info.js";
+import type PlatformInfo from "../../../core/platform_info.js";
+import { KnownOperatingSystems } from "../../../core/platform_info.js";
 
 const WebExtPlatformInfo: PlatformInfo = {
   async os(): Promise<KnownOperatingSystems> {

glean/src/platform/webext/storage.ts → glean/src/platform/browser/webext/storage.ts

@@ -2,12 +2,16 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import log, { LoggingLevel } from "../../core/log.js";
-import type { StorageIndex } from "../../core/storage/index.js";
-import type Store from "../../core/storage/index.js";
-import { updateNestedObject, getValueFromNestedObject, deleteKeyFromNestedObject } from "../../core/storage/utils.js";
-import type { JSONArray, JSONObject, JSONPrimitive, JSONValue } from "../../core/utils.js";
-import { isJSONValue, isObject } from "../../core/utils.js";
+import log, { LoggingLevel } from "../../../core/log.js";
+import type { StorageIndex } from "../../../core/storage/index.js";
+import type Store from "../../../core/storage/index.js";
+import {
+  updateNestedObject,
+  getValueFromNestedObject,
+  deleteKeyFromNestedObject
+} from "../../../core/storage/utils.js";
+import type { JSONArray, JSONObject, JSONPrimitive, JSONValue } from "../../../core/utils.js";
+import { isJSONValue, isObject } from "../../../core/utils.js";
 
 const LOG_TAG = "platform.webext.Storage";
 

glean/tests/unit/platform/webext/uploader.spec.ts → glean/tests/unit/platform/browser/uploader.spec.ts

@@ -6,7 +6,7 @@ import "jsdom-global/register";
 import assert from "assert";
 import sinon from "sinon";
 
-import BrowserUploader from "../../../../src/platform/webext/uploader";
+import BrowserUploader from "../../../../src/platform/browser/uploader";
 import type { JSONObject } from "../../../../src/core/utils";
 import { UploadResult, UploadResultStatus } from "../../../../src/core/upload/uploader";
 

glean/tests/unit/platform/storage.spec.ts

@@ -10,7 +10,7 @@ import type Store from "../../../src/core/storage";
 
 import TestStore from "../../../src/platform/test/storage";
 import QMLStore from "../../../src/platform/qt/storage";
-import WebExtStore from "../../../src/platform/webext/storage";
+import WebExtStore from "../../../src/platform/browser/webext/storage";
 import type { JSONValue } from "../../../src/core/utils";
 import { isUndefined } from "../../../src/core/utils";
 

glean/tsconfig/lib.json

@@ -4,7 +4,8 @@
     "../src/core/metrics/types/*.ts",
     "../src/plugins/*.ts",
     "../src/index/node.ts",
-    "../src/index/webext.ts"
+    "../src/index/webext.ts",
+    "../src/index/web.ts"
   ],
   "compilerOptions": {
     "target": "ES2018",