Adds client config fn for websockets

wasp-lang · Jul 23, 2024 · b72be8e · b72be8e
1 parent ecf1f82
commit b72be8e
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 11 deletions.
diff --git a/waspc/data/Generator/templates/sdk/wasp/client/webSocket/WebSocketProvider.tsx b/waspc/data/Generator/templates/sdk/wasp/client/webSocket/WebSocketProvider.tsx
@@ -8,15 +8,27 @@ import { config } from 'wasp/client'
 
 import type { ClientToServerEvents, ServerToClientEvents } from 'wasp/server/webSocket';
 
-export type WebSocketContextValue = {
-  socket: typeof socket
-  isConnected: boolean
-}
+{=# configFn.isDefined =}
+{=& configFn.importStatement =}
+{=/ configFn.isDefined =}
+
+// PUBLIC API
+export type WebSocketClientConfigFn = () => IoConfig
+
+type IoConfig = Parameters<typeof io>[1]
+
+{=# configFn.isDefined =}
+const ioConfig = {= configFn.importIdentifier =}()
+{=/ configFn.isDefined =}
+{=^ configFn.isDefined =}
+const ioConfig = {
+  autoConnect: {= autoConnect =},
+  transports: ['websocket'],
+} satisfies IoConfig;
+{=/ configFn.isDefined =}
 
 // PRIVATE API
-// TODO: In the future, it would be nice if users could pass more
-// options to `io`, likely via some `configFn`.
-export const socket: Socket<ServerToClientEvents, ClientToServerEvents> = io(config.apiUrl, { autoConnect: {= autoConnect =} })
+export const socket: Socket<ServerToClientEvents, ClientToServerEvents> = io(config.apiUrl, ioConfig)
 
 function refreshAuthToken() {
   // NOTE: When we figure out how `auth: true` works for Operations, we should
@@ -35,6 +47,12 @@ refreshAuthToken()
 apiEventsEmitter.on('sessionId.set', refreshAuthToken)
 apiEventsEmitter.on('sessionId.clear', refreshAuthToken)
 
+// PRIVATE API
+export type WebSocketContextValue = {
+  socket: typeof socket
+  isConnected: boolean
+}
+
 // PRIVATE API
 export const WebSocketContext: Context<WebSocketContextValue> = createContext<WebSocketContextValue>({
   socket,

diff --git a/waspc/data/Generator/templates/sdk/wasp/client/webSocket/index.ts b/waspc/data/Generator/templates/sdk/wasp/client/webSocket/index.ts
@@ -5,6 +5,9 @@ import type {
   ServerToClientEvents,
 } from 'wasp/server/webSocket'
 
+// PUBLIC API
+export type { WebSocketClientConfigFn } from './WebSocketProvider'
+
 // PUBLIC API
 export type ServerToClientPayload<Event extends keyof ServerToClientEvents> =
   Parameters<ServerToClientEvents[Event]>[0]

diff --git a/waspc/examples/todoApp/main.wasp b/waspc/examples/todoApp/main.wasp
@@ -5,7 +5,8 @@ app todoApp {
   title: "ToDo App",
   // head: [],
   webSocket: {
-    fn: import { webSocketFn } from "@src/webSocket",
+    fn: import { webSocketFn } from "@src/webSocket/index.js",
+    clientConfigFn: import { getConfig } from "@src/webSocket/clientConfigFn.js",
     // autoConnect: false
   },
   auth: {

diff --git a/waspc/examples/todoApp/src/webSocket/clientConfigFn.ts b/waspc/examples/todoApp/src/webSocket/clientConfigFn.ts
@@ -0,0 +1,5 @@
+import { WebSocketClientConfigFn } from 'wasp/client/webSocket'
+
+export const getConfig: WebSocketClientConfigFn = () => ({
+  transports: ['polling'],
+})
diff --git a/waspc/examples/todoApp/src/webSocket.ts → ...c/examples/todoApp/src/webSocket/index.ts b/waspc/examples/todoApp/src/webSocket.ts → ...c/examples/todoApp/src/webSocket/index.ts
diff --git a/waspc/src/Wasp/AppSpec/App/WebSocket.hs b/waspc/src/Wasp/AppSpec/App/WebSocket.hs
@@ -10,6 +10,7 @@ import Wasp.AppSpec.ExtImport (ExtImport)
 
 data WebSocket = WebSocket
   { fn :: ExtImport,
+    clientConfigFn :: Maybe ExtImport,
     autoConnect :: Maybe Bool
   }
   deriving (Show, Eq, Data)
diff --git a/waspc/src/Wasp/Generator/Common.hs b/waspc/src/Wasp/Generator/Common.hs
@@ -11,6 +11,7 @@ module Wasp.Generator.Common
     GeneratedSrcDir,
     makeJsArrayFromHaskellList,
     dropExtensionFromImportPath,
+    makeJsBoolFromHaskellBool,
   )
 where
 
@@ -77,6 +78,10 @@ makeJsArrayFromHaskellList list = "[" ++ intercalate ", " listOfJsStrings ++ "]"
   where
     listOfJsStrings = map (\s -> "'" ++ s ++ "'") list
 
+makeJsBoolFromHaskellBool :: Bool -> String
+makeJsBoolFromHaskellBool True = "true"
+makeJsBoolFromHaskellBool False = "false"
+
 dropExtensionFromImportPath :: Path Posix (Rel r) (File f) -> Path Posix (Rel r) (File f)
 dropExtensionFromImportPath = fromJust . SP.parseRelFileP . dropExtension . SP.fromRelFileP
   where

diff --git a/waspc/src/Wasp/Generator/SdkGenerator/WebSocketGenerator.hs b/waspc/src/Wasp/Generator/SdkGenerator/WebSocketGenerator.hs
@@ -5,15 +5,14 @@ module Wasp.Generator.SdkGenerator.WebSocketGenerator
 where
 
 import Data.Aeson (object, (.=))
-import Data.Char (toLower)
 import StrongPath (relfile)
 import Wasp.AppSpec (AppSpec)
 import qualified Wasp.AppSpec as AS
 import qualified Wasp.AppSpec.App as AS.App
 import qualified Wasp.AppSpec.App.Dependency as AS.Dependency
 import qualified Wasp.AppSpec.App.WebSocket as AS.App.WS
 import Wasp.AppSpec.Valid (getApp, isAuthEnabled)
-import Wasp.Generator.Common (makeJsonWithEntityData)
+import Wasp.Generator.Common (makeJsBoolFromHaskellBool, makeJsonWithEntityData)
 import Wasp.Generator.FileDraft (FileDraft)
 import qualified Wasp.Generator.JsImport as GJI
 import Wasp.Generator.Monad (Generator)
@@ -50,7 +49,12 @@ genWebSocketProvider spec = return $ C.mkTmplFdWithData [relfile|client/webSocke
   where
     maybeWebSocket = AS.App.webSocket $ snd $ getApp spec
     shouldAutoConnect = (AS.App.WS.autoConnect <$> maybeWebSocket) /= Just (Just False)
-    tmplData = object ["autoConnect" .= map toLower (show shouldAutoConnect)]
+    maybeClientConfigFn = extImportToJsImport <$> (maybeWebSocket >>= AS.App.WS.clientConfigFn)
+    tmplData =
+      object
+        [ "autoConnect" .= makeJsBoolFromHaskellBool shouldAutoConnect,
+          "configFn" .= GJI.jsImportToImportJson maybeClientConfigFn
+        ]
 
 depsRequiredByWebSockets :: AppSpec -> [AS.Dependency.Dependency]
 depsRequiredByWebSockets spec