feat(robotlangserver): new setting .analysis.cache.saveLocation where you can specify the location where robotcode saves cached data

Author: d-biehl

package.json

@@ -472,6 +472,20 @@
             "default": "default",
             "scope": "resource"
           },
+          "robotcode.analysis.cache.saveLocation": {
+            "type": "string",
+            "enum": [
+              "workspaceStorage",
+              "workspaceFolder"
+            ],
+            "enumDescriptions": [
+              "Save cached data into workspace folder.",
+              "Save cached data into workspace storage."
+            ],
+            "description": "Specifies where cached data is saved.",
+            "default": "workspaceStorage",
+            "scope": "resource"
+          },
           "robotcode.run.openOutputAfterRun": {
             "type": "string",
             "enum": [

robotcode/language_server/robotframework/configuration.py

@@ -20,10 +20,15 @@ class RpaMode(Enum):
     NORPA = "norpa"
 
 
+class CacheSaveLocation(Enum):
+    WORKSPACE_FOLDER = "workspaceFolder"
+    WORKSPACE_STORAGE = "workspaceStorage"
+
+
 @config_section("robotcode.robot")
 @dataclass
 class RobotConfig(ConfigBase):
-    args: Tuple[str, ...] = field(default_factory=tuple)
+    args: List[str] = field(default_factory=list)
     python_path: List[str] = field(default_factory=list)
     env: Dict[str, str] = field(default_factory=dict)
     variables: Dict[str, Any] = field(default_factory=dict)
@@ -73,6 +78,12 @@ class WorkspaceConfig(ConfigBase):
     exclude_patterns: List[str] = field(default_factory=list)
 
 
+@config_section("robotcode.analysis.cache")
+@dataclass
+class Cache(ConfigBase):
+    save_location: CacheSaveLocation = CacheSaveLocation.WORKSPACE_STORAGE
+
+
 @config_section("robotcode.analysis")
 @dataclass
 class AnalysisConfig(ConfigBase):
@@ -81,6 +92,7 @@ class AnalysisConfig(ConfigBase):
     max_project_file_count: int = 5000
     references_code_lens: bool = False
     find_unused_references: bool = False
+    cache: Cache = field(default_factory=Cache)
 
 
 @config_section("robotcode.documentationServer")

robotcode/language_server/robotframework/diagnostics/imports_manager.py

@@ -38,7 +38,7 @@
 from ...common.lsp_types import DocumentUri, FileChangeType, FileEvent
 from ...common.parts.workspace import FileWatcherEntry, Workspace
 from ...common.text_document import TextDocument
-from ..configuration import RobotConfig
+from ..configuration import CacheSaveLocation, RobotCodeConfig
 from ..utils.ast_utils import HasError, HasErrors, Token
 from ..utils.async_ast import walk
 from ..utils.robot_path import find_file_ex
@@ -486,17 +486,21 @@ def filepath_base(self) -> Path:
 class ImportsManager:
     _logger = LoggingDescriptor()
 
-    def __init__(self, parent_protocol: RobotLanguageServerProtocol, folder: Uri, config: RobotConfig) -> None:
+    def __init__(self, parent_protocol: RobotLanguageServerProtocol, folder: Uri, config: RobotCodeConfig) -> None:
         super().__init__()
         self.parent_protocol = parent_protocol
 
         self.folder = folder
         get_robot_version()
 
         cache_base_path = self.folder.to_path()
-        if isinstance(self.parent_protocol.initialization_options, dict):
-            if "storageUri" in self.parent_protocol.initialization_options:
-                cache_base_path = Uri(self.parent_protocol.initialization_options["storageUri"]).to_path()
+        if (
+            config.analysis.cache.save_location == CacheSaveLocation.WORKSPACE_STORAGE
+            and isinstance(self.parent_protocol.initialization_options, dict)
+            and "storageUri" in self.parent_protocol.initialization_options
+        ):
+            cache_base_path = Uri(self.parent_protocol.initialization_options["storageUri"]).to_path()
+
         self._logger.trace(lambda: f"use {cache_base_path} as base for caching")
 
         self.lib_doc_cache_path = (
@@ -506,8 +510,7 @@ def __init__(self, parent_protocol: RobotLanguageServerProtocol, folder: Uri, co
             / get_robot_version_str()
             / "libdoc"
         )
-
-        self.config: RobotConfig = config
+        self.config = config
         self._libaries_lock = Lock()
         self._libaries: OrderedDict[_LibrariesEntryKey, _LibrariesEntry] = OrderedDict()
         self._resources_lock = Lock()
@@ -521,7 +524,7 @@ def __init__(self, parent_protocol: RobotLanguageServerProtocol, folder: Uri, co
         self._command_line_variables_lock = Lock()
 
         self._environment = dict(os.environ)
-        self._environment.update(self.config.env)
+        self._environment.update(self.config.robot.env)
 
         self._library_files_cache = AsyncSimpleLRUCache()
         self._resource_files_cache = AsyncSimpleLRUCache()
@@ -540,14 +543,14 @@ async def get_command_line_variables(self) -> List[VariableDefinition]:
             if self._command_line_variables is None:
                 command_line_vars: List[VariableDefinition] = []
 
-                if self.config is None:
+                if self.config.robot is None:
                     self._command_line_variables = []
                 else:
                     command_line_vars = [
                         CommandLineVariableDefinition(0, 0, 0, 0, "", f"${{{k}}}", None, has_value=True, value=(v,))
-                        for k, v in self.config.variables.items()
+                        for k, v in self.config.robot.variables.items()
                     ]
-                    for variable_file in self.config.variable_files:
+                    for variable_file in self.config.robot.variable_files:
                         name, args = split_args_from_name_or_path(variable_file)
                         try:
                             lib_doc = await self.get_libdoc_for_variables_import(
@@ -806,7 +809,7 @@ async def _find_library(self, name: str, base_dir: str, variables: Optional[Dict
                 name,
                 str(self.folder.to_path()),
                 base_dir,
-                self.config.variables if self.config is not None else None,
+                self.config.robot.variables if self.config.robot is not None else None,
                 variables,
             )
 
@@ -836,7 +839,7 @@ async def __find_resource(
                 name,
                 str(self.folder.to_path()),
                 base_dir,
-                self.config.variables if self.config is not None else None,
+                self.config.robot.variables if self.config.robot is not None else None,
                 variables,
                 file_type,
             )
@@ -855,7 +858,7 @@ async def __find_variables(self, name: str, base_dir: str, variables: Optional[D
                 name,
                 str(self.folder.to_path()),
                 base_dir,
-                self.config.variables if self.config is not None else None,
+                self.config.robot.variables if self.config.robot is not None else None,
                 variables,
             )
 
@@ -918,7 +921,7 @@ async def _get_libdoc() -> LibraryDoc:
                         args,
                         str(self.folder.to_path()),
                         base_dir,
-                        self.config.variables if self.config is not None else None,
+                        self.config.robot.variables if self.config.robot is not None else None,
                         variables,
                     ),
                     LOAD_LIBRARY_TIME_OUT,
@@ -1111,7 +1114,7 @@ async def _get_libdoc() -> VariablesDoc:
                         args,
                         str(self.folder.to_path()),
                         base_dir,
-                        self.config.variables if self.config is not None else None,
+                        self.config.robot.variables if self.config.robot is not None else None,
                         variables,
                     ),
                     LOAD_LIBRARY_TIME_OUT,
@@ -1207,7 +1210,7 @@ async def complete_library_import(
             name,
             str(self.folder.to_path()),
             base_dir,
-            self.config.variables if self.config is not None else None,
+            self.config.robot.variables if self.config.robot is not None else None,
             variables,
         )
 
@@ -1218,7 +1221,7 @@ async def complete_resource_import(
             name,
             str(self.folder.to_path()),
             base_dir,
-            self.config.variables if self.config is not None else None,
+            self.config.robot.variables if self.config.robot is not None else None,
             variables,
         )
 
@@ -1230,7 +1233,7 @@ async def complete_variables_import(
             name,
             str(self.folder.to_path()),
             base_dir,
-            self.config.variables if self.config is not None else None,
+            self.config.robot.variables if self.config.robot is not None else None,
             variables,
         )
 
@@ -1239,6 +1242,6 @@ def resolve_variable(self, name: str, base_dir: str = ".", variables: Optional[D
             name,
             str(self.folder.to_path()),
             base_dir,
-            self.config.variables if self.config is not None else None,
+            self.config.robot.variables if self.config.robot is not None else None,
             variables,
         )

robotcode/language_server/robotframework/parts/documents_cache.py

@@ -23,7 +23,7 @@
 from ...common.decorators import language_id_filter
 from ...common.parts.workspace import WorkspaceFolder
 from ...common.text_document import TextDocument
-from ..configuration import RobotConfig
+from ..configuration import RobotCodeConfig, RobotConfig
 from ..diagnostics.imports_manager import ImportsManager
 from ..diagnostics.namespace import DocumentType, Namespace
 from ..utils.ast_utils import Token
@@ -429,7 +429,7 @@ async def default_imports_manager(self) -> ImportsManager:
                 self._default_imports_manager = ImportsManager(
                     self.parent,
                     Uri(self.parent.workspace.root_uri or "."),
-                    RobotConfig(args=(), python_path=[], env={}, variables={}),
+                    RobotCodeConfig(),
                 )
 
             return self._default_imports_manager
@@ -444,7 +444,7 @@ async def get_imports_manager(self, document: TextDocument) -> ImportsManager:
 
         async with self._imports_managers_lock:
             if folder not in self._imports_managers:
-                config = await self.parent.workspace.get_configuration(RobotConfig, folder.uri)
+                config = await self.parent.workspace.get_configuration(RobotCodeConfig, folder.uri)
 
                 self._imports_managers[folder] = ImportsManager(self.parent, folder.uri, config)