Mongoose: ObjectIdを検証するための最良の方法

私も同じ問題を抱えています。 mongoose.Schema.ObjectId.isValid（）とmongoose.Types.ObjectId.isValid（）を試しましたが、どちらのプロパティにもisValidメソッドがありません。 どのようにしてこの問題を解決したのですか？ また、mongodbには1つあり、別のオプションとして正規表現もあります。 正規表現を使用したくないし、require（'mongodb'）する必要もありません

これは私のために働きます：

var mongoose = require（'./ node_modules / mongoose'）;
console.log（mongoose.Types.ObjectId.isValid）;
// [関数：isValid]
console.log（mongoose.Types.ObjectId.isValid（ '53cb6b9b4f4ddef1ad47f943'））;
//true
console.log（mongoose.Types.ObjectId.isValid（'bleurgh'））;
// false

ちなみに、mongodbのメソッドはbson libメソッドであり、nullではない12文字または24文字の16進文字列をチェックします。これは次のような正規表現です。

var checkForHexRegExp = new RegExp（ "^ [0-9a-fA-F] {24} $"）;

だからそれがそこで使われているならそれはあまりハッキーになることはできません

文字列に12文字が含まれている場合、sValid（）は常にTrueを返します

console.log（mongoose.Types.ObjectId.isValid（ "zzzzzzzzzzzz"））; //true

「zzzzzzzzzzzz」は技術的には有効なObjectIdであるため、オブジェクトIDの唯一の定義機能は、12バイトの長さです。 mongodb / js-bson＃112を参照してください。 長さ12のJS文字列は12バイトで、モジュロユニコードの奇妙さを持っています。 長さ24の16進文字列を確認する場合は、文字列が/^[a-fA-F0-9]{24}$/と一致することを確認してください。

「zzzzzzzzzzzz」は有効なObjectIdではありません。 たとえば、Mongo shell listiong（mongodbバージョン-3.0.2）：

> ObjectId('zzzzzzzzzzzz')
2015-04-29T18:05:20.705+0300 E QUERY    Error: invalid object id: length
    at (shell):1:1
> ObjectId('zzzzzzzzzzzzzzzzzzzzzzzz')
2015-04-29T18:06:09.773+0300 E QUERY    Error: invalid object id: not hex
    at (shell):1:1
> ObjectId('ffffffffffff')
2015-04-29T18:09:17.303+0300 E QUERY    Error: invalid object id: length
    at (shell):1:1
> ObjectId('ffffffffffffffffffffffff')
ObjectId("ffffffffffffffffffffffff")

mongodbシェルのObjectIdコンストラクターは、16進文字列のみを受け入れるように記述されているためです。 これは、BSONタイプのObjectIdではなく、便宜上のmongoシェルの制限です。 確かに、これは16進文字列がObjectIdの通常の表現方法であることを考えると、やや直感に反するケースですが、それが気に入らない場合は、正規表現/^[a-fA-F0-9]{24}$/を使用してください:)

文字列ではなくObjectId自体isValidを実行しようとすると、なぜfalseになるのですか？ ObjectIdは有効なObjectIdであるため、これはtrueを返す必要がありますか？ それは意味がありません-オブジェクトがisValidに渡されている場合は、 .toString()を呼び出しますか？

@niftylettuceのコメントは＃3365で歓迎します。 今のところ、 bsonパッケージのObjectId.isValid（）関数に任せていますが、これは、人々がマングースのObjectIdをどのように考えているかと正確には一致していません。 ただし、ObjectIdが与えられた場合は、trueを返すためのPRを開きますが、これは完全に合理的なようです。

ここで少し古い問題に戻ります... @atcwellsソリューションmongoose.Types.ObjectId.isValid('53cb6b9b4f4ddef1ad47f943')は私にとっては十分に機能しますが、オブジェクトIDが有効かどうかをコントローラーにチェックさせる必要があるのは少しハッキーなようです。確かに、不正な形式のIDをサーバーに送信し、クラッシュさせないようにすることは、かなり一般的な使用例です。

理想的には、コールバックのerrに何かを返すだけで、それを正しく処理し、コントローラーを使用して正しいHTTPステータスを送信できます。

これがコアの便利な機能ではないユースケースはありますか？ そうでない場合は、プラグインを作成できる可能性があります。 簡単に検索しましたが、仕事をしているものは何もないようです– https://github.com/CampbellSoftwareSolutions/mongoose-id-validatorは、IDが実際に存在することを検証するためのものですが、これはそうではありませんここで実行したいのは、キャッチされないエラーが生成されないようにすることだけです。

現在、Expressコントローラーでは、ObjectIdを含むリクエストを送信するたびに、たとえばGET to https：// myproject / Organisations / {id}を実行するたびに、次のような操作を行う必要があります。

if( !mongoose.Types.ObjectId.isValid(id) ){
    return res.sendStatus(400); // They didn't send an object ID
  }

...その前にOrganisation.findOne();を実行します

かなり定型的なようです。 誰かが私をどこから始めるべきか正しい方向に向けることができれば、プラグインか何かを書いてうれしいです。 それは実際にはスキーマのものではないので、プラグインのようには見えません...

@shankiesanする必要はありません。IDが無効な場合、mongooseはクエリpromiseを拒否します。

var assert = require('assert');
var mongoose = require('mongoose');
var Schema = mongoose.Schema;

mongoose.connect('mongodb://localhost/test');
mongoose.set('debug', true);

var MyModel = mongoose.model('test', new Schema({ name: String }));

MyModel.findOne({ _id: 'invalid' }).exec().catch(error => console.error('error', error));

出力：

$ node gh-1959.js 
error { CastError: Cast to ObjectId failed for value "invalid" at path "_id"
    at MongooseError.CastError (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/error/cast.js:19:11)
    at ObjectId.cast (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/schema/objectid.js:147:13)
    at ObjectId.castForQuery (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/schema/objectid.js:187:15)
    at cast (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/cast.js:174:32)
    at Query.cast (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:2563:10)
    at Query.findOne (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:1239:10)
    at /home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:2163:21
    at new Promise.ES6 (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/promise.js:45:3)
    at Query.exec (/home/val/Workspace/10gen/troubleshoot-mongoose/node_modules/mongoose/lib/query.js:2156:10)
    at Object.<anonymous> (/home/val/Workspace/10gen/troubleshoot-mongoose/gh-1959.js:10:37)
    at Module._compile (module.js:570:32)
    at Object.Module._extensions..js (module.js:579:10)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)
    at Function.Module._load (module.js:438:3)
    at Module.runMain (module.js:604:10)
  message: 'Cast to ObjectId failed for value "invalid" at path "_id"',
  name: 'CastError',
  kind: 'ObjectId',
  value: 'invalid',
  path: '_id',
  reason: undefined }
^C
$ 

また、再：プラグインhttp://thecodebarbarian.com/2015/03/06/guide-to-mongoose-plugins

ああ、なんてマペットなんだ！ もちろん、拒否された約束を処理します... arg、私の脳。 ありがとう@vkarpov15

約束が頭痛の種である場合、コールバックも機能しますMyModel.findOne({ _id: 'invalid' }).exec(error => console.error('error', error)); :)

上記の12バイトのValeriが言ったことからまだ明らかでない場合は、 ObjectId.isValid()を使用しないでください。 これでかなりよくやけどしました：
ObjectId.isValid('The Flagship') === true

@atcwells非常に賛成のコメントを更新して、そのビットを含めることができれば、私が最初にあなたの言ったことに基づいてそれを行っていたので、他の人がそれを高く評価するかもしれないと思います： ObjectId.isValid('The Flagship') === true

面白い部分は次のとおりです。
次のステートメントはtrueを返します
mongoose.Types.ObjectId.isValid（ "南アフリカ"）

私が（今のところ）取り組んでいるのは、promisecatchのエラータイプをチェックすることです。 'ObjectId'の場合、404が返されます。API/ Webサービスのコンシューマーにリソースが見つからないか存在しないため、404が返されます。

例を参照してください：

  Widget.findByIdAndRemove(resourceId)
    .then((result) => {
      if (!result) {
        let error = new Error('Resource not found');
        error.status = 404;
        next(error);
      } else {
        res.redirect(303, '/');
      }
    })
    .catch((error) => {
      if (error.kind === 'ObjectId') {
        let error = new Error('Resource not found');
        error.status = 404;

        next(error);
      } else {
        next(error);
      }
    });

アップデート：
これをコントローラーの各ルートハンドラーに追加する代わりに。 グローバルキャッチオールハンドラーに追加しています。

例を参照してください：

app.use(function(err, req, res, next) {
  // set locals, only providing error in development
  res.locals.message = err.message;
  res.locals.error = req.app.get('env') === 'development' ? err : {};

  if (err.kind === 'ObjectId') {
    err.status = 404;
  }

  // render the error page
  res.status(err.status || 500);
  res.render('error');
});

スキーマで検証することは可能ですか？ それを繰り返すのはベストプラクティスではありませんが、キャストエラーイベントをログに記録したいと思います。

MongoDBのみを処理しているのに、isValidの正規表現/ ^ [a-fA-F0-9] {24}$/をmongooseで実装できないのはなぜですか。 これはとても紛らわしいです。 問題のデバッグに1時間費やすだけで、気付かないほどばかげたことが判明しました。

このnpmパッケージhttps://www.npmjs.com/package/valid-objectidを使用することをお勧めします
それは完璧に動作します

私はこれの回避策を作成しました：

function isObjectId(value) {
  try {
      const { ObjectId } = mongoose.Types;
      const asString = value.toString(); // value is either ObjectId or string or anything
      const asObjectId = new ObjectId(asString);
      const asStringifiedObjectId = asObjectId.toString();
      return asString === asStringifiedObjectId;
    } catch (error) {
      return false;
    }
}

@mstmustisnt試行/キャッチする必要があると思います。値が「123」の場合、エラーがスローされます。

それが誰かを助ける場合に備えて、私は上記のObjectId.isValid()アプローチの適応を行ってきました。 私のユースケースでは、IDまたはurl-slugのいずれかでリソースを取得できるようにしたいので、次のようになります。

GET /users/59f5e7257a92d900168ce49a ...または..。
GET /users/andrew-shankie

...これは私のコントローラーでうまく機能することがわかりました：

  const { id } = req.params;

  const query = {
    $or: [{ slug: id }],
  };

  if (mongoose.Types.ObjectId.isValid(id)) query.$or.push({ _id: id });

  User.findOne(query)
    .exec((err, user) => { ... }

この場合、12バイトの文字列は引き続き有効なオブジェクトIDであり、それを検索すると、エラーをスローするのではなく、長さがゼロの配列が返されます。 また、 $orクエリを使用しているため、URLスラッグ（他の可能なオプション）で検索します。

最もエレガントな解決策ではないかもしれませんが、それは私にとってはうまくいきます。

@victorbadilaはい、その通りです。 ヒントを出しました。 コメントを編集しました。実際に使用するコードを配置するだけです。

validator.jsには組み込みのisMongoIdメソッドがあります

私がマングースを使用するときはいつでも、私は常にいくつかの静的ヘルパーメソッドでそれを拡張します：

const mongoose = require('mongoose');
const {Types: {ObjectId}} = mongoose;

//Helper to check if an ID is an object ID
mongoose.isObjectId = function(id) {
  return (id instanceof ObjectId);
};

//Helper to validate a string as object ID
mongoose.isValidObjectId = function(str) {
  if (typeof str !== 'string') {
    return false;
  }
  return str.match(/^[a-f\d]{24}$/i);
};

これはデータベース初期化スクリプトの一部として実行できるため、メソッドはアプリで常に使用できます。

ObjectId.isValid（id）がtrueの場合、（new ObjectId（id）.toString（））の値とIDを判断できます。

const mongoose = require('mongoose');
const {Types: {ObjectId}} = mongoose;
const validateObjectId = (id) => ObjectId.isValid(id) && (new ObjectId(id)).toString() === id;