如何使用 graphql 和 passport 设置身份验证但仍然使用 Playground

Question

向我们的后端 Graphql 服务器添加身份验证后，“Schema”和“Docs”在 Graphql Playground 中不再可见。在 Playground 中向“HTTP HEADERS”添加令牌时执行查询在经过身份验证时可以正常工作，而在用户未经过身份验证时无法正常工作，所以没关系。

我们禁用了 Apollo 服务器的内置 Playground，并使用中间件 graphql-playground-middleware-express 来使用不同的 URL 并绕过身份验证。我们现在可以浏览到 Playground 并使用它，但我们无法阅读那里的“架构”或“文档”。

尝试启用 introspection 没有解决这个问题。在apollo-server的Context中调用passport.authenticate()会不会更好？在调用 Playground 路由之前，还有一个名为 passport-graphql but it works with local strategy and might not solve the problem. I've also tried setting the token in the header 的工具，但是没有用。

我们对此有点迷茫。感谢您提供给我们的任何见解。

相关代码：

// index/ts
import passport from 'passport'
import expressPlayground from 'graphql-playground-middleware-express'

const app = express()
app.use(cors({ origin: true }))
app.get('/playground', expressPlayground({ endpoint: '/graphql' }))
app.use(passport.initialize())
passport.use(bearerStrategy)

app.use(
  passport.authenticate('oauth-bearer', { session: false }),
  (req, _res, next) => { next() }
)
;(async () => {
    await createConnections()
    const server = await new ApolloServer({
      schema: await getSchema(),
      context: ({ req }) => ({ getUser: () => req.user, }),
      introspection: false,
      playground: false,
    })
    server.applyMiddleware({ app, cors: false })

    app.listen({ port: ENVIRONMENT.port }, () => { console.log(`Server ready`) })      
})()

// passport.ts
import { IBearerStrategyOptionWithRequest, BearerStrategy, ITokenPayload } from passport-azure-ad'
import { Account } from '@it-portal/entity/Account'

export const bearerStrategy = new BearerStrategy( config,
  async (token: ITokenPayload, done: CallableFunction) => {
    try {
      if (!token.oid) throw 'token oid missing'

      const knownAccount = await Account.findOne({ accountIdentifier: token.oid })
      if (knownAccount) return done(null, knownAccount, token)

      const account = new Account()
      account.accountIdentifier = token.oid
      account.name = token.name
      account.userName = (token as any).preferred_username
      const newAccount = await account.save()
      return done(null, newAccount, token)
    } catch (error) {
      console.error(`Failed adding the user to the request object: ${error}`)
    }
  }
)

Answer 1

感谢 this SO answer，我弄明白了。关键不是在 Express 上使用 passport 作为中间件，而是在 Graphql Context.

中使用它

在下面的示例代码中，您可以看到在 ApolloServer 的 Context 中使用了进行护照身份验证的 Promise getUser。这样，当运行处于 dev 模式时，仍然可以访问 Playground 并且仍然可以访问“Schema”端的“Docs”。

根据 Apollo docs 部分“将用户信息放在上下文中”，这也是首选方式。

// apollo.ts
passport.use(bearerStrategy)

const getUser = (req: Express.Request, res: Express.Response) =>
  new Promise((resolve, reject) => {
    passport.authenticate('oauth-bearer', { session: false }, (err, user) => {
      if (err) reject(err)
      resolve(user)
    })(req, res)
  })

const playgroundEnabled = ENVIRONMENT.mode !== 'production'

export const getApolloServer = async () => {
  return new ApolloServer({
    schema,
    context: async ({ req, res }) => {
      const user = await getUser(req, res)
      if (!user) throw new AuthenticationError('No user logged in')
      console.log('User found', user)

      return { user }
    },
    introspection: playgroundEnabled,
    playground: playgroundEnabled,
  })
}

最棒的是你只需要两个函数就可以工作：passport.use(BearerStrategy) 和 passport.authenticate()。这是因为没有使用会话，所以我们不需要将其添加为 Express 中间件。

// index/ts
const app = express()
app.use(cors({ origin: true }))

;(async () => {
    await createConnections()
    const server = await getApolloServer()
    server.applyMiddleware({ app, cors: false })

    app.listen({ port: ENVIRONMENT.port }, () => { console.log(`Server ready`) })      
})()

我希望这对遇到同样问题的其他人有所帮助。

如何使用 graphql 和 passport 设置身份验证但仍然使用 Playground

How to setup authentication with graphql, and passport but still use Playground

express

passport.js

graphql

apollo-server

passport-azure-ad