feat(user-tokens): user tokens api (#428)

* feat(user-tokens): user tokens api

* fix inject watch script

* it just works

* fix version bug when legacy disabled

* return id also

* don't always reload

* fix

* anotha one

* version bumps

* bump webchat

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/messaging",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Botpress messaging repo",
   "author": "Botpress, Inc.",
   "license": "AGPL-3.0",

packages/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/messaging-client",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "source": "src/index.ts",

packages/client/src/api.ts

@@ -85,6 +85,16 @@ export abstract class MessagingChannelApi extends MessagingChannelBase {
     }, undefined)
   }
 
+  /**
+   * Creates a new user token
+   * @param clientId id of the client that owns the user
+   * @param userId id of the user
+   * @returns token that can be used to make user-level requests
+   */
+  async createUserToken(clientId: uuid, userId: uuid): Promise<{ id: string; token: string }> {
+    return (await this.http.post('/users/tokens', { userId }, { headers: this.headers[clientId] })).data
+  }
+
   /**
    * Creates a new messaging conversation
    * @param clientId id of the client that will own this conversation

packages/client/src/client.ts

@@ -158,6 +158,15 @@ export class MessagingClient extends ProtectedEmitter<{
     return this.channel.getUser(this.clientId, id)
   }
 
+  /**
+   * Creates a new user token
+   * @param userId id of the user
+   * @returns token that can be used to make user-level requests
+   */
+  async createUserToken(userId: uuid): Promise<{ id: string; token: string }> {
+    return this.channel.createUserToken(this.clientId, userId)
+  }
+
   /**
    * Creates a new messaging conversation
    * @param userId id of the user that starts this conversation

packages/client/test/e2e/client.test.ts

@@ -54,6 +54,7 @@ describe('Http Client', () => {
     conversation?: Conversation
     message?: Message
     webhooks?: SyncWebhook[]
+    userToken?: { id: string; token: string }
   } = {}
   let client: MessagingClient
   const webhooks = [{ url: 'http://un.known.url' }, { url: 'http://second.un.known.url' }]
@@ -210,6 +211,30 @@ describe('Http Client', () => {
     })
   })
 
+  describe('User Tokens', () => {
+    test('Should create a user token without throwing any error', async () => {
+      const userToken = await client.createUserToken(state.user!.id)
+
+      expect(userToken.id).toBeDefined()
+      expect(userToken.token).toBeDefined()
+      expect(userToken.token.startsWith(userToken.id)).toBeTruthy()
+
+      state.userToken = userToken
+    })
+
+    test('Should create a second user token for the same user', async () => {
+      const userToken = await client.createUserToken(state.user!.id)
+
+      expect(userToken.id).toBeDefined()
+      expect(userToken.token).toBeDefined()
+      expect(userToken.token.startsWith(userToken.id)).toBeTruthy()
+
+      // should be a different token
+      expect(userToken.id).not.toEqual(state.userToken?.id)
+      expect(userToken.token).not.toEqual(state.userToken?.token)
+    })
+  })
+
   describe('Message', () => {
     const payload = {
       type: 'text',

packages/inject/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@botpress/webchat-inject",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "license": "AGPL-3.0",
   "scripts": {
     "build": "yarn && yarn run -T parcel build src/index.html src/inject.js --public-url ./",
     "write:version": "node -p \"require('../webchat/package.json').version\" > ./dist/version.txt",
-    "watch": "yarn && yarn run -T parcel watch src/index.html src/inject.js",
+    "watch": "yarn && yarn run -T parcel watch src/index.html src/inject.js  --public-url ./",
     "dev": "yarn && yarn run -T parcel src/index.html src/inject.js",
     "prepublish": "yarn run -T rimraf dist && yarn --immutable && yarn run -T parcel build src/index.html src/inject.js --public-url ./ && yarn write:version",
     "analyze": "yarn run -T parcel build src/index.html --public-url ./ --reporter @parcel/reporter-bundle-analyzer"
@@ -21,7 +21,7 @@
     "@types/react-dom": "^17.0.11"
   },
   "dependencies": {
-    "@botpress/webchat": "0.3.3",
+    "@botpress/webchat": "0.3.4",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   }

packages/server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/messaging-server",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "main": "index.ts",
   "license": "AGPL-3.0",
   "scripts": {

packages/server/src/api.ts

@@ -12,6 +12,7 @@ import { HealthApi } from './health/api'
 import { MappingApi } from './mapping/api'
 import { MessageApi } from './messages/api'
 import { SyncApi } from './sync/api'
+import { UserTokenApi } from './user-tokens/api'
 import { UserApi } from './users/api'
 
 export class Api {
@@ -24,6 +25,7 @@ export class Api {
   private syncs: SyncApi
   private health: HealthApi
   private users: UserApi
+  private userTokens: UserTokenApi
   private conversations: ConversationApi
   private messages: MessageApi
   private mapping: MappingApi
@@ -39,6 +41,7 @@ export class Api {
     this.syncs = new SyncApi(this.app.syncs, this.app.channels)
     this.health = new HealthApi(this.app.health)
     this.users = new UserApi(this.app.users)
+    this.userTokens = new UserTokenApi(this.app.users, this.app.userTokens)
     this.conversations = new ConversationApi(this.app.users, this.app.conversations)
     this.messages = new MessageApi(this.app.users, this.app.conversations, this.app.messages, this.app.converse)
     this.mapping = new MappingApi(this.app.channels, this.app.conversations, this.app.mapping)
@@ -68,6 +71,7 @@ export class Api {
     this.syncs.setup(this.manager)
     this.health.setup(this.manager)
     this.users.setup(this.manager)
+    this.userTokens.setup(this.manager)
     this.conversations.setup(this.manager)
     this.messages.setup(this.manager)
     this.mapping.setup(this.manager)

packages/server/src/sync/schema.ts

@@ -1,5 +1,6 @@
 import { Channel } from '@botpress/messaging-channels'
 import Joi from 'joi'
+import yn from 'yn'
 import { ReqSchema } from '../base/schema'
 
 export const makeSyncRequestSchema = (channels: Channel[]) => {
@@ -14,10 +15,11 @@ export const makeSyncRequestSchema = (channels: Channel[]) => {
   }
 
   for (const [name, channels] of Object.entries(channelsByName)) {
+    const versionSchema = Joi.string().valid(...new Set(channels.map((x) => x.meta.version)))
+
     channelsSchema[name] = Joi.object({
-      version: Joi.string()
-        .valid(...channels.map((x) => x.meta.version))
-        .optional()
+      // when legacy channels are enable, not supplying the version defaults to 0.1.0
+      version: yn(process.env.ENABLE_LEGACY_CHANNELS) ? versionSchema.optional() : versionSchema.required()
     })
       .options({
         allowUnknown: true

packages/server/src/user-tokens/api.ts

@@ -0,0 +1,29 @@
+import { uuid } from '@botpress/messaging-base'
+import { Response } from 'express'
+import { ApiManager } from '../base/api-manager'
+import { ClientApiRequest } from '../base/auth/client'
+import { UserService } from '../users/service'
+import { Schema } from './schema'
+import { UserTokenService } from './service'
+
+export class UserTokenApi {
+  constructor(private users: UserService, private userTokens: UserTokenService) {}
+
+  setup(router: ApiManager) {
+    router.post('/users/tokens', Schema.Api.Create, this.create.bind(this))
+  }
+
+  async create(req: ClientApiRequest, res: Response) {
+    const userId = req.body.userId as uuid
+
+    const user = await this.users.fetch(userId)
+    if (!user || user.clientId !== req.clientId) {
+      return res.sendStatus(404)
+    }
+
+    const tokenRaw = await this.userTokens.generateToken()
+    const userToken = await this.userTokens.create(user.id, tokenRaw, undefined)
+
+    res.status(201).send({ id: userToken.id, token: `${userToken.id}.${tokenRaw}` })
+  }
+}

packages/server/src/user-tokens/schema.ts

@@ -0,0 +1,12 @@
+import Joi from 'joi'
+import { ReqSchema } from '../base/schema'
+
+const Api = {
+  Create: ReqSchema({
+    body: { userId: Joi.string().guid().required() }
+  })
+}
+
+const Socket = {}
+
+export const Schema = { Api, Socket }

packages/webchat/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/webchat",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "source": "src/index.tsx",

packages/webchat/src/core/socket.tsx

@@ -7,7 +7,7 @@ export default class BpSocket {
 
   public onMessage!: (event: any) => void
 
-  constructor(config: Config) {
+  constructor(private config: Config) {
     this.chatId = config.chatId
     this.socket = new MessagingSocket({ url: config.messagingUrl, clientId: config.clientId })
 
@@ -29,7 +29,7 @@ export default class BpSocket {
   }
 
   public async connect(): Promise<void> {
-    const creds = window.BP_STORAGE.get<UserCredentials>('creds')
+    const creds = this.getCreds()
     await this.socket.connect(creds)
 
     if (this.socket.userId) {
@@ -39,4 +39,18 @@ export default class BpSocket {
       this.postToParent('', { userId })
     }
   }
+
+  public async reload(config: Config) {
+    this.config = config
+    const creds = this.getCreds()
+
+    if (creds?.userId !== this.socket.userId || creds?.userToken !== this.socket.creds?.userToken) {
+      await this.socket.disconnect()
+      await this.connect()
+    }
+  }
+
+  private getCreds() {
+    return this.config.customUser || window.BP_STORAGE.get<UserCredentials>('creds')
+  }
 }

packages/webchat/src/main.tsx

@@ -174,7 +174,16 @@ class Web extends React.Component<MainProps> {
       case 'configure':
         return this.props.updateConfig!(Object.assign({}, constants.DEFAULT_CONFIG, data.payload))
       case 'mergeConfig':
-        return this.props.mergeConfig!(data.payload)
+        this.props.mergeConfig!(data.payload)
+
+        const oldUserId = this.socket.socket.userId
+        await this.socket.reload(data.payload)
+
+        if (this.socket.socket.userId !== oldUserId) {
+          this.props.resetConversation!()
+          await this.props.initializeChat!()
+        }
+        return
       case 'sendPayload':
         return this.props.sendData!(data.payload)
       case 'event':
@@ -357,7 +366,8 @@ export default inject(({ store }: { store: RootStore }) => ({
   fetchConversation: store.fetchConversation,
   setIntlProvider: store.setIntlProvider,
   setSocket: store.setSocket,
-  currentConversationId: store.currentConversationId
+  currentConversationId: store.currentConversationId,
+  resetConversation: store.resetConversation
 }))(injectIntl(observer(Web)))
 
 type MainProps = { store?: RootStore } & WrappedComponentProps &
@@ -396,4 +406,5 @@ type MainProps = { store?: RootStore } & WrappedComponentProps &
     | 'setIntlProvider'
     | 'setSocket'
     | 'currentConversationId'
+    | 'resetConversation'
   >

packages/webchat/src/typings.ts

@@ -297,6 +297,13 @@ export interface Config {
    * @default ''
    */
   googleMapsAPIKey?: string
+  /**
+   * Allows setting a custom user id
+   */
+  customUser?: {
+    userId: string
+    userToken: string
+  }
 }
 
 export interface BotDetails {

yarn.lock

@@ -2487,7 +2487,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@botpress/webchat-inject@workspace:packages/inject"
   dependencies:
-    "@botpress/webchat": 0.3.3
+    "@botpress/webchat": 0.3.4
     "@parcel/config-default": ^2.2.1
     "@parcel/reporter-bundle-analyzer": 2.2.1
     "@parcel/transformer-typescript-tsc": ^2.2.1
@@ -2498,7 +2498,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@botpress/webchat@*, @botpress/webchat@0.3.3, @botpress/webchat@workspace:packages/webchat":
+"@botpress/webchat@*, @botpress/webchat@0.3.4, @botpress/webchat@workspace:packages/webchat":
   version: 0.0.0-use.local
   resolution: "@botpress/webchat@workspace:packages/webchat"
   dependencies: