Warn users when using V2 API features with micro:bit V1

src/device/device.ts

@@ -133,6 +133,8 @@ export interface ConnectOptions {
   serial?: boolean;
 }
 
+export type BoardVersion = "V1" | "V2";
+
 export interface DeviceConnection extends EventEmitter {
   status: ConnectionStatus;
 
@@ -153,6 +155,13 @@ export interface DeviceConnection extends EventEmitter {
    */
   connect(options?: ConnectOptions): Promise<ConnectionStatus>;
 
+  /**
+   * Get the board version.
+   *
+   * @returns the board version or null if there is no connection.
+   */
+  getBoardVersion(): BoardVersion | null;
+
   /**
    * Flash the micro:bit.
    *

src/device/mock.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: MIT
  */
 import {
+  BoardVersion,
   ConnectionStatus,
   DeviceConnection,
   EVENT_FLASH,
@@ -62,6 +63,10 @@ export class MockDeviceConnection
     return this.status;
   }
 
+  getBoardVersion(): BoardVersion | null {
+    return "V2";
+  }
+
   /**
    * Flash the micro:bit.
    *

src/device/simulator.ts

@@ -6,6 +6,7 @@
 import EventEmitter from "events";
 import { Logging } from "../logging/logging";
 import {
+  BoardVersion,
   ConnectionStatus,
   DeviceConnection,
   EVENT_FLASH,
@@ -262,6 +263,10 @@ export class SimulatorDeviceConnection
     return this.status;
   }
 
+  getBoardVersion(): BoardVersion | null {
+    return "V2";
+  }
+
   async flash(
     dataSource: FlashDataSource,
     options: {

src/device/webusb.ts

@@ -10,6 +10,7 @@ import { withTimeout, TimeoutError } from "./async-util";
 import { DAPWrapper } from "./dap-wrapper";
 import { PartialFlashing } from "./partial-flashing";
 import {
+  BoardVersion,
   ConnectionStatus,
   ConnectOptions,
   DeviceConnection,
@@ -172,6 +173,14 @@ export class MicrobitWebUSBConnection
     });
   }
 
+  getBoardVersion(): BoardVersion | null {
+    if (!this.connection) {
+      return null;
+    }
+    const boardId = this.connection.boardSerialInfo.id;
+    return boardId.isV1() ? "V1" : boardId.isV2() ? "V2" : null;
+  }
+
   async flash(
     dataSource: FlashDataSource,
     options: {
@@ -297,7 +306,6 @@ export class MicrobitWebUSBConnection
     } finally {
       this.connection = undefined;
       this.setStatus(ConnectionStatus.NOT_CONNECTED);
-
       this.logging.log("Disconnection complete");
       this.logging.event({
         type: "WebUSB-info",

src/editor/codemirror/CodeMirror.tsx

@@ -40,6 +40,7 @@ import { languageServer } from "./language-server/view";
 import { lintGutter } from "./lint/lint";
 import { codeStructure } from "./structure-highlighting";
 import themeExtensions from "./themeExtensions";
+import { useDevice } from "../../device/device-hooks";
 
 interface CodeMirrorProps {
   className?: string;
@@ -81,6 +82,7 @@ const CodeMirror = ({
   const actionFeedback = useActionFeedback();
   const [sessionSettings, setSessionSettings] = useSessionSettings();
   const { apiReferenceMap } = useDocumentation();
+  const device = useDevice();
 
   // Reset undo/redo events on file change.
   useEffect(() => {
@@ -131,6 +133,7 @@ const CodeMirror = ({
             client
               ? languageServer(
                   client,
+                  device,
                   uri,
                   intl,
                   logging,
@@ -172,6 +175,7 @@ const CodeMirror = ({
     parameterHelpOption,
     uri,
     apiReferenceMap,
+    device,
   ]);
   useEffect(() => {
     // Do this separately as we don't want to destroy the view whenever options needed for initialization change.
@@ -191,6 +195,7 @@ const CodeMirror = ({
           client
             ? languageServer(
                 client,
+                device,
                 uri,
                 intl,
                 logging,
@@ -215,6 +220,7 @@ const CodeMirror = ({
     logging,
     uri,
     apiReferenceMap,
+    device,
   ]);
 
   const { location } = selection;

src/editor/codemirror/language-server/diagnostics.ts

@@ -7,6 +7,7 @@ import { Text } from "@codemirror/state";
 import * as LSP from "vscode-languageserver-protocol";
 import { Diagnostic } from "../lint/lint";
 import { positionToOffset } from "./positions";
+import { DeviceConnection } from "../../../device/device";
 
 const severityMapping = {
   [LSP.DiagnosticSeverity.Error]: "error",
@@ -17,10 +18,20 @@ const severityMapping = {
 
 export const diagnosticsMapping = (
   document: Text,
-  lspDiagnostics: LSP.Diagnostic[]
+  lspDiagnostics: LSP.Diagnostic[],
+  device: DeviceConnection
 ): Diagnostic[] =>
   lspDiagnostics
-    .map(({ range, message, severity, tags }): Diagnostic | undefined => {
+    .map(({ range, message, severity, tags, code }): Diagnostic | undefined => {
+      console.log(code);
+      console.log(device);
+      // Only show warnings for using V2 API features if a V1 board is connected.
+      if (
+        code === "reportMicrobitV2ApiUse" &&
+        device.getBoardVersion() !== "V1"
+      ) {
+        return undefined;
+      }
       let from = positionToOffset(document, range.start);
       let to = positionToOffset(document, range.end);
       // Skip if we can't map to the current document.

src/editor/codemirror/language-server/view.ts

@@ -15,6 +15,7 @@ import { autocompletion } from "./autocompletion";
 import { BaseLanguageServerView, clientFacet, uriFacet } from "./common";
 import { diagnosticsMapping } from "./diagnostics";
 import { signatureHelp } from "./signatureHelp";
+import { DeviceConnection, EVENT_STATUS } from "../../../device/device";
 
 /**
  * The main extension. This synchronises the diagnostics between the client
@@ -26,24 +27,35 @@ class LanguageServerView extends BaseLanguageServerView implements PluginValue {
     if (params.uri === this.uri) {
       const diagnostics = diagnosticsMapping(
         this.view.state.doc,
-        params.diagnostics
+        params.diagnostics,
+        this.device
       );
       this.view.dispatch(setDiagnostics(this.view.state, diagnostics));
     }
   };
   private destroyed = false;
-  constructor(view: EditorView) {
+  private onDeviceStatusChanged = () => {
+    const diagnostics = diagnosticsMapping(
+      this.view.state.doc,
+      this.client.allDiagnostics(),
+      this.device
+    );
+    this.view.dispatch(setDiagnostics(this.view.state, diagnostics));
+  };
+  constructor(view: EditorView, protected device: DeviceConnection) {
     super(view);
 
     this.client.on("diagnostics", this.diagnosticsListener);
+    this.device.on(EVENT_STATUS, this.onDeviceStatusChanged);
 
     // Is there a better way to do this? We can 't dispatch at this point.
     // It would be best to do this with initial state and avoid the dispatch.
     setTimeout(() => {
       if (!this.destroyed) {
         const diagnostics = diagnosticsMapping(
           view.state.doc,
-          this.client.currentDiagnostics(this.uri)
+          this.client.currentDiagnostics(this.uri),
+          device
         );
         view.dispatch(setDiagnostics(view.state, diagnostics));
       }
@@ -63,6 +75,7 @@ class LanguageServerView extends BaseLanguageServerView implements PluginValue {
   destroy() {
     this.destroyed = true;
     this.client.removeListener("diagnostics", this.diagnosticsListener);
+    this.device.on(EVENT_STATUS, this.onDeviceStatusChanged);
     // We don't own the client/connection which might outlive us, just our notifications.
   }
 }
@@ -84,6 +97,7 @@ interface Options {
  */
 export function languageServer(
   client: LanguageServerClient,
+  device: DeviceConnection,
   uri: string,
   intl: IntlShape,
   logging: Logging,
@@ -93,7 +107,7 @@ export function languageServer(
   return [
     uriFacet.of(uri),
     clientFacet.of(client),
-    ViewPlugin.define((view) => new LanguageServerView(view)),
+    ViewPlugin.define((view) => new LanguageServerView(view, device)),
     signatureHelp(intl, options.signatureHelp.automatic, apiReferenceMap),
     autocompletion(intl, logging, apiReferenceMap),
   ];

src/language-server/pyright.ts

@@ -12,7 +12,7 @@ import { baseUrl } from "../base";
 import { createUri, LanguageServerClient } from "./client";
 
 // This is modified by bin/update-pyright.sh
-const workerScriptName = "pyright-main-fbd1b969112a733566b7.worker.js";
+const workerScriptName = "pyright-main-4d883fb033fc7fbb9f75.worker.js";
 
 // Very simple cache to avoid React re-creating pointlessly in development.
 let counter = 0;