feat(sockets): enable sockets by default (#364)

* feat(sockets): enable sockets by default

* typing

* migration

packages/inject/README.md

@@ -24,4 +24,4 @@ For example with a server started on port 8080, and a messaging server started o
 </html>
 ```
 
-`hostUrl` should be the same base url that you get the inject.js script from. `messagingUrl` is simply the the url of the messaging server. To test this locally you will need to have a messaging server running as standalone from botpress (using the MESSAGING_ENDPOINT variable) with sockets enabled (ENABLE_EXPERIMENTAL_SOCKETS=true on the messaging server)
+`hostUrl` should be the same base url that you get the inject.js script from. `messagingUrl` is simply the the url of the messaging server. To test this locally you will need to have a messaging server running as standalone from botpress (using the MESSAGING_ENDPOINT variable)

packages/server/src/global.ts

@@ -14,6 +14,7 @@ export type MessagingEnv = EngineEnv & {
   APM_ENABLED?: string
   TWILIO_TESTING?: string
   BILLING_ENDPOINT?: string
+  DISABLE_SOCKETS?: string
 }
 
 declare global {

packages/server/src/migrations/1.1.0-user-tokens.ts

@@ -0,0 +1,33 @@
+import { getTableId, Migration } from '@botpress/messaging-engine'
+
+export class UserTokensMigration extends Migration {
+  meta = {
+    name: UserTokensMigration.name,
+    description: 'Adds msg_user_tokens table',
+    version: '1.1.0'
+  }
+
+  async valid() {
+    return true
+  }
+
+  async applied() {
+    return this.trx.schema.hasTable(getTableId('msg_user_tokens'))
+  }
+
+  async up() {
+    // since it was possible to have this table created in the past with an experimental option, we delete it here
+    await this.trx.schema.dropTableIfExists(getTableId('msg_user_tokens'))
+
+    await this.trx.schema.createTable(getTableId('msg_user_tokens'), (table) => {
+      table.uuid('id').primary()
+      table.uuid('userId').references('id').inTable(getTableId('msg_users'))
+      table.string('token').notNullable()
+      table.timestamp('expiry').nullable()
+    })
+  }
+
+  async down() {
+    await this.trx.schema.dropTable(getTableId('msg_user_tokens'))
+  }
+}

packages/server/src/migrations/index.ts

@@ -4,11 +4,13 @@ import { StatusMigration } from './0.1.19-status'
 import { FixClientSchemaMigration } from './0.1.20-fix-client-schema'
 import { ClientTokensMigration } from './0.1.21-client-tokens'
 import { ChannelVersionsMigration } from './1.0.2-channel-versions'
+import { UserTokensMigration } from './1.1.0-user-tokens'
 
 export const Migrations: { new (): Migration }[] = [
   InitMigration,
   StatusMigration,
   FixClientSchemaMigration,
   ClientTokensMigration,
-  ChannelVersionsMigration
+  ChannelVersionsMigration,
+  UserTokensMigration
 ]

packages/server/src/socket/manager.ts

@@ -24,11 +24,13 @@ export class SocketManager {
   ) {}
 
   async setup(server: Server) {
-    if (yn(process.env.ENABLE_EXPERIMENTAL_SOCKETS)) {
-      this.ws = new Socket.Server(server, { serveClient: false, cors: { origin: '*' } })
-      this.ws.use(this.handleSocketAuthentication.bind(this))
-      this.ws.on('connection', this.handleSocketConnection.bind(this))
+    if (yn(process.env.DISABLE_SOCKETS)) {
+      return
     }
+
+    this.ws = new Socket.Server(server, { serveClient: false, cors: { origin: '*' } })
+    this.ws.use(this.handleSocketAuthentication.bind(this))
+    this.ws.on('connection', this.handleSocketConnection.bind(this))
   }
 
   async destroy() {

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

@@ -36,11 +36,6 @@ export class UserTokenService extends Service {
   }
 
   async setup() {
-    if (!yn(process.env.ENABLE_EXPERIMENTAL_SOCKETS)) {
-      // let's not create a table we don't need for now
-      return
-    }
-
     this.batcher = await this.batchingService.newBatcher(
       'batcher_user_tokens',
       [this.userService.batcher],

packages/server/test/integration/client-tokens.test.ts

@@ -17,9 +17,6 @@ describe('ClientTokens', () => {
   }
 
   beforeAll(async () => {
-    // This should be reset after those tests
-    process.env.ENABLE_EXPERIMENTAL_SOCKETS = '1'
-
     await setupApp()
     clientTokens = app.clientTokens
     querySpy = jest.spyOn(clientTokens as any, 'query')

packages/server/test/integration/user-tokens.test.ts

@@ -12,9 +12,6 @@ describe('UserTokens', () => {
   let state: { provider: Provider; client: Client; user: User; rawToken?: string; userToken?: UserToken }
 
   beforeAll(async () => {
-    // This should be reset after those tests
-    process.env.ENABLE_EXPERIMENTAL_SOCKETS = '1'
-
     await setupApp()
     userTokens = app.userTokens
     querySpy = jest.spyOn(userTokens as any, 'query')

test/jest.e2e.setup.ts

@@ -8,7 +8,6 @@ import { v4 as uuidv4 } from 'uuid'
 
 const setup = async () => {
   process.env.SKIP_LOAD_ENV = 'true'
-  process.env.ENABLE_EXPERIMENTAL_SOCKETS = 'true'
   process.env.ADMIN_KEY = 'admin123'
   process.env.DATABASE_URL = process.env.DATABASE_URL || path.join(__dirname, '.test-data', `${uuidv4()}.sqlite`)