在Foxx中更新(补丁)时进行Joi验证

时间:2016-07-20 03:12:01

标签: arangodb foxx

我使用arangodb 3.0.2并且在更新/补丁架构时遇到joi验证问题。

我有像这样的用户架构

_key: joi.string(),
name: joi.string().required(),
username: joi.string(),
email: joi.string().required(),
profilePicture: joi.string(),
provider: joi.object().keys({
  name: joi.string(),
  id: joi.string()
}),
interest: joi.array().items(joi.string()),
level: joi.number().default(0)

当我创建新用户时,尝试添加未知字段,如状态 它会抛出错误,

但如果我更新用户,并添加未知字段,则不会抛出任何错误。因为它不验证请求架构。

如何在更新/修补用户时验证架构,忽略集合中已存在的字段?

路线更新:

router.post(function (req, res) {
  const user = req.body;
  let provider = user.provider.name;
  let id = user.provider.id;
  let meta;
  try {
    meta = users.save(user);
  } catch (e) {
    if (e.isArangoError && e.errorNum === ARANGO_DUPLICATE) {
      throw httpError(HTTP_CONFLICT, e.message);
    }
    throw e;
  }
  Object.assign(user, meta);
  res.status(201);
  res.set('location', req.makeAbsolute(
    req.reverse('detail', {key: user._key})
  ));
  res.send(user);
}, 'create')
.body(User, 'The user to create.')
.response(201, User, 'The created user.')
.error(HTTP_CONFLICT, 'The user already exists.')
.summary('Create a new user')
.description(dd`
  Creates a new user from the request body and
  returns the saved document.
`);

router.patch(':key', function (req, res) {
  const key = req.pathParams.key;
  const patchData = req.body;
  let user;
  try {
    users.update(key, patchData);
    user = users.document(key);
  } catch (e) {
    if (e.isArangoError && e.errorNum === ARANGO_NOT_FOUND) {
      throw httpError(HTTP_NOT_FOUND, e.message);
    }
    if (e.isArangoError && e.errorNum === ARANGO_CONFLICT) {
      throw httpError(HTTP_CONFLICT, e.message);
    }
    throw e;
  }
  res.send(user);
}, 'update')
.pathParam('key', keySchema)
.body(joi.object().description('The data to update the user with.'))
.response(User, 'The updated user.')
.summary('Update a user')
.description(dd`
  Patches a user with the request body and
  returns the updated document.
`);

这是我的路线,你可以看到。当我发布新用户时,它将验证用户架构,因此如果我添加未知字段,则会给我一些错误。

但我补丁用户,它不会验证用户架构,因为在" body"我没有设置为用户架构。但是如果在那里添加用户架构,它将检查必填字段,所以我不能修补一些已知字段。

1 个答案:

答案 0 :(得分:1)

如果要确保创建(.post()路由)和更新(.patch()路由)的特定模式,请确保仅定义模式一次并在两个路由中引用它而不是在.body()DRY principle)中内联编写两次。

let userSchema = joi.object().keys({
  _key: joi.string(),
  name: joi.string().required(),
  username: joi.string(),
  email: joi.string().required(),
  profilePicture: joi.string(),
  provider: joi.object().keys({
    name: joi.string(),
    id: joi.string()
  }),
  interest: joi.array().items(joi.string()),
  level: joi.number().default(0)
});

router.post(...)
  .body(userSchema)

router.patch(...)
  .body(userSchema)

看起来你实际上定义了这样的模式,存储在变量User中并在POST路由中使用:

.body(User, 'The user to create.')

但是你没有在PATCH路线中使用架构:

.body(joi.object().description('The data to update the user with.'))

它只确保req.body是一个对象,但不强制执行任何架构。