Sub Field Visible

[Arinji2]

Hiya... awesome plugin :D
But yea why is the Sub Field Visible? Could it be an option to enable/disable it? Since i dont really like random fields being added to my collections xD

[WilsonLe]

Sub field is the user ID stored in the oauth providers' database. It is introduced by the plugin to determine if a user already exists (https://github.com/WilsonLe/payload-oauth2/blob/922338af18e0ecae0f3a687b21c88eb13460111d/src/callback-endpoint.ts#L96C1-L115C8).

That said, it makes sense to have it optional since developers could set useEmailAsIdentity to true and the need for a sub field is no longer needed.

[WilsonLe]

Also, yes it makes sense to make it hidden too.

[Arinji2]

Wait now I'm confused, how does the plugin usually know which payload account to link to? It matches your email right?

[Arinji2]

Also i checked my code, i do have it enabled, so im not sure why sub is needed at this point.

export const discordOauth = OAuth2Plugin({
  enabled: true,
  strategyName: 'discord',
  useEmailAsIdentity: true,
  serverURL: process.env.NEXT_PUBLIC_URL || 'http://localhost:3000',
  clientId: DISCORD_CLIENT_ID,
  clientSecret: DISCORD_CLIENT_SECRET || '',
  authorizePath: '/oauth/discord',
  callbackPath: '/oauth/discord/callback',
  authCollection: 'users',
  tokenEndpoint: 'https://discord.com/api/oauth2/token',
  scopes: SCOPES,
  providerAuthorizationUrl: generateCodeURL(DISCORD_CLIENT_ID, DISCORD_REDIRECT_URL, SCOPES),
  getUserInfo: async (accessToken: string) => {
    const response = await fetch('https://discord.com/api/users/@me', {
      headers: { Authorization: `Bearer ${accessToken}` },
    })
    const user = await response.json()
    return { email: user.email, sub: user.id }
  },
  getToken: async (code: string, req: PayloadRequest) => {
    const redirectUri = DISCORD_REDIRECT_URL
    const token = await getToken(DISCORD_CLIENT_ID, DISCORD_CLIENT_SECRET, redirectUri, code)
    const serverList = await getUserGuilds(token)
    const foundServer = serverList.find((server) => server === GUILD_ID)
    if (!foundServer) {
      throw new Error('Unauthorized User')
    }
    if (req.user) {
      req.payload.update({
        collection: 'users',
        id: req.user.id,
        data: {},
      })
    }

    return token
  },
  successRedirect: () => {
    return '/admin'
  },
  failureRedirect: (req, err) => {
    req.payload.logger.error(err)
    let errorMessage = err as string
    errorMessage = errorMessage.split(':')[1]!
    return `/admin/login?error=${errorMessage}`
  },
})

[WilsonLe]

Yeah, you don't need sub if you have useEmailAsIdentity. However it's nice to have a sub field when you want to determine which oauth provider the user is logged in with when you have multiple oauth provider. You can set discord sub field to, say, discordSub, and google sub field to googleSub, and whichever field is not None implies user authenticates via that oauth provider.

[Arinji2]

Agreed on that, how would you make custom ones though? Just like return discordSub in the get users info, then make a field for that in the collection?

[WilsonLe]

use the subFieldName option and make sure you return that field in getUserInfo

[Arinji2]

Ah, also if your fine with the adding an option to hide the sub fields, i could just make a pr for it
https://github.com/WilsonLe/payload-oauth2/blob/922338af18e0ecae0f3a687b21c88eb13460111d/src/modify-auth-collection.ts#L21C8-L31

Looks to just be that code, and adding an extra option in the plugin fields