10854950988

Committed 13 Sep 2024 07:24PM UTC coverage: 0.432% (-13.3%) from 13.759%

Build # 10854950988

Build Type

Pull #8537

github

Committed by

web-flow

Commit Message

Merge cb7c8a40b into 954e5bd9e

Pull Request Pull Request #8537: Canvas v0.10 and federation readiness

Run Details

64 of 13704 branches covered (0.47%)

Branch coverage included in aggregate %.

0 of 156 new or added lines in 32 files covered. (0.0%)

2072 existing lines in 232 files now uncovered.

108 of 26117 relevant lines covered (0.41%)

0.01 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/packages/commonwealth/server/controllers/server_analytics_controller.ts

import { analytics, config } from '@hicommonwealth/core';
import { AnalyticsPayload } from 'shared/analytics/types';

export type TrackOptions = Record<string, any> & AnalyticsPayload;

export class ServerAnalyticsController {
  /**
   * Tracks an analytics event.
   * Can optionally pass a request object to add browser info to event.
   */
  async track(options: TrackOptions, req?: any) {
    let newOptions = { ...options };
    const host = req?.get?.('host');
    if (req) {
      const browserInfo = getRequestBrowserInfo(req);
      newOptions = {
        ...newOptions,
        ...browserInfo,
        ...(host && { isCustomDomain: config.SERVER_URL.includes(host) }),
      };
    }
    const reqIsPWA = req?.headers?.['isPWA'] === 'true';
    const { event, ...payload } = newOptions;
    payload.isPWA = reqIsPWA;
    analytics().track(event, payload);
  }
}

/**
 * Returns a record containing condensed browser info.
 * Expects the 'express-useragent' middleware to be
 * applied to the route.
 */
function getRequestBrowserInfo(req: any): Record<string, any> {
  if (!req.useragent) {
    return {};
  }
  if (Object.keys(req.useragent).length === 0) {
    return {};
  }
  // take the useragent data and pick certain entries to add to browserInfo
  const browserInfo = {};
  const userAgent = (req as any).useragent || {};
  for (const [k, v] of Object.entries(userAgent)) {
    if (k.startsWith('is') && v) {
      // for keys like 'isChrome' and 'isFirefox', only include them if the value is true
      browserInfo[k] = v;
    } else if (typeof v === 'string') {
      // or include any entry where the value is a string
      browserInfo[k] = v;
    }
  }
  // manually check for Brave since middleware thinks Brave is Chrome
  const brand = req.headers['sec-ch-ua'];
  if (typeof brand === 'string' && brand.includes('Brave')) {
    delete browserInfo['isChrome'];
    browserInfo['isBrave'] = true;
    browserInfo['browser'] = 'Brave';
  }
  return browserInfo;
}

1	import { analytics, config } from '@hicommonwealth/core';
2	import { AnalyticsPayload } from 'shared/analytics/types';
3
4	export type TrackOptions = Record<string, any> & AnalyticsPayload;
5
6	export class ServerAnalyticsController {
7	/**
8	* Tracks an analytics event.
9	* Can optionally pass a request object to add browser info to event.
10	*/
11	async track(options: TrackOptions, req?: any) {
UNCOV 12	let newOptions = { ...options };	×
UNCOV 13	const host = req?.get?.('host');	×
UNCOV 14	if (req) {	×
UNCOV 15	const browserInfo = getRequestBrowserInfo(req);	×
UNCOV 16	newOptions = {	×
17	...newOptions,
18	...browserInfo,
19	...(host && { isCustomDomain: config.SERVER_URL.includes(host) }),	×
20	};
21	}
UNCOV 22	const reqIsPWA = req?.headers?.['isPWA'] === 'true';	×
UNCOV 23	const { event, ...payload } = newOptions;	×
UNCOV 24	payload.isPWA = reqIsPWA;	×
UNCOV 25	analytics().track(event, payload);	×
26	}
27	}
28
29	/**
30	* Returns a record containing condensed browser info.
31	* Expects the 'express-useragent' middleware to be
32	* applied to the route.
33	*/
34	function getRequestBrowserInfo(req: any): Record<string, any> {
UNCOV 35	if (!req.useragent) {	×
36	return {};	×
37	}
UNCOV 38	if (Object.keys(req.useragent).length === 0) {	×
39	return {};	×
40	}
41	// take the useragent data and pick certain entries to add to browserInfo
UNCOV 42	const browserInfo = {};	×
UNCOV 43	const userAgent = (req as any).useragent \|\| {};	×
UNCOV 44	for (const [k, v] of Object.entries(userAgent)) {	×
UNCOV 45	if (k.startsWith('is') && v) {	×
46	// for keys like 'isChrome' and 'isFirefox', only include them if the value is true
UNCOV 47	browserInfo[k] = v;	×
UNCOV 48	} else if (typeof v === 'string') {	×
49	// or include any entry where the value is a string
UNCOV 50	browserInfo[k] = v;	×
51	}
52	}
53	// manually check for Brave since middleware thinks Brave is Chrome
UNCOV 54	const brand = req.headers['sec-ch-ua'];	×
UNCOV 55	if (typeof brand === 'string' && brand.includes('Brave')) {	×
56	delete browserInfo['isChrome'];	×
57	browserInfo['isBrave'] = true;	×
58	browserInfo['browser'] = 'Brave';	×
59	}
UNCOV 60	return browserInfo;	×
61	}

hicommonwealth / commonwealth / 10854950988

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous