fix(heliotrope): suppress duplicate warnings and guard against missing sunrise/sunset

#1184

Author: tagyoureit

controller/Constants.ts

@@ -136,6 +136,7 @@ export class Heliotrope {
             this.dt.getMonth() !== dt.getMonth() ||
             this.dt.getDate() !== dt.getDate()) {
             this.isCalculated = false;
+            this._warningSuppressed = false;
             // Always store a copy since we don't want to create instances where the change doesn't get reflected.  This
             // also could hold onto references that we don't want held for garbage cleanup.
             this.dt = typeof dt !== 'undefined' && typeof dt.getMonth === 'function' ? new Date(dt.getFullYear(), dt.getMonth(), dt.getDate(),
@@ -146,19 +147,24 @@ export class Heliotrope {
     public set longitude(lon: number) {
         if (this._longitude !== lon) {
             this.isCalculated = false;
+            this._warningSuppressed = false;
         }
         this._longitude = lon;
     }
     public get latitude() { return this._latitude; }
     public set latitude(lat: number) {
         if (this._latitude !== lat) {
             this.isCalculated = false;
+            this._warningSuppressed = false;
         }
         this._latitude = lat;
     }
     public get zenith() { return this._zenith; }
     public set zenith(zen: number) {
-        if (this._zenith !== zen) this.isCalculated = false;
+        if (this._zenith !== zen) {
+            this.isCalculated = false;
+            this._warningSuppressed = false;
+        }
         this._zenith = zen;
     }
     private dt: Date;
@@ -171,6 +177,7 @@ export class Heliotrope {
     private _dtNextSunset: Date;
     private _dtPrevSunrise: Date;
     private _dtPrevSunset: Date;
+    private _warningSuppressed: boolean = false;
     public get isNight(): boolean {
         let times = this.calculatedTimes;
         if (this.isValid) {
@@ -214,10 +221,10 @@ export class Heliotrope {
             logger.verbose(`Calculated Heliotrope: sunrise:${Timestamp.toISOLocal(this._dtSunrise)} sunset:${Timestamp.toISOLocal(this._dtSunset)}`);
         }
         else {
-            // Set isCalculated = true to prevent warning spam (6 warnings per minute).
-            // When user sets valid lat/lon, the setters reset isCalculated = false, triggering recalculation.
-            this.isCalculated = true;
-            logger.warn(`dt:${this.dt} lat:${this._latitude} lon:${this._longitude} Not enough information to calculate Heliotrope.  See https://github.com/tagyoureit/nodejs-poolController/issues/245`);
+            if (!this._warningSuppressed) {
+                logger.warn(`dt:${this.dt} lat:${this._latitude} lon:${this._longitude} Not enough information to calculate Heliotrope.  See https://github.com/tagyoureit/nodejs-poolController/issues/245`);
+                this._warningSuppressed = true;
+            }
         }
     }
     public get sunrise(): Date {

controller/boards/AquaLinkBoard.ts

@@ -223,7 +223,7 @@ class AquaLinkScheduleCommands extends ScheduleCommands {
 
 
         // If we have sunrise/sunset then adjust for the values; if heliotrope isn't set just ignore
-        if (state.heliotrope.isCalculated) {
+        if (state.heliotrope.isCalculated && state.heliotrope.sunrise && state.heliotrope.sunset) {
             const sunrise = state.heliotrope.sunrise.getHours() * 60 + state.heliotrope.sunrise.getMinutes();
             const sunset = state.heliotrope.sunset.getHours() * 60 + state.heliotrope.sunset.getMinutes();
             if (startTimeType === sys.board.valueMaps.scheduleTimeTypes.getValue('sunrise')) startTime = sunrise;

controller/boards/EasyTouchBoard.ts

@@ -764,7 +764,7 @@ export class TouchScheduleCommands extends ScheduleCommands {
 
 
             // If we have sunrise/sunset then adjust for the values; if heliotrope isn't set just ignore
-            if (state.heliotrope.isCalculated) {
+            if (state.heliotrope.isCalculated && state.heliotrope.sunrise && state.heliotrope.sunset) {
                 const sunrise = state.heliotrope.sunrise.getHours() * 60 + state.heliotrope.sunrise.getMinutes();
                 const sunset = state.heliotrope.sunset.getHours() * 60 + state.heliotrope.sunset.getMinutes();
                 if (startTimeType === sys.board.valueMaps.scheduleTimeTypes.getValue('sunrise')) startTime = (sunrise + startTimeOffset);
@@ -963,7 +963,7 @@ export class TouchScheduleCommands extends ScheduleCommands {
         // This will check the schedule and if the existing sunrise/sunset times 
         // are not matching the desired time it will update the time on the OCP.
         // https://github.com/tagyoureit/nodejs-poolController/discussions/560#discussioncomment-3362149
-        if (!state.heliotrope.isCalculated) { return false; }
+        if (!state.heliotrope.isCalculated || !state.heliotrope.sunrise || !state.heliotrope.sunset) { return false; }
         const sunrise = state.heliotrope.sunrise.getHours() * 60 + state.heliotrope.sunrise.getMinutes();
         const sunset = state.heliotrope.sunset.getHours() * 60 + state.heliotrope.sunset.getMinutes();