test: build examples in the CI (#3856)

Updated docker compose to be in line with current practices.

Reference: https://docs.docker.com/compose/

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: 'bug'
+labels: 'to triage'
 assignees: ''
 
 ---

.github/workflows/ci.yml

@@ -24,3 +24,31 @@ jobs:
       - run: npm test
         env:
           CI: true
+
+  build-examples:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      fail-fast: false
+      matrix:
+        example:
+          - custom-parsers
+          - typescript
+          - webpack-build
+          - webpack-build-server
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        
+      - name: Use Node.js 20
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          
+      - name: Build ${{ matrix.example }}
+        run: |
+          cd examples/${{ matrix.example }}
+          npm install
+          npm run build

Readme.md

@@ -2,8 +2,6 @@
 [![Run on Repl.it](https://repl.it/badge/github/socketio/socket.io)](https://replit.com/@socketio/socketio-minimal-example)
 [![Backers on Open Collective](https://opencollective.com/socketio/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/socketio/sponsors/badge.svg)](#sponsors)
 [![Build Status](https://github.com/socketio/socket.io/workflows/CI/badge.svg)](https://github.com/socketio/socket.io/actions)
-[![Dependency Status](https://david-dm.org/socketio/socket.io.svg)](https://david-dm.org/socketio/socket.io)
-[![devDependency Status](https://david-dm.org/socketio/socket.io/dev-status.svg)](https://david-dm.org/socketio/socket.io#info=devDependencies)
 [![NPM version](https://badge.fury.io/js/socket.io.svg)](https://www.npmjs.com/package/socket.io)
 ![Downloads](https://img.shields.io/npm/dm/socket.io.svg?style=flat)
 [![](https://slackin-socketio.now.sh/badge.svg)](https://slackin-socketio.now.sh)

examples/cluster-nginx/docker-compose.yml

@@ -1,58 +1,43 @@
+services:
+  nginx:
+    image: nginx:alpine
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf:ro
+    ports:
+    - "3000:80"
 
-nginx:
-  image: nginx:alpine
-  volumes:
-    - ./nginx.conf:/etc/nginx/nginx.conf:ro
-  links:
-    - server-john
-    - server-paul
-    - server-george
-    - server-ringo
-  ports:
-   - "3000:80"
-
-server-john:
-  build: ./server
-  links:
-    - redis
-  expose:
+  server-john:
+    build: ./server
+    expose:
     - "3000"
-  environment:
-    - NAME=John
+    environment:
+      - NAME=John
 
-server-paul:
-  build: ./server
-  links:
-    - redis
-  expose:
-    - "3000"
-  environment:
-    - NAME=Paul
+  server-paul:
+    build: ./server
+    expose:
+      - "3000"
+    environment:
+      - NAME=Paul
 
-server-george:
-  build: ./server
-  links:
-    - redis
-  expose:
-    - "3000"
-  environment:
-    - NAME=George
+  server-george:
+    build: ./server
+    expose:
+      - "3000"
+    environment:
+      - NAME=George
 
-server-ringo:
-  build: ./server
-  links:
-    - redis
-  expose:
-    - "3000"
-  environment:
-    - NAME=Ringo
+  server-ringo:
+    build: ./server
+    expose:
+      - "3000"
+    environment:
+      - NAME=Ringo
 
-client:
-  build: ./client
-  links:
-    - nginx
+  client:
+    build: ./client
 
-redis:
-  image: redis:alpine
-  expose:
-    - "6379"
+  redis:
+    image: redis:alpine
+    expose:
+      - "6379"

lib/socket.ts

@@ -107,7 +107,10 @@ export interface Handshake {
   auth: { [key: string]: any };
 }
 
-export type Event = [eventName: string, ...args: any[]];
+/**
+ * `[eventName, ...args]`
+ */
+export type Event = [string, ...any[]];
 
 export class Socket<
   ListenEvents extends EventsMap = DefaultEventsMap,

package.json

@@ -49,7 +49,7 @@
     "accepts": "~1.3.4",
     "base64id": "~2.0.0",
     "debug": "~4.3.2",
-    "engine.io": "~6.1.0",
+    "engine.io": "~6.1.2",
     "socket.io-adapter": "~2.3.3",
     "socket.io-parser": "~4.0.4"
   },