Merge remote branch 'origin/master' into edge

Author: automatic-merge

.gitlab-ci.yml

@@ -114,8 +114,6 @@ als-cov:
 
     - target_subdir=$target_subdir/ada-coverage
     - publish-pages $CI_PROJECT_DIR/coverage/dhtml/ --target-subdir $target_subdir --expires 30
-    - >
-      echo "Coverage report: https://pages.gitlab.adacore-it.com/$CI_PROJECT_PATH/$target_subdir/index.html"
   coverage: '/^Stmt Coverage:\s+(\d+\.\d+\%) \(\d+ \/ \d+\)$/'
   artifacts:
     when: always #  Upload on errors too
@@ -152,8 +150,6 @@ vscode-extension:
       fi
     - target_subdir=$target_subdir/ts-coverage
     - publish-pages $CI_PROJECT_DIR/coverage/ --target-subdir $target_subdir --expires 30
-    - >
-      echo "Coverage report: https://pages.gitlab.adacore-it.com/$CI_PROJECT_PATH/$target_subdir/index.html"
 
     # Compute coverage percentage
     - line_rate=$(cat $CI_PROJECT_DIR/coverage/cobertura-coverage.xml | grep -o 'line-rate="\([^"]\+\)"' | head -1 | grep -o '[0-9.]\+')

.mypy.ini

@@ -0,0 +1,2 @@
+[mypy]
+mypy_path = $MYPY_CONFIG_FILE_DIR/testsuite

.pre-commit-config.yaml

@@ -22,6 +22,24 @@ repos:
     hooks:
       - id: mypy
         files: '\.py$'
-        # exclude: "^tests/.+$"
+        args:
+          # These flags make mypy associate different module names to `test.py`
+          # files from different test directories.
+          - --explicit-package-bases
+          - --namespace-packages
         additional_dependencies:
           - pytest-lsp
+          - e3-testsuite
+          - psutil
+          - types-psutil
+
+  - repo: local
+    hooks:
+      # This hook checks that Python test directories are valid module names so
+      # that mypy will accept to analyse multiple test.py in different
+      # directories.
+      - id: py-filenames
+        name: Python test.py paths
+        entry: Python path components should be valid modules names (e.g. no '.' or whitespace). This is for mypy to accept dealing with test.py files in different directories.
+        language: fail
+        files: 'testsuite.*[^A-Za-z0-9_\/].*test\.py$'

.vscode/settings.json.tmpl

@@ -16,7 +16,8 @@
       "editor.autoIndent": "none",
       "editor.formatOnType": true,
       "editor.tabSize": 3,
-      "editor.detectIndentation": false
+      "editor.detectIndentation": false,
+      "showNotificationsOnErrors": true
    },
    "python.analysis.extraPaths": ["testsuite"],
    "python.analysis.packageIndexDepths": [

CHANGELOG.md

@@ -4,6 +4,8 @@
 section below it for the last release. -->
 ## \<next>
 
+* Add a setting `ada.showNotificationsOnErrors` to control whether VS Code should display error notifications for failing LSP requests.
+
 ## 26.0.202411173
 
 * Create commands for opening the project file and the log file

doc/settings.md

@@ -75,7 +75,12 @@ prefixing each setting name with `ada.`, e.g.
 
 ## Settings
 
-Ada Language Server understands these settings:
+Settings taken into account only from the Ada & SPARK VS Code extension:
+
+* [showNotificationsOnErrors](#shownotificationsonerrors)
+* [trace.server](#traceserver)
+
+Settings understood by the Ada Language Server itself, independently from the LSP client:
 
 * [projectFile](#projectfile)
 * [scenarioVariables](#scenariovariables)
@@ -97,6 +102,29 @@ Ada Language Server understands these settings:
 
 ----
 
+### showNotificationsOnErrors
+
+Controls whether VS Code should display error notifications for failing LSP requests.
+
+This is disabled by default to avoid distractions while coding, and can be enabled if the User wishes to troubleshoot an unexpected behavior in the Ada & SPARK language support in VS Code.
+Note that regardless of this setting, errors are always logged to the VS Code output channels `Ada Language Server` and `GPR Language Server`. This setting only controls whether a corresponding visual notification is emitted in the UI.
+
+### trace.server
+
+This option controls the tracing of the communication between VS Code and the Ada
+language server. It causes the client to trace each message sent and received
+to/from the Ada language server in the `Ada Language Server` Output view.
+
+The possible values are:
+
+* `off`: no tracing.
+* `messages`: brief traces are emitted for each request sent and each response received.
+* `verbose`: verbose traces are emitted for each request sent and each response received, including the message content.
+
+On the server side this option does not trigger any additional logging.
+
+An equivalent setting `gpr.trace.server` exists for tracing the communcation between VS Code and the GPR language server.
+
 ### projectFile
 
 You can configure the GNAT Project File via the `projectFile` key.
@@ -291,22 +319,6 @@ For more information about documentation styles see GNATdoc User's Manual.
     'documentationStyle': 'gnat'
 ```
 
-### trace.server
-
-This option controls the tracing of the communication between VS Code and the Ada
-language server. It causes the client to trace each message sent and received
-to/from the Ada language server in the `Ada Language Server` Output view.
-
-The possible values are:
-
-* `off`: no tracing.
-* `messages`: brief traces are emitted for each request sent and each response received.
-* `verbose`: verbose traces are emitted for each request sent and each response received, including the message content.
-
-On the server side this option does not trigger any additional logging.
-
-An equivalent setting `gpr.trace.server` exists for tracing the communcation between VS Code and the GPR language server.
-
 ### onTypeFormatting.indentOnly
 
 This option controls if the `textDocument/onTypeFormatting` request only indents a new line, or if
@@ -318,3 +330,4 @@ it additionally tries to format the previous node. By default, this option is en
 This option controls the formatting provider for the `textDocument/formatting`,
 `textDocument/rangeFormatting` and `textDocument/onTypeFormatting` request. By default, this option
 is enabled and ALS uses GNATformat as its formatting provider. If disabled, GNATpp is used instead.
+

integration/vscode/ada/package.json

@@ -348,6 +348,11 @@
                 "title": "UI",
                 "order": 2,
                 "properties": {
+                    "ada.showNotificationsOnErrors": {
+                        "markdownDescription": "Whether to show error notifications for failing LSP requests.",
+                        "default": false,
+                        "type": "boolean"
+                    },
                     "ada.documentationStyle": {
                         "scope": "window",
                         "type": "string",

integration/vscode/ada/src/clients.ts

@@ -1,9 +1,35 @@
 import { existsSync } from 'fs';
 import * as vscode from 'vscode';
-import { LanguageClient, LanguageClientOptions, ServerOptions } from 'vscode-languageclient/node';
+import {
+    LanguageClient,
+    LanguageClientOptions,
+    MessageSignature,
+    ServerOptions,
+} from 'vscode-languageclient/node';
 import { logger } from './extension';
 import { logErrorAndThrow, setTerminalEnvironment } from './helpers';
 
+class AdaLanguageClient extends LanguageClient {
+    /**
+     * Override this function to avoid displaying popup notifications on LSP errors when
+     * the 'showNotificationsOnErrors' setting is disabled.
+     */
+    override handleFailedRequest<T>(
+        type: MessageSignature,
+        token: vscode.CancellationToken | undefined,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        error: any,
+        defaultValue: T,
+        showNotification?: boolean | undefined,
+    ): T {
+        const showError = vscode.workspace.getConfiguration('ada').get('showNotificationsOnErrors');
+        if (!showError) {
+            showNotification = false;
+        }
+
+        return super.handleFailedRequest(type, token, error, defaultValue, showNotification);
+    }
+}
 export function createClient(
     context: vscode.ExtensionContext,
     id: string,
@@ -93,5 +119,5 @@ export function createClient(
         initializationOptions: () => ({ ada: vscode.workspace.getConfiguration('ada') }),
     };
     // Create the language client
-    return new LanguageClient(id, name, serverOptions, clientOptions);
+    return new AdaLanguageClient(id, name, serverOptions, clientOptions);
 }

source/ada/lsp-ada_configurations.adb

@@ -361,6 +361,11 @@ package body LSP.Ada_Configurations is
            and then JSON (Index).Kind = Boolean_Value
          then
             Self.Use_Gnatformat := JSON (Index).Boolean_Value;
+
+         elsif Name = "showNotificationsOnErrors"
+         then
+            --  This is a VS Code only setting, treated at the VS Code extension's level
+            null;
          end if;
 
          Skip_Value (JSON, Index);

source/ada/lsp-ada_driver.adb

@@ -96,7 +96,10 @@ with LSP.Server_Notifications.DidChange;
 with LSP.Server_Notifications.DidChangeConfiguration;
 with LSP.Server_Notifications.DidChangeWorkspaceFolders;
 with LSP.Server_Notifications.DidClose;
+with LSP.Server_Notifications.DidCreateFiles;
+with LSP.Server_Notifications.DidDeleteFiles;
 with LSP.Server_Notifications.DidOpen;
+with LSP.Server_Notifications.DidRenameFiles;
 with LSP.Server_Notifications.Exits;
 with LSP.Server_Requests.Declaration;
 with LSP.Server_Requests.Definition;
@@ -626,6 +629,18 @@ begin
            (LSP.Server_Notifications.DidClose.Notification'Tag,
             Ada_Fence_Message_Handler'Unchecked_Access);
 
+         Server.Register_Handler
+           (LSP.Server_Notifications.DidCreateFiles.Notification'Tag,
+            Ada_Fence_Message_Handler'Unchecked_Access);
+
+         Server.Register_Handler
+           (LSP.Server_Notifications.DidRenameFiles.Notification'Tag,
+            Ada_Fence_Message_Handler'Unchecked_Access);
+
+         Server.Register_Handler
+           (LSP.Server_Notifications.DidDeleteFiles.Notification'Tag,
+            Ada_Fence_Message_Handler'Unchecked_Access);
+
          Server.Register_Handler
            (LSP.Server_Notifications.DidChangeWorkspaceFolders.Notification'Tag,
             Ada_Fence_Message_Handler'Unchecked_Access);