lifning/ws4kp
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

auto-retry for some forecast data

Browse source
This commit is contained in:
Matt Walsh 2022-12-12 13:53:33 -06:00
parent 76fd93e6e1
commit 5dd8f4bd62
16 changed files with 101 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
server/scripts/modules/currentweather.mjs
View file

@ -19,7 +19,8 @@ class CurrentWeather extends WeatherDisplay {
}
async getData(_weatherParameters) {
if (!super.getData(_weatherParameters)) return;
// always load the data for use in the lower scroll
const superResult = super.getData(_weatherParameters);
const weatherParameters = _weatherParameters ?? this.weatherParameters;
// Load the observations
@ -39,6 +40,8 @@ class CurrentWeather extends WeatherDisplay {
data: {
limit: 2,
},
retryCount: 3,
stillWaiting: () => this.stillWaiting(),
});
// test data quality
@ -60,14 +63,17 @@ class CurrentWeather extends WeatherDisplay {
this.getDataCallback(undefined);
return;
}
// preload the icon
preloadImg(getWeatherIconFromIconLink(observations.features[0].properties.icon));
// we only get here if there was no error above
this.data = { ...observations, station };
this.setStatus(STATUS.loaded);
this.getDataCallback();
// stop here if we're disabled
if (!superResult) return;
// preload the icon
preloadImg(getWeatherIconFromIconLink(observations.features[0].properties.icon));
this.setStatus(STATUS.loaded);
}
// format the data for use outside this function
@ -163,7 +169,8 @@ class CurrentWeather extends WeatherDisplay {
// make data available outside this class
// promise allows for data to be requested before it is available
async getCurrentWeather() {
async getCurrentWeather(stillWaiting) {
if (stillWaiting) this.stillWaitingCallbacks.push(stillWaiting);
return new Promise((resolve) => {
if (this.data) resolve(this.parseData());
// data not available, put it into the data callback queue

2
server/scripts/modules/currentweatherscroll.mjs
View file

@ -43,7 +43,7 @@ const incrementInterval = () => {
const drawScreen = async () => {
// get the conditions
const data = await getCurrentWeather();
const data = await getCurrentWeather(() => this.stillWaiting());
// nothing to do if there's no data yet
if (!data) return;

2
server/scripts/modules/extendedforecast.mjs
View file

@ -28,6 +28,8 @@ class ExtendedForecast extends WeatherDisplay {
data: {
units: 'us',
},
retryCount: 3,
stillWaiting: () => this.stillWaiting(),
});
} catch (e) {
console.error('Unable to get extended forecast');

2
server/scripts/modules/hourly-graph.mjs
View file

@ -27,7 +27,7 @@ class HourlyGraph extends WeatherDisplay {
async getData() {
if (!super.getData()) return;
const data = await getHourlyData();
const data = await getHourlyData(() => this.stillWaiting());
if (data === undefined) {
this.setStatus(STATUS.failed);
return;

5
server/scripts/modules/hourly.mjs
View file

@ -33,7 +33,7 @@ class Hourly extends WeatherDisplay {
let forecast;
try {
// get the forecast
forecast = await json(weatherParameters.forecastGridData);
forecast = await json(weatherParameters.forecastGridData, { retryCount: 3, stillWaiting: () => this.stillWaiting() });
} catch (e) {
console.error('Get hourly forecast failed');
console.error(e.status, e.responseJSON);
@ -120,7 +120,8 @@ class Hourly extends WeatherDisplay {
// make data available outside this class
// promise allows for data to be requested before it is available
async getCurrentData() {
async getCurrentData(stillWaiting) {
if (stillWaiting) this.stillWaitingCallbacks.push(stillWaiting);
return new Promise((resolve) => {
if (this.data) resolve(this.data);
// data not available, put it into the data callback queue

2
server/scripts/modules/latestobservations.mjs
View file

@ -34,7 +34,7 @@ class LatestObservations extends WeatherDisplay {
// get data for regional stations
const allConditions = await Promise.all(regionalStations.map(async (station) => {
try {
const data = await json(`https://api.weather.gov/stations/${station.id}/observations/latest`);
const data = await json(`https://api.weather.gov/stations/${station.id}/observations/latest`, { retryCount: 3, stillWaiting: () => this.stillWaiting() });
// test for temperature, weather and wind values present
if (data.properties.temperature.value === null
|| data.properties.textDescription === ''

2
server/scripts/modules/localforecast.mjs
View file

@ -63,6 +63,8 @@ class LocalForecast extends WeatherDisplay {
data: {
units: 'us',
},
retryCount: 3,
stillWaiting: () => this.stillWaiting(),
});
} catch (e) {
console.error(`GetWeatherForecast failed: ${weatherParameters.forecast}`);

9
server/scripts/modules/navigation.mjs
View file

@ -98,7 +98,7 @@ const getWeather = async (latLon) => {
const updateStatus = (value) => {
if (value.id < 0) return;
if (!progress) return;
progress.drawCanvas(displays, countLoadedCanvases());
progress.drawCanvas(displays, countLoadedDisplays());
// if this is the first display and we're playing, load it up so it starts playing
if (isPlaying() && value.id === 0 && value.status === STATUS.loaded) {
@ -106,13 +106,16 @@ const updateStatus = (value) => {
}
// send loaded messaged to parent
if (countLoadedCanvases() < displays.length) return;
if (countLoadedDisplays() < displays.length) return;
// everything loaded, set timestamps
AssignLastUpdate(new Date());
};
const countLoadedCanvases = () => displays.reduce((acc, display) => {
// note: a display that is "still waiting"/"retrying" is considered loaded intentionally
// the weather.gov api has long load times for some products when you are the first
// requester for the product after the cache expires
const countLoadedDisplays = () => displays.reduce((acc, display) => {
if (display.status !== STATUS.loading) return acc + 1;
return acc;
}, 0);

3
server/scripts/modules/progress.mjs
View file

@ -55,6 +55,9 @@ class Progress extends WeatherDisplay {
case STATUS.disabled:
statusClass = 'disabled';
break;
case STATUS.retrying:
statusClass = 'retrying';
break;
default:
}

1
server/scripts/modules/status.mjs
View file

@ -4,6 +4,7 @@ const STATUS = {
failed: Symbol('failed'),
noData: Symbol('noData'),
disabled: Symbol('disabled'),
retrying: Symbol('retyring'),
};
export default STATUS;

48
server/scripts/modules/utils/fetch.mjs
View file

@ -11,8 +11,12 @@ const fetchAsync = async (_url, responseType, _params = {}) => {
method: 'GET',
mode: 'cors',
type: 'GET',
retryCount: 0,
..._params,
};
// store original number of retries
params.originalRetries = params.retryCount;
// build a url, including the rewrite for cors if necessary
let corsUrl = _url;
if (params.cors === true) corsUrl = rewriteUrl(_url);
@ -30,7 +34,7 @@ const fetchAsync = async (_url, responseType, _params = {}) => {
}
// make the request
const response = await fetch(url, params);
const response = await doFetch(url, params);
// check for ok response
if (!response.ok) throw new Error(`Fetch error ${response.status} ${response.statusText} while fetching ${response.url}`);
@ -47,6 +51,48 @@ const fetchAsync = async (_url, responseType, _params = {}) => {
}
};
// fetch with retry and back-off
const doFetch = (url, params) => new Promise((resolve, reject) => {
fetch(url, params).then((response) => {
if (params.retryCount > 0) {
// 500 status codes should be retried after a short backoff
if (response.status >= 500 && response.status <= 599 && params.retryCount > 0) {
// call the "still waiting" function
if (typeof params.stillWaiting === 'function' && params.retryCount === params.originalRetries) {
params.stillWaiting();
}
// decrement and retry
const newParams = {
...params,
retryCount: params.retryCount - 1,
};
return resolve(delay(retryDelay(params.originalRetries - newParams.retryCount), doFetch, url, newParams));
}
// not 500 status
return resolve(response);
}
// out of retries
return resolve(response);
})
.catch((e) => reject(e));
});
const delay = (time, func, ...args) => new Promise((resolve) => {
setTimeout(() => {
resolve(func(...args));
}, time);
});
const retryDelay = (retryNumber) => {
switch (retryNumber) {
case 1: return 1000;
case 2: return 2000;
case 3: return 5000;
case 4: return 10000;
default: return 30000;
}
};
export {
json,
text,

9
server/scripts/modules/weatherdisplay.mjs
View file

@ -17,6 +17,7 @@ class WeatherDisplay {
this.loadingStatus = STATUS.loading;
this.name = name ?? elemId;
this.getDataCallbacks = [];
this.stillWaitingCallbacks = [];
this.defaultEnabled = defaultEnabled;
this.okToDrawCurrentConditions = true;
this.okToDrawCurrentDateTime = true;
@ -392,6 +393,14 @@ class WeatherDisplay {
return template;
}
// still waiting for data (retries triggered)
stillWaiting() {
if (this.enabled) this.setStatus(STATUS.retrying);
// handle still waiting callbacks
this.stillWaitingCallbacks.forEach((callback) => callback());
this.stillWaitingCallbacks = [];
}
}
export default WeatherDisplay;

2
server/styles/main.css
View file

File diff suppressed because one or more lines are too long

2
server/styles/main.css.map
View file

File diff suppressed because one or more lines are too long

26
server/styles/scss/_progress.scss
View file

@ -37,7 +37,8 @@
padding-left: 4px;
}
.loading {
.loading,
.retrying {
color: #ffff00;
}
@ -58,23 +59,12 @@
color: #C0C0C0;
}
&.loading .loading {
display: block;
}
&.press-here .press-here {
display: block;
}
&.failed .failed {
display: block;
}
&.no-data .no-data {
display: block;
}
&.disabled .disabled {
&.loading .loading,
&.press-here .press-here,
&.failed .failed,
&.no-data .no-data,
&.disabled .disabled,
&.retrying .retrying {
display: block;
}

1
views/partials/progress.ejs
View file

@ -9,6 +9,7 @@
<div class="failed">Failed</div>
<div class="no-data">No Data</div>
<div class="disabled">Disabled</div>
<div class="retrying">Retrying</div>
</div>
</div>
</div>