26 Commits

Author SHA1 Message Date
2d84d11034 fix: update jsonwebtoken from v9.0.1 to v9.0.2 2023-09-18 21:45:05 +02:00
4ba9a452ea docs: improve Prerequisites section 2023-08-06 11:45:16 +02:00
6a28554b00 fix: update jsonwebtoken from v9.0.0 to v9.0.1 2023-07-22 12:20:18 +02:00
50c236ca4d refactor: usage of node:test instead of tap 2023-07-22 12:18:28 +02:00
b708d66586 chore: sync package-lock.json 2023-07-02 18:14:09 +02:00
d1145e5f63 perf: ignore test files in published package (reduce package size) 2023-07-02 18:12:07 +02:00
487965b9aa chore: clean up 2023-07-02 18:10:38 +02:00
108ae8f6fc fix: update author - Théo LUDWIG 2023-07-02 18:08:35 +02:00
7d0df02299 build(deps): update latest 2023-07-02 18:05:47 +02:00
26bbc075cf feat: add npm package provenance
Ref: https://github.blog/2023-04-19-introducing-npm-package-provenance/
2023-05-13 19:34:01 +02:00
41d9424940 build(deps): update latest 2023-05-13 19:25:45 +02:00
41a0f1839f fix: safer (and correct) isUnauthorizedError 2023-04-02 23:32:28 +02:00
71e0d82655 fix: safer isUnauthorizedError type guard 2023-04-02 23:04:41 +02:00
03e8d51f9a fix: bump jsonwebtoken to v9.0.0
fixes #342

It introduces several security fixes to follow best practices.
2023-01-10 20:57:23 +01:00
bf234bd7b8 docs: client side usage, specify build in import 2022-09-09 12:10:12 +02:00
ff6a84a8e1 fix: publish updated README 2022-09-09 11:41:42 +02:00
c7c152a554 build(deps): update latest 2022-09-09 11:39:27 +02:00
7977c42c20 build(deps): bump npm from 8.10.0 to 8.12.0 (#338) 2022-07-25 12:52:11 +02:00
05b9eea638 build(deps): bump semver-regex from 3.1.3 to 3.1.4 (#339) 2022-07-25 12:51:59 +02:00
e14b456d9a build(deps-dev): bump semantic-release from 19.0.2 to 19.0.3 (#340) 2022-07-25 12:51:41 +02:00
f85595224f build(deps): update latest 2022-05-12 21:26:33 +02:00
1247a9b5f0 chore: remove codecov 2022-05-12 21:24:15 +02:00
9a942c52c5 style: fix linting issue 2022-04-07 10:14:52 +02:00
dbb363747d feat: usage of ESM modules imports (instead of CommonJS)
BREAKING CHANGE: This package is now pure ESM

BREAKING CHANGE: minimum supported Node.js >= 16.0.0
2022-04-07 10:11:48 +02:00
559ad8bd6d ci: avoid duplicate runs 2022-03-01 09:02:21 +01:00
e68ed3c432 fix: emit types declaration 2022-02-19 10:36:34 +01:00
26 changed files with 7859 additions and 17705 deletions

View File

@ -1,22 +1,15 @@
{ {
"extends": ["standard-with-typescript", "prettier"], "extends": ["conventions", "prettier"],
"plugins": ["unicorn", "import", "prettier"], "plugins": ["prettier", "import", "unicorn"],
"parser": "@typescript-eslint/parser",
"parserOptions": { "parserOptions": {
"project": "./tsconfig.json" "project": "./tsconfig.json"
}, },
"env": { "env": {
"node": true, "node": true
"jest": true
}, },
"rules": { "rules": {
"prettier/prettier": "error", "prettier/prettier": "error",
"import/order": [
"error",
{
"groups": ["builtin", "external", "internal"],
"newlines-between": "always"
}
],
"import/extensions": ["error", "always"], "import/extensions": ["error", "always"],
"unicorn/prefer-node-protocol": "error" "unicorn/prefer-node-protocol": "error"
} }

View File

@ -1,6 +1,6 @@
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. --> <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
## What changes this PR introduce? # What changes this PR introduce?
## List any relevant issue numbers ## List any relevant issue numbers

View File

@ -2,7 +2,7 @@ name: 'Build'
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
@ -10,16 +10,18 @@ jobs:
build: build:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
steps: steps:
- uses: 'actions/checkout@v2' - uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js' - name: 'Setup Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.8.1'
with: with:
node-version: 'lts/*' node-version: '20.x'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install dependencies'
run: 'npm install' run: 'npm clean-install'
- name: 'Build Package' - name: 'Build'
run: 'npm run build' run: 'npm run build'
- run: 'npm run build:typescript'

View File

@ -2,7 +2,7 @@ name: 'Lint'
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
@ -10,19 +10,19 @@ jobs:
lint: lint:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
steps: steps:
- uses: 'actions/checkout@v2' - uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js' - name: 'Setup Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.8.1'
with: with:
node-version: 'lts/*' node-version: '20.x'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install dependencies'
run: 'npm install' run: 'npm clean-install'
- run: 'npm run lint:commit -- --to "${{ github.sha }}"' - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
- run: 'npm run lint:editorconfig' - run: 'npm run lint:editorconfig'
- run: 'npm run lint:markdown' - run: 'npm run lint:markdown'
- run: 'npm run lint:typescript' - run: 'npm run lint:eslint'
- run: 'npm run lint:prettier' - run: 'npm run lint:prettier'

View File

@ -7,21 +7,31 @@ on:
jobs: jobs:
release: release:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
permissions:
contents: 'write'
issues: 'write'
pull-requests: 'write'
id-token: 'write'
steps: steps:
- uses: 'actions/checkout@v2' - uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js' - name: 'Setup Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.8.1'
with: with:
node-version: 'lts/*' node-version: '20.x'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install dependencies'
run: 'npm install' run: 'npm clean-install'
- name: 'Build Package' - name: 'Build Package'
run: 'npm run build' run: 'npm run build'
- run: 'npm run build:typescript'
- name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
run: 'npm audit signatures'
- name: 'Release' - name: 'Release'
run: 'npm run release' run: 'npm run release'
env: env:

View File

@ -2,7 +2,7 @@ name: 'Test'
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
@ -10,19 +10,19 @@ jobs:
test: test:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
steps: steps:
- uses: 'actions/checkout@v2' - uses: 'actions/checkout@v4.0.0'
- name: 'Use Node.js' - name: 'Setup Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.8.1'
with: with:
node-version: 'lts/*' node-version: '20.x'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install dependencies'
run: 'npm install' run: 'npm clean-install'
- name: 'Build'
run: 'npm run build'
- name: 'Test' - name: 'Test'
run: 'npm run test' run: 'npm run test'
- name: 'Upload Coverage'
uses: 'codecov/codecov-action@v2.1.0'

1
.gitignore vendored
View File

@ -10,6 +10,7 @@ build
# testing # testing
coverage coverage
.nyc_output
# debug # debug
npm-debug.log* npm-debug.log*

View File

@ -3,3 +3,4 @@
npm run lint:staged npm run lint:staged
npm run build npm run build
npm run build:typescript

View File

@ -1,10 +1,6 @@
{ {
"*": ["editorconfig-checker"], "*": ["editorconfig-checker"],
"*.{js,jsx,ts,tsx}": [ "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
"prettier --write",
"eslint --fix",
"jest --findRelatedTests"
],
"*.{json,jsonc,yml,yaml}": ["prettier --write"], "*.{json,jsonc,yml,yaml}": ["prettier --write"],
"*.{md}": ["prettier --write", "markdownlint --dot --fix"] "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
} }

11
.markdownlint-cli2.jsonc Normal file
View File

@ -0,0 +1,11 @@
{
"config": {
"extends": "markdownlint/style/prettier",
"relative-links": true,
"default": true,
"MD033": false
},
"globs": ["**/*.{md,mdx}"],
"ignores": ["**/node_modules"],
"customRules": ["markdownlint-rule-relative-links"]
}

View File

@ -1,7 +0,0 @@
{
"default": true,
"MD013": false,
"MD024": false,
"MD033": false,
"MD041": false
}

1
.npmrc
View File

@ -1 +1,2 @@
save-exact=true save-exact=true
provenance=true

15
.swcrc
View File

@ -1,22 +1,13 @@
{ {
"sourceMaps": true,
"jsc": { "jsc": {
"parser": { "parser": {
"syntax": "typescript", "syntax": "typescript",
"decorators": true,
"dynamicImport": true "dynamicImport": true
}, },
"transform": { "target": "esnext"
"legacyDecorator": true,
"decoratorMetadata": true
},
"target": "es2022",
"loose": true
}, },
"module": { "module": {
"type": "commonjs", "type": "es6"
"strict": false,
"strictMode": true,
"lazy": false,
"noInterop": false
} }
} }

View File

@ -6,5 +6,6 @@
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.codeActionsOnSave": { "editor.codeActionsOnSave": {
"source.fixAll": true "source.fixAll": true
} },
"eslint.options": { "ignorePath": ".gitignore" }
} }

View File

@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at reported to the community leaders responsible for enforcement at
contact@divlo.fr. <contact@theoludwig.fr>.
All complaints will be reviewed and investigated promptly and fairly. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the All community leaders are obligated to respect the privacy and security of the

View File

@ -21,7 +21,7 @@ All work on **Thream** happens directly on [GitHub](https://github.com/Thream).
- **Please first discuss** the change you wish to make via [issue](https://github.com/Thream/socketio-jwt/issues) before making a change. It might avoid a waste of your time. - **Please first discuss** the change you wish to make via [issue](https://github.com/Thream/socketio-jwt/issues) before making a change. It might avoid a waste of your time.
- Ensure your code respect `eslint` and `prettier`. - Ensure your code respect linting.
- Make sure your **code passes the tests**. - Make sure your **code passes the tests**.
@ -29,26 +29,4 @@ If you're adding new features to **Thream/socketio-jwt**, please include tests.
## Commits ## Commits
The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases. The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
### Types
Types define which kind of changes you made to the project.
| Types | Description |
| -------- | ------------------------------------------------------------------------------------------------------------ |
| feat | A new feature. |
| fix | A bug fix. |
| docs | Documentation only changes. |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). |
| refactor | A code change that neither fixes a bug nor adds a feature. |
| perf | A code change that improves performance. |
| test | Adding missing tests or correcting existing tests. |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm). |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
| chore | Other changes that don't modify src or test files. |
| revert | Reverts a previous commit. |
### Scopes
Scopes define what part of the code changed.

View File

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) Auth0, Inc. <support@auth0.com> (http://auth0.com) and Thream contributors Copyright (c) Auth0, Inc. <support@auth0.com> (<https://auth0.com/>) and Thream contributors
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@ -12,7 +12,6 @@
<a href="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml/badge.svg?branch=develop" /></a> <a href="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/build.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml/badge.svg?branch=develop" /></a> <a href="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml/badge.svg?branch=develop" /></a> <a href="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml"><img src="https://github.com/Thream/socketio-jwt/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
<a href="https://codecov.io/gh/Thream/socketio-jwt"><img src="https://codecov.io/gh/Thream/socketio-jwt/branch/develop/graph/badge.svg" alt="codecov" /></a>
<br /> <br />
<a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a> <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a> <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@ -23,9 +22,12 @@
Authenticate socket.io incoming connections with JWTs. Authenticate socket.io incoming connections with JWTs.
Compatible with `socket.io >= 3.0.0`. This repository was originally forked from [auth0-socketio-jwt](https://github.com/auth0-community/auth0-socketio-jwt) and it is not intended to take any credit but to improve the code from now on.
This repository was originally forked from [auth0-socketio-jwt](https://github.com/auth0-community/auth0-socketio-jwt) & it is not intended to take any credit but to improve the code from now on. ## Prerequisites
- [Node.js](https://nodejs.org/) >= 16.0.0
- [Socket.IO](https://socket.io/) >= 3.0.0
## 💾 Install ## 💾 Install
@ -129,7 +131,7 @@ io.on('connection', async (socket) => {
```ts ```ts
import { io } from 'socket.io-client' import { io } from 'socket.io-client'
import { isUnauthorizedError } from '@thream/socketio-jwt' import { isUnauthorizedError } from '@thream/socketio-jwt/build/UnauthorizedError.js'
// Require Bearer Token // Require Bearer Token
const socket = io('http://localhost:9000', { const socket = io('http://localhost:9000', {

View File

@ -1,10 +0,0 @@
{
"testEnvironment": "node",
"resolver": "jest-ts-webcompat-resolver",
"transform": {
"^.+\\.(t|j)sx?$": ["@swc/jest"]
},
"rootDir": "./src",
"collectCoverage": true,
"coverageDirectory": "../coverage/"
}

24594
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,26 +1,32 @@
{ {
"name": "@thream/socketio-jwt", "name": "@thream/socketio-jwt",
"version": "0.0.0-development", "version": "0.0.0-development",
"type": "module",
"public": true, "public": true,
"description": "Authenticate socket.io incoming connections with JWTs.", "description": "Authenticate socket.io incoming connections with JWTs.",
"license": "MIT", "license": "MIT",
"main": "build/index.js", "main": "build/index.js",
"types": "build/index.d.ts", "types": "build/index.d.ts",
"files": [ "files": [
"build" "build",
"!**/*.test.js",
"!**/*.test.d.ts",
"!**/*.map"
], ],
"engines": { "engines": {
"node": ">=12.0.0" "node": ">=16.0.0",
"npm": ">=9.0.0"
}, },
"publishConfig": { "publishConfig": {
"access": "public" "access": "public",
"provenance": true
}, },
"keywords": [ "keywords": [
"socket", "socket",
"socket.io", "socket.io",
"jwt" "jwt"
], ],
"author": "Divlo <contact@divlo.fr>", "author": "Théo LUDWIG <contact@theoludwig.fr>",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/Thream/socketio-jwt" "url": "https://github.com/Thream/socketio-jwt"
@ -30,14 +36,16 @@
}, },
"homepage": "https://github.com/Thream/socketio-jwt#readme", "homepage": "https://github.com/Thream/socketio-jwt#readme",
"scripts": { "scripts": {
"build": "rimraf ./build && swc ./src --out-dir ./build && tsc", "build": "rimraf ./build && swc ./src --out-dir ./build",
"build:dev": "swc ./src --out-dir ./build --watch",
"build:typescript": "tsc",
"lint:commit": "commitlint", "lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"", "lint:markdown": "markdownlint-cli2",
"lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"", "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"", "lint:prettier": "prettier . --check",
"lint:staged": "lint-staged", "lint:staged": "lint-staged",
"test": "jest", "test": "cross-env NODE_ENV=test node --enable-source-maps --test build/",
"release": "semantic-release", "release": "semantic-release",
"postinstall": "husky install", "postinstall": "husky install",
"prepublishOnly": "pinst --disable", "prepublishOnly": "pinst --disable",
@ -47,43 +55,39 @@
"socket.io": ">=3.0.0" "socket.io": ">=3.0.0"
}, },
"dependencies": { "dependencies": {
"jsonwebtoken": "8.5.1" "jsonwebtoken": "9.0.2"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "16.2.1", "@commitlint/cli": "17.7.1",
"@commitlint/config-conventional": "16.2.1", "@commitlint/config-conventional": "17.7.0",
"@swc/cli": "0.1.55", "@swc/cli": "0.1.62",
"@swc/core": "1.2.141", "@swc/core": "1.3.85",
"@swc/jest": "0.2.17", "@tsconfig/strictest": "2.0.2",
"@types/express": "4.17.13", "@types/jsonwebtoken": "9.0.3",
"@types/jest": "27.4.0", "@types/node": "20.6.2",
"@types/jsonwebtoken": "8.5.8", "@typescript-eslint/eslint-plugin": "6.7.2",
"@types/node": "17.0.18", "@typescript-eslint/parser": "6.7.2",
"@types/server-destroy": "1.0.1", "axios": "1.5.0",
"@typescript-eslint/eslint-plugin": "4.32.0", "cross-env": "7.0.3",
"axios": "0.26.0", "editorconfig-checker": "5.1.1",
"editorconfig-checker": "4.0.2", "eslint": "8.49.0",
"eslint": "7.32.0", "eslint-config-conventions": "11.0.1",
"eslint-config-prettier": "8.3.0", "eslint-config-prettier": "9.0.0",
"eslint-config-standard-with-typescript": "21.0.1", "eslint-plugin-import": "2.28.1",
"eslint-plugin-import": "2.25.4", "eslint-plugin-prettier": "5.0.0",
"eslint-plugin-node": "11.1.0", "eslint-plugin-promise": "6.1.1",
"eslint-plugin-prettier": "4.0.0", "eslint-plugin-unicorn": "48.0.1",
"eslint-plugin-promise": "5.2.0", "fastify": "4.23.2",
"eslint-plugin-unicorn": "40.1.0", "husky": "8.0.3",
"express": "4.17.3", "lint-staged": "14.0.1",
"husky": "7.0.4", "markdownlint-cli2": "0.10.0",
"jest": "27.5.1", "markdownlint-rule-relative-links": "2.1.0",
"jest-ts-webcompat-resolver": "1.0.0", "pinst": "3.0.0",
"lint-staged": "12.3.4", "prettier": "3.0.3",
"markdownlint-cli": "0.31.1", "rimraf": "5.0.1",
"pinst": "2.1.6", "semantic-release": "22.0.0",
"rimraf": "3.0.2", "socket.io": "4.7.2",
"semantic-release": "19.0.2", "socket.io-client": "4.7.2",
"server-destroy": "1.0.1", "typescript": "5.2.2"
"prettier": "2.5.1",
"socket.io": "4.4.1",
"socket.io-client": "4.4.1",
"typescript": "4.5.5"
} }
} }

View File

@ -4,7 +4,7 @@ export class UnauthorizedError extends Error {
constructor(code: string, error: { message: string }) { constructor(code: string, error: { message: string }) {
super(error.message) super(error.message)
this.message = error.message this.name = 'UnauthorizedError'
this.inner = error this.inner = error
this.data = { this.data = {
message: this.message, message: this.message,
@ -15,6 +15,16 @@ export class UnauthorizedError extends Error {
} }
} }
export const isUnauthorizedError = (error: any): error is UnauthorizedError => { export const isUnauthorizedError = (
return error.data.type === 'UnauthorizedError' error: unknown
): error is UnauthorizedError => {
return (
typeof error === 'object' &&
error != null &&
'data' in error &&
typeof error.data === 'object' &&
error.data != null &&
'type' in error.data &&
error.data.type === 'UnauthorizedError'
)
} }

View File

@ -1,194 +1,217 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import axios from 'axios' import axios from 'axios'
import type { Socket } from 'socket.io-client'
import { io } from 'socket.io-client' import { io } from 'socket.io-client'
import { isUnauthorizedError } from '../UnauthorizedError.js' import { isUnauthorizedError } from '../UnauthorizedError.js'
import type { Profile } from './fixture/index.js'
import { import {
API_URL,
fixtureStart, fixtureStart,
fixtureStop, fixtureStop,
getSocket, getSocket,
Profile basicProfile
} from './fixture/index.js' } from './fixture/index.js'
describe('authorize - with secret as string in options', () => { export const api = axios.create({
let token: string = '' baseURL: API_URL,
headers: {
beforeEach((done) => { 'Content-Type': 'application/json'
fixtureStart(async () => {
const response = await axios.post('http://localhost:9000/login')
token = response.data.token
})
.then(done)
.catch((error) => {
done(error)
})
})
afterEach((done) => {
fixtureStop(done)
})
it('should emit error with no token provided', (done) => {
const socket = io('http://localhost:9000')
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual('no token provided')
expect(error.data.code).toEqual('credentials_required')
} }
socket.close()
done()
})
})
it('should emit error with bad token format', (done) => {
const socket = io('http://localhost:9000', {
auth: { token: 'testing' }
})
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual(
'Format is Authorization: Bearer [token]'
)
expect(error.data.code).toEqual('credentials_bad_format')
}
socket.close()
done()
})
})
it('should emit error with unauthorized handshake', (done) => {
const socket = io('http://localhost:9000', {
auth: { token: 'Bearer testing' }
})
socket.on('connect_error', (error) => {
expect(isUnauthorizedError(error)).toBeTruthy()
if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual(
'Unauthorized: Token is missing or invalid Bearer'
)
expect(error.data.code).toEqual('invalid_token')
}
socket.close()
done()
})
})
it('should connect the user', (done) => {
const socket = io('http://localhost:9000', {
auth: { token: `Bearer ${token}` }
})
socket.on('connect', () => {
socket.close()
done()
})
socket.on('connect_error', (error) => {
done(error)
})
})
}) })
const secretCallback = async (): Promise<string> => { const secretCallback = async (): Promise<string> => {
return 'somesecret' return 'somesecret'
} }
describe('authorize - with secret as callback in options', () => { await test('authorize', async (t) => {
let token: string = '' await t.test('with secret as string in options', async (t) => {
let token = ''
let socket: Socket | null = null
beforeEach((done) => { t.beforeEach(async () => {
fixtureStart( await fixtureStart()
async () => { const response = await api.post('/login', {})
const response = await axios.post('http://localhost:9000/login')
token = response.data.token token = response.data.token
},
{ secret: secretCallback }
)
.then(done)
.catch((error) => {
done(error)
})
}) })
afterEach((done) => { t.afterEach(async () => {
fixtureStop(done) socket?.disconnect()
await fixtureStop()
}) })
it('should emit error with no token provided', (done) => { await t.test('should emit error with no token provided', () => {
const socket = io('http://localhost:9000') socket = io(API_URL)
socket.on('connect_error', (error) => { socket.on('connect_error', async (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual('no token provided') assert.strictEqual(error.data.message, 'no token provided')
expect(error.data.code).toEqual('credentials_required') assert.strictEqual(error.data.code, 'credentials_required')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
} }
socket.close() })
done() socket.on('connect', async () => {
assert.fail('should not connect')
}) })
}) })
it('should emit error with bad token format', (done) => { await t.test('should emit error with bad token format', () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: 'testing' } auth: { token: 'testing' }
}) })
socket.on('connect_error', (error) => { socket.on('connect_error', async (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual( assert.strictEqual(
error.data.message,
'Format is Authorization: Bearer [token]' 'Format is Authorization: Bearer [token]'
) )
expect(error.data.code).toEqual('credentials_bad_format') assert.strictEqual(error.data.code, 'credentials_bad_format')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
} }
socket.close() })
done() socket.on('connect', async () => {
assert.fail('should not connect')
}) })
}) })
it('should emit error with unauthorized handshake', (done) => { await t.test('should emit error with unauthorized handshake', () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: 'Bearer testing' } auth: { token: 'Bearer testing' }
}) })
socket.on('connect_error', (error) => { socket.on('connect_error', async (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual( assert.strictEqual(
error.data.message,
'Unauthorized: Token is missing or invalid Bearer' 'Unauthorized: Token is missing or invalid Bearer'
) )
expect(error.data.code).toEqual('invalid_token') assert.strictEqual(error.data.code, 'invalid_token')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
} }
socket.close() })
done() socket.on('connect', async () => {
assert.fail('should not connect')
}) })
}) })
it('should connect the user', (done) => { await t.test('should connect the user', () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: `Bearer ${token}` } auth: { token: `Bearer ${token}` }
}) })
socket.on('connect', () => { socket.on('connect', async () => {
socket.close() assert.ok(true)
done()
}) })
socket.on('connect_error', (error) => { socket.on('connect_error', async (error) => {
done(error) assert.fail(error.message)
}) })
}) })
}) })
describe('authorize - with onAuthentication callback in options', () => { await t.test('with secret as callback in options', async (t) => {
let token: string = '' let token = ''
let wrongToken: string = '' let socket: Socket | null = null
beforeEach((done) => { t.beforeEach(async () => {
fixtureStart( await fixtureStart({ secret: secretCallback })
async () => { const response = await api.post('/login', {})
const response = await axios.post('http://localhost:9000/login')
token = response.data.token token = response.data.token
const responseWrong = await axios.post( })
'http://localhost:9000/login-wrong'
t.afterEach(async () => {
socket?.disconnect()
await fixtureStop()
})
await t.test('should emit error with no token provided', () => {
socket = io(API_URL)
socket.on('connect_error', async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(error.data.message, 'no token provided')
assert.strictEqual(error.data.code, 'credentials_required')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
}
})
socket.on('connect', async () => {
assert.fail('should not connect')
})
})
await t.test('should emit error with bad token format', () => {
socket = io(API_URL, {
auth: { token: 'testing' }
})
socket.on('connect_error', async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(
error.data.message,
'Format is Authorization: Bearer [token]'
) )
wrongToken = responseWrong.data.token assert.strictEqual(error.data.code, 'credentials_bad_format')
}, assert.ok(true)
{ } else {
assert.fail('should be unauthorized error')
}
})
socket.on('connect', async () => {
assert.fail('should not connect')
})
})
await t.test('should emit error with unauthorized handshake', () => {
socket = io(API_URL, {
auth: { token: 'Bearer testing' }
})
socket.on('connect_error', async (error) => {
assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) {
assert.strictEqual(
error.data.message,
'Unauthorized: Token is missing or invalid Bearer'
)
assert.strictEqual(error.data.code, 'invalid_token')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
}
})
socket.on('connect', async () => {
assert.fail('should not connect')
})
})
await t.test('should connect the user', () => {
socket = io(API_URL, {
auth: { token: `Bearer ${token}` }
})
socket.on('connect', async () => {
assert.ok(true)
})
socket.on('connect_error', async (error) => {
assert.fail(error.message)
})
})
})
await t.test('with onAuthentication callback in options', async (t) => {
let token = ''
let wrongToken = ''
let socket: Socket | null = null
t.beforeEach(async () => {
await fixtureStart({
secret: secretCallback, secret: secretCallback,
onAuthentication: (decodedToken: Profile) => { onAuthentication: (decodedToken: Profile) => {
if (!decodedToken.checkField) { if (!decodedToken.checkField) {
@ -198,102 +221,120 @@ describe('authorize - with onAuthentication callback in options', () => {
email: decodedToken.email email: decodedToken.email
} }
} }
}
)
.then(done)
.catch((error) => {
done(error)
}) })
const response = await api.post('/login', {})
token = response.data.token
const responseWrong = await api.post('/login-wrong', {})
wrongToken = responseWrong.data.token
}) })
afterEach((done) => { t.afterEach(async () => {
fixtureStop(done) socket?.disconnect()
await fixtureStop()
}) })
it('should emit error with no token provided', (done) => { await t.test('should emit error with no token provided', () => {
const socket = io('http://localhost:9000') socket = io(API_URL)
socket.on('connect_error', (error) => { socket.on('connect_error', async (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual('no token provided') assert.strictEqual(error.data.message, 'no token provided')
expect(error.data.code).toEqual('credentials_required') assert.strictEqual(error.data.code, 'credentials_required')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
} }
socket.close() })
done() socket.on('connect', async () => {
assert.fail('should not connect')
}) })
}) })
it('should emit error with bad token format', (done) => { await t.test('should emit error with bad token format', () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: 'testing' } auth: { token: 'testing' }
}) })
socket.on('connect_error', (error) => { socket.on('connect_error', async (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual( assert.strictEqual(
error.data.message,
'Format is Authorization: Bearer [token]' 'Format is Authorization: Bearer [token]'
) )
expect(error.data.code).toEqual('credentials_bad_format') assert.strictEqual(error.data.code, 'credentials_bad_format')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
} }
socket.close() })
done() socket.on('connect', async () => {
assert.fail('should not connect')
}) })
}) })
it('should emit error with unauthorized handshake', (done) => { await t.test('should emit error with unauthorized handshake', () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: 'Bearer testing' } auth: { token: 'Bearer testing' }
}) })
socket.on('connect_error', (error) => { socket.on('connect_error', async (error) => {
expect(isUnauthorizedError(error)).toBeTruthy() assert.strictEqual(isUnauthorizedError(error), true)
if (isUnauthorizedError(error)) { if (isUnauthorizedError(error)) {
expect(error.data.message).toEqual( assert.strictEqual(
error.data.message,
'Unauthorized: Token is missing or invalid Bearer' 'Unauthorized: Token is missing or invalid Bearer'
) )
expect(error.data.code).toEqual('invalid_token') assert.strictEqual(error.data.code, 'invalid_token')
assert.ok(true)
} else {
assert.fail('should be unauthorized error')
} }
socket.close() })
done() socket.on('connect', async () => {
assert.fail('should not connect')
}) })
}) })
it('should connect the user', (done) => { await t.test('should connect the user', () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: `Bearer ${token}` } auth: { token: `Bearer ${token}` }
}) })
socket.on('connect', () => { socket.on('connect', async () => {
socket.close() assert.ok(true)
done() })
socket.on('connect_error', async (error) => {
assert.fail(error.message)
}) })
}) })
it('should contain user property', (done) => { await t.test('should contains user properties', () => {
const socketServer = getSocket() const socketServer = getSocket()
socketServer?.on('connection', (client: any) => { socketServer?.on('connection', (client: any) => {
expect(client.user.email).toEqual('john@doe.com') assert.strictEqual(client.user.email, basicProfile.email)
assert.ok(true)
}) })
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: `Bearer ${token}` } auth: { token: `Bearer ${token}` }
}) })
socket.on('connect', () => { socket.on('connect_error', async (error) => {
socket.close() assert.fail(error.message)
done()
}) })
}) })
it('should emit error when user validation fails', (done) => { await t.test('should emit error when user validation fails', () => {
const socket = io('http://localhost:9000', { socket = io(API_URL, {
auth: { token: `Bearer ${wrongToken}` } auth: { token: `Bearer ${wrongToken}` }
}) })
socket.on('connect_error', (err: any) => { socket.on('connect_error', async (error) => {
try { try {
expect(err.message).toEqual('Check Field validation failed') assert.strictEqual(error.message, 'Check Field validation failed')
} catch (err) { assert.ok(true)
socket.close() } catch {
done(err) assert.fail(error.message)
} }
socket.close() })
done() socket.on('connect', async () => {
assert.fail('should not connect')
})
}) })
}) })
}) })

View File

@ -1,42 +1,43 @@
import type { Server as HttpServer } from 'node:http'
import type { Server as HttpsServer } from 'node:https'
import express from 'express'
import jwt from 'jsonwebtoken' import jwt from 'jsonwebtoken'
import { Server as SocketIoServer } from 'socket.io' import { Server as SocketIoServer } from 'socket.io'
import enableDestroy from 'server-destroy' import type { FastifyInstance } from 'fastify'
import fastify from 'fastify'
import { authorize, AuthorizeOptions } from '../../index.js' import type { AuthorizeOptions } from '../../index.js'
import { authorize } from '../../index.js'
export interface Profile { interface FastifyIo {
instance: SocketIoServer
}
declare module 'fastify' {
export interface FastifyInstance {
io: FastifyIo
}
}
export interface BasicProfile {
email: string email: string
id: number id: number
}
export interface Profile extends BasicProfile {
checkField: boolean checkField: boolean
} }
interface Socket { export const PORT = 9000
io: null | SocketIoServer export const API_URL = `http://localhost:${PORT}`
init: (httpServer: HttpServer | HttpsServer) => void export const basicProfile: BasicProfile = {
email: 'john@doe.com',
id: 123
} }
const socket: Socket = { let application: FastifyInstance | null = null
io: null,
init(httpServer) {
socket.io = new SocketIoServer(httpServer)
}
}
let server: HttpServer | null = null
export const fixtureStart = async ( export const fixtureStart = async (
done: any,
options: AuthorizeOptions = { secret: 'super secret' } options: AuthorizeOptions = { secret: 'super secret' }
): Promise<void> => { ): Promise<void> => {
const profile: Profile = { const profile: Profile = { ...basicProfile, checkField: true }
email: 'john@doe.com',
id: 123,
checkField: true
}
let keySecret = '' let keySecret = ''
if (typeof options.secret === 'string') { if (typeof options.secret === 'string') {
keySecret = options.secret keySecret = options.secret
@ -46,35 +47,37 @@ export const fixtureStart = async (
payload: profile payload: profile
}) })
} }
const app = express() application = fastify()
app.use(express.json()) application.post('/login', async (_request, reply) => {
app.post('/login', (_req, res) => {
const token = jwt.sign(profile, keySecret, { const token = jwt.sign(profile, keySecret, {
expiresIn: 60 * 60 * 5 expiresIn: 60 * 60 * 5
}) })
return res.json({ token }) reply.statusCode = 201
return { token }
}) })
app.post('/login-wrong', (_req, res) => { application.post('/login-wrong', async (_request, reply) => {
profile.checkField = false profile.checkField = false
const token = jwt.sign(profile, keySecret, { const token = jwt.sign(profile, keySecret, {
expiresIn: 60 * 60 * 5 expiresIn: 60 * 60 * 5
}) })
return res.json({ token }) reply.statusCode = 201
return { token }
})
const instance = new SocketIoServer(application.server)
instance.use(authorize(options))
application.decorate('io', { instance })
application.addHook('onClose', (fastify) => {
fastify.io.instance.close()
})
await application.listen({
port: PORT
}) })
server = app.listen(9000, done)
socket.init(server)
socket.io?.use(authorize(options))
enableDestroy(server)
} }
export const fixtureStop = (callback: Function): void => { export const fixtureStop = async (): Promise<void> => {
socket.io?.close() await application?.close()
try {
server?.destroy()
} catch {}
callback()
} }
export const getSocket = (): SocketIoServer | null => { export const getSocket = (): SocketIoServer | undefined => {
return socket.io return application?.io.instance
} }

View File

@ -1,5 +1,6 @@
import jwt, { Algorithm } from 'jsonwebtoken' import type { Algorithm } from 'jsonwebtoken'
import { Socket } from 'socket.io' import jwt from 'jsonwebtoken'
import type { Socket } from 'socket.io'
import { UnauthorizedError } from './UnauthorizedError.js' import { UnauthorizedError } from './UnauthorizedError.js'
@ -61,7 +62,7 @@ export const authorize = (options: AuthorizeOptions): SocketIOMiddleware => {
} }
socket.encodedToken = encodedToken socket.encodedToken = encodedToken
let keySecret: string | null = null let keySecret: string | null = null
let decodedToken: any let decodedToken: any = null
if (typeof secret === 'string') { if (typeof secret === 'string') {
keySecret = secret keySecret = secret
} else { } else {

View File

@ -1,14 +1,13 @@
{ {
"extends": "@tsconfig/strictest/tsconfig.json",
"compilerOptions": { "compilerOptions": {
"target": "ESNext", "target": "ESNext",
"module": "commonjs",
"lib": ["ESNext"], "lib": ["ESNext"],
"moduleResolution": "node", "module": "NodeNext",
"moduleResolution": "NodeNext",
"outDir": "./build", "outDir": "./build",
"rootDir": "./src", "rootDir": "./src",
"noEmit": true, "emitDeclarationOnly": true,
"strict": true, "declaration": true
"skipLibCheck": true,
"esModuleInterop": true
} }
} }