📝 Add docstrings to codex/add-web-vitals-reporting-to-backend

Docstrings generation was requested by @shayancoin.

* #144 (comment)

The following files were modified:

* `frontend/src/app/reportWebVitals.ts`

Author: coderabbitai[bot]

frontend/src/app/reportWebVitals.ts

@@ -3,6 +3,12 @@ import type { Metric } from 'next/app';
 const DEFAULT_ENDPOINT = '/observability/web-vitals';
 const APP_LABEL = process.env.NEXT_PUBLIC_WEB_VITALS_APP ?? 'frontend';
 
+/**
+ * Normalize a protocol string to ensure a trailing colon or return `undefined` for empty/undefined input.
+ *
+ * @param protocol - The protocol string to normalize (e.g., "http", "https:", or undefined). Leading/trailing whitespace is ignored.
+ * @returns The normalized protocol with a trailing colon (e.g., "https:") or `undefined` if `protocol` is `undefined` or empty after trimming.
+ */
 function normalizeProtocol(protocol: string | undefined): string | undefined {
   if (protocol === undefined) {
     return undefined;
@@ -17,6 +23,11 @@ function normalizeProtocol(protocol: string | undefined): string | undefined {
   return trimmedProtocol.endsWith(':') ? trimmedProtocol : `${trimmedProtocol}:`;
 }
 
+/**
+ * Build the full URL used to report web-vitals metrics.
+ *
+ * @returns The endpoint URL constructed from environment overrides (protocol, host, port, endpoint) with browser location fallbacks; returns `DEFAULT_ENDPOINT` when not running in a browser.
+ */
 function buildEndpoint(): string {
   if (typeof window === 'undefined') {
     return DEFAULT_ENDPOINT;
@@ -67,4 +78,4 @@ export function reportWebVitals(metric: Metric) {
   });
 
   sendMetric(endpoint, body);
-}
+}