Skip to content

Commit e485355

Browse files
theturtle32theturtle32
authored
Merge pull request #463 from theturtle32/phase1-test-suite-modernization
Phase 1: Complete test suite modernization with ES6 patterns
2 parents 6a8783e + cd1174c commit e485355

36 files changed

+2959
-2872
lines changed

‎.eslintrc.js‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
module.exports = {
2+
env: {
3+
browser: true,
4+
commonjs: true,
5+
es6: true,
6+
node: true
7+
},
8+
extends: 'eslint:recommended',
9+
parserOptions: {
10+
ecmaVersion: 2018,
11+
sourceType: 'script'
12+
},
13+
rules: {
14+
'indent': ['error', 2],
15+
'linebreak-style': ['error', 'unix'],
16+
'quotes': ['error', 'single'],
17+
'semi': ['error', 'always'],
18+
'no-unused-vars': ['error', { 'args': 'none' }],
19+
'no-console': 'off',
20+
'no-useless-escape': 'off',
21+
'no-prototype-builtins': 'off',
22+
'no-control-regex': 'off',
23+
'no-empty': 'off',
24+
'no-unsafe-finally': 'off'
25+
},
26+
globals: {
27+
'WebSocket': 'readonly',
28+
'globalThis': 'readonly'
29+
}
30+
};

‎.github/workflows/websocket-tests.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,7 @@ jobs:
1212

1313
- run: npm install
1414

15+
- run: npm run lint
16+
1517
- run: npm run test
1618

‎.jshintrc‎

Lines changed: 0 additions & 88 deletions
This file was deleted.

‎CLAUDE.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# WebSocket-Node Development Guide
2+
3+
## Build/Test Commands
4+
- Run all tests: `npm test`
5+
- Run single test: `npx tape test/unit/[filename].js`
6+
- Lint codebase: `npm run lint`
7+
- Fix lint issues: `npm run lint:fix`
8+
- Run autobahn tests: `cd test/autobahn && ./run-wstest.sh`
9+
10+
## Coding Style
11+
- Use 2 spaces for indentation
12+
- Constants: ALL_CAPS with underscores
13+
- Variables/Functions: camelCase
14+
- Classes: PascalCase
15+
- Private properties: prefix with underscore (_propertyName)
16+
- Prefer const/let over var for new code
17+
- Use descriptive error messages with proper capitalization
18+
- Maintain backward compatibility with Node.js 4.x+
19+
- Use EventEmitter pattern for async events
20+
- Always catch and handle errors in Promise chains
21+
- Document API facing methods with clear JSDoc comments
22+
- Use utility functions from ./lib/utils.js for buffer operations
23+
- Add debug logging with the debug module at key points

‎ES6_REFACTORING_PLAN.md‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# WebSocket-Node ES6 Refactoring Plan
2+
3+
## Current Status
4+
5+
The ES6 refactoring is **partially complete**. The following core library files have been refactored:
6+
7+
### ✅ Completed Files (13 files)
8+
- `lib/Deprecation.js` - Basic var → const conversion
9+
- `lib/W3CWebSocket.js` - var → const/let conversion
10+
- `lib/WebSocketClient.js` - var → const conversion
11+
- `lib/WebSocketConnection.js` - Extensive refactoring (1442 lines changed)
12+
- `lib/WebSocketFrame.js` - var → const conversion
13+
- `lib/WebSocketRequest.js` - var → const conversion
14+
- `lib/WebSocketRouter.js` - var → const conversion
15+
- `lib/WebSocketRouterRequest.js` - Basic var → const conversion
16+
- `lib/WebSocketServer.js` - var → const conversion
17+
- `lib/browser.js` - var → const conversion
18+
- `lib/utils.js` - var → const/let conversion + template literals
19+
- `lib/websocket.js` - var → const conversion
20+
- `example/whiteboard/whiteboard.js` - Example file refactored
21+
22+
### 🔄 Refactoring Patterns Applied
23+
1. **Variable Declarations**: `var` → `const`/`let` based on reassignment
24+
2. **Template Literals**: String concatenation → template literals (partial)
25+
3. **Block Scoping**: Proper const/let scoping in loops and functions
26+
4. **Modern Syntax**: Arrow functions in some contexts
27+
28+
## Remaining Work
29+
30+
### 1. **Unmodified Library Files** (1 file)
31+
- `lib/version.js` - Already uses modern `module.exports`, no changes needed
32+
33+
### 2. **Test Suite Refactoring** ✅ **COMPLETED** (15 files)
34+
**Status: Complete** - All test files modernized to ES6+ patterns
35+
36+
#### Unit Tests (5/5 Complete)
37+
- ✅ `test/unit/request.js` - Modern const/let, arrow functions
38+
- ✅ `test/unit/dropBeforeAccept.js` - Modern const/let, arrow functions
39+
- ✅ `test/unit/regressions.js` - Modern const/let, arrow functions
40+
- ✅ `test/unit/w3cwebsocket.js` - Modern const/let, arrow functions
41+
- ✅ `test/unit/websocketFrame.js` - Modern const/let
42+
43+
#### Test Infrastructure (2/2 Complete)
44+
- ✅ `test/shared/test-server.js` - Modern const/let, arrow functions
45+
- ✅ `test/shared/start-echo-server.js` - Modern const/let, function expressions
46+
47+
#### Test Scripts (8/8 Complete)
48+
- ✅ `test/scripts/memoryleak-server.js` - Modern const/let, arrow functions
49+
- ✅ `test/scripts/memoryleak-client.js` - Modern const/let, arrow functions
50+
- ✅ `test/scripts/libwebsockets-test-server.js` - Modern const/let, arrow functions
51+
- ✅ `test/scripts/libwebsockets-test-client.js` - Modern const/let, arrow functions
52+
- ✅ `test/scripts/fragmentation-test-client.js` - Modern const/let, arrow functions
53+
- ✅ `test/scripts/fragmentation-test-server.js` - Modern const/let, arrow functions
54+
- ✅ `test/scripts/echo-server.js` - Modern const/let, arrow functions
55+
- ✅ `test/scripts/autobahn-test-client.js` - Modern const/let, arrow functions
56+
57+
### 3. **Example Files** (1 file)
58+
**Priority: Low** - Examples should demonstrate modern patterns
59+
- `example/whiteboard/public/client.js` - Browser-side client code
60+
61+
### 4. **Code Quality Improvements**
62+
**Priority: High** - Enhance already-refactored files
63+
64+
#### A. **Enhanced Modern JavaScript Features**
65+
- **Arrow Functions**: Convert appropriate function expressions
66+
- **Destructuring**: Extract object/array properties modernly
67+
- **Template Literals**: Complete string concatenation replacement
68+
- **Default Parameters**: Replace manual parameter defaulting
69+
- **Enhanced Object Literals**: Use shorthand property syntax
70+
- **Spread Operator**: Replace `Array.prototype.slice.call()` patterns
71+
72+
#### B. **Async/Await Migration** (Optional)
73+
- Consider Promise-based APIs where appropriate
74+
- Maintain backward compatibility with callback patterns
75+
76+
#### C. **Class Syntax** (Evaluation Needed)
77+
- Evaluate prototype-based constructors for class conversion
78+
- Maintain inheritance patterns with extends/super
79+
- Consider impact on Node.js 4.x+ compatibility requirements
80+
81+
### 5. **Configuration & Build Updates**
82+
**Priority: Medium**
83+
- Update ESLint rules for ES6+ patterns
84+
- Verify Node.js 4.x+ compatibility maintained
85+
- Update package.json engines field if needed
86+
87+
### 6. **Documentation Updates**
88+
**Priority: Low**
89+
- Update code examples in README to use modern syntax
90+
- Ensure API documentation reflects any syntax changes
91+
92+
## Implementation Strategy
93+
94+
### Phase 1: Test Suite Modernization ✅ **COMPLETED**
95+
**Goal**: Ensure test reliability during refactoring
96+
1. ✅ Refactor unit tests (`test/unit/*.js`) - 5/5 files complete
97+
2. ✅ Refactor test infrastructure (`test/shared/*.js`) - 2/2 files complete
98+
3. ✅ Refactor test scripts (`test/scripts/*.js`) - 8/8 files complete
99+
4. ✅ Run full test suite to ensure no regressions
100+
101+
### Phase 2: Code Quality Enhancements
102+
**Goal**: Maximize modern JavaScript usage in core library
103+
1. **Enhanced Template Literals** - Complete string concatenation replacement
104+
2. **Arrow Functions** - Convert appropriate callbacks and handlers
105+
3. **Destructuring** - Simplify object property extraction
106+
4. **Default Parameters** - Clean up manual parameter handling
107+
5. **Object Literal Enhancements** - Use shorthand syntax
108+
109+
### Phase 3: Advanced Features (Optional)
110+
**Goal**: Evaluate modern patterns without breaking changes
111+
1. **Class Syntax Evaluation** - Assess constructor → class conversion
112+
2. **Async/Await Integration** - Add Promise-based alternatives
113+
3. **Module System** - Consider ES6 imports (Node.js version dependent)
114+
115+
### Phase 4: Validation & Cleanup
116+
**Goal**: Ensure quality and compatibility
117+
1. Run complete test suite (`npm test`)
118+
2. Run autobahn compatibility tests
119+
3. Lint entire codebase (`npm run gulp`)
120+
4. Update documentation and examples
121+
5. Performance regression testing
122+
123+
## Compatibility Considerations
124+
125+
- **Node.js 4.x+ Support**: Maintain current compatibility requirements
126+
- **ES6 Feature Support**: All used features must work in Node.js 4.x+
127+
- **API Compatibility**: No breaking changes to public APIs
128+
- **Performance**: Ensure refactoring doesn't impact WebSocket performance
129+
130+
## Risk Assessment
131+
132+
**Low Risk**: Variable declaration changes (var → const/let)
133+
**Medium Risk**: Function expression → arrow function conversion
134+
**High Risk**: Constructor → class conversion, async/await integration
135+
136+
## Success Criteria
137+
138+
1. ✅ All tests pass (`npm test`)
139+
2. ✅ Autobahn tests pass (`cd test/autobahn && ./run-wstest.sh`)
140+
3. ✅ Linting passes (`npm run gulp`)
141+
4. ✅ No performance regressions
142+
5. ✅ Backward compatibility maintained
143+
6. ✅ Modern JavaScript patterns consistently applied

‎example/whiteboard/public/client.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Whiteboard.prototype.clear = function() {
114114

115115
Whiteboard.prototype.handleMouseDown = function(event) {
116116
this.mouseDown = true;
117-
this.lastPoint = this.resolveMousePosition(event);
117+
this.lastPoint = this.resolveMousePosition(event);
118118
};
119119

120120
Whiteboard.prototype.handleMouseUp = function(event) {
@@ -178,12 +178,12 @@ Whiteboard.prototype.addCanvasEventListeners = function() {
178178

179179
Whiteboard.prototype.resolveMousePosition = function(event) {
180180
var x, y;
181-
if (event.offsetX) {
182-
x = event.offsetX;
183-
y = event.offsetY;
184-
} else {
185-
x = event.layerX - this.offsetX;
186-
y = event.layerY - this.offsetY;
187-
}
188-
return { x: x, y: y };
181+
if (event.offsetX) {
182+
x = event.offsetX;
183+
y = event.offsetY;
184+
} else {
185+
x = event.layerX - this.offsetX;
186+
y = event.layerY - this.offsetY;
187+
}
188+
return { x: x, y: y };
189189
};

‎example/whiteboard/whiteboard.js‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
* limitations under the License.
1616
***********************************************************************/
1717

18-
var WebSocketServer = require('../../lib/websocket').server;
19-
var express = require('express');
18+
const WebSocketServer = require('../../lib/websocket').server;
19+
const express = require('express');
2020

21-
var app = express.createServer();
21+
const app = express.createServer();
2222

2323
app.configure(function() {
2424
app.use(express.static(__dirname + "/public"));
@@ -31,22 +31,22 @@ app.get('/', function(req, res) {
3131
app.listen(8080);
3232

3333

34-
var wsServer = new WebSocketServer({
34+
const wsServer = new WebSocketServer({
3535
httpServer: app,
3636

3737
// Firefox 7 alpha has a bug that drops the
3838
// connection on large fragmented messages
3939
fragmentOutgoingMessages: false
4040
});
4141

42-
var connections = [];
43-
var canvasCommands = [];
42+
const connections = [];
43+
const canvasCommands = [];
4444

4545
wsServer.on('request', function(request) {
46-
var connection = request.accept('whiteboard-example', request.origin);
46+
const connection = request.accept('whiteboard-example', request.origin);
4747
connections.push(connection);
4848

49-
console.log(connection.remoteAddress + " connected - Protocol Version " + connection.webSocketVersion);
49+
console.log(`${connection.remoteAddress} connected - Protocol Version ${connection.webSocketVersion}`);
5050

5151
// Send all the existing canvas commands to the new client
5252
connection.sendUTF(JSON.stringify({
@@ -56,9 +56,9 @@ wsServer.on('request', function(request) {
5656

5757
// Handle closed connections
5858
connection.on('close', function() {
59-
console.log(connection.remoteAddress + " disconnected");
59+
console.log(`${connection.remoteAddress} disconnected`);
6060

61-
var index = connections.indexOf(connection);
61+
const index = connections.indexOf(connection);
6262
if (index !== -1) {
6363
// remove the connection from the pool
6464
connections.splice(index, 1);
@@ -69,10 +69,10 @@ wsServer.on('request', function(request) {
6969
connection.on('message', function(message) {
7070
if (message.type === 'utf8') {
7171
try {
72-
var command = JSON.parse(message.utf8Data);
72+
const command = JSON.parse(message.utf8Data);
7373

7474
if (command.msg === 'clear') {
75-
canvasCommands = [];
75+
canvasCommands.length = 0; // Clear array without replacing reference
7676
}
7777
else {
7878
canvasCommands.push(command);

0 commit comments

Comments
 (0)