Websockets Server implementation for script editor integration with VSCode or other external editors. #4599

Rider-Linden · 2025-08-22T23:30:01Z

Description

Implements a websocket server that may be launched in the viewer to allow external programs two way communication with systems in the viewer.

Allows external code editors to communicate with the viewer and receive compile status and runtime information. It also allows for transfering the current language definitions from the viewer to the editor.
(See: doc/external-editor-json-rpc.md for full protocol.)

Related Issues

Needs a full test plan, should test in coordination with https://github.com/secondlife/sl-vscode-edit/

Ansariel · 2025-08-23T13:23:47Z

autobuild.xml

It would be great if the file would not randomly get re-ordered (again) to reduce merge conflicts for TPVs.

Sadly that's a side effect of the autobuild program.
:-(

Let's avoid the churn if possible --manual edit or figure out the sorting (presuming dictionary sorting differences with python llsd.)

Should be all better now... 🤞

Copilot

Pull Request Overview

This PR implements a WebSocket server infrastructure for enabling external script editor integration with the Second Life viewer, using JSON-RPC 2.0 protocol for structured communication.

Adds WebSocket server and JSON-RPC 2.0 communication layer via WebSocketMgr and JSONRPCServer base classes
Creates specialized script editor WebSocket connection handling with handshake protocol and editor association
Integrates WebSocket server startup with existing script editor workflow when opening external editors

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
indra/newview/llscripteditorws.h	Header defining specialized script editor WebSocket server and connection classes
indra/newview/llscripteditorws.cpp	Implementation of script editor WebSocket communication and editor association
indra/newview/llpreviewscript.h	Added WebSocket connection methods and member to script container class
indra/newview/llpreviewscript.cpp	Integrated WebSocket server startup into external editor workflow
indra/newview/llappviewer.cpp	Added WebSocket manager update call to main event loop
indra/newview/CMakeLists.txt	Added new script editor WebSocket source files to build
indra/llcorehttp/llwebsocketmgr.h	Core WebSocket server and connection management infrastructure
indra/llcorehttp/llwebsocketmgr.cpp	Implementation of WebSocket server with threading and connection handling
indra/llcorehttp/lljsonrpcws.h	JSON-RPC 2.0 protocol implementation over WebSocket connections
indra/llcorehttp/lljsonrpcws.cpp	JSON-RPC message processing, method registration, and error handling
indra/llcorehttp/CMakeLists.txt	Added WebSocket and JSON-RPC source files to llcorehttp build
indra/cmake/websocketpp.cmake	CMake configuration for websocketpp library dependency
indra/cmake/CMakeLists.txt	Added websocketpp CMake module to build system
autobuild.xml	Added websocketpp package dependency configuration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

indra/newview/llscripteditorws.cpp

bennettgoble · 2025-09-30T17:32:55Z

@Rider-Linden could we get a summary of the JSON-RPC API this exposes? Perhaps it'd be useful to provide a separate *.md documenting the interface for developers to reference.

Rider-Linden · 2025-10-01T15:29:34Z

@Rider-Linden could we get a summary of the JSON-RPC API this exposes? Perhaps it'd be useful to provide a separate *.md documenting the interface for developers to reference.

I'll make a copy of the one included in the vscode extension. I usually dislike having two copies of the same document, but I'm not sure there is a way around it.

bennettgoble · 2025-10-01T15:54:02Z

I'll make a copy of the one included in the vscode extension. I usually dislike having two copies of the same document, but I'm not sure there is a way around it.

The server defines the spec: so I would think it would be appropriate to place in here, then link to the document from the extension repo.

Rider-Linden · 2025-10-01T22:33:49Z

indra/newview/llscripteditorws.cpp

+        // TODO: Build an actual error message to forward to the external editor
+        // Explaination:
+        // Well! Heck!
+        // As it turns out, the complete error message arrives as either two or three
+        // separate chat messages from the server.
+        // 2 if the script is LSL or if it is Lua but not owned by the editing agent
+        // 3 if the script is Lua and owned by the editing agent.
+        //
+        // Message 1: <Object Name> [script:<Script Name>] Script run-time error
+        // Message 2: <runtime error>
+        // Message 3: <script>:<line>: <actual error message>\n
+        //              <call stack>
+        //
+        // These need to be compositited into a single error message to send to the IDE.
+        //
+        //if (lines.size() > 1)
+        //{   // The second line is the actual error message
+        //    error_message = lines[1];
+        //    remove_count++;
+        //    if ((error_message == "runtime error") && (lines.size() > 2))
+        //    { // If the error message is just "runtime error", the next line might actually be the real message:
+        //        // "lua_script:7: attempt to perform arithmetic (sub) on nil"
+        //        static const boost::regex LUA_ERROR_REGEX(R"(^(.+?):(\d+):\s*(.+)$)");
+        //
+        //        if (boost::regex_match(first_line, m, RUNTIME_ERR_REGEX_FLEX))
+        //        {
+        //            line_number   = std::stoi(m[2].str());
+        //            error_message = m[3].str();
+        //            remove_count++;
+        //        }
+        //    }
+        //    else
+        //    {
+        //        error_message = "Unknown script runtime error";
+        //    }
+        //}
+        //else
+        //{
+        //    error_message = "Unknown script runtime error";
+        //}


Ok... This bit has me flumoxed.

@marchcat Any thoughts?

Yeah I've been meaning to merge the last two into a single message, it just means that I need to add a new function to the server that allows sending a chat message to everyone in the sim except a single person. Then we can send most users the general error message, then a more specific one to the owner.

No idea about the first though. Things in-world might be listening for that message currently? Do Mono objects currently get 2 messages on error?

Yes, Mono gets two messages. So, that will simplify things.
From the slack conversation:

We'll consolidate this so that it is always 2 messages.

We can not go to one message since that may break script crash monitors.

Geenz · 2025-10-06T23:03:55Z

indra/llcorehttp/lljsonrpcws.cpp

I'd want to see a little bit more separation here of concerns into individual files (for example, LLJSONRPCServer and LLJSONRPCConnection), but that's not a blocker. Generally looks fine.

Geenz · 2025-10-06T23:06:22Z

indra/llcorehttp/llwebsocketmgr.h

+
+#include <websocketpp/common/connection_hdl.hpp>
+
+struct Server_impl;


Why just forward declare here and not just have Server_impl up here instead?

I want the server implementation to be opaque to anything outside of llwebsocketmgr.cpp while not having to declare it as a void * in the header.

Co-authored-by: Copilot <[email protected]>

…connection for all scripts.

Co-authored-by: Copilot <[email protected]>

…ests.

… connection.

…values. Added "runtime.debug" and "runtime.error" notifications.

Copilot

Pull Request Overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 6 comments.

Comments suppressed due to low confidence (1)

indra/newview/llpreviewscript.cpp:1

The variable 'connection_id' is assigned from 'it->second.mConnectionID' after 'it' has been erased, causing undefined behavior. Store the connection ID before erasing the subscription.

/**

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

indra/newview/skins/default/xui/en/floater_scripting_settings.xml

indra/newview/app_settings/types_lua_default.llsd

indra/newview/llscripteditorws.cpp

Co-authored-by: Copilot <[email protected]>

Re-enable when test is debugged.

… empty lang def is not a success. Hopefully this will package correctly.

github-actions bot added c/cpp cmake llcorehttp team:viewer labels Aug 22, 2025

Rider-Linden requested a review from Copilot August 22, 2025 23:33

This comment was marked as outdated.

Sign in to view

Rider-Linden requested a review from Copilot August 23, 2025 05:19

Rider-Linden self-assigned this Aug 23, 2025

This comment was marked as outdated.

Sign in to view

Ansariel reviewed Aug 23, 2025

View reviewed changes

Rider-Linden force-pushed the rider/vscode_integration branch from 0a25b9e to c8b0729 Compare August 24, 2025 21:43

github-actions bot added llmessage llui labels Aug 24, 2025

Rider-Linden changed the base branch from develop to project/lua_editor August 25, 2025 04:18

Rider-Linden requested a review from Copilot August 25, 2025 04:20

This comment was marked as outdated.

Sign in to view

github-actions bot removed llmessage llui labels Aug 27, 2025

Rider-Linden requested a review from Copilot August 27, 2025 13:39

Copilot AI reviewed Aug 27, 2025

View reviewed changes

indra/newview/llscripteditorws.cpp Outdated Show resolved Hide resolved

github-actions bot added the llcommon label Sep 17, 2025

marchcat approved these changes Sep 30, 2025

View reviewed changes

Rider-Linden commented Oct 1, 2025

View reviewed changes

Geenz reviewed Oct 6, 2025

View reviewed changes

Rider-Linden and others added 3 commits October 7, 2025 09:19

Initial simple websockets server with managing singleton.

dcf6d8c

Finish blocking run and adding documentation.

e27b363

Update indra/llcorehttp/llwebsocketmgr.cpp

de65dbf

Co-authored-by: Copilot <[email protected]>

Rider-Linden and others added 12 commits October 7, 2025 09:19

First pass at websocket server for editing.

7b174ab

Expand the websocket implementation a bit. Added JSONRPC specialization.

f31c194

initial Lua types files, and switch websocket server to use a single …

684af84

…connection for all scripts.

Update indra/newview/llscripteditorws.cpp

0d7ca7f

Co-authored-by: Copilot <[email protected]>

Changes to the message protocol for script.compiled and language requ…

e750c58

…ests.

Implemented simple challenge on handshake, fixed issue with closing a…

26268f7

… connection.

Some cleanup on the JSONRPC class.

672bdc8

Added scripting options floater for config, switched to using config …

339e7cc

…values. Added "runtime.debug" and "runtime.error" notifications.

Inconsistent snakes vs. camels.

4196360

Adding default default lua types file.

b305860

Forward llOwnerSay/print messages to the plugin as well.

c678b45

Unscramble autobuild.xml

5f9dd14

Rider-Linden force-pushed the rider/vscode_integration branch from 3ce1955 to 5f9dd14 Compare October 7, 2025 16:24

Rider-Linden requested a review from Copilot October 7, 2025 16:29

Copilot AI reviewed Oct 7, 2025

View reviewed changes

Rider-Linden and others added 4 commits October 7, 2025 15:46

Fixed some virtual/override disagreements.

0f92f2a

Update indra/newview/skins/default/xui/en/floater_scripting_settings.xml

2dd9d14

Co-authored-by: Copilot <[email protected]>

Update indra/newview/llscripteditorws.cpp

8794f45

Co-authored-by: Copilot <[email protected]>

A couple of naming issues, and accessing an iterator post erase.

696e1b1

Rider-Linden marked this pull request as ready for review October 8, 2025 01:31

Rider-Linden changed the title ~~[WIP] Websockets Server implementation for script editor integration with VSCode or other external editors.~~ Websockets Server implementation for script editor integration with VSCode or other external editors. Oct 8, 2025

Rider-Linden added 3 commits October 8, 2025 08:43

Added the JSON-rpc documentation for external editor integration.

595a9e8

Disabling known failing integration test for llprocess.cpp

93a4f8a

Re-enable when test is debugged.

Renamed types_lua_default.llsd to types_lua_default.xml, returning an…

5306ad7

… empty lang def is not a success. Hopefully this will package correctly.


		#include <websocketpp/common/connection_hdl.hpp>

		struct Server_impl;

Websockets Server implementation for script editor integration with VSCode or other external editors. #4599

Are you sure you want to change the base?

Websockets Server implementation for script editor integration with VSCode or other external editors. #4599

Conversation

Rider-Linden commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

bennettgoble commented Sep 30, 2025

Uh oh!

Rider-Linden commented Oct 1, 2025

Uh oh!

bennettgoble commented Oct 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rider-Linden commented Aug 22, 2025 •

edited

Loading