socket.ioのイベントの処理を1度だけ行われるようにしたい

Question

お世話になっております。
node.jsのsocket.ioを使用し、WEBアプリを実装しようと考えおります。
あるイベントを受け取ったときに1度だけ処理を実現させたいです。
そこで、フラグで処理を管理しようとしております。
ただ、イベントがほぼ同時に2回以上起こった場合、フラグを操作する前にそれらの処理がすり抜けてしまい、処理が2度以上行われることがあるのではないかと思い、質問させていただきました。
そこで、お伺いしたいのですが、

• イベントがほぼ同時に2回以上起こった場合、処理が2度以上行われることがあるかどうか。
• 上記のことが起こる場合、回避策があるかどうか

をご教授いただけると幸いです。
大変お手数ですがよろしくお願いいたします。

'use strict';

// モジュール
const express = require( 'express' );
const http = require( 'http' );
const socketIO = require( 'socket.io' );

// オブジェクト
const app = express();
const server = http.Server( app );
const io = socketIO( server );

// 定数
const PORT = process.env.PORT || 8080;

/* 処理を管理するためのフラグ */
let onceFlag = true;

io.on(
  socket.on(
            'once',
            () =>
            {
                if(onceFlag) {
                    onceFlag = false;
                    /* ここに一度しか行わせたくない処理を書く */ 
                }
            } );
);

試したソースコードを追記いたします。
最初に記述したソースコードがエラーになってしまい、申し訳ございませんでした。

'use strict';

// モジュール
const express = require( 'express' );
const http = require( 'http' );
const socketIO = require( 'socket.io' );

// オブジェクト
const app = express();
const server = http.Server( app );
const io = socketIO( server );

// 定数
const PORT = process.env.PORT || 8080;
const SYSTEMNICKNAME = '**system**';

// 関数
// 数字を２桁の文字列に変換
const toDoubleDigitString =
    ( num ) =>
    {
        return ( "0" + num ).slice( -2 );   // slice( -2 )で後ろから２文字取り出す。
    };

// 時刻文字列の作成（書式は「YY/DD/MM hh:mm ss」）
const makeTimeString =
    ( time ) =>
    {
        return toDoubleDigitString( time.getFullYear() ) + '/' + toDoubleDigitString( time.getMonth() + 1 ) + '/' + toDoubleDigitString( time.getDate() )
            + ' ' + toDoubleDigitString( time.getHours() ) + ':' + toDoubleDigitString( time.getMinutes() ) + ' ' + toDoubleDigitString( time.getSeconds() );
    }

// グローバル変数
let iCountUser = 0; // ユーザー数

/* 処理を管理するためのフラグ */
let onceFlag = true; // ボタンの状態

// 接続時の処理
// ・サーバーとクライアントの接続が確立すると、
// 　サーバー側で、'connection'イベント
// 　クライアント側で、'connect'イベントが発生する
io.on(
    'connection',
    ( socket ) =>
    {
        console.log( 'connection' );

        let strNickname = '';	// コネクションごとで固有のニックネーム。イベントをまたいで使用される。

        // 切断時の処理
        // ・クライアントが切断したら、サーバー側では'disconnect'イベントが発生する
        socket.on(
            'disconnect',
            () =>
            {
                console.log( 'disconnect' );

                if( strNickname )
                {
                    // ユーザー数の更新
                    iCountUser--;

                    // メッセージオブジェクトに現在時刻を追加
                    const strNow = makeTimeString( new Date() );

                    // システムメッセージの作成
                    const objMessage = {
                        strNickname: SYSTEMNICKNAME,
                        strMessage: strNickname + ' left.' + " there are " + iCountUser + " participants",
                        strDate: strNow
                    }

                    // 送信元含む全員に送信
                    io.emit( 'spread message', objMessage );
                }
            } );

        // 入室時の処理
        // ・クライアント側のメッセージ送信時の「socket.emit( 'join', strNickname );」に対する処理
        socket.on(
            'join',
            ( strNickname_ ) =>
            {
                console.log( 'joined :', strNickname_ );

                // コネクションごとで固有のニックネームに設定
                strNickname = strNickname_;

                // ユーザー数の更新
                iCountUser++;

                // メッセージオブジェクトに現在時刻を追加
                const strNow = makeTimeString( new Date() );

                // システムメッセージの作成
                const objMessage = {
                    strNickname: SYSTEMNICKNAME,
                    strMessage: strNickname + ' joined.' + " there are " + iCountUser + " participants",
                    strDate: strNow
                }

                // 送信元含む全員に送信
                io.emit( 'spread message', objMessage );
            } );

        // 新しいメッセージ受信時の処理
        // ・クライアント側のメッセージ送信時の「socket.emit( 'new message', $( '#input_message' ).val() );」に対する処理
        socket.on(
            'new message',
            ( strMessage ) =>
            {
                console.log( 'new message', strMessage );

                // 現在時刻の文字列の作成
                const strNow = makeTimeString( new Date() );

                // メッセージオブジェクトの作成
                const objMessage = {
                    strNickname: socket.id,
                    strMessage: strMessage,
                    strDate: strNow
                }

                // 送信元含む全員に送信
                //io.emit( 'spread message', strMessage );
                io.emit( 'spread message', objMessage );
            } );
			
		/*　一度しか行わせたくない */ 
        socket.on(
            'once',
            () =>
            {
				if(onceFlag) {
					console.log('once');
				}
            } );
    } );

// 公開フォルダの指定
app.use( express.static( __dirname + '/public' ) );

// サーバーの起動
server.listen(
    PORT,
    () =>
    {
        console.log( 'Server on port %d', PORT );
    } );

クライアント側ではjqueryを用いてソースコードを用意して、onceのidを付けたdivタグを用意しておりました。

$("#once").on(
  'click',
  () =>
    {
        socket.emit('once');
    }
);

上のイベントが発火したときに「once」のログが1度だけ残り、以後はクリックしてもログが残らないことは確認しております。
しかし、ほぼ同時に起こった場合はあくまで推測でしかなく、試せてない状況です。申し訳ございません。

すみません、よろしくお願いいたします。

Comments

[dodox86]

> フラグを操作する前にそれらの処理がすり抜けてしまい
node.js には詳しくないのでコメントのみですが。そんな場合はプラットフォームで提供されるLOCK系のAPIを使って排他処理を行うものだと思います。

https://www.npmjs.com/package/async-lock
https://www.npmjs.com/search?q=keywords:lock

[AkitoshiManabe]

試したことを追記してください（ご提示のコードはサーバープログラムを起動しようとした時点で、io.on()の箇所でエラーになるはずです）。構想だけで socket.io の特徴や実装を確認されていないように思います。

github） https://github.com/socketio/socket.io の「Simple and convenient API」セクションに、ブラウザ-サーバー間のコネクション確立させるサンプルコードが示されています。
docs/ で詳細なドキュメント（サンプルコード有り）を、lib/ で実装（ソースコード）を確認できます。

Answer 1

1. イベントがほぼ同時に2回以上起こった場合、処理が2度以上行われることがあるかどうか。
2. 上記のことが起こる場合、回避策があるかどうか

1. クライアント側のチャタリングや通信状況によるユーザ操作の繰り返しは起こりうると考えた方が良いと思います。
2. サーバー側で socket.id と ユーザ情報を対にしたキーにして連想配列的なオブジェクトやMapを使いステート管理することで回避できそうに思います。

socket.io のリアルタイム通信は、@IT :チャットアプリ開発に見る、Socket.IOの基本ライブラリの使い方 が参考になります。
特に記事の３ページ目まで読み進めると、io.on("connect", socket=>{ }) のイベントリスナに渡される socket オブジェクトから socket.id を接続ごとのユニークな値として活用している事例を確認できたり、リアルタイム通信に存在する３つのステップの後処理まで説明されています。

1. 接続確立
2. 接続中の通信
3. 接続解除 (後処理) ... ＠IT記事３ページ目の「クライアント切断時の処理」セクションを参照

Comments

[kohaku]

ご解答ありがとうございます！
起こりうるということで、リンクを参照しながら回避できるようにしてきます。