Add debounce to the status observers to reduce unnecessary CPU loops (e…

…lastic#108952)
kibanamachine · Aug 17, 2021 · 42fbfd7 · 42fbfd7
1 parent c0c3695
commit 42fbfd7
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 2 deletions.
diff --git a/src/core/server/status/plugins_status.test.ts b/src/core/server/status/plugins_status.test.ts
@@ -247,7 +247,6 @@ describe('PluginStatusService', () => {
       subscription.unsubscribe();
 
       expect(statusUpdates).toEqual([
-        { a: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' } },
         { a: { level: ServiceStatusLevels.degraded, summary: 'a degraded' } },
         { a: { level: ServiceStatusLevels.unavailable, summary: 'a unavailable' } },
         { a: { level: ServiceStatusLevels.available, summary: 'a available' } },
@@ -274,7 +273,6 @@ describe('PluginStatusService', () => {
       subscription.unsubscribe();
 
       expect(statusUpdates).toEqual([
-        { a: { level: ServiceStatusLevels.available, summary: 'All dependencies are available' } },
         { a: { level: ServiceStatusLevels.degraded, summary: 'a degraded' } },
         { a: { level: ServiceStatusLevels.unavailable, summary: 'a unavailable' } },
         { a: { level: ServiceStatusLevels.available, summary: 'a available' } },
@@ -357,6 +355,35 @@ describe('PluginStatusService', () => {
       }).toThrowError();
     });
 
+    it('debounces plugins custom status registration', async () => {
+      const service = new PluginsStatusService({
+        core$: coreAllAvailable$,
+        pluginDependencies,
+      });
+      const available: ServiceStatus = {
+        level: ServiceStatusLevels.available,
+        summary: 'a available',
+      };
+
+      const statusUpdates: Array<Record<string, ServiceStatus>> = [];
+      const subscription = service
+        .getDependenciesStatus$('b')
+        .subscribe((status) => statusUpdates.push(status));
+
+      const pluginA$ = new BehaviorSubject(available);
+      service.set('a', pluginA$);
+
+      expect(statusUpdates).toStrictEqual([]);
+
+      const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
+
+      // Waiting for the debounce timeout should cut a new update
+      await delay(25);
+      subscription.unsubscribe();
+
+      expect(statusUpdates).toStrictEqual([{ a: available }]);
+    });
+
     it('debounces events in quick succession', async () => {
       const service = new PluginsStatusService({
         core$: coreAllAvailable$,

diff --git a/src/core/server/status/plugins_status.ts b/src/core/server/status/plugins_status.ts
@@ -76,6 +76,7 @@ export class PluginsStatusService {
 
   public getDerivedStatus$(plugin: PluginName): Observable<ServiceStatus> {
     return this.update$.pipe(
+      debounceTime(25), // Avoid calling the plugin's custom status logic for every plugin that depends on it.
       switchMap(() => {
         // Only go up the dependency tree if any of this plugin's dependencies have a custom status
         // Helps eliminate memory overhead of creating thousands of Observables unnecessarily.