Rate limit CPU warning logs from the Voice Focus worklet (#2252)

* Rate limit CPU warning logs from the Voice Focus worklet * Adjust CHANGELOG for Voice Focus CPU warning changes * Reduce CPU warning interval to 5 seconds and adjust CHANGELOG * Address comments * Remove unnecessary CHANGELOG in 3.3.0 Co-authored-by: Richard Huang <[email protected]> Co-authored-by: Venkatesh Devale <[email protected]>
aws · May 26, 2022 · a030477 · a030477
1 parent 6fae98a
commit a030477
Show file tree

Hide file tree

Showing 12 changed files with 46 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add reset function to uplink policy interface, and ignore indexes in nscale policy if the number of published videos did not change.
 
 ### Fixed
+- Rate limited CPU warnings to at most once a minute in Voice Focus library, so that builder logs are not flooded.
 
 ## [3.3.0] - 2022-05-12
 

diff --git a/libs/voicefocus/decider.js b/libs/voicefocus/decider.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

diff --git a/libs/voicefocus/fetch.js b/libs/voicefocus/fetch.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isValidRevisionID = exports.isValidAssetGroup = exports.resolveURL = exports.addQueryParams = exports.withQueryString = exports.withRequestHeaders = exports.fetchWithBehavior = void 0;

diff --git a/libs/voicefocus/loader.js b/libs/voicefocus/loader.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadWorker = void 0;

diff --git a/libs/voicefocus/support.js b/libs/voicefocus/support.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

diff --git a/libs/voicefocus/types.d.ts b/libs/voicefocus/types.d.ts
@@ -130,5 +130,4 @@ export interface VoiceFocusFetchBehavior {
 export interface VoiceFocusFetchConfig extends VoiceFocusFetchBehavior {
     paths: VoiceFocusPaths;
 }
-
 export {};
diff --git a/libs/voicefocus/types.js b/libs/voicefocus/types.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VoiceFocusAudioWorkletNode = void 0;

diff --git a/libs/voicefocus/voicefocus.js b/libs/voicefocus/voicefocus.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -23,12 +26,12 @@ const DEFAULT_AGC_DISABLED_SETTING = {
 };
 const DEFAULT_AGC_SETTING = DEFAULT_AGC_DISABLED_SETTING;
 const DEFAULT_ASSET_GROUP = 'stable-v1';
-const DEFAULT_CDN = 'https://static.sdkassets.chime.aws/';
+const DEFAULT_CDN = 'https://static.sdkassets.chime.aws';
 const DEFAULT_PATHS = {
-    processors: `${DEFAULT_CDN}processors/`,
-    workers: `${DEFAULT_CDN}workers/`,
-    wasm: `${DEFAULT_CDN}wasm/`,
-    models: `${DEFAULT_CDN}wasm/`,
+    processors: `${DEFAULT_CDN}/processors/`,
+    workers: `${DEFAULT_CDN}/workers/`,
+    wasm: `${DEFAULT_CDN}/wasm/`,
+    models: `${DEFAULT_CDN}/wasm/`,
 };
 const DEFAULT_CONTEXT_HINT = {
     latencyHint: 0,

diff --git a/libs/voicefocus/worklet-inline-node.d.ts b/libs/voicefocus/worklet-inline-node.d.ts
@@ -3,6 +3,8 @@ declare class VoiceFocusInlineNode extends VoiceFocusAudioWorkletNode {
     private delegate?;
     private worker;
     private logger;
+    private cpuWarningLastTriggered;
+    private cpuWarningCount;
     constructor(context: AudioContext, options: VoiceFocusNodeOptions);
     onModuleBufferLoaded(buffer: ArrayBuffer, key: string): void;
     onModuleLoaded(module: WebAssembly.Module, key: string): void;

diff --git a/libs/voicefocus/worklet-inline-node.js b/libs/voicefocus/worklet-inline-node.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -11,9 +14,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const support_js_1 = require("./support.js");
 const types_js_1 = require("./types.js");
+const CPU_WARNING_MAX_INTERVAL_MS = 5 * 1000;
 class VoiceFocusInlineNode extends types_js_1.VoiceFocusAudioWorkletNode {
     constructor(context, options) {
         super(context, options.processor, options);
+        this.cpuWarningCount = 0;
         this.channelCountMode = 'explicit';
         this.channelCount = 1;
         const { modelURL, worker, fetchBehavior, logger, delegate, } = options;
@@ -59,7 +64,15 @@ class VoiceFocusInlineNode extends types_js_1.VoiceFocusAudioWorkletNode {
         const data = event.data;
         switch (data.message) {
             case 'cpu':
-                (_a = this.logger) === null || _a === void 0 ? void 0 : _a.warn('CPU warning:', data.message);
+                this.cpuWarningCount++;
+                const now = Date.now();
+                const before = this.cpuWarningLastTriggered || now;
+                const diff = Math.abs(now - before);
+                if (!this.cpuWarningLastTriggered || diff > CPU_WARNING_MAX_INTERVAL_MS) {
+                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.warn(`CPU warning (count: ${this.cpuWarningCount}):`, data.message);
+                    this.cpuWarningCount = 0;
+                    this.cpuWarningLastTriggered = now;
+                }
                 (_b = this.delegate) === null || _b === void 0 ? void 0 : _b.onCPUWarning();
                 break;
             default:

diff --git a/libs/voicefocus/worklet-worker-postMessage-node.js b/libs/voicefocus/worklet-worker-postMessage-node.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

diff --git a/libs/voicefocus/worklet-worker-sab-node.js b/libs/voicefocus/worklet-worker-sab-node.js
@@ -1,3 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }