{"id":20645007,"url":"https://github.com/romanow/websocket-service","last_synced_at":"2025-08-28T02:41:14.220Z","repository":{"id":146005731,"uuid":"593180101","full_name":"Romanow/websocket-service","owner":"Romanow","description":"Multi-instance adapter between REST and WebSocket","archived":false,"fork":false,"pushed_at":"2025-02-24T21:19:18.000Z","size":127,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-09T15:54:31.758Z","etag":null,"topics":["spring-boot","stomp","web-socket"],"latest_commit_sha":null,"homepage":"https://romanow.github.io/websocket-service/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Romanow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-25T12:31:14.000Z","updated_at":"2024-12-09T09:30:31.000Z","dependencies_parsed_at":"2024-11-16T16:18:49.201Z","dependency_job_id":"8ab4fda4-c84f-400f-88da-1d6b0c3aa822","html_url":"https://github.com/Romanow/websocket-service","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Romanow/websocket-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fwebsocket-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fwebsocket-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fwebsocket-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fwebsocket-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Romanow","download_url":"https://codeload.github.com/Romanow/websocket-service/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Fwebsocket-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272424196,"owners_count":24932893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-28T02:00:10.768Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["spring-boot","stomp","web-socket"],"created_at":"2024-11-16T16:18:23.634Z","updated_at":"2025-08-28T02:41:14.197Z","avatar_url":"https://github.com/Romanow.png","language":"Kotlin","readme":"[![Build project](https://github.com/Romanow/websocket-service/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/Romanow/websocket-service/actions/workflows/build.yml)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n\n# Multi-instance adapter between REST and WebSocket\n\n## Поставно ка задачи\n\nНужно реализовать схему асинхронной нотификации от backend (`calm-gateway`) до UI (`calm-ui`) с\nпомощью [WebSocket](https://learn.javascript.ru/websocket).\n\nДля кодирования данных / команд используем протокол [`STOMP`](https://stomp.github.io/stomp-specification-1.2.html).\nSockJS для обратной совместимости использовать не требуется, т.к. заказчики являются внутренней структурой и используют\nпоследние версии браузеров.\n\n## Backend\n\nТ.к. WebSocket является сессионным протоколом, то для трансляции событий через него нужно выделить специальный сервис,\nт.к. frontend будет держать сессию именно с этим сервисом. Его основная задача – трансляция сообщений из REST / очереди\nв сообщениях для всех / конкретного пользователя по WebSocket. Т.е. на сервис приходит запрос _\"состояние расчета\nизменилось\"_ и он отправляет эту информацию по всем открытым соединениям. Если страница не подписана на эти сообщения,\nто она просто игнорирует его.\n\n### Подписки на события (`STOMP`)\n\nДля разделения потоков данных в `STOMP` используются подписки, аналогичные топикам в очередях.\n\n### Авторизация\n\n`STOMP` over WebSocket имеет свои заголовки и нельзя их передать как `basic` или `bearer` авторизацию, а только из тела\nсообщения, поэтому нужно вручную\nчерез [`MessageCredentialsInterceptor`](src/main/kotlin/ru/romanow/websocket/config/MessageCredentialsInterceptor.kt)\nвытащить пользователя из заголовка самого сообщения (не HTTP заголовков). В примере используется формат basic\nавторизации, передаваемый в теле `STOMP` в заголовке `X-Authorization`. Проверка пользователя выполняется там же в\n`MessageCredentialsInterceptor` через стандартный `AuthenticationManager`.\n\nАналогично можно реализовать token-based авторизацию, передавая в заголовке сообщения `X-Authorization` bearer токен.\n\n#### Disconnect\n\nСобытия `DISCONNECT` не имеет смысла закрывать безопасностью, поэтому они описаны как `permitAll()`.\n\n### Несколько instance\n\nТ.к. WebSocket сессионный протокол, то сообщение отправляется в _постоянно открытое_ соединение. Это TCP соединение на\nуровне ОС, следовательно, делать shared-сессию бесполезно. Вместо этого используется следующий подход: каждый instance\nподключен к очереди (которая поддерживает `STOMP` (`RabbitMQ`, `ArtemisMQ`)) и помимо отправки сообщения всем своим\nсоединениям, он кидает это сообщение в очередь и его получают все другие instance и рассылают своим подписчикам.\n\nАналогично работает и с отправкой пользователю, за исключением того, что instance проверяет, есть ли у него такой\nактивный пользователь (по связке пользователь (из авторизации) – сессия).\n\n## Frontend\n\nИспользуем `STOMP`, поэтому\nреализации [sockjs-client](https://github.com/sockjs/sockjs-client), [react-use-websocket](https://www.npmjs.com/package/react-use-websocket)\nне подходят, т.к. там нельзя кодировать сообщения WebSocket через `STOMP`.\n\nВ [демо (websocket-frontend)](https://github.com/Romanow/websocket-frontend) для реализации\nиспользовался [stomp-js](https://stomp-js.github.io/guide/stompjs/using-stompjs-v5.html) обернутый в React Hooks.\n\n### Переподключение\n\nВ случае потери соединения используем автоматические переподключение через короткий timeout.\n\n### Stale сессия\n\nДля контроля протухания сессии Spring WebSocket использует heart-beat сообщения (`ping`).\n\n## Реализация\n\nПодключаем в [build.gradle](build.gradle) зависимости:\n\n```groovy\nimplementation \"org.springframework.boot:spring-boot-starter-websocket\"\nimplementation \"org.springframework.boot:spring-boot-starter-security\"\nimplementation \"org.springframework.security:spring-security-messaging\"\n```\n\nВключаем поддержку\nWebSocket + `STOMP` ([`WebSocketConfiguration`](src/main/kotlin/ru/romanow/websocket/config/WebSocketConfiguration.kt):\n\n```kotlin\n@Configuration\n@EnableWebSocketMessageBroker           // включаем поддержку STOMP\n@Order(Ordered.HIGHEST_PRECEDENCE + 99) // конфигурация должна примениться раньше security\nclass WebSocketConfiguration : WebSocketMessageBrokerConfigurer {\n\n    override fun registerStompEndpoints(registry: StompEndpointRegistry) {\n        registry\n            .addEndpoint(\"/ws\")              // context-path\n            .setAllowedOriginPatterns(\"*\")   // выключаем CORS (в production нужно указать конкретные origin)\n    }\n\n    override fun configureMessageBroker(config: MessageBrokerRegistry) {\n        config\n            .setApplicationDestinationPrefixes(\"/chat\") // входные сообщения /chat/**\n            .setUserDestinationPrefix(\"/user\")          // исходящие сообщения /user/queue/**\n            .enableStompBrokerRelay(\"/queue\")           // общие исходящие сообщения (на WebSocket и очередь) /queue/**\n            .setRelayHost(artemisProperties.host!!)     // адрес очереди\n            .setRelayPort(artemisProperties.port!!)\n    }\n\n    override fun configureClientInboundChannel(registration: ChannelRegistration) {\n        // STOMP over WebSocket имеет свои заголовки и нельзя их передать как basic или bearer авторизацию через HTTP.\n        // Поэтому они передаются в заголовках STOMP сообщения, а MessageInterceptor их достает и проверяет авторизацию.\n        registration.interceptors(messageCredentialsInterceptor)\n    }\n}\n```\n\nТ.к. из клиента мы не можем передать HTTP авторизацию, то в HTTP конфигурации Spring Security мы\nуказываем `permitAll()`, а в messaging задает пользователя с ролью `USER` для всех\nподписок ([`SecurityConfiguration`](src/main/kotlin/ru/romanow/websocket/config/SecurityConfiguration.kt)):\n\n```kotlin\n@Configuration\n@EnableWebSecurity\nclass SecurityConfiguration {\n\n    @Bean\n    fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {\n        return http\n            .antMatcher(\"/ws/**\")\n            .authorizeHttpRequests {\n                it.anyRequest().permitAll()                            // для /ws/** не проверяем HTTP авторизацию\n            }\n            .sessionManagement {\n                it.sessionCreationPolicy(SessionCreationPolicy.ALWAYS) // создаем сессию для всех соединений\n            }\n            .build()\n    }\n}\n\n@Configuration\n@EnableWebSocketSecurity\nclass WebSocketSecurityConfiguration {\n\n    @Bean\n    fun authorizationManager(messages: MessageMatcherDelegatingAuthorizationManager.Builder): AuthorizationManager\u003cMessage\u003c*\u003e\u003e {\n        return messages\n            .simpTypeMatchers(SimpMessageType.DISCONNECT).permitAll()  // для disconnect не нужна авторизация\n            .anyMessage().hasRole(USER_ROLE)                           // все остальные сообщения с ролью USER\n            .build()\n    }\n\n    @Bean\n    @Order(Ordered.HIGHEST_PRECEDENCE)\n    fun csrfChannelInterceptor(): ChannelInterceptor {\n        return object : ChannelInterceptor {}                          // выключаем CSRF\n    }\n}\n```\n\nЗапрос проходит по цепочке фильтров `securityFilterChain` (`permitAll`), после заходит\nв [`MessageCredentialsInterceptor`](src/main/kotlin/ru/romanow/websocket/config/MessageCredentialsInterceptor.kt), там\nиз заголовка `X-Authorization` берется пользователь и _вручную_ через `AuthenticationManager` выполняется проверка по\nцепочке `configureInbound`.\n\n## Тестирование\n\nДля тестирования отказоустойчивости конфигурации поднимается два instance `websocker-service` (8081, 8082) и nginx\n(8080), который работает как reverse proxy и ArtemisMQ ([docker-compose.yml](docker-compose.yml)). Через nginx _только_\nустанавливается соединение до конечного instance, с которым и идет общение по WebSocket. Общение между instance идет\nчерез очередь ArtemisMQ.\n\nДля UI используется [websocket-frontend](https://github.com/Romanow/websocket-frontend).\n\nВ случае падения одного instance, UI просто подключается к другой ноде. Если на instance пришло сообщение, то он\nотправляет его по своим соединениям и так же передает в очередь, чтобы остальные instance отправили его своим\nподключениям.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Fwebsocket-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromanow%2Fwebsocket-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Fwebsocket-service/lists"}