Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 | 21x 21x 3x 18x 18x 3x 18x 18x 18x 18x 18x 18x 21x 21x 21x 21x 21x 6x 15x 15x 18x 6x 6x 6x 6x 6x 3x 3x 3x 3x 3x 3x 18x 12x 12x 12x 3x 9x 3x 6x 6x 6x 18x 12x 12x 12x 18x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 18x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 18x 3x 3x 3x 3x 3x 18x 3x 3x 3x 3x 3x 3x 3x 18x 18x 6x 6x 6x 3x 3x | /**
* Express adapter for Drizzle Cube
* Provides Cube.js-compatible API endpoints for Express applications with Drizzle ORM
*/
import express, { Router, Request, Response, NextFunction, Express } from 'express'
import cors from 'cors'
import type { CorsOptions } from 'cors'
import type {
SemanticQuery,
SecurityContext,
DatabaseExecutor,
DrizzleDatabase,
Cube
} from '../../server'
import { SemanticLayerCompiler } from '../../server'
import type { PostgresJsDatabase } from 'drizzle-orm/postgres-js'
import type { MySql2Database } from 'drizzle-orm/mysql2'
import type { BetterSQLite3Database } from 'drizzle-orm/better-sqlite3'
import {
handleDryRun,
formatCubeResponse,
formatSqlResponse,
formatMetaResponse,
formatErrorResponse,
handleBatchRequest
} from '../utils'
export interface ExpressAdapterOptions {
/**
* Array of cube definitions to register
*/
cubes: Cube[]
/**
* Drizzle database instance (REQUIRED)
* This is the core of drizzle-cube - Drizzle ORM integration
* Accepts PostgreSQL, MySQL, or SQLite database instances
*/
drizzle: PostgresJsDatabase<any> | MySql2Database<any> | BetterSQLite3Database<any> | DrizzleDatabase
/**
* Database schema for type inference (RECOMMENDED)
* Provides full type safety for cube definitions
*/
schema?: any
/**
* Extract security context from incoming HTTP request.
* Called for EVERY API request to determine user permissions and multi-tenant isolation.
*
* This is your security boundary - ensure proper authentication and authorization here.
*
* @param req - Express Request object containing the incoming HTTP request
* @param res - Express Response object
* @returns Security context with organisationId, userId, roles, etc.
*
* @example
* extractSecurityContext: async (req, res) => {
* // Extract JWT from Authorization header
* const token = req.headers.authorization?.replace('Bearer ', '')
* const decoded = await verifyJWT(token)
*
* // Return context that will be available in all cube SQL functions
* return {
* organisationId: decoded.orgId,
* userId: decoded.userId,
* roles: decoded.roles
* }
* }
*/
extractSecurityContext: (req: Request, res: Response) => SecurityContext | Promise<SecurityContext>
/**
* Database engine type (optional - auto-detected if not provided)
*/
engineType?: 'postgres' | 'mysql' | 'sqlite'
/**
* CORS configuration (optional)
*/
cors?: CorsOptions
/**
* API base path (default: '/cubejs-api/v1')
*/
basePath?: string
/**
* JSON body parser limit (default: '10mb')
*/
jsonLimit?: string
}
/**
* Create Express router for Cube.js-compatible API
*/
export function createCubeRouter(
options: ExpressAdapterOptions
): Router {
const {
cubes,
drizzle,
schema,
extractSecurityContext,
engineType,
cors: corsConfig,
basePath = '/cubejs-api/v1',
jsonLimit = '10mb'
} = options
// Validate required options
if (!cubes || cubes.length === 0) {
throw new Error('At least one cube must be provided in the cubes array')
}
const router = Router()
// Configure CORS if provided
if (corsConfig) {
router.use(cors(corsConfig))
}
// JSON body parser with size limit
router.use(express.json({ limit: jsonLimit }))
// URL-encoded parser (for GET requests with complex queries)
router.use(express.urlencoded({ extended: true, limit: jsonLimit }))
// Create semantic layer and register all cubes
const semanticLayer = new SemanticLayerCompiler({
drizzle,
schema,
engineType
})
// Register all provided cubes
cubes.forEach(cube => {
semanticLayer.registerCube(cube)
})
/**
* POST /cubejs-api/v1/load - Execute queries
*/
router.post(`${basePath}/load`, async (req: Request, res: Response) => {
try {
// Handle both direct query and nested query formats
const query: SemanticQuery = req.body.query || req.body
// Extract security context using user-provided function
const securityContext = await extractSecurityContext(req, res)
// Validate query structure and field existence
const validation = semanticLayer.validateQuery(query)
if (!validation.isValid) {
return res.status(400).json(formatErrorResponse(
`Query validation failed: ${validation.errors.join(', ')}`,
400
))
}
// Execute multi-cube query (handles both single and multi-cube automatically)
const result = await semanticLayer.executeMultiCubeQuery(query, securityContext)
// Return in official Cube.js format
res.json(formatCubeResponse(query, result, semanticLayer))
} catch (error) {
console.error('Query execution error:', error)
res.status(500).json(formatErrorResponse(
error instanceof Error ? error.message : 'Query execution failed',
500
))
}
})
/**
* GET /cubejs-api/v1/load - Execute queries via query string
*/
router.get(`${basePath}/load`, async (req: Request, res: Response) => {
try {
const queryParam = req.query.query as string
Iif (!queryParam) {
return res.status(400).json(formatErrorResponse(
'Query parameter is required',
400
))
}
let query: SemanticQuery
try {
query = JSON.parse(queryParam)
} catch (parseError) {
return res.status(400).json(formatErrorResponse(
'Invalid JSON in query parameter',
400
))
}
// Extract security context
const securityContext = await extractSecurityContext(req, res)
// Validate query structure and field existence
const validation = semanticLayer.validateQuery(query)
Iif (!validation.isValid) {
return res.status(400).json(formatErrorResponse(
`Query validation failed: ${validation.errors.join(', ')}`,
400
))
}
// Execute multi-cube query (handles both single and multi-cube automatically)
const result = await semanticLayer.executeMultiCubeQuery(query, securityContext)
// Return in official Cube.js format
res.json(formatCubeResponse(query, result, semanticLayer))
} catch (error) {
console.error('Query execution error:', error)
res.status(500).json(formatErrorResponse(
error instanceof Error ? error.message : 'Query execution failed',
500
))
}
})
/**
* POST /cubejs-api/v1/batch - Execute multiple queries in a single request
* Optimizes network overhead for dashboards with many portlets
*/
router.post(`${basePath}/batch`, async (req: Request, res: Response) => {
try {
const { queries } = req.body as { queries: SemanticQuery[] }
if (!queries || !Array.isArray(queries)) {
return res.status(400).json(formatErrorResponse(
'Request body must contain a "queries" array',
400
))
}
if (queries.length === 0) {
return res.status(400).json(formatErrorResponse(
'Queries array cannot be empty',
400
))
}
// Extract security context ONCE (shared across all queries)
const securityContext = await extractSecurityContext(req, res)
// Use shared batch handler (wraps existing single query logic)
const batchResult = await handleBatchRequest(queries, securityContext, semanticLayer)
res.json(batchResult)
} catch (error) {
console.error('Batch execution error:', error)
res.status(500).json(formatErrorResponse(
error instanceof Error ? error.message : 'Batch execution failed',
500
))
}
})
/**
* GET /cubejs-api/v1/meta - Get cube metadata
* Optimized for fast response times with caching
*/
router.get(`${basePath}/meta`, (_req: Request, res: Response) => {
try {
// Extract security context (some apps may want to filter cubes by context)
// await getSecurityContext(req, res) // Available if needed for filtering
// Get cached metadata (fast path)
const metadata = semanticLayer.getMetadata()
res.json(formatMetaResponse(metadata))
} catch (error) {
console.error('Metadata error:', error)
res.status(500).json(formatErrorResponse(
error instanceof Error ? error.message : 'Failed to fetch metadata',
500
))
}
})
/**
* POST /cubejs-api/v1/sql - Generate SQL without execution (dry run)
*/
router.post(`${basePath}/sql`, async (req: Request, res: Response) => {
try {
const query: SemanticQuery = req.body
const securityContext = await extractSecurityContext(req, res)
// Validate query structure and field existence
const validation = semanticLayer.validateQuery(query)
Iif (!validation.isValid) {
return res.status(400).json(formatErrorResponse(
`Query validation failed: ${validation.errors.join(', ')}`,
400
))
}
// For SQL generation, we need at least one cube referenced
const firstMember = query.measures?.[0] || query.dimensions?.[0]
Iif (!firstMember) {
return res.status(400).json(formatErrorResponse(
'No measures or dimensions specified',
400
))
}
const cubeName = firstMember.split('.')[0]
// Generate SQL using the semantic layer compiler
const sqlResult = await semanticLayer.generateSQL(cubeName, query, securityContext)
res.json(formatSqlResponse(query, sqlResult))
} catch (error) {
console.error('SQL generation error:', error)
res.status(500).json(formatErrorResponse(
error instanceof Error ? error.message : 'SQL generation failed',
500
))
}
})
/**
* GET /cubejs-api/v1/sql - Generate SQL via query string
*/
router.get(`${basePath}/sql`, async (req: Request, res: Response) => {
try {
const queryParam = req.query.query as string
Iif (!queryParam) {
return res.status(400).json(formatErrorResponse(
'Query parameter is required',
400
))
}
const query: SemanticQuery = JSON.parse(queryParam)
const securityContext = await extractSecurityContext(req, res)
// Validate query structure and field existence
const validation = semanticLayer.validateQuery(query)
Iif (!validation.isValid) {
return res.status(400).json(formatErrorResponse(
`Query validation failed: ${validation.errors.join(', ')}`,
400
))
}
// For SQL generation, we need at least one cube referenced
const firstMember = query.measures?.[0] || query.dimensions?.[0]
Iif (!firstMember) {
return res.status(400).json(formatErrorResponse(
'No measures or dimensions specified',
400
))
}
const cubeName = firstMember.split('.')[0]
// Generate SQL using the semantic layer compiler
const sqlResult = await semanticLayer.generateSQL(cubeName, query, securityContext)
res.json(formatSqlResponse(query, sqlResult))
} catch (error) {
console.error('SQL generation error:', error)
res.status(500).json(formatErrorResponse(
error instanceof Error ? error.message : 'SQL generation failed',
500
))
}
})
/**
* POST /cubejs-api/v1/dry-run - Validate queries without execution
*/
router.post(`${basePath}/dry-run`, async (req: Request, res: Response) => {
try {
// Handle both direct query and nested query formats
const query: SemanticQuery = req.body.query || req.body
// Extract security context using user-provided function
const securityContext = await extractSecurityContext(req, res)
// Perform dry-run analysis
const result = await handleDryRun(query, securityContext, semanticLayer)
res.json(result)
} catch (error) {
console.error('Dry-run error:', error)
res.status(400).json({
error: error instanceof Error ? error.message : 'Dry-run validation failed',
valid: false
})
}
})
/**
* GET /cubejs-api/v1/dry-run - Validate queries via query string
*/
router.get(`${basePath}/dry-run`, async (req: Request, res: Response) => {
try {
const queryParam = req.query.query as string
Iif (!queryParam) {
return res.status(400).json({
error: 'Query parameter is required',
valid: false
})
}
const query: SemanticQuery = JSON.parse(queryParam)
// Extract security context
const securityContext = await extractSecurityContext(req, res)
// Perform dry-run analysis
const result = await handleDryRun(query, securityContext, semanticLayer)
res.json(result)
} catch (error) {
console.error('Dry-run error:', error)
res.status(400).json({
error: error instanceof Error ? error.message : 'Dry-run validation failed',
valid: false
})
}
})
// Error handling middleware for the router
router.use((error: Error, _req: Request, res: Response, _next: NextFunction) => {
console.error('Express adapter error:', error)
if (!res.headersSent) {
res.status(500).json(formatErrorResponse(error, 500))
}
})
return router
}
/**
* Convenience function to mount Cube routes on an existing Express app
*/
export function mountCubeRoutes(
app: Express,
options: ExpressAdapterOptions
): Express {
const cubeRouter = createCubeRouter(options)
app.use('/', cubeRouter)
return app
}
/**
* Create a complete Express app with Cube.js routes
*
* @example
* const app = createCubeApp({
* cubes: [salesCube, employeesCube],
* drizzle: db,
* schema,
* extractSecurityContext: async (req, res) => {
* const token = req.headers.authorization?.replace('Bearer ', '')
* const decoded = await verifyJWT(token)
* return { organisationId: decoded.orgId, userId: decoded.userId }
* }
* })
*/
export function createCubeApp(
options: ExpressAdapterOptions
): Express {
const app = express()
return mountCubeRoutes(app, options)
}
// Re-export types for convenience
export type { SecurityContext, DatabaseExecutor, SemanticQuery, DrizzleDatabase, CorsOptions } |