如何让 Foxx 服务使用基础集合而不是挂载特定集合

Question

如何让 Foxx 服务使用基本集合进行身份验证操作？例如，我想要 https://docs.arangodb.com/3.3/Manual/Foxx/Users.html 处的用户管理教程使用集合 "users" 和 "sessions" 而不是 "test_users" 和 "test_sessions"，其中 "test" 是我的挂载点的名称。

我想运行多个服务都使用相同的基础集合。但是，如果我按照教程中给出的内容进行操作，我最终会得到特定于服务的身份验证集合和路由，这对我来说意义不大。

我的setup.js是；

'use strict';
const db = require('@arangodb').db;
const sessions = module.context.collectionName('sessions');
const users = module.context.collectionName('users');

if (!db._collection(sessions)) {
  db._createDocumentCollection(sessions);
}

if (!db._collection(users)) {
  db._createDocumentCollection(users);
}

db._collection(users).ensureIndex({
  type: 'hash',
  fields: ['username'],
  unique: true
});

我的 index.js 是；

'use strict';

const joi = require('joi');
const createAuth = require('@arangodb/foxx/auth');
const createRouter = require('@arangodb/foxx/router');
const sessionsMiddleware = require('@arangodb/foxx/sessions');
// const db = require('@arangodb').db;

const auth = createAuth();
const router = createRouter();
const users = db._collection('users');
const sessions = sessionsMiddleware({
storage: module.context.collection('sessions'),
transport: 'cookie'
});

module.context.use(sessions);
module.context.use(router);

// continued
router.post('/signup', function (req, res) {
    const user = {};
    try {
      user.authData = auth.create(req.body.password);
      user.username = req.body.username;
      user.perms = [];
      const meta = users.save(user);
      Object.assign(user, meta);
    } catch (e) {
      // Failed to save the user
      // We'll assume the uniqueness constraint has been violated
      res.throw('bad request', 'Username already taken', e);
    }
    req.session.uid = user._key;
    req.sessionStorage.save(req.session);
    res.send({success: true});
  })
  .body(joi.object({
    username: joi.string().required(),
    password: joi.string().required()
  }).required(), 'Credentials')
  .description('Creates a new user and logs them in.');

我尝试使用 const users = db._collection('users'); 而不是 const users = module.context.collection('users');，但这会引发 swagger api 错误。

Answer 1

要实现这一点，您需要在所有文件中将集合名称的分配从 module.context.collectionName('nameOfCollection') 更改为 'nameOfCollection'，因为 module.context.collectionName 以服务名称前缀字符串

所以

setup.js

const sessions = 'sessions';
const users = 'users';

index.js

const users = db._collection('users');
const sessions = sessionsMiddleware({
    storage: 'sessions',
    transport: 'cookie'
});

但是，当更多服务需要访问相同的底层集合时，这种方法是反模式的（例如，一项服务的拆卸可以删除其他服务的这些集合）。

对于这种情况，您应该使用 dependencies，只有您的身份验证服务应该可以访问它自己的集合，其他服务应该将身份验证服务作为依赖项并通过身份验证服务访问身份验证数据。

授权服务需要

在manifest.json

"provides": {
    "myauth": "1.0.0"
}

in index.js 或您在 manifest.json

中指向 main 的文件

module.exports = {
    isAuthorized (id) {
        return false; // your code for validating if user is authorized
    }
};

消费服务需要有

在manifest.json

"dependencies": {
    "myauth": {
        "name": "myauth",
        "version": "^1.0.0",
        "description": "Auth service.",
        "required": true
    }
}

然后就可以注册调用了

const myauth = module.context.dependencies.myauth;
if (myauth.isAuthorized()) {
    // your code
} else {
    res.throw(401);
}

有关请求授权的进一步步骤，请查看如何使用 Middleware and Session middleware

神速

如何让 Foxx 服务使用基础集合而不是挂载特定集合

How to have a Foxx service use base collection instead of mount specific ones

authentication

arangodb

foxx