connection.query の実行結果を返す関数を作りたい。

Question

実現したいこと

console.log(
    m_sql(
        "SELECT * FROM accounts WHERE user=?;", ["Jhon"]
    ).results[0].mail_address
);

みたいな感じに、Node.jsでSQL文をm_sql()関数に渡し、SQL文の実行結果をm_sql()関数の戻り値として受け取る。
このm_sql()関数を作りたい。

つまずいてる場所

const mysql = require("mysql");

const connection = mysql.createConnection({
    host: "localhost",
    user: "root",
    password: "toor",
    database: "test"
});

/*=============================================================*/

function m_sql (code, argv) {
    var ret;

    new Promise((resolve, reject) => {
        // connection.query は非同期関数なので、Promise を使っています。
        connection.query(code, argv,
            (error, results, fields) => {
                resolve({
                    error: error,
                    results: results,
                    fields: fields
                });
            }
        );

    }).then(data => {
        ret = data;

        console.log(data);
        //=> SQL文の実行結果

        console.log(ret);
        //=> SQL文の実行結果

        //ここでは無事、retにSQL文の実行結果が入っていますが、
    });
    //ここではretがundefinedになっています

    console.log(ret);
    //=> undefined

    return ret;
}

console.log(m_sql("SELECT * FROM auth;"));
//=> undefined

知りたいこと

• どうやったら、retが SQL文の実行結果を保持したまま、return出来るのか。

調べたこと・試したこと

• 参照渡し

JavaScript の参照渡しはややこしいし、やってもできなかった。
参照渡しは存在しないという記事も。

環境・バージョン

• OS Windows 10 Home 64bit
• Node.js v12.16.1
• SQL 10.5.5-MariaDB

Answer 1

Promiseの動作について誤解が発生していると思います。retに発生している問題は「保持できていない」ではなく「代入していない」です。直感的ではないかもしれませんが、このコードは次の順番で処理が行われています：

        function m_sql (code, argv) {
/* 1 */     var ret; // 未代入

            new Promise((resolve, reject) => {
/* 3 */         connection.query(code, argv,
/* 4 */             (error, results, fields) => {
/* 5 */                 resolve({
                            error: error,
                            results: results,
                            fields: fields
                        });
                    }
                );
            }).then(data => {
/* 6 */         ret = data; // ここで代入される
            });

            // 「`Promise`を待て」と言われていないため、ここまで飛ばされてしまう

/* 2 */     return ret ; // 未代入
        }

        console.log(m_sql("SELECT * FROM auth;")); // 2のステップで出力される

これを解決するためにm_sql()自体を非同期化（Promise化）してしまいましょう。

// 頭に`async`を付けることで、関数の返り値を`Promise`にします
async function m_sql (code, argv) {
    // `var ret`は不要

    // `new Promise`の前に`await`を付けることで、`Promise`の解決を待つ
    const data = await new Promise((resolve, reject) => {
        connection.query(code, argv,
            (error, results, fields) => {
                resolve({
                    error: error,
                    results: results,
                    fields: fields
                });
            }
        );

    // ここに到達した時点で`Promise`の処理の完了が保障されている

    // `.then(...)`は不要

    return data; // `data`を直接返すことができる
}

この関数（非同期関数）を呼び出すときは頭にawaitを付けてPromiseの解決を待ちましょう：

// 関数の外で`await`を使うことを「Top-level await」と呼びます
console.log(await m_sql("SELECT * FROM auth;"));

古いnodeのバージョン（14.7.0以前）ではTop-level awaitがサポートされていないため、全体をasync main関数で囲む必要があります：

async function main () {
    // 処理全体をここに入れてください
    console.log(await m_sql("SELECT * FROM auth;"));
}

main();

Comments

[ws156]

無事解決できました。

なるほど！Promise と async/await にそんな関係があったんですね！
あと、実行順序も結構衝撃的でした。

Node.jsに新しいバージョンが出たことも初めて知りました。
早速アップデートしました。

ありがとうございました。