Eager DB client initialization makes the DB required to preview the docs

Abierto
#590 1 comentario 3 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
postgresql, typescript
Área
build-system, database, documentation

Línea de trabajo

Empieza por las líneas 5-21 de src/db/client.ts y reproduce una compilación o vista previa de la documentación sin DATABASE_URL. Rastrea qué rutas de documentación inicializan el cliente y compáralas con las rutas que realmente necesitan acceso a la base de datos. El trabajo estará terminado cuando la documentación pueda compilarse y previsualizarse sin una base de datos, mientras que el comportamiento respaldado por la base de datos siga funcionando cuando esté configurado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

https://github.com/TanStack/tanstack.com/blob/b5379db43a8112a5e929260e992099b58f61734a/src/db/client.ts#L5-L21

If there is no DB connection set, the build will fail. On docs only contributions, it is annoying.

As a workaround, I'm doing this:

function lazyObject<T extends object>(factory: () => T): T {
  let value: T | undefined = undefined
  return new Proxy({} as T, {
    get(_, prop) {
      if (!value) value = factory()
      return value[prop as keyof T]
    },
  }) as T
}

export const db = lazyObject(() => {
  // Create the connection string from environment variable
  const connectionString = process.env.DATABASE_URL

  if (!connectionString) {
    throw new Error('DATABASE_URL environment variable is not set')
  }

  // Create postgres client
  // For serverless environments, use connection pooling
  const client = postgres(connectionString, {
    max: 1, // For serverless, limit connections
    idle_timeout: 20,
    connect_timeout: 10,
  })

  // Create drizzle instance with schema
  return drizzle(client, { schema })
})

Is that ok for a workaround for a PR, or is there a better pattern or approach? Passing it though the backend context? Or maybe a React's cache like API in start? 🤔

Lenguaje dominante
TypeScript
Estrellas
1.1k
Forks
401
Merge medio
18 h 44 min
PR fusionados (30 d)
55

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TanStack/tanstack.com

Todos los issues de TanStack/tanstack.com

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.