mirror of
https://github.com/home-assistant/frontend.git
synced 2025-08-04 15:07:48 +00:00
drop cached history
This commit is contained in:
parent
bdcd1a0a88
commit
c467ef82ea
@ -1,200 +0,0 @@
|
|||||||
import { LocalizeFunc } from "../common/translations/localize";
|
|
||||||
import { HomeAssistant } from "../types";
|
|
||||||
import {
|
|
||||||
computeHistory,
|
|
||||||
HistoryStates,
|
|
||||||
HistoryResult,
|
|
||||||
LineChartUnit,
|
|
||||||
TimelineEntity,
|
|
||||||
entityIdHistoryNeedsAttributes,
|
|
||||||
fetchRecentWS,
|
|
||||||
} from "./history";
|
|
||||||
|
|
||||||
export interface CacheConfig {
|
|
||||||
cacheKey: string;
|
|
||||||
hoursToShow: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface CachedResults {
|
|
||||||
prom: Promise<HistoryResult>;
|
|
||||||
startTime: Date;
|
|
||||||
endTime: Date;
|
|
||||||
language: string;
|
|
||||||
data: HistoryResult;
|
|
||||||
}
|
|
||||||
|
|
||||||
const stateHistoryCache: { [cacheKey: string]: CachedResults } = {};
|
|
||||||
|
|
||||||
// Cache type 2 functionality
|
|
||||||
function getEmptyCache(
|
|
||||||
language: string,
|
|
||||||
startTime: Date,
|
|
||||||
endTime: Date
|
|
||||||
): CachedResults {
|
|
||||||
return {
|
|
||||||
prom: Promise.resolve({ line: [], timeline: [] }),
|
|
||||||
language,
|
|
||||||
startTime,
|
|
||||||
endTime,
|
|
||||||
data: { line: [], timeline: [] },
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export const getRecentWithCache = (
|
|
||||||
hass: HomeAssistant,
|
|
||||||
entityIds: string[],
|
|
||||||
cacheConfig: CacheConfig,
|
|
||||||
localize: LocalizeFunc,
|
|
||||||
language: string
|
|
||||||
) => {
|
|
||||||
const cacheKey = cacheConfig.cacheKey;
|
|
||||||
const fullCacheKey = cacheKey + `_${cacheConfig.hoursToShow}`;
|
|
||||||
const endTime = new Date();
|
|
||||||
const startTime = new Date(endTime);
|
|
||||||
startTime.setHours(startTime.getHours() - cacheConfig.hoursToShow);
|
|
||||||
let toFetchStartTime = startTime;
|
|
||||||
let appendingToCache = false;
|
|
||||||
|
|
||||||
let cache = stateHistoryCache[fullCacheKey];
|
|
||||||
if (
|
|
||||||
cache &&
|
|
||||||
toFetchStartTime >= cache.startTime &&
|
|
||||||
toFetchStartTime <= cache.endTime &&
|
|
||||||
cache.language === language
|
|
||||||
) {
|
|
||||||
toFetchStartTime = cache.endTime;
|
|
||||||
appendingToCache = true;
|
|
||||||
// This pretty much never happens as endTime is usually set to now
|
|
||||||
if (endTime <= cache.endTime) {
|
|
||||||
return cache.prom;
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
cache = stateHistoryCache[fullCacheKey] = getEmptyCache(
|
|
||||||
language,
|
|
||||||
startTime,
|
|
||||||
endTime
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const curCacheProm = cache.prom;
|
|
||||||
const noAttributes = !entityIds.some((entityId) =>
|
|
||||||
entityIdHistoryNeedsAttributes(hass, entityId)
|
|
||||||
);
|
|
||||||
|
|
||||||
const genProm = async () => {
|
|
||||||
let fetchedHistory: HistoryStates;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const results = await Promise.all([
|
|
||||||
curCacheProm,
|
|
||||||
fetchRecentWS(
|
|
||||||
hass,
|
|
||||||
entityIds,
|
|
||||||
toFetchStartTime,
|
|
||||||
endTime,
|
|
||||||
appendingToCache,
|
|
||||||
undefined,
|
|
||||||
true,
|
|
||||||
noAttributes
|
|
||||||
),
|
|
||||||
]);
|
|
||||||
fetchedHistory = results[1];
|
|
||||||
} catch (err: any) {
|
|
||||||
delete stateHistoryCache[fullCacheKey];
|
|
||||||
throw err;
|
|
||||||
}
|
|
||||||
const stateHistory = computeHistory(hass, fetchedHistory, localize);
|
|
||||||
if (appendingToCache) {
|
|
||||||
if (stateHistory.line.length) {
|
|
||||||
mergeLine(stateHistory.line, cache.data.line);
|
|
||||||
}
|
|
||||||
if (stateHistory.timeline.length) {
|
|
||||||
mergeTimeline(stateHistory.timeline, cache.data.timeline);
|
|
||||||
// Replace the timeline array to force an update
|
|
||||||
cache.data.timeline = [...cache.data.timeline];
|
|
||||||
}
|
|
||||||
pruneStartTime(startTime, cache.data);
|
|
||||||
} else {
|
|
||||||
cache.data = stateHistory;
|
|
||||||
}
|
|
||||||
return cache.data;
|
|
||||||
};
|
|
||||||
|
|
||||||
cache.prom = genProm();
|
|
||||||
cache.startTime = startTime;
|
|
||||||
cache.endTime = endTime;
|
|
||||||
return cache.prom;
|
|
||||||
};
|
|
||||||
|
|
||||||
const mergeLine = (
|
|
||||||
historyLines: LineChartUnit[],
|
|
||||||
cacheLines: LineChartUnit[]
|
|
||||||
) => {
|
|
||||||
historyLines.forEach((line) => {
|
|
||||||
const unit = line.unit;
|
|
||||||
const oldLine = cacheLines.find((cacheLine) => cacheLine.unit === unit);
|
|
||||||
if (oldLine) {
|
|
||||||
line.data.forEach((entity) => {
|
|
||||||
const oldEntity = oldLine.data.find(
|
|
||||||
(cacheEntity) => entity.entity_id === cacheEntity.entity_id
|
|
||||||
);
|
|
||||||
if (oldEntity) {
|
|
||||||
oldEntity.states = oldEntity.states.concat(entity.states);
|
|
||||||
} else {
|
|
||||||
oldLine.data.push(entity);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
// Replace the cached line data to force an update
|
|
||||||
oldLine.data = [...oldLine.data];
|
|
||||||
} else {
|
|
||||||
cacheLines.push(line);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
const mergeTimeline = (
|
|
||||||
historyTimelines: TimelineEntity[],
|
|
||||||
cacheTimelines: TimelineEntity[]
|
|
||||||
) => {
|
|
||||||
historyTimelines.forEach((timeline) => {
|
|
||||||
const oldTimeline = cacheTimelines.find(
|
|
||||||
(cacheTimeline) => cacheTimeline.entity_id === timeline.entity_id
|
|
||||||
);
|
|
||||||
if (oldTimeline) {
|
|
||||||
oldTimeline.data = oldTimeline.data.concat(timeline.data);
|
|
||||||
} else {
|
|
||||||
cacheTimelines.push(timeline);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
const pruneArray = (originalStartTime: Date, arr) => {
|
|
||||||
if (arr.length === 0) {
|
|
||||||
return arr;
|
|
||||||
}
|
|
||||||
const changedAfterStartTime = arr.findIndex(
|
|
||||||
(state) => new Date(state.last_changed) > originalStartTime
|
|
||||||
);
|
|
||||||
if (changedAfterStartTime === 0) {
|
|
||||||
// If all changes happened after originalStartTime then we are done.
|
|
||||||
return arr;
|
|
||||||
}
|
|
||||||
|
|
||||||
// If all changes happened at or before originalStartTime. Use last index.
|
|
||||||
const updateIndex =
|
|
||||||
changedAfterStartTime === -1 ? arr.length - 1 : changedAfterStartTime - 1;
|
|
||||||
arr[updateIndex].last_changed = originalStartTime;
|
|
||||||
return arr.slice(updateIndex);
|
|
||||||
};
|
|
||||||
|
|
||||||
const pruneStartTime = (originalStartTime: Date, cacheData: HistoryResult) => {
|
|
||||||
cacheData.line.forEach((line) => {
|
|
||||||
line.data.forEach((entity) => {
|
|
||||||
entity.states = pruneArray(originalStartTime, entity.states);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
cacheData.timeline.forEach((timeline) => {
|
|
||||||
timeline.data = pruneArray(originalStartTime, timeline.data);
|
|
||||||
});
|
|
||||||
};
|
|
@ -3,10 +3,12 @@ import { css, html, LitElement, PropertyValues, TemplateResult } from "lit";
|
|||||||
import { customElement, property, state } from "lit/decorators";
|
import { customElement, property, state } from "lit/decorators";
|
||||||
import { isComponentLoaded } from "../../common/config/is_component_loaded";
|
import { isComponentLoaded } from "../../common/config/is_component_loaded";
|
||||||
import { fireEvent } from "../../common/dom/fire_event";
|
import { fireEvent } from "../../common/dom/fire_event";
|
||||||
import { throttle } from "../../common/util/throttle";
|
|
||||||
import "../../components/chart/state-history-charts";
|
import "../../components/chart/state-history-charts";
|
||||||
import { getRecentWithCache } from "../../data/cached-history";
|
import {
|
||||||
import { HistoryResult } from "../../data/history";
|
HistoryResult,
|
||||||
|
subscribeHistoryStatesTimeWindow,
|
||||||
|
computeHistory,
|
||||||
|
} from "../../data/history";
|
||||||
import {
|
import {
|
||||||
fetchStatistics,
|
fetchStatistics,
|
||||||
getStatisticMetadata,
|
getStatisticMetadata,
|
||||||
@ -39,9 +41,11 @@ export class MoreInfoHistory extends LitElement {
|
|||||||
|
|
||||||
private _statNames?: Record<string, string>;
|
private _statNames?: Record<string, string>;
|
||||||
|
|
||||||
private _throttleGetStateHistory = throttle(() => {
|
private _interval?: number;
|
||||||
this._getStateHistory();
|
|
||||||
}, 10000);
|
private _subscribed?: Promise<(() => Promise<void>) | void>;
|
||||||
|
|
||||||
|
private _error?: string;
|
||||||
|
|
||||||
protected render(): TemplateResult {
|
protected render(): TemplateResult {
|
||||||
if (!this.entityId) {
|
if (!this.entityId) {
|
||||||
@ -59,7 +63,9 @@ export class MoreInfoHistory extends LitElement {
|
|||||||
)}</a
|
)}</a
|
||||||
>
|
>
|
||||||
</div>
|
</div>
|
||||||
${this._statistics
|
${this._error
|
||||||
|
? html`<div class="errors">${this._error}</div>`
|
||||||
|
: this._statistics
|
||||||
? html`<statistics-chart
|
? html`<statistics-chart
|
||||||
.hass=${this.hass}
|
.hass=${this.hass}
|
||||||
.isLoadingData=${!this._statistics}
|
.isLoadingData=${!this._statistics}
|
||||||
@ -94,24 +100,45 @@ export class MoreInfoHistory extends LitElement {
|
|||||||
this.entityId
|
this.entityId
|
||||||
}&start_date=${startOfYesterday().toISOString()}`;
|
}&start_date=${startOfYesterday().toISOString()}`;
|
||||||
|
|
||||||
this._throttleGetStateHistory();
|
this._getStateHistory();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public connectedCallback() {
|
||||||
|
super.connectedCallback();
|
||||||
|
if (this.hasUpdated && this.entityId) {
|
||||||
|
this._getStateHistory();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public disconnectedCallback() {
|
||||||
|
super.disconnectedCallback();
|
||||||
|
this._unsubscribeHistoryTimeWindow();
|
||||||
|
}
|
||||||
|
|
||||||
|
private _unsubscribeHistoryTimeWindow() {
|
||||||
|
if (!this._subscribed) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
clearInterval(this._interval);
|
||||||
|
this._subscribed.then((unsubscribe) => {
|
||||||
|
if (unsubscribe) {
|
||||||
|
unsubscribe();
|
||||||
|
}
|
||||||
|
this._subscribed = undefined;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
if (this._statistics || !this.entityId || !changedProps.has("hass")) {
|
private _redrawGraph() {
|
||||||
// Don't update statistics on a state update, as they only update every 5 minutes.
|
if (this._stateHistory) {
|
||||||
return;
|
this._stateHistory = { ...this._stateHistory };
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const oldHass = changedProps.get("hass") as HomeAssistant | undefined;
|
private _setRedrawTimer() {
|
||||||
|
// redraw the graph every minute to update the time axis
|
||||||
if (
|
clearInterval(this._interval);
|
||||||
oldHass &&
|
this._interval = window.setInterval(() => this._redrawGraph(), 1000 * 60);
|
||||||
this.hass.states[this.entityId] !== oldHass?.states[this.entityId]
|
|
||||||
) {
|
|
||||||
// wait for commit of data (we only account for the default setting of 1 sec)
|
|
||||||
setTimeout(this._throttleGetStateHistory, 1000);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private async _getStateHistory(): Promise<void> {
|
private async _getStateHistory(): Promise<void> {
|
||||||
@ -134,19 +161,29 @@ export class MoreInfoHistory extends LitElement {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (!isComponentLoaded(this.hass, "history")) {
|
if (!isComponentLoaded(this.hass, "history") || this._subscribed) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
this._stateHistory = await getRecentWithCache(
|
this._subscribed = subscribeHistoryStatesTimeWindow(
|
||||||
this.hass!,
|
this.hass!,
|
||||||
[this.entityId],
|
(combinedHistory) => {
|
||||||
{
|
if (!this._subscribed) {
|
||||||
cacheKey: `more_info.${this.entityId}`,
|
// Message came in before we had a chance to unload
|
||||||
hoursToShow: 24,
|
return;
|
||||||
|
}
|
||||||
|
this._stateHistory = computeHistory(
|
||||||
|
this.hass!,
|
||||||
|
combinedHistory,
|
||||||
|
this.hass!.localize
|
||||||
|
);
|
||||||
},
|
},
|
||||||
this.hass!.localize,
|
24,
|
||||||
this.hass!.language
|
[this.entityId]
|
||||||
);
|
).catch((err) => {
|
||||||
|
this._subscribed = undefined;
|
||||||
|
this._error = err;
|
||||||
|
});
|
||||||
|
this._setRedrawTimer();
|
||||||
}
|
}
|
||||||
|
|
||||||
private _close(): void {
|
private _close(): void {
|
||||||
|
@ -10,6 +10,7 @@ import { customElement, property, state } from "lit/decorators";
|
|||||||
import { classMap } from "lit/directives/class-map";
|
import { classMap } from "lit/directives/class-map";
|
||||||
import "../../../components/ha-card";
|
import "../../../components/ha-card";
|
||||||
import "../../../components/chart/state-history-charts";
|
import "../../../components/chart/state-history-charts";
|
||||||
|
import { isComponentLoaded } from "../../../common/config/is_component_loaded";
|
||||||
import {
|
import {
|
||||||
HistoryResult,
|
HistoryResult,
|
||||||
subscribeHistoryStatesTimeWindow,
|
subscribeHistoryStatesTimeWindow,
|
||||||
@ -98,7 +99,7 @@ export class HuiHistoryGraphCard extends LitElement implements LovelaceCard {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private _subscribeHistoryTimeWindow() {
|
private _subscribeHistoryTimeWindow() {
|
||||||
if (this._subscribed) {
|
if (!isComponentLoaded(this.hass!, "history") || this._subscribed) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
this._subscribed = subscribeHistoryStatesTimeWindow(
|
this._subscribed = subscribeHistoryStatesTimeWindow(
|
||||||
@ -176,7 +177,8 @@ export class HuiHistoryGraphCard extends LitElement implements LovelaceCard {
|
|||||||
|
|
||||||
if (
|
if (
|
||||||
changedProps.has("_config") &&
|
changedProps.has("_config") &&
|
||||||
(oldConfig?.entities !== this._config.entities ||
|
(!this._subscribed ||
|
||||||
|
oldConfig?.entities !== this._config.entities ||
|
||||||
oldConfig?.hours_to_show !== this._hoursToShow)
|
oldConfig?.hours_to_show !== this._hoursToShow)
|
||||||
) {
|
) {
|
||||||
this._unsubscribeHistoryTimeWindow();
|
this._unsubscribeHistoryTimeWindow();
|
||||||
|
Loading…
x
Reference in New Issue
Block a user