040a4b7d-f615-445c-bcd1-29afcfef90d2

Committed 23 Sep 2024 06:08PM UTC coverage: 96.294% (-0.009%) from 96.303%

Build # 040a4b7d-f615-445c-bcd1-29afcfef90d2

Build Type

Pull #410

circleci

Committed by

stulees

Commit Message

Revise unit test [stage-4]

Pull Request Pull Request #410: Support forcing google sheet data to refresh in rise-data-table

Run Details

2611 of 2720 branches covered (95.99%)

Branch coverage included in aggregate %.

4 of 6 new or added lines in 1 file covered. (66.67%)

1 existing line in 1 file now uncovered.

14250 of 14790 relevant lines covered (96.35%)

39.66 hits per line

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

96.62

/src/rise-data-table/rise-data-table.js

/* eslint-disable class-methods-use-this */

import { RiseElement } from '../common/rise-element.js';
import { CacheMixin } from '../common/cache-mixin.js';
import { FetchMixin } from '../common/fetch-mixin.js';
import { version } from '../version.js';
import * as Globals from '../common/globals.js';

const fetchBase = CacheMixin(RiseElement);

export default class RiseDataTable extends FetchMixin(fetchBase) {
  static get properties() {
    return {
      fields: { type: String },
      values: { type: String },
      environment: { type: String },
      account: { type: String },
      source: { type: String },
      hideFirstRow: { type: Boolean },
    };
  }

  constructor() {
    super();

    this.version = version;
    this.fields = null;
    this.values = null;
    this.environment = 'prod';
    this.account = null;
    this.source = '';
    this.hideFirstRow = true;

    this._initialStart = true;
    this._lastDataUpdateResult = null;

    super.initFetch(
      {
        refreshFromCacheControlHeader: true,
        cooldown: 1000 * 60 * 3, // add 3 min randomization to refresh interval
        // TODO: confirm avoidRetriesForStatusCodes
        avoidRetriesForStatusCodes: [
          Globals.BAD_REQUEST_ERROR,
          Globals.UNAUTHORIZED_ERROR,
          Globals.FORBIDDEN_ERROR,
          Globals.NOT_FOUND_ERROR,
          Globals.TOO_MANY_REQUESTS_ERROR,
        ],
      },
      this._handleResponse,
      this._handleError
    );
  }

  updated(changedProperties) {
    if (this.source) {
      if (
        changedProperties.has('source') ||
        changedProperties.has('account') ||
        changedProperties.has('hideFirstRow')
      ) {
        this._resetGoogleSheets();
      }
    } else if (changedProperties.has('values')) {
      this._valuesChanged();
    }
  }

  refreshData() {
    this._resetGoogleSheets();
  }

  _handleStart(event) {
    super._handleStart(event);

    if (this._initialStart) {
      this._initialStart = false;
      this._start();
    }
  }

  _valuesChanged() {
    this._sendTableEvent(RiseDataTable.EVENT_DATA_UPDATE, {
      values: this.values,
    });
  }

  _sendTableEvent(eventName, detail) {
    super._sendEvent(eventName, detail);
  }

  _start() {
    if (!this.source) {
      return;
    }

    const url = this._getGoogleSheetsUrl(
      this.source,
      this.account,
      this.environment
    );

    super.fetch(url, {
      headers: { 'X-Requested-With': 'rise-data-table' },
    });
  }

  _resetGoogleSheets() {
    if (!this._initialStart) {
      this._start();
    }
  }

  _getGoogleSheetsUrl(source, account, env) {
    const serverUrl =
      env === 'test'
        ? Globals.SERVICES_URL_TEST
        : Globals.SERVICES_URL_PRODUCTION;

    const searchParams = {
      id: source,
      account,
      cb: Date.now(),
    };

    return `${serverUrl}/google/sheets/data?${new URLSearchParams(
      searchParams
    )}`;
  }

  _processResponse(json) {
    try {
      let { values } = json;

      if (this.hideFirstRow || this.hideFirstRow === undefined) {
        values.shift();
      }

      values = this._deleteExtraColumns(values);

      return JSON.stringify(values);
    } catch (error) {
      throw new Error(`Invalid data: ${error}`);
    }
  }

  _deleteExtraColumns(values) {
    const fields = JSON.parse(this.fields);
    const fieldsCount = fields.length;

    return values.map(row => row.slice(0, fieldsCount));
  }

  _handleResponse(response) {
    return response
      .json()
      .then(json => this._processResponse(json))
      .then(values => {
        if (this._lastDataUpdateResult !== values) {
          this._lastDataUpdateResult = values;

          this._sendTableEvent(RiseDataTable.EVENT_DATA_UPDATE, { values });
        }
      })
      .catch(error => {
        this._sendTableEvent(RiseDataTable.EVENT_DATA_ERROR, { error });
      });
  }

  _handleError(error) {
    this._sendTableEvent(RiseDataTable.EVENT_REQUEST_ERROR, { error });
  }
}

customElements.define('rise-data-table', RiseDataTable);

1	/* eslint-disable class-methods-use-this */	1✔
2		1✔
3	import { RiseElement } from '../common/rise-element.js';	1✔
4	import { CacheMixin } from '../common/cache-mixin.js';	1✔
5	import { FetchMixin } from '../common/fetch-mixin.js';	1✔
6	import { version } from '../version.js';	1✔
7	import * as Globals from '../common/globals.js';	1✔
8		1✔
9	const fetchBase = CacheMixin(RiseElement);	1✔
10		1✔
11	export default class RiseDataTable extends FetchMixin(fetchBase) {	1✔
12	static get properties() {	1✔
13	return {	1✔
14	fields: { type: String },	1✔
15	values: { type: String },	1✔
16	environment: { type: String },	1✔
17	account: { type: String },	1✔
18	source: { type: String },	1✔
19	hideFirstRow: { type: Boolean },	1✔
20	};	1✔
21	}	1✔
22		1✔
23	constructor() {	1✔
24	super();	20✔
25		20✔
26	this.version = version;	20✔
27	this.fields = null;	20✔
28	this.values = null;	20✔
29	this.environment = 'prod';	20✔
30	this.account = null;	20✔
31	this.source = '';	20✔
32	this.hideFirstRow = true;	20✔
33		20✔
34	this._initialStart = true;	20✔
35	this._lastDataUpdateResult = null;	20✔
36		20✔
37	super.initFetch(	20✔
38	{	20✔
39	refreshFromCacheControlHeader: true,	20✔
40	cooldown: 1000 * 60 * 3, // add 3 min randomization to refresh interval	20✔
41	// TODO: confirm avoidRetriesForStatusCodes	20✔
42	avoidRetriesForStatusCodes: [	20✔
43	Globals.BAD_REQUEST_ERROR,	20✔
44	Globals.UNAUTHORIZED_ERROR,	20✔
45	Globals.FORBIDDEN_ERROR,	20✔
46	Globals.NOT_FOUND_ERROR,	20✔
47	Globals.TOO_MANY_REQUESTS_ERROR,	20✔
48	],	20✔
49	},	20✔
50	this._handleResponse,	20✔
51	this._handleError	20✔
52	);	20✔
53	}	20✔
54		1✔
55	updated(changedProperties) {	1✔
56	if (this.source) {	34✔
57	if (	6✔
58	changedProperties.has('source') \|\|	6✔
59	changedProperties.has('account') \|\|	6✔
60	changedProperties.has('hideFirstRow')	2✔
61	) {	6✔
62	this._resetGoogleSheets();	5✔
63	}	5✔
64	} else if (changedProperties.has('values')) {	34✔
65	this._valuesChanged();	22✔
66	}	22✔
67	}	34✔
68		1✔
69	refreshData() {	1✔
NEW 70	this._resetGoogleSheets();	×
NEW 71	}	×
72		1✔
73	_handleStart(event) {	1✔
74	super._handleStart(event);	2✔
75		2✔
76	if (this._initialStart) {	2✔
77	this._initialStart = false;	1✔
78	this._start();	1✔
79	}	1✔
80	}	2✔
81		1✔
82	_valuesChanged() {	1✔
83	this._sendTableEvent(RiseDataTable.EVENT_DATA_UPDATE, {	21✔
84	values: this.values,	21✔
85	});	21✔
86	}	21✔
87		1✔
88	_sendTableEvent(eventName, detail) {	1✔
89	super._sendEvent(eventName, detail);	21✔
90	}	21✔
91		1✔
92	_start() {	1✔
93	if (!this.source) {	2✔
94	return;	1✔
95	}	1✔
96		1✔
97	const url = this._getGoogleSheetsUrl(	1✔
98	this.source,	1✔
99	this.account,	1✔
100	this.environment	1✔
101	);	1✔
102		1✔
103	super.fetch(url, {	1✔
104	headers: { 'X-Requested-With': 'rise-data-table' },	1✔
105	});	1✔
106	}	2✔
107		1✔
108	_resetGoogleSheets() {	1✔
109	if (!this._initialStart) {	2!
UNCOV 110	this._start();	×
111	}	×
112	}	2✔
113		1✔
114	_getGoogleSheetsUrl(source, account, env) {	1✔
115	const serverUrl =	1✔
116	env === 'test'	1✔
117	? Globals.SERVICES_URL_TEST	1✔
118	: Globals.SERVICES_URL_PRODUCTION;	1!
119		1✔
120	const searchParams = {	1✔
121	id: source,	1✔
122	account,	1✔
123	cb: Date.now(),	1✔
124	};	1✔
125		1✔
126	return `${serverUrl}/google/sheets/data?${new URLSearchParams(	1✔
127	searchParams	1✔
128	)}`;	1✔
129	}	1✔
130		1✔
131	_processResponse(json) {	1✔
132	try {	7✔
133	let { values } = json;	7✔
134		7✔
135	if (this.hideFirstRow \|\| this.hideFirstRow === undefined) {	7!
136	values.shift();	7✔
137	}	7✔
138		5✔
139	values = this._deleteExtraColumns(values);	5✔
140		5✔
141	return JSON.stringify(values);	5✔
142	} catch (error) {	7✔
143	throw new Error(`Invalid data: ${error}`);	2✔
144	}	2✔
145	}	7✔
146		1✔
147	_deleteExtraColumns(values) {	1✔
148	const fields = JSON.parse(this.fields);	7✔
149	const fieldsCount = fields.length;	7✔
150		7✔
151	return values.map(row => row.slice(0, fieldsCount));	7✔
152	}	7✔
153		1✔
154	_handleResponse(response) {	1✔
155	return response	4✔
156	.json()	4✔
157	.then(json => this._processResponse(json))	4✔
158	.then(values => {	4✔
159	if (this._lastDataUpdateResult !== values) {	3✔
160	this._lastDataUpdateResult = values;	2✔
161		2✔
162	this._sendTableEvent(RiseDataTable.EVENT_DATA_UPDATE, { values });	2✔
163	}	2✔
164	})	4✔
165	.catch(error => {	4✔
166	this._sendTableEvent(RiseDataTable.EVENT_DATA_ERROR, { error });	1✔
167	});	4✔
168	}	4✔
169		1✔
170	_handleError(error) {	1✔
171	this._sendTableEvent(RiseDataTable.EVENT_REQUEST_ERROR, { error });	1✔
172	}	1✔
173	}	1✔
174		1✔
175	customElements.define('rise-data-table', RiseDataTable);	1✔

Rise-Vision / rise-lit-components / 040a4b7d-f615-445c-bcd1-29afcfef90d2

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