Cleanup

Author: mgurgel

injected/src/features/duckplayer/components/ddg-video-overlay.js

@@ -24,10 +24,7 @@ export class DDGVideoOverlay extends HTMLElement {
      */
     constructor({ environment, params, ui, manager }) {
         super();
-        if (!(manager instanceof VideoOverlay)) {
-            const error = new Error('Invalid VideoOverlay manager');
-            throw error;
-        }
+        if (!(manager instanceof VideoOverlay)) throw new Error('Invalid VideoOverlay manager');
         this.environment = environment;
         this.ui = ui;
         this.params = params;

injected/src/features/duckplayer/overlay-messages.js

@@ -140,16 +140,12 @@ export class DuckPlayerOverlayMessages {
                 if (evt.detail.kind === constants.MSG_NAME_SET_VALUES) {
                     return this.setUserValues(evt.detail.data)
                         .then((updated) => respond(constants.MSG_NAME_PUSH_DATA, updated))
-                        .catch((e) => {
-                            console.error(e);
-                        });
+                        .catch(console.error);
                 }
                 if (evt.detail.kind === constants.MSG_NAME_READ_VALUES_SERP) {
                     return this.getUserValues()
                         .then((updated) => respond(constants.MSG_NAME_PUSH_DATA, updated))
-                        .catch((e) => {
-                            console.error(e);
-                        });
+                        .catch(console.error);
                 }
                 if (evt.detail.kind === constants.MSG_NAME_OPEN_INFO) {
                     return this.openInfo();

injected/src/features/duckplayer/video-overlay.js

@@ -425,6 +425,7 @@ export class VideoOverlay {
                 return this.environment.setHref(params.toPrivatePlayerUrl());
             })
             .catch((e) => {
+                console.error(e);
                 this.messages.metrics.reportExceptionWithError(e);
             });
     }
@@ -455,7 +456,7 @@ export class VideoOverlay {
                 })
                 .then(() => this.watchForVideoBeingAdded({ ignoreCache: true, via: 'userOptOut' }))
                 .catch((e) => {
-                    console.error('could not set userChoice for opt-out', e);
+                    console.error(e);
                     this.messages.metrics.reportExceptionWithError(e);
                 });
         } else {

special-pages/pages/duckplayer/app/index.js

@@ -75,14 +75,14 @@ export async function init(messaging, telemetry, baseEnvironment) {
 
     const embed = createEmbedSettings(window.location.href, settings);
     if (!embed) {
-        messaging.metrics.reportException({ message: 'embed not found', kind: EXCEPTION_KIND_INIT_ERROR });
-        console.log('embed not found');
+        const message = 'Embed not found';
+        messaging.metrics.reportException({ message, kind: EXCEPTION_KIND_INIT_ERROR });
+        console.log(message);
     }
 
     const didCatch = (error) => {
         const message = error?.message;
-        const kind = error?.error?.name;
-        messaging.metrics.reportException({ message, kind });
+        messaging.metrics.reportExceptionWithError(error?.error);
 
         // TODO: Remove the following event once all native platforms are responding to 'reportMetric: exception'
         messaging.reportPageException({ message: message || 'unknown error' });

special-pages/pages/duckplayer/app/providers/UserValuesProvider.jsx

@@ -60,6 +60,9 @@ export function UserValuesProvider({ initial, children }) {
             })
             .catch((err) => {
                 console.error('could not set the enabled flag', err);
+
+                // TODO: Remove the following event once all native platforms are responding to 'reportMetric: exception'
+                messaging.reportPageException({ message: 'could not set the enabled flag: ' + err.toString() });
             });
     }
 

special-pages/pages/duckplayer/integration-tests/duckplayer.spec.js

@@ -339,7 +339,7 @@ test.describe('reporting exceptions', () => {
         const duckplayer = DuckPlayerPage.create(page, workerInfo);
         // load as normal
         await duckplayer.openWithNoEmbed();
-        await duckplayer.didSendException('InitError', 'embed not found');
+        await duckplayer.didSendException('InitError', 'Embed not found');
     });
     test('initial setup error', async ({ page }, workerInfo) => {
         const duckplayer = DuckPlayerPage.create(page, workerInfo);

special-pages/shared/report-metric.js

@@ -25,6 +25,9 @@
  *     message: 'Failed to load user data',
  *     kind: 'NetworkError'
  * });
+ *
+ * // Report an exception by passing an Error object
+ * metrics.reportExceptionWithError(new Error('Missing params'));
  * ```
  *
  * @module Report Metric
@@ -118,7 +121,7 @@ export class ReportMetric {
     }
 
     /**
-     * Sends a standard 'reportMetric' event to the native layer.
+     * Sends a standard `reportMetric` event to the native layer.
      *
      * @param {ReportMetricEvent} metricEvent - The metric event to report, must contain a metricName
      * @throws {Error} When metricEvent.metricName is missing
@@ -159,14 +162,22 @@ export class ReportMetric {
     }
 
     /**
-     * Sends a 'reportMetric' event with metric name 'exception', getting message and kind from the error object. If no error object is passed, a default error is reported.
+     * Sends a `reportMetric` event with metric name `exception`, getting message and kind from the error object. The `kind` property is inferred from `error.name`.
+     *
+     * If no error object is passed, a default error is reported.
      *
      * If an invalid error object is passed, nothing is reported.
      *
      * @param {Error} [error] - The error to report
+     *
+     * @example
+     * ```javascript
+     * const error = new Error('Failed to fetch user data from API');
+     * error.name = 'NetworkError';
+     * metrics.reportExceptionWithError(error);
+     * ```
      */
     reportExceptionWithError(error) {
-        console.log('reportExceptionWithError', error instanceof Error);
         if (error && !(error instanceof Error)) {
             console.warn('reportExceptionWithError: error is not an Error object', error);
             return;