feat: Convex integration with backend

Author: NamesMT

apps/backend/.env

@@ -2,6 +2,8 @@
 
 # STREAMING_ENABLED=true
 # FRONTEND_URL=https://YOUR_FRONTEND_URL
+# CONVEX_URL=https://YOUR_CONVEX_URL
+
 
 # KINDE_DOMAIN=https://<YOUR_SUBDOMAIN>.kinde.com
 # KINDE_CLIENT_ID=<YOUR_CLIENT_ID>

apps/backend/.env.local

@@ -3,6 +3,7 @@ APP_DEV_host=127.0.0.1
 APP_DEV_port=3301
 
 FRONTEND_URL=https://127.0.0.1:3300
+CONVEX_URL=
 
 # KINDE_DOMAIN=https://<YOUR_SUBDOMAIN>.kinde.com
 # KINDE_CLIENT_ID=<YOUR_CLIENT_ID>

apps/backend/package.json

@@ -31,7 +31,9 @@
     "@scalar/hono-api-reference": "^0.9.3",
     "@vitest/coverage-v8": "^3.2.2",
     "arktype": "^2.1.20",
+    "backend-convex": "workspace:*",
     "consola": "^3.4.2",
+    "convex": "^1.24.8",
     "hono": "^4.7.11",
     "hono-adapter-aws-lambda": "^1.3.3",
     "hono-openapi": "^0.4.8",

apps/backend/src/api/dummy/hello.helper.ts

@@ -1,4 +1,4 @@
 import { i18nComposer } from '#src/helpers/i18n.js'
 
 // This isa sample for structuring guide
-export const getHelloMessage = () => `${i18nComposer.t('hello-from-/x', { x: 'i18n and Hono' })}! - ${Date.now()}`
+export const getHelloMessage = (from: string) => `${i18nComposer.t('hello-from-/x', { x: from })}! - ${Date.now()}`

apps/backend/src/api/dummy/hello.ts

@@ -1,5 +1,10 @@
 import { appFactory } from '#src/helpers/factory.js'
+import { getCachedConvexClient } from '#src/providers/baas/convex-main.js'
 import { getHelloMessage } from './hello.helper'
 
 export const dummyHelloRouteApp = appFactory.createApp()
-  .get('', async c => c.text(getHelloMessage()))
+  .get('', async (c) => {
+    const convexClient = getCachedConvexClient()
+
+    return c.text(getHelloMessage(`i18n and Hono ${convexClient ? '(+ Convex detected)' : ''}`))
+  })

apps/backend/src/dev.ts

@@ -1,8 +1,12 @@
 import { localcertKeyPath, localcertPath } from '@local/common/dev/cert'
+import { getConvexEnvs } from 'backend-convex/_util'
 import { serve } from 'srvx'
 import { env } from 'std-env'
 import { app } from './app'
 
+// Try load CONVEX_URL from local dev env
+env.CONVEX_URL ||= (await getConvexEnvs()).CONVEX_URL
+
 // Serve local server
 serve({
   fetch(request) {

apps/backend/src/providers/baas/convex-main.ts

@@ -0,0 +1,33 @@
+import { logger } from '#src/helpers/logger.js'
+import { ConvexHttpClient } from 'convex/browser'
+import { env } from 'std-env'
+import { cacheProvider, getCachedProvider, isNonSharingPlatforms } from '..'
+
+export function getCachedConvexClient() {
+  return getCachedProvider<ConvexHttpClient>('convex-main--client')
+}
+
+export async function getConvexClient() {
+  const cachedClient = getCachedConvexClient()
+
+  if (!cachedClient && !isNonSharingPlatforms)
+    throw new Error('Not initialized')
+
+  return cachedClient ?? await initConvexClient()
+}
+
+export async function initConvexClient() {
+  const cachedClient = getCachedConvexClient()
+
+  if (!isNonSharingPlatforms && cachedClient)
+    logger.warn('Already initialized')
+
+  if (!env.CONVEX_URL)
+    return logger.error('CONVEX_URL is not set')
+
+  const client = new ConvexHttpClient(env.CONVEX_URL!)
+
+  cacheProvider('convex-main--client', client)
+
+  return client
+}

apps/backend/src/providers/index.ts

@@ -2,6 +2,7 @@ import { env as honoEnv } from 'hono/adapter'
 import { createMiddleware } from 'hono/factory'
 import { runtime } from 'std-env'
 import { initKindeClient } from './auth/kinde-main'
+import { initConvexClient } from './baas/convex-main'
 
 export const nonSharingPlatforms = new Set(['workerd'])
 export const isNonSharingPlatforms = nonSharingPlatforms.has(runtime)
@@ -31,6 +32,7 @@ export const providersInit = createMiddleware(async (c, next) => {
     if (!providersState.initialized) {
       await Promise.all([
         initKindeClient(),
+        initConvexClient(),
       ])
 
       providersState.initialized = true