cfml

set the channel description: All new Lucee WebSocket Extension (2024)

First question... Do I need some configuration in my webserver (apache in my case) to make this work? Similar to the config I needed for rest services?

Try hitting the lucee port (eg 8080) directly first to ensure it is working

Note: a Lucee restart is required when a new ws component is added

Try this for Apache config
<https://httpd.apache.org/docs/2.4/en/mod/mod_proxy_wstunnel.html|https://httpd.apache.org/docs/2.4/en/mod/mod_proxy_wstunnel.html>

Can you please let me know what works for you and I will add to Lucee Docs recipe page

Nginx config here
<https://www.f5.com/company/blog/nginx/websocket-nginx|https://www.f5.com/company/blog/nginx/websocket-nginx>

I will add this to Lucee Docs too

image.png

I'm not sure if the problem is with my Apache config or with Lucee...
I see this error in the Apache log
```File does not exist: C:/Web/websocketsDemo/www/ws/chat```
there is a chat.cfc file in the .../www/ws folder which I was expecting Lucee to be somehow automagically picked up by Lucee based on this comment in the 'recipe'

this is the line of JS in my test page that triggers the error
```const socket = new WebSocket("<wss://websocketsdemo/ws/chat>");```

I also tried putting my chat.cfc here: {lucee-config}/websockets/chat.cfc

That will go to port 443

Try ws: on your lucee port

I have SSL set up locally so I have to use wss

IMG_6295.jpg

WS tech support coming to you from Dubrovnik islands

ok... according to the Apache log it looks like I have Apache figured out
```serving URL <ws://websocketsdemo:8009/ws/chat>```
But I'm seeing nothing the Lucee logs...

Is Lucee really Ning on port 8009?

Please show dump of websocketinfo()
This will show paths lucee is going expecting CFC to be in

And yes, I have chat.cfc in the {lucee-config}/websockets/ folder

Nothing in application log either?
Did you create websocket log?
Set level to trace to pick up everything

Take a look at console output too

In my Apache config I had
```ProxyPassMatch ^/ws/(.*)$ <ws://websocketsdemo:8009/ws/$1$2>```
But I could see in the Tomcat lucee-stderr log file that was causing a SEVERE error
```org.apache.coyote.ajp.AjpMessage.processHeader Invalid message received with signature [18245]```
So I switched the Apache config to
```ProxyPassMatch ^/ws/(.*)$ <ajp://websocketsdemo:8009/ws/$1$2>```
and the error has stopped but I am still not seeing anything in the Lucee logs regarding websockets - the 'websocket' log file is not even being created

You need to create the ws log yourself 

You can do that in lucee admin 
Set level to trace

I have a ticket to add this to lucee docs too

I see the log file being written to on Lucee startup but nothing when I try to connect to the socket :thinking_face:

I have created a ticket to creating working code (rather than sample) on Lucee Docs recipe page

<https://github.com/lucee/extension-websocket/issues/10|https://github.com/lucee/extension-websocket/issues/10>

I think I have fixed all the configuration issues I've been chasing down today with the generous assistance of <@U06U2THDX> who is actually on holiday(!) in Croatia...So, time for a new thread that I think gets to the heart of the matter...

After spending most of the day chasing errors in Apache, Tomcat and Lucee configuration I am finally seeing activity in my websocket log. Which is good but it is only one message that is logged by the init() method of my websocket CFC.

*Apache*
In Apache I have loaded the wstunnel module in my httpd.conf file...

```LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so```
and am using it in my service .conf file...

```ProxyPassMatch ^/ws/(.*)$ <ws://websocketsdemo:8009/$1$2> ```
Other configuration records that may prove to be relevant are:

```#Enable 'rest' services
ProxyPassMatch ^/rest/(.*)$ <ajp://websocketsdemo:8009/rest/$1$2> 

#Enable 'http' services
ProxyPassMatch ^/(.+\.cf[cm])(/.*)?$ <ajp://websocketsdemo:8009/$1$2>```
So you see that I am using ProxyPassMatch rather than mod_cfml to connect Apache to Tomcat/Lucee.

I have enabled Apache 'error' logging for this service and I can see that the incoming message appears to be handled correctly by mod_proxy_wstunnel...

```[Thu Jun 20 21:34:12.033817 2024] [proxy_wstunnel:debug] [pid 25344:tid 1708] mod_proxy_wstunnel.c(318): [client 127.0.0.1:50002] AH02451: serving URL <ws://websocketsdemo:8009/chat>
[Thu Jun 20 21:34:12.033817 2024] [proxy:debug] [pid 25344:tid 1708] proxy_util.c(2160): AH00942: WS: has acquired connection for (*)
[Thu Jun 20 21:34:12.033817 2024] [proxy:debug] [pid 25344:tid 1708] proxy_util.c(2214): [client 127.0.0.1:50002] AH00944: connecting <ws://websocketsdemo:8009/chat> to websocketsdemo:8009
[Thu Jun 20 21:34:12.033817 2024] [proxy:debug] [pid 25344:tid 1708] proxy_util.c(2423): [client 127.0.0.1:50002] AH00947: connected /chat to websocketsdemo:8009
[Thu Jun 20 21:34:12.033817 2024] [proxy:debug] [pid 25344:tid 1708] proxy_util.c(2889): AH02824: WS: connection established with 127.0.0.1:8009 (*)
[Thu Jun 20 21:34:12.033817 2024] [proxy:debug] [pid 25344:tid 1708] proxy_util.c(3059): AH00962: WS: connection complete to 127.0.0.1:8009 (websocketsdemo)```
*Lucee*
In my chat.cfc file I have added an init() method that logs to the websocket log...

```public function init() {
	WriteLog(log='websocket', text='Chat server initialised...');
	return this;
}```
I have also adding a WriteLog() call to each of the methods in chat.cfc but the only records I see in websocket.log are from the init() method.

On the page I use to test the socket connection the JS invocation is...

```const socket = new WebSocket("<ws://websocketsdemo/ws/chat>");```
and in websocket.log I see the following record...

```"INFO","ajp-nio-127.0.0.1-8009-exec-9","06/20/2024","21:34:11","websocket_chat","Chat server initialised..."```
and in lucee-stderr.log I see the following message...

```20-Jun-2024 21:34:12.034 SEVERE [ajp-nio-127.0.0.1-8009-exec-10] org.apache.coyote.ajp.AjpMessage.processHeader Invalid message received with signature [18245]```
I don't know exactly how to read the log records but the presence of "ajp" in both Lucee log records suggests the wrong protocol is being used 'under the hood' but that is impossible for me to tell and at this point I have run out of ideas as to what else to try.

Thanks for reading this far... I'm hoping <@U06U2THDX> will know who to ask about all of this...

So there's some additional webserver config needed? I just spinned up commandbox, maybe that's my problem. But a websocket library is included in commandbox

Lucee will use JVM libs and install some of its own

The extension turns Lucee in to a websocket server. You use the same port as you do for http requests to hit that server

If you want to web server in front of Lucee Server, then yes, you will need to configure nginx/Apache/iis/… I will add web server configs to lucee docs page soon(ish)

"The extension turns Lucee in to a websocket server. You use the same port as you do for http requests to hit that server" - oh - :thinking_face: - maybe I wasted my day yesterday...

<@U08URT215> that was what I was trying to tell you; start simple

The recipe needs to be a bit clearer methinks... :wink:

I have a couple of tickets to update doco

IMG_6347.jpg

<@U08URT215> <@U06U1KW2V>
I have created a GitHub project that setups up `WebSocket Extension on Lucee 6 using CommandBox`
<https://github.com/webonix/Lucee-websocket-commandbox>

I will working on the test scripts, but if you are able to try this now to see if it makes sense and works, it would be greatly appreciated

Thanks AJ, I'll try to take a look today but it might slip a few days as I catch up after being AWOL for the end of last week...

Thank you for demo project. I tried it but could not get it to work - I get 404 on ws endpoints.

Hey AJ... I got it working after a bit of fiddling around since I'm on Windoze 10 rather then *nix...

The next trick for me will be to get it working with Apache rather than Commandbox...

"should not be here" ??? :rolling_on_the_floor_laughing:

<@U08URT215> what did you have to change for Windows?

<@U07B6HCCDDY> are you on Windows?

Not much - all I really needed to do was manually do the things that were in the bash script and it pretty much worked...

<@U08URT215> can you send me a `bat` (or whatever window uses) script and I will add it to my repo?

I still struggle to get it up and running with commandbox on win10. Followed the .sh script manually and `websocketInfo()` says everything is fine.
But the connection to the socketserver fails: `websocket.cfm:68 WebSocket connection to '<ws://127.0.0.1:55479/ws/Test2>' failed:`

<@U06U1KW2V> just to confirm
your site runs on `<http://127.0.0.1:55479/index.cfm>`

<@U08URT215> and anyone else using Windows10
here is a converted script by chatGPT

can someone please test and report back

```# PowerShell script for Windows 10

# Extension to install
# websocket, lucee admin
$env:LUCEE_EXTENSIONS="07082C66-510A-4F0B-B5E63814E2FDF7BE;version=1.0.0.11-RC,CED6227E-0F49-6367-A68D21AACA6B07E8;version=1.0.0.5"

$installdir = "$pwd\lucee6"
Write-Host "Install directory: $installdir"

New-Item -ItemType Directory -Force -Path "$installdir"
New-Item -ItemType Directory -Force -Path "$installdir\www"

if (-not (Test-Path "$installdir\www\index.cfm")) {
    Copy-Item .\index.cfm "$installdir\www\"
}

if (-not (Test-Path "$installdir\www\websocket.cfm")) {
    Copy-Item .\websocket.cfm "$installdir\www\"
}

Write-Host "Starting Lucee Server"
# Start Lucee Server with CommandBox
box start serverConfigFile=lucee6.json

# Set Lucee Admin password
Write-Host "Set Lucee Admin password to commandbox"
"commandbox" | Out-File "$installdir\WEB-INF\lucee-server\context\password.txt"

Write-Host "Copying websocket components"
# Websocket - "directory": "{lucee-config}/websockets/",
# lucee-config = lucee6/WEB-INF/lucee-server/context
New-Item -ItemType Directory -Force -Path "$installdir\WEB-INF\lucee-server\context\websockets"
Copy-Item .\test.cfc "$installdir\WEB-INF\lucee-server\context\websockets\"
Copy-Item .\test2.cfc "$installdir\WEB-INF\lucee-server\context\websockets\"

Write-Host "Using CFConfig to create websocket log file"
box cfconfig import from=CFConfig-websocket-log.json to=lucee6

Write-Host "Restarting Lucee Server"
# Restart Lucee to pick up new websocket
box restart serverConfigFile=lucee6.json

# Lucee Logs
box server log lucee6 --follow```

&gt; your site runs on `<http://127.0.0.1:55479/index.cfm>`
It does, yes.

<@U06U1KW2V> are you able to try my repo on your windows machine?

will do with the GPT version of the script.

<@U06U2THDX>: I am on windows, yes. I was running script using git bash shell. I tried with chatgpt converted script, but the result is the same - 404 when websocket tries to connect to <https://127.0.0.1:8443/ws/Test2|https://127.0.0.1:8443/ws/Test2>

<@U07B6HCCDDY> are you browsing to
<https://127.0.0.1:4433/|https://127.0.0.1:4433/>index.cfm

That is a test page that will call the websocket

You do not hit the websocket directly with the browser; you need a WS client - in this case, JavaScript 

<@U06U2THDX> yes, I am browsing to index and then to websocket  test script (<https://localhost:4433/websocket.cfm|https://localhost:4433/websocket.cfm>). Error 404 occurs when clicking Open button on test page.

Can you try <https://127.0.0.1:4433/index.cfm>

I tired <https://127.0.0.1:4433/index.cfm>  and I get Lucee Placeholders, link to websocket.cfm and websocketinfo and server info.

<@U07B6HCCDDY> - try clicking on this link...

Can you show me the dump of websocketinfo()

<@U06U2THDX>:
websocketinfo (i blacked out my local username):

<@U08URT215>: yes, i do see that and when i click on open button I get 404 on <http://GET%20wss://127.0.0.1:4433/ws/Test2|GET wss://127.0.0.1:4433/ws/Test2> (copied from network tab in dev tools)

This is what I get at this point: `websocket.cfm:68 WebSocket connection to '<ws://127.0.0.1:55479/ws/Test2>' failed:`

<@U08URT215> are you able to connect to WS and send/receive messages?

yes, but I haven't had time to test the new powershell script - I'm still running on the stuff I was tinkering with a few days ago.

Tried the powershell script. Needed to change one thing (force to ssl, because 127.0.0.1). Is starting correctly, everything looks fine. I get the window with all the buttons and klick "open 127.0.0.1:8091".
Results in a javascript error windows and:
```websocket.cfm:68 WebSocket connection to '<ws://127.0.0.1:8091/ws/Test2>' failed: 
openSocket	@	websocket.cfm:68
onclick	@	websocket.cfm:10```

<@U06U2THDX> - I'm back from two weeks on a bike and am trying to get web-sockets working through Apache rather than CommandBox. I fought with it for a couple of hours but am thinking I need to start from scratch with the whole thing. Just putting this out there in case there is someone here who has got a working example outside of CommandBox...

I also still struggle with it. I'm curious on a solution.

<@U08URT215> do you have it working directly on Lucee?
You should be ale to hit the websocket on the same port is the one server lucee web pages

Do we have a complete example how to make this work 
In lucee 


if you like commandBox, give this a go
<https://github.com/webonix/Lucee-websocket-commandbox>

discussion thread here
<https://cfml.slack.com/archives/C078TD8PPRT/p1719743231871269>

is there any demo ready for lucee web sockets \

this may assist
<https://docs.lucee.org/recipes/websocket-extension.html>