refactor(signal): add a global signalCounter instead of Symbol & …

…use `signal` object instead of `signalName`

packages/core/signal/src/core.ts

@@ -18,6 +18,11 @@ alwatrRegisteredList.push({
   version: '{{ALWATR_VERSION}}',
 });
 
+/**
+ * Signal `id` counter
+ */
+let signalCounter = 0;
+
 /**
  * Signal stack database.
  */
@@ -69,7 +74,7 @@ function __callListeners<SignalName extends keyof AlwatrSignals>(signal: SignalO
 
   signal.listenerList
       .filter((listener) => !listener.disabled && listener.once)
-      .forEach((listener) => _removeSignalListener(signal.name, listener.id));
+      .forEach((listener) => _removeSignalListener(signal, listener.id));
 }
 
 /**
@@ -82,15 +87,15 @@ function __callListeners<SignalName extends keyof AlwatrSignals>(signal: SignalO
  * ```
  */
 export function _addSignalListener<SignalName extends keyof AlwatrSignals>(
-    signalName: SignalName,
+    signal: SignalObject<SignalName>,
     signalCallback: ListenerCallback<SignalName>,
     options?: ListenerOptions,
 ): ListenerObject<SignalName> {
-  logger.logMethodArgs('addSignalListener', {signalName, options});
+  logger.logMethodArgs('addSignalListener', {signal, options});
 
-  const signal = __getSignalObject(signalName);
+  // const signal = __getSignalObject(signalName);
   const listener: ListenerObject<SignalName> = {
-    id: Symbol('Alwatr signal listener for ' + signalName),
+    id: signalCounter++,
     once: options?.once ?? false,
     disabled: options?.disabled ?? false,
     callback: signalCallback,
@@ -102,20 +107,22 @@ export function _addSignalListener<SignalName extends keyof AlwatrSignals>(
   if (signal.value !== undefined) {
     if (options?.receivePrevious === 'Immediate') {
       logger.incident('addSignalListener', 'call_signal_callback', 'run callback with previous signal value!', {
-        signalName,
+        signalName: signal.name,
         mode: 'Immediate',
       });
       try {
         signalCallback(signal.value);
       } catch (err) {
-        logger.error('addSignalListener', 'call_signal_callback_failed', (err as Error).stack || err, {signalName});
+        logger.error('addSignalListener', 'call_signal_callback_failed', (err as Error).stack || err, {
+          signalName: signal.name,
+        });
       }
       callbackCalled = true;
     } else if (options?.receivePrevious === true) {
       requestAnimationFrame(() => {
         if (signal.value !== undefined) {
           logger.incident('addSignalListener', 'call_signal_callback', 'run callback with previous signal value!', {
-            signalName,
+            signalName: signal.name,
             mode: 'Delay',
           });
           signalCallback(signal.value);
@@ -148,11 +155,10 @@ export function _addSignalListener<SignalName extends keyof AlwatrSignals>(
  * ```
  */
 export function _removeSignalListener<SignalName extends keyof AlwatrSignals>(
-    signalName: SignalName,
-    listenerId: symbol,
+    signal: SignalObject<SignalName>,
+    listenerId: number,
 ): void {
-  logger.logMethodArgs('_removeSignalListener', signalName);
-  const signal = __getSignalObject(signalName);
+  logger.logMethodArgs('_removeSignalListener', {signal, listenerId});
   const listenerIndex = signal.listenerList.findIndex((_listener) => _listener.id === listenerId);
   if (listenerIndex !== -1) {
     signal.listenerList.splice(listenerIndex, 1);
@@ -216,7 +222,6 @@ export function _setSignalProvider<SignalName extends keyof AlwatrRequestSignals
 ): ListenerObject<SignalName> {
   logger.logMethodArgs('setSignalProvider', {signalName, options});
 
-  // @TODO: refactor with removeSignalProvider
   const signal = __getSignalObject(`request-${signalName}` as unknown as SignalName);
   if (signal.listenerList.length > 0) {
     logger.accident('setSignalProvider', 'signal_provider_already_set', 'another provider defined and will removed', {
@@ -233,9 +238,7 @@ export function _setSignalProvider<SignalName extends keyof AlwatrRequestSignals
     }
   };
 
-  return _addSignalListener(
-    `request-${signalName}` as unknown as SignalName,
-    _callback as unknown as ListenerCallback<SignalName>,
-    {receivePrevious: options?.receivePrevious ?? true},
-  );
+  return _addSignalListener(signal, _callback as unknown as ListenerCallback<SignalName>, {
+    receivePrevious: options?.receivePrevious ?? true,
+  });
 }

packages/core/signal/src/signal.ts

@@ -23,11 +23,13 @@ import type {
  */
 export class SignalInterface<SignalName extends keyof AlwatrSignals> {
   protected _signal;
+  protected _requestSignalName;
   protected _logger;
 
   constructor(signalName: SignalName) {
     this._logger = createLogger(`signal<${signalName}>`);
     this._signal = __getSignalObject(signalName);
+    this._requestSignalName = `request-${signalName}` as unknown as SignalName;
   }
 
   /**
@@ -131,13 +133,11 @@ export class SignalInterface<SignalName extends keyof AlwatrSignals> {
    * });
    * ```
    */
-  setProvider(signalProvider: SignalProvider<SignalName>, options?: SignalProviderOptions): symbol {
+  setProvider(signalProvider: SignalProvider<SignalName>, options?: SignalProviderOptions): ListenerObject<SignalName> {
     this._logger.logMethodArgs('setProvider', {options});
-    return _setSignalProvider(this.name, signalProvider, options).id;
+    return _setSignalProvider(this.name, signalProvider, options);
   }
 
-  // @TODO: removeProvider(signalName): void
-
   /**
    * Dispatch request signal and wait for answer (wait for new signal dispatched).
    *
@@ -154,8 +154,7 @@ export class SignalInterface<SignalName extends keyof AlwatrSignals> {
   request(requestParam: AlwatrRequestSignals[SignalName]): Promise<AlwatrSignals[SignalName]> {
     this._logger.logMethodArgs('request', {requestParam});
     const nextSignalValuePromise = this.getNextSignalValue();
-    _dispatchSignal(
-      `request-${this.name}` as unknown as SignalName,
+    _dispatchSignal(this._requestSignalName,
       requestParam as unknown as AlwatrSignals[SignalName], // mastmalize to avoid type error
     );
     return nextSignalValuePromise;
@@ -232,7 +231,7 @@ export class SignalInterface<SignalName extends keyof AlwatrSignals> {
    */
   addListener(listener: ListenerCallback<SignalName>, options?: ListenerOptions): ListenerInterface<SignalName> {
     this._logger.logMethodArgs('addListener', {listener, options});
-    const listenerId = _addSignalListener(this._signal.name, listener, options);
+    const listenerId = _addSignalListener(this._signal, listener, options);
     return new ListenerInterface(this._signal, listenerId);
   }
 }
@@ -279,6 +278,6 @@ export class ListenerInterface<SignalName extends keyof AlwatrSignals> {
    */
   remove(): void {
     this._logger.logMethod('remove');
-    _removeSignalListener(this._signal.name, this._listener.id);
+    _removeSignalListener(this._signal, this._listener.id);
   }
 }

packages/core/signal/src/type.ts

@@ -98,9 +98,9 @@ export type SignalProvider<SignalName extends keyof AlwatrRequestSignals> = (
  */
 export interface ListenerObject<SignalName extends keyof AlwatrSignals> {
   /**
-   * Listener symbol id (unique).
+   * Listener number id (unique).
    */
-  id: symbol;
+  id: number;
 
   /**
    * If true, the listener will be called only once and removed automatically after first call