Skip to content

Commit

Permalink
fix: suppress deprecation warnings to once per unique args (#6875)
Browse files Browse the repository at this point in the history
  • Loading branch information
ozyx authored and akhenry committed Aug 2, 2023
1 parent 44415b3 commit dca23aa
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/api/time/TimeContext.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ class TimeContext extends EventEmitter {
this.activeClock = undefined;
this.offsets = undefined;
this.mode = undefined;
this.warnCounts = {};

this.tick = this.tick.bind(this);
}
Expand Down Expand Up @@ -648,6 +649,17 @@ class TimeContext extends EventEmitter {
}

#warnMethodDeprecated(method, newMethod) {
const MAX_CALLS = 1; // Only warn once per unique method and newMethod combination

const key = `${method}.${newMethod}`;
const currentWarnCount = this.warnCounts[key] || 0;

if (currentWarnCount >= MAX_CALLS) {
return; // Don't warn if already warned once
}

this.warnCounts[key] = currentWarnCount + 1;

let message = `[DEPRECATION WARNING]: The ${method} API method is deprecated and will be removed in a future version of Open MCT.`;

if (newMethod) {
Expand Down

0 comments on commit dca23aa

Please sign in to comment.