[wip] Add Robot Framework language server #493

bollwyvl · 2021-01-24T19:34:49Z

References

fixes Support/test a Robot Framework language server #332 with robotframework-lsp, which is generally available on pypi and conda-forge
also adding
- jupyterlab_robotmode for robot syntax highlighting
- robotkernel as it has a number of nice bells and whistles for browser-based testing
  - xeus-robot is also very cool, as it works with the debugger, which we need to start considering
    - but I think we want a separate PR that adds all the xeus stuff in one go, as they are most likely to conflict with each other
      - e.g. xeus-python, xeus-sql, xeus-robot, etc.

Code changes

add robotframework-lsp in a number of places (not lint, though!)
- if we find ourselves wanting to use robot notebooks, we can figure out an nblint plugin or something
the robotframework 4.0 release is coming up... there might be some version adventures between releases, have pinned for the time being to avoid surprises.
validate that spec that robotframework-lsp ships 🎉 works
- we're better off upstreaming a PR than claiming support for one with tweaks
add editor robot tests
add notebook robot tests

User-facing changes

Users should see nicer integration with robot files and notebooks
- will demo on our Binder for looking at/running our tests, which is cute
  - browser screenshots can be made to work
    - might need to add apt.txt (or stuff it, and use a Dockerfile)... binder's getting a bit unwieldy

Backwards-incompatible changes

N/A

Chores

linted
tested
documented
changelog entry

bollwyvl · 2021-01-24T19:43:55Z

Ahh, rflsp isn't compatible with python 3.6. Knew this day would come.

bollwyvl · 2021-01-24T20:24:51Z

Woof... the vendored watchdog is going nuts on my setup... will push so we have something to look at in CI/binder, but something's definitely not right:

lsp: 2021-01-24 15:14:18 UTC pid: 159268 - MainThread - EXCEPTION - robocorp_ls_core.jsonrpc.endpoint
Failed to handle request 0

Traceback (most recent call last):
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/jsonrpc/endpoint.py", line 142, in consume
    self._handle_request(
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/jsonrpc/endpoint.py", line 278, in _handle_request
    handler_result = handler(params)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/jsonrpc/dispatchers.py", line 38, in handler
    return method(**(params or {}))
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/python_ls.py", line 261, in m_initialize
    self.workspace = self._create_workspace(rootUri, workspaceFolders or [])
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/server_api/server.py", line 83, in _create_workspace
    return RobotWorkspace(
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/impl/robot_workspace.py", line 18, in __init__
    Workspace.__init__(self, root_uri, workspace_folders=workspace_folders)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/workspace.py", line 265, in __init__
    self.add_folder(folder)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/impl/robot_workspace.py", line 24, in add_folder
    self.libspec_manager.add_workspace_folder(folder.uri)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/impl/libspec_manager.py", line 544, in add_workspace_folder
    folder_info.start_watch(self._observer, self._file_changes_notifier)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/impl/libspec_manager.py", line 260, in start_watch
    self._watch = observer.notify_on_any_change(
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/watchdog_wrapper.py", line 223, in notify_on_any_change
    self._observer.schedule(
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/observers/api.py", line 301, in schedule
    emitter.start()
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/utils/__init__.py", line 110, in start
    self.on_thread_start()
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/observers/inotify.py", line 121, in on_thread_start
    self._inotify = InotifyBuffer(path, self.watch.is_recursive)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/observers/inotify_buffer.py", line 35, in __init__
    self._inotify = Inotify(path, recursive)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/observers/inotify_c.py", line 201, in __init__
    self._add_dir_watch(path, recursive, event_mask)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/observers/inotify_c.py", line 398, in _add_dir_watch
    self._add_watch(full_path, mask)
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/observers/inotify_c.py", line 412, in _add_watch
    Inotify._raise_error()
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/libs/watchdog_lib/watchdog/observers/inotify_c.py", line 424, in _raise_error
    raise OSError(errno.ENOSPC, "inotify watch limit reached")
OSError: [Errno 28] inotify watch limit reached
lsp: 2021-01-24 15:14:18 UTC pid: 159268 - MainThread - EXCEPTION - robocorp_ls_core.python_ls
Error updating document: {'uri': 'file://~/jupyterlab-lsp/atest/examples/example.robot', 'version': 0} with changes: [{'text': '*** Settings ***\nLibrary           SeleniumLibrary\nLibrary           Builtin\n\n*** Variables ***\n${ABC}            abc\n\n*** Keywords ***\nSpecial Log\n    [Arguments]    ${log}\n    [Documentation]    a special log\n    Log    ${log.upper()}!\n\n*** Test Cases ***\nLog Something\n    Special Log    ${ABC}\n\n'}]

Traceback (most recent call last):
  File "~/envs/default/lib/python3.8/site-packages/robotframework_ls/vendored/robocorp_ls_core/python_ls.py", line 318, in m_text_document__did_change
    self.workspace.update_document(
AttributeError: 'NoneType' object has no attribute 'update_document'
lsp: 2021-01-24 15:14:18 UTC pid: 159268 - MainThread - EXCEPTION - robocorp_ls_core.python_ls
Error updating document: {'uri': 'file://~/jupyterlab-lsp/atest/examples/example.robot', 'version': 1} with changes: [{'text': '*** Settings ***\nLibrary           SeleniumLibrary\nLibrary           Builtin\n\n*** Variables ***\n${ABC}            abc\n\n*** Keywords ***\nSpecial Log\n    [Arguments]    ${log}\n    [Documentation]    a special log\n    Log    ${log.upper()}!\n\n*** Test Cases ***\nLog Something\n    Special Log    ${ABC}\n\n'}]

bollwyvl · 2021-02-20T13:31:19Z

Looks like some changes were made upstream on rflsp, so maybe this will work now?

Of note, it doesn't support a ton of features that intersect with ours... but it's something.

bollwyvl · 2021-02-20T15:11:25Z

Nope :(

bollwyvl · 2021-03-03T22:41:27Z

Worth another shot in a couple hours...
conda-forge/robotframework-lsp-feedstock#14

bollwyvl · 2021-04-21T12:51:20Z

Working on warming this back up, and getting the new, more-maintained (than rflint) robocop up, which will be nice to have for our code anyway.

bollwyvl · 2021-04-22T13:12:52Z

Gah, i've made a proper mess of things, here. I think given the increasing complexity of the py36/37 stuff, it's time to look at doing an up-front job (or committing) lockfiles with conda-lock.

Basically, the YML in requirements would look more like:

requirements/
  - _base.yml  # what's needed in _every_ env
  - build.yml
  - lint.yml
  - test.yml
  - test-3.6.yml
  - test-3.7.yml
  - test-3.8.yml
  - test-3.9.yml

And permute across these things to yield:

.github/
  - locks/
    - build-3.9-linux-64.conda.lock
    - lint-3.9-linux-64.conda.lock
    - test-3.6-linux-64.conda.lock
    # ...
    - test-3.9-windows-64.conda.lock

Then all of the jobs would just use their respective lockfile in environment-file.

The advantage to checking them in is we'd save the couple minutes up-front of doing the resolve, and have them around for local review. But the danger then becomes if we get lazy with our locks: we've actually found a number of regressions on upstream things by mostly sticking to the bleeding edge... maybe we'd just have one or two jobs that were canary-like.

krassowski · 2021-12-11T15:18:16Z

Should we just add the spec for robotframework-lsp and mark it editor support only or partial support to make it more discoverable? I know that pip install robotframework-lsp just works, but it's not in the docs.

bollwyvl · 2021-12-11T17:51:29Z

Oy! I should definitely warm this back up. rflsp really supports a lot of lsp features now, and should feel really nice.

If we're dropping py 3.6 in #718 , that will make this easier, so i may well re-start from a clean slate.

krassowski · 2022-03-06T20:02:44Z

Closing as superseded by #724. Thank you!

bollwyvl added 2 commits January 24, 2021 14:18

add some robot dependencies

65c916d

add some more pins for robotkernel/lsp

0c9b3a8

bollwyvl added 3 commits January 24, 2021 14:47

try parametrizing rflsp

df75128

put rflsp in more places

f45f8c0

linting

e5586d2

bollwyvl added 4 commits January 24, 2021 15:28

tweak workflow tokens

1579964

yet more work on rflsp

f7b0347

put rflsp version under integrity

a80a77f

clean up tokens more, more coverage

05106ec

bollwyvl mentioned this pull request Jan 25, 2021

Watchdog error on startup: "inotify watch limit reached", robocorp/robotframework-lsp#238

Closed

bollwyvl added 2 commits February 20, 2021 08:23

Merge remote-tracking branch 'upstream/master' into add-robot-server

cef0dcb

try bumping to newest rflsp

64ece29

bollwyvl mentioned this pull request Mar 20, 2021

CI updates: action updates, caching, some pins #558

Merged

4 tasks

bollwyvl mentioned this pull request Mar 31, 2021

Robotframework-lsp do not find keywords imported relatively #573

Open

update to latest robotframework-ls

540fbaa

bollwyvl mentioned this pull request Apr 21, 2021

Include license in distributions MarketSquare/robotframework-robocop#363

Merged

bollwyvl added 6 commits April 21, 2021 20:51

start robocop

a15fe55

fix up robot atest fixture

0acb925

pin testutils for now

7a958f5

add test fail ignore due to upstream spec claiming plain

3ed42dc

add robot to docs

962b695

update changelog, linting

12f83c4

bollwyvl force-pushed the add-robot-server branch from 68b90da to 12f83c4 Compare April 22, 2021 03:23

more linting

b749f96

bollwyvl added 5 commits April 22, 2021 00:41

switch to xeus-robot for now

e190330

fix rflsp version regex

ebad44c

add python version replacing in CI

7db359a

also hide xeus-robot from 3.6, because rflsp

453b24a

also no xeus-robot on 3.7

0475ec3

bollwyvl mentioned this pull request Apr 22, 2021

refresh binder, update jupyter_lsp spec with install instructions robocorp/robotframework-lsp#331

Merged

This was referenced Dec 12, 2021

Update Pythons in CI #723

Merged

Add Robot Framework language server (again) #724

Merged

krassowski closed this Mar 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[wip] Add Robot Framework language server #493

[wip] Add Robot Framework language server #493

bollwyvl commented Jan 24, 2021 •

edited

Loading

bollwyvl commented Jan 24, 2021

bollwyvl commented Jan 24, 2021

bollwyvl commented Feb 20, 2021

bollwyvl commented Feb 20, 2021

bollwyvl commented Mar 3, 2021

bollwyvl commented Apr 21, 2021

bollwyvl commented Apr 22, 2021

krassowski commented Dec 11, 2021

bollwyvl commented Dec 11, 2021

krassowski commented Mar 6, 2022

[wip] Add Robot Framework language server #493

[wip] Add Robot Framework language server #493

Conversation

bollwyvl commented Jan 24, 2021 • edited Loading

References

Code changes

User-facing changes

Backwards-incompatible changes

Chores

bollwyvl commented Jan 24, 2021

bollwyvl commented Jan 24, 2021

bollwyvl commented Feb 20, 2021

bollwyvl commented Feb 20, 2021

bollwyvl commented Mar 3, 2021

bollwyvl commented Apr 21, 2021

bollwyvl commented Apr 22, 2021

krassowski commented Dec 11, 2021

bollwyvl commented Dec 11, 2021

krassowski commented Mar 6, 2022

bollwyvl commented Jan 24, 2021 •

edited

Loading