use monitor settings provider properly

Author: Alberto Iannaccone

arduino-ide-extension/src/browser/monitor-manager-proxy-client-impl.ts

@@ -70,7 +70,12 @@ export class MonitorManagerProxyClientImpl
       const parsedMessage = JSON.parse(message.data);
       if (Array.isArray(parsedMessage))
         this.onMessagesReceivedEmitter.fire({ messages: parsedMessage });
-      else this.onMonitorSettingsDidChangeEmitter.fire(parsedMessage);
+      else if (
+        parsedMessage.command ===
+        Monitor.MiddlewareCommand.ON_SETTINGS_DID_CHANGE
+      ) {
+        this.onMonitorSettingsDidChangeEmitter.fire(parsedMessage.data);
+      }
     };
     this.wsPort = addressPort;
   }

arduino-ide-extension/src/browser/serial/monitor/monitor-widget.tsx

@@ -84,7 +84,7 @@ export class MonitorWidget extends ReactWidget {
     );
   }
 
-  protected onAfterAttach(msg: Message): void {
+  protected onBeforeAttach(msg: Message): void {
     this.update();
     this.toDispose.push(this.monitorModel.onChange(() => this.update()));
     this.getCurrentSettings().then(this.onMonitorSettingsDidChange.bind(this));

arduino-ide-extension/src/common/protocol/monitor-service.ts

@@ -70,7 +70,7 @@ export namespace Monitor {
   }
 
   export type Message = {
-    command: Monitor.ClientCommand;
+    command: Monitor.ClientCommand | Monitor.MiddlewareCommand;
     data: string | MonitorSettings;
   };
 }

arduino-ide-extension/src/node/arduino-ide-backend-module.ts

@@ -229,14 +229,15 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
         const webSocketProvider =
           container.get<WebSocketProvider>(WebSocketProvider);
 
-        const { board, port, coreClientProvider } = options;
+        const { board, port, coreClientProvider, monitorID } = options;
 
         return new MonitorService(
           logger,
           monitorSettingsProvider,
           webSocketProvider,
           board,
           port,
+          monitorID,
           coreClientProvider
         );
       }

arduino-ide-extension/src/node/monitor-manager.ts

@@ -196,6 +196,7 @@ export class MonitorManager extends CoreClientAware {
     const monitor = this.monitorServiceFactory({
       board,
       port,
+      monitorID,
       coreClientProvider: this.coreClientProvider,
     });
     this.monitorServices.set(monitorID, monitor);

arduino-ide-extension/src/node/monitor-service-factory.ts

@@ -7,12 +7,14 @@ export interface MonitorServiceFactory {
   (options: {
     board: Board;
     port: Port;
+    monitorID: string;
     coreClientProvider: CoreClientProvider;
   }): MonitorService;
 }
 
 export interface MonitorServiceFactoryOptions {
   board: Board;
   port: Port;
+  monitorID: string;
   coreClientProvider: CoreClientProvider;
 }

arduino-ide-extension/src/node/monitor-service.ts

@@ -63,14 +63,11 @@ export class MonitorService extends CoreClientAware implements Disposable {
 
     private readonly board: Board,
     private readonly port: Port,
+    private readonly monitorID: string,
     protected readonly coreClientProvider: CoreClientProvider
   ) {
     super();
 
-    this.monitorSettingsProvider = {
-      getSettings: () => ({} as Promise<PluggableMonitorSettings>),
-      setSettings: () => ({} as Promise<PluggableMonitorSettings>),
-    };
     this.onWSClientsNumberChanged =
       this.webSocketProvider.onClientsNumberChanged(async (clients: number) => {
         if (clients === 0) {
@@ -81,13 +78,19 @@ export class MonitorService extends CoreClientAware implements Disposable {
         }
       });
 
-    this.portMonitorSettings(port.protocol, board.fqbn!).then((settings) => {
-      this.settings = {
-        ...this.settings,
-        pluggableMonitorSettings: settings,
-      };
-      this._initialized.resolve();
-    });
+    this.portMonitorSettings(port.protocol, board.fqbn!).then(
+      async (settings) => {
+        this.settings = {
+          ...this.settings,
+          pluggableMonitorSettings:
+            await this.monitorSettingsProvider.getSettings(
+              this.monitorID,
+              settings
+            ),
+        };
+        this._initialized.resolve();
+      }
+    );
   }
 
   get initialized(): Promise<void> {
@@ -368,22 +371,27 @@ export class MonitorService extends CoreClientAware implements Disposable {
   async changeSettings(settings: MonitorSettings): Promise<Status> {
     const config = new MonitorPortConfiguration();
     const { pluggableMonitorSettings } = settings;
+    const reconciledSettings = await this.monitorSettingsProvider.setSettings(
+      this.monitorID,
+      pluggableMonitorSettings || {}
+    );
 
-    this.webSocketProvider.sendMessage(JSON.stringify(settings));
-
-    if (pluggableMonitorSettings) {
-      for (const id in pluggableMonitorSettings) {
+    if (reconciledSettings) {
+      for (const id in reconciledSettings) {
         const s = new MonitorPortSetting();
         s.setSettingId(id);
-        s.setValue(pluggableMonitorSettings[id].selectedValue);
+        s.setValue(reconciledSettings[id].selectedValue);
         config.addSettings(s);
-        this.settings.pluggableMonitorSettings = {
-          ...this.settings.pluggableMonitorSettings,
-          [id]: pluggableMonitorSettings[id],
-        };
       }
     }
 
+    const command: Monitor.Message = {
+      command: Monitor.MiddlewareCommand.ON_SETTINGS_DID_CHANGE,
+      data: { ...settings, pluggableMonitorSettings: reconciledSettings },
+    };
+
+    this.webSocketProvider.sendMessage(JSON.stringify(command));
+
     if (!this.duplex) {
       return Status.NOT_CONNECTED;
     }

arduino-ide-extension/src/node/monitor-settings/monitor-settings-provider-impl.ts

@@ -58,7 +58,11 @@ export class MonitorSettingsProviderImpl implements MonitorSettingsProvider {
 
     const { matchingSettings } = this.longestPrefixMatch(monitorId);
 
-    return this.reconcileSettings(matchingSettings, defaultSettings);
+    this.monitorSettings[monitorId] = this.reconcileSettings(
+      matchingSettings,
+      defaultSettings
+    );
+    return this.monitorSettings[monitorId];
   }
 
   async setSettings(
@@ -70,7 +74,7 @@ export class MonitorSettingsProviderImpl implements MonitorSettingsProvider {
 
     const newSettings = this.reconcileSettings(
       settings,
-      this.monitorSettings[monitorId]
+      this.monitorSettings[monitorId] || {}
     );
     this.monitorSettings[monitorId] = newSettings;