controller-runtime: add 'started' getters to manager and source

Author: cjihrig

controller-runtime/lib/manager.d.ts

@@ -9,7 +9,6 @@ export class Manager {
     constructor(options?: ManagerOptions);
     client: KubernetesObjectApi;
     kubeconfig: KubeConfig;
-    started: boolean;
     /**
      * add() causes the Manager to manage the provided controller.
      * @param {Controller} controller The controller to manage.
@@ -26,6 +25,11 @@ export class Manager {
      * @returns {Promise<void>}
      */
     start(context?: Context): Promise<void>;
+    /**
+     * A boolean indicating if the manager was started.
+     * @type {boolean}
+     */
+    get started(): boolean;
     #private;
 }
 declare namespace _default {

controller-runtime/lib/manager.js

@@ -47,6 +47,8 @@ export class Manager {
   #controllers;
   /** @type LeaderElector */
   #leaderElector;
+  /** @type boolean */
+  #started;
   /** @type Server */
   #webhookServer;
 
@@ -166,7 +168,7 @@ export class Manager {
     this.client = client;
     this.#controllers = [];
     this.kubeconfig = kubeconfig;
-    this.started = false;
+    this.#started = false;
     this.#webhookServer = null;
   }
 
@@ -196,12 +198,10 @@ export class Manager {
    * @returns {Promise<void>}
    */
   async start(context = Context.create()) {
-    if (this.started) {
+    if (this.#started) {
       throw new Error('manager already started');
     }
 
-    this.started = true;
-
     // Webhooks can start before leader election.
     if (this.#webhookServer !== null) {
       await this.#webhookServer.start(context.child());
@@ -212,6 +212,16 @@ export class Manager {
     } else {
       this.#startControllers(context);
     }
+
+    this.#started = true;
+  }
+
+  /**
+   * A boolean indicating if the manager was started.
+   * @type {boolean}
+   */
+  get started() {
+    return this.#started;
   }
 
   /**

controller-runtime/lib/source.d.ts

@@ -25,6 +25,12 @@ export class Source {
      * @returns {Promise<void>}
      */
     start(context: Context, queue: Queue<Request>): Promise<void>;
+    /**
+     * A boolean indicating if the source was started.
+     * @type {boolean}
+     */
+    get started(): boolean;
+    #private;
 }
 declare namespace _default {
     export { Source };

controller-runtime/lib/source.js

@@ -15,6 +15,9 @@ import { Request } from './reconcile.js';
  * Source provides event streams to hook up to Controllers.
  */
 export class Source {
+  /** @type boolean */
+  #started;
+
   /**
    * Construct a Source.
    * @param {KubeConfig} kubeconfig - Kubeconfig to use.
@@ -44,6 +47,7 @@ export class Source {
     this.kind = kind;
     this.apiVersion = apiVersion;
     this.informer = null;
+    this.#started = false;
   }
 
   /**
@@ -61,6 +65,10 @@ export class Source {
       throw new TypeError('queue must be a Queue instance');
     }
 
+    if (this.#started) {
+      throw new Error('source already started');
+    }
+
     let apiVersion = this.apiVersion;
 
     if (apiVersion !== 'v1' && apiVersion.split('/').length === 1) {
@@ -119,7 +127,16 @@ export class Source {
       queue.enqueue(k8sObjectToRequest(resource));
     });
 
-    return this.informer.start();
+    await this.informer.start();
+    this.#started = true;
+  }
+
+  /**
+   * A boolean indicating if the source was started.
+   * @type {boolean}
+   */
+  get started() {
+    return this.#started;
   }
 }
 

controller-runtime/test/manager.js

@@ -152,6 +152,7 @@ suite('Manager', () => {
       const manager = new Manager(options);
       manager.start(ctx);
 
+      assert.strictEqual(manager.started, true);
       await assert.rejects(() => {
         return manager.start(ctx);
       }, /manager already started/);

controller-runtime/test/source.js

@@ -16,6 +16,7 @@ suite('Source', () => {
       assert.strictEqual(source.client, o.client);
       assert.strictEqual(source.kind, o.kind);
       assert.strictEqual(source.apiVersion, o.apiVersion);
+      assert.strictEqual(source.started, false);
     });
 
     test('kubeconfig argument must be a KubeConfig instance', () => {