Feature/websocket Поддержка работы через websocket #2567

salexdv · 2022-02-24T14:13:37Z

Описание

Поддержка общения в BSL Language Server через websocket

Связанные задачи

#1427

Чеклист

Общие

Ветка PR обновлена из develop
Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
Изменения покрыты тестами
Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Дополнительно

Хотелось бы иметь возможность общаться BSL Language Server через websocket. Например, это нужно для редактора на основе monaco editor, работающего внутри 1С через webkit

Сложности, недоработки, вопросы

С разработкой на Java был мало знаком, до того как решил добавить указанную функциональность, отсюда есть несколько сложностей, которые мешают полноценной работе сервера через вебсокет.

Сервер всегда использует конфигурацию по умолчанию. Я так понимаю, что взаимодействие с конфигурацией завязано на аннотацию @RequiredArgsConstructor и поле класса private final LanguageServerConfiguration. При обработке команды в классе WebsocketStartCommand никаких проблем с чтением и обновлением конфигурации из указанного файла не возникает. Однако, не ясно, как конфигурацию можно передать в BSLLSWebSocketEndpoint для дальнейшей передачи в BSLLanguageServer. Можете подсказать, как решить эту проблему?
Как правильно тестировать работу через вебсокеты, какие тесты желательно реализовать?

nixel2007 · 2022-02-24T16:21:13Z

ну нихрена себе!

спасибо, заценим.

src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/WebsocketStartCommand.java

otymko · 2022-02-27T06:43:27Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/WebsocketStartCommand.java

+ footer = "@|green Copyright(c) 2018-2020|@")
+@Component
+@RequiredArgsConstructor
+public class WebsocketStartCommand implements Callable<Integer> {


@salexdv в рамках реализации LanguageServerStartCommand общение через веб-сокет не реализовать? Это ведь только транспорт, верно?

Наверно, это можно назвать транспортом. Делал по аналогии с LanguageServerStartCommand

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketRunner.java

otymko · 2022-02-27T06:53:30Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/WebsocketStartCommand.java

+ private final LanguageServerConfiguration configuration;
+ private final WebSocketRunner launcher;
+
+ public Integer call() {


@salexdv нужны тесты

Тесты добавил. Проверяется запуск сервера и возможность подключения к нему. Таких проверок будет достаточно?

otymko · 2022-02-27T07:02:51Z

Описание

Поддержка общения в BSL Language Server через websocket

Связанные задачи

#1427

Чеклист

Общие

Ветка PR обновлена из develop

Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены

Изменения покрыты тестами

Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Дополнительно

Хотелось бы иметь возможность общаться BSL Language Server через websocket. Например, это нужно для редактора на основе monaco editor, работающего внутри 1С через webkit

Сложности, недоработки, вопросы

С разработкой на Java был мало знаком, до того как решил добавить указанную функциональность, отсюда есть несколько сложностей, которые мешают полноценной работе сервера через вебсокет.

Сервер всегда использует конфигурацию по умолчанию. Я так понимаю, что взаимодействие с конфигурацией завязано на аннотацию @RequiredArgsConstructor и поле класса private final LanguageServerConfiguration. При обработке команды в классе WebsocketStartCommand никаких проблем с чтением и обновлением конфигурации из указанного файла не возникает. Однако, не ясно, как конфигурацию можно передать в BSLLSWebSocketEndpoint для дальнейшей передачи в BSLLanguageServer. Можете подсказать, как решить эту проблему?

Как правильно тестировать работу через вебсокеты, какие тесты желательно реализовать?

попробую на днях найти примеры тестирования lsp и вебсокета, вроде такие тесты были в lsp4j.

salexdv · 2022-03-01T13:15:11Z

Прилагаю "клиенты" для тестирования test_client.zip

С простым текстом модуля index_successful.html всё хорошо, а вот index_fail.html падает вот здесь и причины падения пока непонятны.

nixel2007 · 2022-03-02T08:43:57Z

@salexdv а есть стак-трейс и trace.log?

salexdv · 2022-03-02T08:56:43Z

@salexdv а есть стак-трейс и trace.log?

Да. trace.log

nixel2007 · 2022-03-12T03:52:34Z

@qtLex тут трейс лог по переменным в индексе. глянешь?

qtLex · 2022-03-12T06:22:08Z

@nixel2007 Гляну.

qtLex · 2022-03-12T09:32:08Z

@qtLex тут трейс лог по переменным в индексе. глянешь?

Вот, что удалось накопать #2577.

nixel2007 · 2022-03-12T10:12:41Z

Влил, спасибо!

nixel2007 · 2022-07-18T13:45:13Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/BSLLSWebSocketEndpoint.java

+
+ @Override
+ protected void configure(Builder<LanguageClient> builder) {
+ builder.setLocalService(BSLLSBinding.getApplicationContext().getBean(BSLLanguageServer.class));


Использование BSLLSBinding чем-то обосновано? Обычное внедрение зависимостей не работало?

Через обычное внедрение зависимостей у меня не получилось сделать. Скорее всего, я что-то делал не так, но клиент у меня возвращал вот такое

Хм. Можем попробовать еще раз? на класс повесить аннотацию @RequiredArgsConstructor, и объявить поле private final BSLLanguageServer languageServer

Пробовал так сделать. Сервер стартует, но клиент не соединяется с ним. Вернее соединение устанавливается, клиент вызывает метод initialize и отваливается. Затем заново попытка создать соединение и так по кругу.

nixel2007 · 2022-07-18T13:46:13Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/BSLLSWebSocketEndpoint.java

+
+ @Override
+ protected void connect(Collection<Object> localServices, LanguageClient remoteProxy) {
+ LanguageClientHolder clientHolder = BSLLSBinding.getApplicationContext().getBean(LanguageClientHolder.class);


Более правильно это делать через внедрение List

Не очень понимаю, о чём речь. Можешь подробнее написать или подсказать, куда посмотреть, что почитать?

добавить поле private final List<LanguageClientAware> languageClientAwares;

и обойти их в цикле, вызвав у каждого connect. Как пример - LanguageServerStartCommand

Попробовал так:

@RequiredArgsConstructor public class BSLLSWebSocketEndpoint extends WebSocketEndpoint<LanguageClient> { private final List<LanguageClientAware> languageClientAwares; @Override protected void connect(Collection<Object> localServices, LanguageClient remoteProxy) { languageClientAwares.forEach(languageClientAware -> languageClientAware.connect(remoteProxy)); } }

Поведение у клиента становится таким же, как выше описывал для @RequiredArgsConstructor и private final BSLLanguageServer languageServer

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketRunner.java

nixel2007 · 2022-07-18T13:48:01Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketRunner.java

+
+ String contextPath = "/";
+ var server = new Server(hostname, port, contextPath, null, BSLLSWebSocketServerConfigProvider.class);
+ Runtime.getRuntime().addShutdownHook(new Thread(server::stop, "bsl-websocket-server-shutdown-hook"));


может быть здесь подойдет использование родного спрингового @PreDestroy вместо shudown hook целиком JVM?

addShutdownHook убрал

nixel2007 · 2022-07-18T13:49:39Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketRunner.java

+ } catch (Exception e) {
+ LOGGER.error("Cannot start websocket server.", e);
+ } finally {
+ server.stop();


не совсем понимаю, зачем stop и тут и в preshutdown hook

Этот блок тоже убрал

nixel2007 · 2022-07-18T13:50:28Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketRunner.java

+
+ try {
+ server.start();
+ Thread.currentThread().join();


поясни, плз, зачем здесь join?

Скорее всего напишу полную фигню т.к. опыта разработки на java мне явно не хватает. Тут приостанавливаем выполнение текущего потока, чтобы иметь возможность обработать InterruptedException и там остановить websocket-сервер. Долго сидел с этим, но другого способа нормально работать, в том числе тесты, не нашел. Если не обработать прерывание потока, тогда ws-сервер при окончании текста продолжает висеть на порту и следующий тест выдает Address already in use: bind

src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/WebsocketStartCommand.java

nixel2007 · 2022-07-18T13:56:02Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketRunner.java

+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class WebSocketRunner {


Предлагаю немного привести API в соответствие с LSP. Переименовать класс в WebSocketLauncher, а основной метод в startListening.

Может быть вообще сделать его implements Launcher

Тогда и внедрять его можно будет по какому-нибудь условию прямо в команду запуска в режиме LSP. Покурю этот момент

Переименовал класс в WebSocketLauncher, а основной метод в startListening

build.gradle.kts

nixel2007 · 2022-07-20T20:37:03Z

Нужно врубать отладочные логи и глядеть... Тестовый клиент ты скидывал, да? Op wo 20 jul. 2022 18:49 schreef Alexander Shkuraev < ***@***.***>:

…

***@***.**** commented on this pull request. ------------------------------ In src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/BSLLSWebSocketEndpoint.java <#2567 (comment)> : > +import com.github._1c_syntax.bsl.languageserver.BSLLSBinding; +import com.github._1c_syntax.bsl.languageserver.BSLLanguageServer; +import com.github._1c_syntax.bsl.languageserver.LanguageClientHolder; +import org.eclipse.lsp4j.jsonrpc.Launcher.Builder; +import org.eclipse.lsp4j.services.LanguageClient; +import org.eclipse.lsp4j.websocket.WebSocketEndpoint; +import org.springframework.stereotype.Component; + +import java.util.Collection; + ***@***.*** +public class BSLLSWebSocketEndpoint extends WebSocketEndpoint<LanguageClient> { + + @OverRide + protected void configure(Builder<LanguageClient> builder) { + builder.setLocalService(BSLLSBinding.getApplicationContext().getBean(BSLLanguageServer.class)); Пробовал так сделать. Сервер стартует, но клиент не соединяется с ним. Вернее соединение устанавливается, клиент вызывает метод initialize и отваливается. Затем заново попытка создать соединение и так по кругу. [image: chrome_4SK2fxQiUx] <https://user-images.githubusercontent.com/6356534/180026172-a2894b60-cb42-4f1e-9c00-036ad86c14f8.gif> [image: BSL_Unsupported_0] <https://user-images.githubusercontent.com/6356534/180026468-1f8d6dc9-9234-4768-b84a-aaf9809f7efe.png> — Reply to this email directly, view it on GitHub <#2567 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIUSKEG44GCLD7TQDJJ3SDVVANXFANCNFSM5PHP5A3A> . You are receiving this because you were mentioned.Message ID: ***@***.***>

salexdv · 2022-07-21T04:52:34Z

Нужно врубать отладочные логи и глядеть... Тестовый клиент ты скидывал, да?

Да, выше тут выкладывал

salexdv · 2022-07-21T05:00:11Z

Была у меня такая проблема:

Сервер всегда использует конфигурацию по умолчанию. Я так понимаю, что взаимодействие с конфигурацией завязано на аннотацию @RequiredArgsConstructor и поле класса private final LanguageServerConfiguration. При обработке команды в классе WebsocketStartCommand никаких проблем с чтением и обновлением конфигурации из указанного файла не возникает. Однако, не ясно, как конфигурацию можно передать в BSLLSWebSocketEndpoint для дальнейшей передачи в BSLLanguageServer. Можете подсказать, как решить эту проблему?

Проблему решил, но не уверен, что сделал это правильно. Решение такое:

// Класс WebsocketCommand
LanguageServerConfiguration configuration = BSLLSBinding.getLanguageServerConfiguration();
configuration.update(configurationFile);

Изначально была аннотация @RequiredArgsConstructor и поле private final LanguageServerConfiguration configuration;, но в классе BSLLanguageServer всё равно оказывалась конфигурация по умолчанию, не смотря на передачу имени файла конфигурации при запуске.

nixel2007 · 2022-07-21T06:38:35Z

Однако, не ясно, как конфигурацию можно передать в BSLLSWebSocketEndpoint

Точно так же, через private final поле. Это класс-синглтон, все классы, которые запрашивают себе конфигурацию, получат один и тот же её инстанс. Соответственно если ты в команде сделаешь configuration.update, то она обновится во всех классах сразу.

Вообще единственное назначение BSLLSBinding - инициализация bsl ls вне спринг контекста, как например в сонар-плагине. Здесь же запуск из cli, поэтому все должно работать штатно, через внедрение зависимостей

salexdv · 2022-07-21T06:44:29Z

Точно так же, через private final поле. Это класс-синглтон, все классы, которые запрашивают себе конфигурацию, получат один и тот же её инстанс. Соответственно если ты в команде сделаешь configuration.update, то она обновится во всех классах сразу.

Это понятно. Изначально по этому пути и пошёл, но не работает.

nixel2007 · 2022-10-26T14:05:12Z

@salexdv тэкс, я таки осилил перевод веб-сокетов на ядро спринга. просьба протестировать.

@asosnoviy @otymko присоединяйтесь к веселью.

P.S. Из того что обнаружил - в "тест-клиенте" довольно старая версия монако/лэнгклиента и нет свежих фич. плюс клиент не шлет workspace в initialize, из-за этого не подхватываются сорцы из конфиг файла. но это вроде бы все решаемо.

otymko · 2022-10-26T14:09:27Z

src/main/resources/application.properties

@@ -1,4 +1,4 @@
-spring.main.web-application-type=none
+server.port=8025


Это бы сразу указать в доке.

В джавадоке указано, в маркдаун еще перенести надо

src/main/java/com/github/_1c_syntax/bsl/languageserver/BSLTextDocumentService.java

src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/WebsocketCommand.java

otymko · 2022-10-26T14:14:57Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/BSLLSWebSocketEndpoint.java

+
+@Component
+@RequiredArgsConstructor
+public class BSLLSWebSocketEndpoint extends WebSocketEndpoint<LanguageClient> {


Жабадок спасет мир=)

otymko · 2022-10-26T14:15:29Z

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketConfiguration.java

+
+@Configuration
+@EnableWebSocket
+public class WebSocketConfiguration {


Жабадок спасет мир

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketConfiguration.java

salexdv · 2022-10-26T16:12:32Z

P.S. Из того что обнаружил - в "тест-клиенте" довольно старая версия монако/лэнгклиента и нет свежих фич. плюс клиент не шлет workspace в initialize, из-за этого не подхватываются сорцы из конфиг файла. но это вроде бы все решаемо.

Используется версия monaco 0.20.0. Более новые версии отказываются запускаться внутри 1С. Для использования в вебе вполне можно использовать последнюю.

nixel2007 · 2022-10-28T15:35:55Z

@salexdv поменял эндпоинт с /bsl-language-server на /lsp. Порт по умолчанию 8025. И порт и путь можно переопределить из командой строки.

sonarcloud · 2022-10-28T18:23:45Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

salexdv changed the title ~~Feature/websocket~~ Feature/websocket Поддержка работы через websocket Feb 24, 2022

nixel2007 requested review from nixel2007, theshadowco, otymko and asosnoviy and removed request for nixel2007 February 24, 2022 16:21

otymko reviewed Feb 27, 2022

View reviewed changes

salexdv added a commit to salexdv/bsl-language-server that referenced this pull request Mar 1, 2022

Update PR 1c-syntax#2567

856de55

salexdv closed this Mar 2, 2022

salexdv reopened this Mar 2, 2022

qtLex mentioned this pull request Mar 12, 2022

Исправлено падение при работе с индексом ссылок переменных в файле с ошибками разбора #2577

Merged

4 tasks

nixel2007 reviewed Jul 18, 2022

View reviewed changes

src/main/java/com/github/_1c_syntax/bsl/languageserver/websocket/WebSocketRunner.java Outdated Show resolved Hide resolved

nixel2007 reviewed Jul 18, 2022

View reviewed changes

src/main/java/com/github/_1c_syntax/bsl/languageserver/cli/WebsocketStartCommand.java Outdated Show resolved Hide resolved

nixel2007 reviewed Jul 18, 2022

View reviewed changes

build.gradle.kts Outdated Show resolved Hide resolved

nixel2007 force-pushed the feature/websocket branch from ec83c60 to fa06596 Compare October 26, 2022 14:01

nixel2007 pushed a commit to salexdv/bsl-language-server that referenced this pull request Oct 26, 2022

Update PR 1c-syntax#2567

0767c55

nixel2007 pushed a commit to salexdv/bsl-language-server that referenced this pull request Oct 26, 2022

Рефакторинг по замечаниям PR 1c-syntax#2567

92ed879

salexdv added 7 commits October 26, 2022 18:06

build gradle api lsp4j.websocket

454e62d

Классы для web socket runner

8e7a473

Команда для запуска в режиме websocket

53171fb

Добавление команды в BSLLSPLauncher

e4a31ec

Update PR 1c-syntax#2567

93b06c1

Тесты для режима работы через websocket

54a4995

Рефакторинг по замечаниям PR 1c-syntax#2567

b7036d4

nixel2007 force-pushed the feature/websocket branch from fa06596 to d8d896b Compare October 26, 2022 14:06

otymko reviewed Oct 26, 2022

View reviewed changes

nixel2007 force-pushed the feature/websocket branch from d8d896b to bf79d27 Compare October 26, 2022 14:54

Перевод на рельсы спринга

d93809b

nixel2007 force-pushed the feature/websocket branch from bf79d27 to d93809b Compare October 26, 2022 15:06

nixel2007 added 3 commits October 28, 2022 17:07

Причесывание, вынос пути к эндпоинту в параметр

0e1a431

Обновление года в описании команд

b7e7cd2

Документация

2b3f13e

otymko approved these changes Oct 28, 2022

View reviewed changes

Тесты на cli

acc411f

nixel2007 merged commit 2e7c1a4 into 1c-syntax:develop Oct 28, 2022

		@@ -1,4 +1,4 @@
		spring.main.web-application-type=none
		server.port=8025

Feature/websocket Поддержка работы через websocket #2567

Feature/websocket Поддержка работы через websocket #2567

Conversation

salexdv commented Feb 24, 2022 • edited Loading

Описание

Связанные задачи

Чеклист

Общие

Дополнительно

Сложности, недоработки, вопросы

nixel2007 commented Feb 24, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

otymko commented Feb 27, 2022

Описание

Связанные задачи

Чеклист

Общие

Дополнительно

Сложности, недоработки, вопросы

salexdv commented Mar 1, 2022

nixel2007 commented Mar 2, 2022

salexdv commented Mar 2, 2022

nixel2007 commented Mar 12, 2022

qtLex commented Mar 12, 2022

qtLex commented Mar 12, 2022

nixel2007 commented Mar 12, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nixel2007 commented Jul 20, 2022 via email

salexdv commented Jul 21, 2022

salexdv commented Jul 21, 2022

nixel2007 commented Jul 21, 2022

salexdv commented Jul 21, 2022

nixel2007 commented Oct 26, 2022

otymko Oct 26, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

salexdv commented Oct 26, 2022

nixel2007 commented Oct 28, 2022

sonarcloud bot commented Oct 28, 2022

salexdv commented Feb 24, 2022 •

edited

Loading

otymko Oct 26, 2022 •

edited

Loading