Communityコーディング&開発github.com

socketio-docs

公式Socket.IO v4ドキュメントに基づいて、Socket.IO 4.8サーバーとクライアントの構築、設定、デバッグを行います。Node.jsのSocket.IOサーバー(Express、Fastify、Koa、Bun、uWebSockets.js)やsocket.io-clientアプリを作成する際に使用します。

socketio-docs とは?

このスキルは、Socket.IO 4.8に関する、間違えやすいルールや落とし穴を網羅した包括的なリファレンスです。開発者は、ソケットIDの扱い、リスナーの重複登録、タイムアウト付き確認応答のコールバック形状の変化など、よくある問題を回避できます。CORS設定、リバースプロキシ、スティッキーセッション、RedisやPostgreSQLなどのアダプターによるスケーリング、接続状態の復旧、テスト、移行(v2/v3 → v4)など、実運用に即したトピックをカバーしています。各ルールには公式ドキュメントのURLが明記されており、信頼性が高く、Claude Code、Coder、Cursor、CodexなどのAIエージェントでの利用に最適化されています。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/quentin-autret/claude-skills/tree/main/skills/socketio-docs

Installed? Explore more コーディング&開発 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

Socket.IO 4.8

概要

このスキルには、Socket.IO 4.8の間違えやすいルールがまとめられています。一時的なsocket.idをユーザーキーとして使ってしまう、リスナーが二重登録される、timeout()で確認応答のコールバックの形状が変わる、CORSがWebSocketを保護しない、ロードバランサー配下でスティッキーセッションを忘れる、v2やv3のAPIが動作しなくなる――こうした落とし穴を避けるための情報が詰まっています。すべての主張には、その根拠となるページURLが付記されています。参照ファイルには各ドメインの詳細が含まれています。

対象バージョン

Socket.IO 4.8(サーバー socket.io、クライアント socket.io-client)、ドキュメント v4。JS クライアント 3.x および 4.x は、サーバー 3.x および 4.x と通信できます。https://socket.io/docs/v4/client-installation/#version-compatibility

クイックスタート

  • 作成したHTTPサーバーにSocket.IOをアタッチし、そのサーバーに対してlistenを呼び出します。Expressのappに対してlistenを呼び出してはいけません。app.listen()は別のHTTPサーバーを作成し、Socket.IOはそのサーバーにアタッチされません。https://socket.io/docs/v4/server-initialization/#with-express
import express from "express";
import { createServer } from "node:http";
import { Server } from "socket.io";

const app = express();
const httpServer = createServer(app);
const io = new Server(httpServer, { cors: { origin: ["https://example.com"] } });

io.on("connection", (socket) => {
  socket.on("hello", (arg, callback) => callback("got it"));
});

httpServer.listen(3000);

https://socket.io/docs/v4/server-initialization/#with-express

import { io } from "socket.io-client";
const socket = io("https://server-domain.com", { auth: { token: "abc" } });
const answer = await socket.timeout(5000).emitWithAck("hello", "world");

https://socket.io/docs/v4/client-api/#socketemitwithackeventname-args

ルールと落とし穴

接続と識別

  • Socket.IOはWebSocketの実装ではありません。プレーンなWebSocketクライアントはSocket.IOサーバーに接続できず、Socket.IOクライアントはプレーンなWebSocketサーバーに接続できません。https://socket.io/docs/v4/#what-socketio-is-not
  • 接続状態の復旧が有効でない限り、socket.idは再接続やページ更新のたびに変更され、タブごとに異なり、メッセージキューもありません。ユーザーを識別するには、Cookieやauthで送信する独自のセッションIDを使用し、ユーザーのすべてのタブにリーチするには、ユーザーIDを名前としたルームに参加させます。https://socket.io/docs/v4/server-socket-instance/#socketid
io.on("connection", async (socket) => {
  const userId = await computeUserIdFromHeaders(socket.handshake.headers);
  socket.join(userId);
  io.to(userId).emit("hi");
});

https://socket.io/docs/v4/rooms/#sample-use-cases

  • 接続ミドルウェアでの認証はsocket.handshake.authを使用します。すべてのコードパスでnext()を呼び出さないと、接続はタイムアウトで閉じられるまでハングしたままになります。next(err)はconnect_errorとしてクライアントに到達し、err.dataで詳細を伝えます。https://socket.io/docs/v4/middlewares/
io.use((socket, next) => {
  if (isValid(socket.handshake.auth.token)) return next();
  const err = new Error("not authorized");
  err.data = { content: "Please retry later" };
  next(err);
});

https://socket.io/docs/v4/middlewares/#handling-middleware-error

イベントと確認応答

const responses = await io.timeout(10000).emitWithAck("some-event");

https://socket.io/docs/v4/server-api/#serveremitwithackeventname-args

  • リスナーには組み込みのエラーハンドリングやバリデーションはありません。各ハンドラでエラーをキャッチし、スキーマライブラリでペイロードを検証し、コールバックを使用する前にtypeof callback === "function"を確認してください。https://socket.io/docs/v4/listening-to-events/#validation
  • connect、connect_error、disconnect、disconnecting、newListener、removeListenerをアプリケーションイベントとして決して使用しないでください。socket.emit("disconnecting")のように予約名を発行するとエラーがスローされます。https://socket.io/docs/v4/emit-cheatsheet/

ブロードキャストとルーム

配信

  • デフォルトの保証は「最大1回」であり、サーバーはメッセージを保存しません。切断されたクライアントは、ブロードキャストを永久に失います。authで送信されたオフセットを使用してデータベースからリプレイするか、接続状態の復旧を有効にしてください。https://socket.io/docs/v4/delivery-guarantees#at-most-once
  • クライアントはオフライン中にemitをバッファリングし、再接続時にフラッシュします。socket.connectedを確認するか、破棄しても問題のないデータにはsocket.volatile.emit(...)を使用してください。https://socket.io/docs/v4/client-offline-behavior/#buffered-events
  • クライアントからサーバーへの「最低1回」の配信: io({ retries: 3, ackTimeout: 10000 })。厳密に1回の場合は、一意制約のもとでクライアント生成のIDを保存します。成功時と重複時には確認応答を返し、それ以外のエラーでは確認応答を返さないようにすることで、クライアントをタイムアウトさせて再試行させます。https://socket.io/docs/v4/tutorial/step-8
  • 接続状態の復旧はオプトイン方式で、上限のあるmaxDisconnectionDurationが必要であり、失敗する可能性があります。socket.recoveredで分岐してください。Redis (Pub/Sub) アダプターはこの機能をサポートしておらず、Redis Streams アダプターはサポートしています。https://socket.io/docs/v4/connection-state-recovery
const io = new Server(httpServer, {
  connectionStateRecovery: { maxDisconnectionDuration: 2 * 60 * 1000, skipMiddlewares: false },
});

https://socket.io/docs/v4/connection-state-recovery#usage

CORSとデプロイメント

参照ファイル

ファイル参照先
references/server-setup.mdインストール、Express、Koa、Fastify、Hono、HTTPS、HTTP/2、Bun、uWebSockets.jsによる初期化、サーバーオプションとデフォルト値、バンドル、ハンドラのレイアウト
references/middleware-and-auth.md接続、ソケットおよびエンジンミドルウェア、資格情報、ユーザー識別、ヘッダーフック、allowRequest、クライアント証明書
references/cors-and-proxies.mdCORSオプションとエラー、Cookie、nginx、Apache、Caddy、http-proxy、クラウドロードバランサー、wsとのポート共有
references/server-api.mdServerおよびSocketインスタンス、io上の名前空間、ユーティリティメソッド、serverSideEmit、切断理由、エンジンイベントとエラーコード、クローズ
references/client.mdバンドル、初期化、Socketイベント、connect_errorとdisconnect、Managerと多重化、すべてのクライアントオプション、バンドラー
references/events-rooms-namespaces.mdシリアライゼーション、確認応答、キャッチオールリスナー、バリデーション、エラーハンドリング、ブロードキャスト、ルーム、動的な名前空間
references/delivery-and-recovery.md配信保証、再試行、厳密に1回、オフセットリプレイ、接続状態の復旧
references/multiple-nodes.mdスティッキーセッション、複数ノードのプロキシ設定、代替案、Node.jsクラスタ、PM2
references/adapters.mdRedis、シャード化Redis、Redis Streams、Postgres、MongoDB、Cluster、AWS SQS、Azure、GCPアダプター、機能マトリックス、エミッター
references/performance-and-operations.mdネイティブアドオン、wsEngine、メモリ、カスタムパーサー、OS制限、負荷テスト、Admin UI、デバッグログ
references/typescript.mdサーバー、クライアント、名前空間でのイベントインターフェース、SocketData、型付きテスト
references/testing-and-troubleshooting.mdサーバー統合テスト、フェイクソケットを使ったクライアントテスト、接続失敗、切断、ロングポーリングのスタック
references/migrations-and-protocol.mdv2からv3、v3からv4の変更点、allowEIO3を使ったローリングアップグレード、Engine.IOおよびSocket.IOワイヤープロトコル

古いパターン

古い使用法新しい使用法ソース
origins または handlePreflightRequest オプションcors: { origin: [...] }https://socket.io/docs/v4/migrating-from-2-x-to-3-0/#cors-handling
io.set("authorization", fn)io.use((socket, next) => ...)https://socket.io/docs/v4/migrating-from-2-x-to-3-0/#ioset-is-removed
Socketのqueryオプション内のトークンauthオプション、socket.handshake.authとして読み取るhttps://socket.io/docs/v4/migrating-from-2-x-to-3-0/
接続拒否時のクライアントerrorイベントconnect_error、err.messageとerr.dataを伴うhttps://socket.io/docs/v4/migrating-from-2-x-to-3-0/
Socket上のsocket.on("reconnect_attempt")Manager上のsocket.io.on("reconnect_attempt")https://socket.io/docs/v4/client-socket-instance/#events
レイテンシ取得のためのクライアントpongイベントインターバルでのsocket.volatile.emit("ping", cb)https://socket.io/docs/v4/migrating-from-2-x-to-3-0/#no-more-pong-event-for-retrieving-latency
Namespace.connected オブジェクトNamespace.sockets(Map)https://socket.io/docs/v4/migrating-from-2-x-to-3-0/
Object.keys(socket.rooms)socket.roomsはSethttps://socket.io/docs/v4/migrating-from-2-x-to-3-0/
socket.join(room, cb)socket.join(room)、非同期アダプターでawaithttps://socket.io/docs/v4/migrating-from-2-x-to-3-0/
Namespace.clients(cb)(v2)、次にallSockets()(v3、次のメジャーで削除予定)fetchSockets()https://socket.io/docs/v4/server-api/#namespaceallsockets
socket.binary(false)カスタムparserhttps://socket.io/docs/v4/migrating-from-2-x-to-3-0/
socket.emit("a").emit("b")個別の呼び出し、emit()はtrueを返すhttps://socket.io/docs/v4/migrating-from-2-x-to-3-0/
socket.ioまたはsocket.io-clientのデフォルトインポート名前付きインポート(import { Server } from "socket.io"、import { io } from "socket.io-client")https://socket.io/docs/v4/migrating-from-2-x-to-3-0/
io.of("/").adapter(v4)変更なし

Individual skills in this repo

This repo contains 16 individual skills — each has its own dedicated page.

eslint-docs

Teaches current ESLint 10 practices drawn from the official documentation. Use when writing, reviewing or fixing an eslint.config.js (flat config, defineConfig, files, ignores, globalIgnores, extends, languageOptions, globals, parsers, processors), configuring ESLint rules and severities, disable comments and inline config, running the CLI in CI (--fix, --cache, --quiet, --max-warnings, bulk suppressions, formatters, feature flags, MCP server), writing custom rules (meta, schema, fixes, suggestions, selectors, scope, code paths) and testing them with RuleTester, building plugins, shareable configs, custom parsers, processors or formatters, using the Node.js API (ESLint, Linter), or migrating to ESLint 9 or 10 from eslintrc. Triggers on eslint, eslint.config.js, flat config, .eslintrc, .eslintignore, @eslint/js, js/recommended, eslint-disable, no-unused-vars, no-restricted-imports, no-restricted-syntax, RuleTester, eslint-plugin, eslint-config, FlatCompat, context.getScope is not a function, ESLint 10.

grafana-cloud-docs

Grafana Cloud pitfalls, defaults, limits and current patterns from the Grafana, Mimir, Loki and Tempo docs, each tied to its docs URL. Use when sending OpenTelemetry data to Grafana Cloud, writing PromQL, LogQL or TraceQL, controlling cardinality and cost, designing alert rules, routing notifications, provisioning alerting, building Synthetic Monitoring checks, using the /apis dashboard API, choosing access policy tokens or service accounts, or migrating off API keys, the Loki Exporter and legacy /api routes.

javascript-docs

Teaches current JavaScript (ECMAScript) practice drawn from the MDN JavaScript documentation. Use when writing, reviewing or fixing modern JavaScript, choosing a built-in API, or replacing a deprecated pattern. Covers equality and coercion, let/const and the temporal dead zone, strict mode, ASI, functions, classes and private fields, objects, prototypes, Proxy, Reflect, Symbol, eval, operators (??, ?., spread, BigInt arithmetic), statements, Promise, async/await, Promise.try, iterators and iterator helpers, generators, using/await using, DisposableStack, WeakRef, Array (toSorted, at, groupBy, fromAsync), Map, Set methods, WeakMap, strings and Unicode, encodeURIComponent, RegExp (v flag, RegExp.escape, lastIndex), Number, Math, BigInt, JSON (rawJSON, revivers), typed arrays, ArrayBuffer, base64, SharedArrayBuffer, Atomics, Temporal, Date, Intl (DateTimeFormat, NumberFormat, Collator, Segmenter, PluralRules), errors (cause, Error.isError), ES modules, import attributes, import.meta, dynamic import.

next-intl-docs

Teaches current next-intl 4 practices for internationalizing Next.js apps, drawn from the official documentation. Use when setting up next-intl with the App Router, writing i18n/request.ts, adding a [locale] segment with defineRouting, createMiddleware in proxy.ts (formerly middleware.ts), building locale switchers with createNavigation, translating with useTranslations or getTranslations, passing messages to NextIntlClientProvider, writing ICU messages (plurals, select, rich text), formatting dates, numbers and lists with useFormatter, translating metadata, Server Actions, Route Handlers, localized 404 and error pages, static rendering with next/root-params, type-safe messages through AppConfig, testing with Jest, Vitest, Storybook, or extracting inline messages with useExtracted. Triggers on next-intl, useTranslations, getTranslations, NextIntlClientProvider, getRequestConfig, i18n routing, locale prefix, localePrefix, NEXT_LOCALE, hreflang, setRequestLocale, ICU messages, App Router internationalization.

nodejs-docs

Teaches Node.js practice drawn from the official Node.js API documentation, with pitfalls, surprising defaults, deprecations and replacements, each backed by its nodejs.org URL. Use when writing, reviewing, debugging or upgrading Node.js code, or choosing a built-in module (fs, crypto, streams, http, process, CLI flags, node:test, ESM/CommonJS, package.json exports, TypeScript type stripping, child_process, worker_threads, node:sqlite, deprecations).

playwright-docs

Pitfalls, surprising defaults and recommended patterns of Playwright Test for JavaScript and TypeScript, distilled from the official docs. Use when writing, reviewing, debugging or configuring Playwright tests (@playwright/test, playwright.config.ts, npx playwright test), including flaky tests, locators (getByRole, filter, strict mode), web-first assertions (expect, toHaveText, toBeVisible, expect.poll, toPass), fixtures, storageState authentication, project dependencies, timeouts, retries, network mocking (page.route, routeFromHAR, routeWebSocket), API testing, clock, aria snapshots, toHaveScreenshot, axe accessibility scans, traces, UI mode, reporters, CI, Docker, sharding, test locks, component testing with stories and mount, codegen, Playwright MCP, playwright-cli and migration from Puppeteer, Protractor, Testing Library or older Playwright versions.

postgresql-docs

Pitfalls, surprising defaults, PostgreSQL 18 changes and recommended patterns from the official PostgreSQL 18 documentation, each backed by its postgresql.org URL. Use when writing or reviewing PostgreSQL SQL, schema design, migrations and ALTER TABLE locks, indexes, transactions, isolation levels and retries, locking, upsert and MERGE, COPY, JSONB, timestamptz, generated and identity columns, partitioning, EXPLAIN, vacuum, roles, row-level security, PL/pgSQL, full-text search, connection settings, and upgrades to PostgreSQL 18.

react-docs

Writes, reviews and upgrades React 19.3 code from the official react.dev documentation. Use when writing components and Hooks, removing unnecessary useEffect calls, fixing Effect dependencies with useEffectEvent, building forms with Actions (useActionState, useOptimistic, useFormStatus, form action), using Server Components, 'use client', 'use server' and Server Functions, Suspense, use(), useTransition, useDeferredValue, ViewTransition, Activity, adopting React Compiler and eslint-plugin-react-hooks, deciding on useMemo, useCallback and memo, server rendering and hydration (createRoot, hydrateRoot, renderToPipeableStream, prerender), or migrating from React 18 (forwardRef, Context.Provider, ReactDOM.render, propTypes, defaultProps). Triggers on React, JSX, hooks, useState, useEffect, useRef, useContext, Server Components, RSC, Actions, React Compiler, Strict Mode, hydration mismatch, React 19 upgrade.

rust-std-docs

Gives current guidance from the official Rust standard library docs (std 1.99.1 stable) on pitfalls, panics, platform differences, discouraged APIs and newer stable replacements. Use when writing, reviewing or refactoring Rust code that uses std, especially collections (Vec, HashMap, BTreeMap, BinaryHeap, entry, extract_if, sort), Option/Result/error handling (expect, ?, Error, ExitCode, panic), iterators (collect, flatten, Peekable, try_fold), Box/Rc/RefCell/Cow/Pin/mem::take, Arc/Mutex/RwLock/OnceLock/LazyLock/thread::scope/mpsc/Condvar/atomics, String/str/fmt/format!/OsString/CString, io/fs/path (BufWriter, OpenOptions, PathBuf::join), process/env/net/time (Command, set_var, TcpStream, Instant, Duration), From/TryFrom/AsRef/Ord/Drop/Deref/Clone, and unsafe raw pointers, MaybeUninit, transmute, NonNull or integer overflow and float ordering.

tailwindcss-docs

Teaches current Tailwind CSS v4 practices drawn from the official documentation. Use for any task that touches Tailwind CSS v4, even a small one, because many v3 habits silently break in v4. Use when writing or reviewing Tailwind CSS v4 code (utility classes, variants, arbitrary values, theme variables in @theme, @utility, @custom-variant, @apply, @reference, @source), setting up Tailwind in a framework or build tool (Vite plugin, PostCSS plugin, CLI, Next.js, SvelteKit, Nuxt, Angular, Laravel, Rails), customizing the theme (colors, fonts, breakpoints, spacing, animations), building dark mode with a class or data attribute, or migrating a project from Tailwind v3 (tailwind.config.js, @tailwind directives, darkMode class, safelist, bg-opacity, renamed shadow and outline utilities). Triggers on tailwindcss, @import "tailwindcss", @tailwindcss/vite, @tailwindcss/postcss, @tailwindcss/cli, @theme, @custom-variant dark, npx @tailwindcss/upgrade, upgrade to Tailwind v4.

tauri-docs

Tauri 2 apps, tauri.conf.json, capabilities and permissions, commands and invoke, events and channels, plugins, bundling, signing and the updater, migration from Tauri 1. Guides Tauri 2 work from the official v2 documentation, including scopes, managed state, plugin authoring, CSP and the isolation pattern, testing and debugging, Linux, Windows and macOS packages, and mobile and store releases. Use when writing or reviewing a Tauri 2 app, adding a plugin or a capability, fixing a "not allowed" or "forbidden path" error, wiring IPC between Rust and the webview, packaging, signing or publishing a desktop or mobile build, or upgrading a Tauri 1 or 2.0 beta project.

tokio-docs

Gives current guidance from the official tokio documentation (tokio 1.54.1) on async Rust pitfalls, cancel safety, blocking code, surprising defaults and deprecated APIs. Use when writing, reviewing or debugging async Rust code that uses tokio, especially the runtime (#[tokio::main], #[tokio::test], Builder, enable_all, block_on, current_thread, LocalRuntime, shutdown, feature flags), tasks (spawn, JoinHandle, JoinSet, abort, spawn_blocking, block_in_place, LocalSet, spawn_local, task_local), select!, join!, try_join!, cancellation and graceful shutdown, sync primitives (Mutex across .await, RwLock, Semaphore, Notify, OnceCell), channels (mpsc backpressure, oneshot, broadcast lag, watch), time (sleep, interval, MissedTickBehavior, timeout, paused time, start_paused), I/O and networking (AsyncReadExt, BufWriter flush, split, io::copy, framing, TcpListener, TcpStream, UdpSocket), tokio::fs, process (Command, kill_on_drop, Child), signals (ctrl_c, Windows console events) and Windows named pipes.

typescript-docs

Configures, writes and upgrades TypeScript 6.0 code and tsconfig.json from the official TypeScript documentation. Use when upgrading from TypeScript 5.x to 6.0 (strict, types, rootDir, baseUrl, moduleResolution node, target es5, outFile, esModuleInterop), choosing module and moduleResolution, writing package.json exports and imports, fixing ESM and CommonJS interop, enabling verbatimModuleSyntax or erasableSyntaxOnly, setting up project references and tsc --build, writing .d.ts files, checking JavaScript with JSDoc, or debugging narrowing, generics, mapped types, decorators and enums. Triggers on TypeScript, tsc, tsconfig, TS5112, ignoreDeprecations, nodenext, bundler, .d.ts, @ts-check, TypeScript 6 upgrade.

typesense-docs

Pitfalls, surprising defaults and recommended patterns of the Typesense search engine, distilled from the official docs. Use when designing a Typesense collection schema, writing search parameters (q, query_by, filter_by, sort_by, facet_by, group_by), tuning typo tolerance and ranking, building vector, semantic or hybrid search, conversational RAG or natural language search, creating API keys and scoped search keys for multi-tenancy, indexing and import (JSONL, upsert, emplace, dirty_values), syncing from a primary database, reindexing through aliases, managing synonyms (synonym sets), curation sets and stopwords, joins, analytics rules and query suggestions, InstantSearch, migrating from Algolia, or running, clustering, backing up and upgrading a Typesense server.

vite-docs

Teaches current Vite 8 practices drawn from the official documentation. Use when writing or fixing a vite.config, migrating from Vite 7 (Rolldown and Oxc replacing Rollup and esbuild), configuring the dev server, proxy or HMR, handling import.meta.env and modes, tuning the production build, library mode, SSR, writing a Vite plugin, using the HMR or JavaScript API, or the Environment API. Triggers on vite.config, defineConfig, rolldownOptions, import.meta.env, loadEnv, optimizeDeps, ssrLoadModule, ModuleRunner, this.environment, upgrade to Vite 8.

vitest-docs

Teaches current Vitest 5 practices drawn from the official documentation. Use when writing, reviewing or fixing Vitest tests (test, describe, expect, test.for, fixtures with test.extend, hooks, snapshots), mocking with vi (vi.fn, vi.spyOn, vi.mock, vi.when, fake timers, stubGlobal, stubEnv), configuring vitest.config or projects, choosing an environment or pool, filtering and running tests in CI, measuring coverage with v8 or istanbul, debugging slow or flaky suites, testing components in browser mode with Playwright, or migrating from Jest, Mocha or Vitest 4. Triggers on vitest, vi.mock, vi.fn, vitest.config, toMatchSnapshot, expect.poll, coverage thresholds, browser mode, @vitest/browser-playwright, jsdom, happy-dom, migrate Jest to Vitest, upgrade Vitest 5.

関連スキル