@kwirthmagnify/kwirth-common-back 0.5.53 → 0.5.54

package/dist/IProvider.d.ts

@@ -8,8 +8,13 @@ export interface IProviderSubscriber {
     processProviderEvent(providerId: string, obj: any): void;
 }
 /**
- * How a channel subscribes to a producer. The core hands one of these out already bound to the two
- * ends — the producer and the channel asking for it — with 'clusterInfo.getProvider(id, this)'.
+ * How a consumer subscribes to a producer. The core hands one of these out already bound to the two
+ * ends — the producer and whoever asked for it — with 'clusterInfo.getProvider(id, this)'.
+ *
+ * The consumer is usually a channel, but it does NOT have to be: a PROVIDER may consume another
+ * provider, which is how a provider that owns shared configuration — cloud credentials, say — reaches
+ * the providers that need it. A provider subscribes from onProvidersReady(), never from
+ * startProvider(); see that method for why.
  *
  * It exists because a channel used to receive the provider OBJECT and call 'addSubscriber' on it,
  * which meant the core could be bypassed without doing anything wrong, and therefore that its
@@ -118,12 +123,6 @@ export interface IProviderStats {
     /** Errores al entregar, con el mismo criterio: acumulado y barato. */
     errors?: number;
 }
-/**
- * What a provider writes its log with. It is the common extension logger — the need turned out to be
- * the same for senders, so it lives in IExtension. Kept as a name of its own because it is already
- * published and providers compile against it.
- */
-export type IProviderLogger = IExtensionLogger;
 /**
  * Interface that all provider plugins must implement.
  * Use 'any' for clusterInfo to avoid pulling in kubernetes/docker dependencies.
@@ -183,10 +182,26 @@ export interface IProvider extends IExtension {
      * Why it exists: channels get a 'backChannelObject' to log with, providers got nothing, so the
      * only thing left to them was 'console.log'. That comes out with no timestamp, no level and no
      * component — an error from a provider looks exactly like an informational line, and nothing can
-     * be filtered. With this, a provider's line reads '[provider] [ERROR] [longhorn] ...' and the
+     * be filtered. With this, a provider's line reads '[prov] [ERRO] [longhorn] ...' and the
      * provider does not even have to write its own id: the core puts it there.
      */
-    setLogger?(logger: IProviderLogger): void;
+    setLogger?(logger: IExtensionLogger): void;
+    /**
+     * Called once, after EVERY provider and pluvider is registered and started. This is where a
+     * provider that CONSUMES another one subscribes to it.
+     *
+     * ⚠️ Do not subscribe from startProvider(). Whether the producer is registered by then depends on
+     * which startup loop instantiated it and on the order within that loop, so it would work or not
+     * for reasons you cannot see from your own code.
+     *
+     * 🔴 Whatever you subscribe to here, unsubscribe in stopProvider(). Skipping it does not leak one
+     * object: the producer keeps feeding an instance nobody uses any more, and every hot reload
+     * leaves another ghost behind holding whatever that instance held.
+     *
+     * OPTIONAL, like the rest of this block: a provider that does not implement it is never called,
+     * and an older core that does not know about it simply never calls anyone.
+     */
+    onProvidersReady?(): void | Promise<void>;
     startProvider(): Promise<void>;
     stopProvider(): Promise<void>;
     router: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwirthmagnify/kwirth-common-back",
-  "version": "0.5.53",
+  "version": "0.5.54",
   "description": "Backend interfaces for building Kwirth provider and channel plugins",
   "scripts": {
     "build": "tsc",