co-locate

shakyShane · mgurgel · commit 1dd52307d9ea · 2025-08-01T15:02:05.000+01:00
diff --git a/.prettierignore b/.prettierignore
@@ -3,7 +3,7 @@ docs/**/*
 !injected/docs/**/*
 injected/src/types
 special-pages/pages/**/types
-special-pages/shared/types
+special-pages/shared/**/types
 injected/integration-test/extension/contentScope.js
 injected/src/features/Scriptlets
 **/*.json
diff --git a/injected/src/features/duck-player-native.js b/injected/src/features/duck-player-native.js
@@ -4,7 +4,7 @@ import { DuckPlayerNativeMessages } from './duckplayer-native/messages.js';
 import { setupDuckPlayerForNoCookie, setupDuckPlayerForSerp, setupDuckPlayerForYouTube } from './duckplayer-native/sub-feature.js';
 import { Environment } from './duckplayer/environment.js';
 import { Logger } from './duckplayer/util.js';
-import { MetricsReporter, EXCEPTION_KIND_INITIAL_SETUP_ERROR } from '../../../special-pages/shared/metrics-reporter.js';
+import { MetricsReporter, EXCEPTION_KIND_INITIAL_SETUP_ERROR } from '../../../special-pages/shared/metrics/metrics-reporter.js';
 
 /**
  * @import {DuckPlayerNativeSubFeature} from './duckplayer-native/sub-feature.js'
diff --git a/injected/src/features/duck-player.js b/injected/src/features/duck-player.js
@@ -37,7 +37,7 @@ import { DuckPlayerOverlayMessages, OpenInDuckPlayerMsg, Pixel } from './duckpla
 import { isBeingFramed } from '../utils.js';
 import { initOverlays } from './duckplayer/overlays.js';
 import { Environment } from './duckplayer/environment.js';
-import { MetricsReporter } from '../../../special-pages/shared/metrics-reporter.js';
+import { MetricsReporter } from '../../../special-pages/shared/metrics/metrics-reporter.js';
 
 /**
  * @typedef UserValues - A way to communicate user settings
diff --git a/injected/src/features/duckplayer-native/messages.js b/injected/src/features/duckplayer-native/messages.js
@@ -1,5 +1,5 @@
 import * as constants from './constants.js';
-import { MetricsReporter, EXCEPTION_KIND_MESSAGING_ERROR } from '../../../../special-pages/shared/metrics-reporter.js';
+import { MetricsReporter, EXCEPTION_KIND_MESSAGING_ERROR } from 'special-pages/shared/metrics/metrics-reporter.js';
 
 /** @import {YouTubeError} from './error-detection.js' */
 /** @import {Environment} from '../duckplayer/environment.js' */
diff --git a/injected/src/features/duckplayer/overlay-messages.js b/injected/src/features/duckplayer/overlay-messages.js
@@ -1,6 +1,6 @@
 /* eslint-disable promise/prefer-await-to-then */
 import * as constants from './constants.js';
-import { MetricsReporter, EXCEPTION_KIND_MESSAGING_ERROR } from '../../../../special-pages/shared/metrics-reporter.js';
+import { MetricsReporter, EXCEPTION_KIND_MESSAGING_ERROR } from 'special-pages/shared/metrics/metrics-reporter.js';
 
 /**
  * @typedef {import("@duckduckgo/messaging").Messaging} Messaging
diff --git a/injected/src/features/duckplayer/overlays.js b/injected/src/features/duckplayer/overlays.js
@@ -2,7 +2,7 @@ import { DomState } from './util.js';
 import { ClickInterception, Thumbnails } from './thumbnails.js';
 import { VideoOverlay } from './video-overlay.js';
 import { registerCustomElements } from './components/index.js';
-import { EXCEPTION_KIND_INITIAL_SETUP_ERROR } from '../../../../special-pages/shared/metrics-reporter.js';
+import { EXCEPTION_KIND_INITIAL_SETUP_ERROR } from 'special-pages/shared/metrics/metrics-reporter.js';
 
 /**
  * @typedef {object} OverlayOptions
diff --git a/special-pages/pages/duckplayer/app/index.js b/special-pages/pages/duckplayer/app/index.js
@@ -15,7 +15,7 @@ import { Components } from './components/Components.jsx';
 import { MobileApp } from './components/MobileApp.jsx';
 import { DesktopApp } from './components/DesktopApp.jsx';
 import { YouTubeErrorProvider } from './providers/YouTubeErrorProvider';
-import { EXCEPTION_KIND_INIT_ERROR, EXCEPTION_KIND_INITIAL_SETUP_ERROR } from '../../../shared/metrics-reporter.js';
+import { EXCEPTION_KIND_INIT_ERROR, EXCEPTION_KIND_INITIAL_SETUP_ERROR } from '../../../shared/metrics/metrics-reporter.js';
 
 /** @typedef {import('../types/duckplayer').YouTubeError} YouTubeError */
 
diff --git a/special-pages/pages/duckplayer/integration-tests/duck-player.js b/special-pages/pages/duckplayer/integration-tests/duck-player.js
@@ -568,7 +568,7 @@ export class DuckPlayerPage {
     }
 
     /**
-     * @param {import('../../../shared/types/shared.ts').ReportMetricEvent} evt
+     * @param {import('../../../shared/metrics/types/metrics.js').ReportMetricEvent} evt
      */
     async didSendReportMetric(evt) {
         const events = await this.mocks.waitForCallCount({ method: 'reportMetric', count: 1 });
diff --git a/special-pages/pages/duckplayer/src/index.js b/special-pages/pages/duckplayer/src/index.js
@@ -4,7 +4,7 @@ import { createSpecialPageMessaging } from '../../../shared/create-special-page-
 import { init } from '../app/index.js';
 import { initStorage } from './storage.js';
 import '../../../shared/live-reload.js';
-import { MetricsReporter, EXCEPTION_KIND_MESSAGING_ERROR } from '../../../shared/metrics-reporter.js';
+import { MetricsReporter, EXCEPTION_KIND_MESSAGING_ERROR } from '../../../shared/metrics/metrics-reporter.js';
 
 export class DuckplayerPage {
     /**
diff --git a/special-pages/shared/metrics/messages/reportMetric.notify.json b/special-pages/shared/metrics/messages/reportMetric.notify.json
diff --git a/special-pages/shared/metrics/metrics-reporter.js b/special-pages/shared/metrics/metrics-reporter.js
@@ -34,12 +34,12 @@
  */
 
 /**
- * @typedef {import('../shared/types/shared.ts').ExceptionMetric} ExceptionMetric
- * @typedef {import('../shared/types/shared.ts').ReportMetricEvent} ReportMetricEvent
- * @typedef {import('../shared/types/shared.ts').SharedMessages} SharedMessages
- * @typedef {import('@duckduckgo/messaging/lib/shared-types.js').MessagingBase<SharedMessages>|import('@duckduckgo/messaging').Messaging} SharedMessaging
+ * @typedef {import('./types/metrics.ts').ExceptionMetric} ExceptionMetric
+ * @typedef {import('./types/metrics.ts').ReportMetricEvent} ReportMetricEvent
  */
 
+import { createTypedMessages } from '@duckduckgo/messaging/lib/typed-messages.js';
+
 /** Exception kind for generic errors */
 export const EXCEPTION_KIND_GENERIC_ERROR = 'Error';
 
@@ -68,14 +68,14 @@ export class MetricsReporter {
     /**
      * Creates a new MetricsReporter instance.
      *
-     * @param {SharedMessaging} messaging - The messaging instance used to communicate with the native layer
+     * @param {import('@duckduckgo/messaging').Messaging} messaging - The messaging instance used to communicate with the native layer
      * @throws {Error} When messaging is not provided or messaging.notify is not defined
      */
     constructor(messaging) {
         if (!messaging) {
             throw new Error('messaging is required');
         }
-        this.messaging = messaging;
+        this.messaging = createTypedMessages(this, messaging);
     }
 
     /**
diff --git a/special-pages/shared/metrics/types/metrics.ts b/special-pages/shared/metrics/types/metrics.ts
@@ -3,15 +3,15 @@
  * scripts/build-types.mjs is responsible for type generation.
  * **DO NOT** edit this file directly as your changes will be lost.
  *
- * @module Shared Messages
+ * @module Metrics Messages
  */
 
 export type ReportMetricEvent = ExceptionMetric;
 
 /**
- * Requests, Notifications and Subscriptions from the Shared feature
+ * Requests, Notifications and Subscriptions from the Metrics feature
  */
-export interface SharedMessages {
+export interface MetricsMessages {
   notifications: ReportMetricNotification;
 }
 /**
@@ -28,3 +28,9 @@ export interface ExceptionMetric {
     kind?: string;
   };
 }
+
+declare module "../metrics-reporter.js" {
+  export interface MetricsReporter {
+    notify: import("@duckduckgo/messaging/lib/shared-types").MessagingBase<MetricsMessages>['notify']
+  }
+}
diff --git a/special-pages/types.mjs b/special-pages/types.mjs
@@ -30,14 +30,14 @@ for (const pageListElement of pageList) {
 }
 
 /* Shared types */
-specialPagesTypes.shared = {
-    schemaDir: join(specialPagesRoot, 'shared', 'messages'),
-    typesDir: join(specialPagesRoot, 'shared', 'types'),
+specialPagesTypes.metrics = {
+    schemaDir: join(specialPagesRoot, 'shared', 'metrics', 'messages'),
+    typesDir: join(specialPagesRoot, 'shared', 'metrics', 'types'),
     exclude: process.platform === 'win32',
     kind: 'single',
-    resolve: (_dirname) => '../src/index.js',
-    className: () => null,
-    filename: `shared.ts`,
+    resolve: (_dirname) => '../metrics-reporter.js',
+    className: (_top) => 'MetricsReporter',
+    filename: `metrics.ts`,
 };
 
 if (isLaunchFile(import.meta.url)) {
diff --git a/special-pages/unit-test/metrics-reporter.mjs b/special-pages/unit-test/metrics-reporter.mjs
@@ -1,6 +1,6 @@
 import { describe, it, mock, beforeEach } from 'node:test';
 import assert from 'node:assert';
-import { MetricsReporter } from '../shared/metrics-reporter.js';
+import { MetricsReporter } from '../shared/metrics/metrics-reporter.js';
 
 describe('reportMetric', () => {
     let messaging;
diff --git a/types-generator/json-schema.mjs b/types-generator/json-schema.mjs
@@ -173,10 +173,6 @@ export function generateSchema(featureName, fileList) {
  * @return {string}
  */
 export function createMessagingTypes(job, { featurePath, className }) {
-    if (!className) {
-        return '';
-    }
-
     const json = job.schema;
     const notifications = (json.properties?.notifications?.oneOf?.length ?? 0) > 0;
     const requests = (json.properties?.requests?.oneOf?.length ?? 0) > 0;

Original file line number	Diff line number	Diff line change
`@@ -568,7 +568,7 @@ export class DuckPlayerPage {`
`568`	`568`	`}`
`569`	`569`
`570`	`570`	`/**`
`571`		`- * @param {import('../../../shared/types/shared.ts').ReportMetricEvent} evt`
	`571`	`+ * @param {import('../../../shared/metrics/types/metrics.js').ReportMetricEvent} evt`
`572`	`572`	`*/`
`573`	`573`	`async didSendReportMetric(evt) {`
`574`	`574`	`const events = await this.mocks.waitForCallCount({ method: 'reportMetric', count: 1 });`