Files
zpan/server/entry-node.ts
T
saltbo 53ca110218 feat(about): split runtime into runtime engine + deployment platform
Flatten the instance `runtime` object into two fields: `runtime` (the JS engine,
node | workerd) and `platform` (the deployment host). The About page shows each
as its own row with friendly labels (e.g. "workerd" + "Cloudflare Workers",
"Node.js" + "Docker").

- Detect the platform from the entry file (entry === target): each serverless
  entry declares it; entry-node sniffs Cloud Run (K_SERVICE) / Docker
  (ZPAN_RUNTIME, set in the Dockerfile) / bare node. Cloudflare is detected from
  the D1 binding.
- Decouple the cloud payload: zpan-cloud-sdk fixes runtime { provider, target },
  so CloudInstanceInfo keeps that shape and buildCloudInstanceInfo maps to it;
  buildInstanceInfo serves the richer flat shape to the About API.
- Migrate PostHog instance telemetry to the runtime/platform shape and merge the
  duplicate runtimeInfo in licensing-admin into the shared one.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-09 14:56:29 -04:00

137 lines
5.5 KiB
TypeScript

import { existsSync } from 'node:fs'
import { release as osRelease } from 'node:os'
import { serve } from '@hono/node-server'
import { serveStatic } from '@hono/node-server/serve-static'
import { Hono } from 'hono'
import { resolveAppCommit, resolveAppVersion } from '../scripts/app-version.mjs'
import { ZPAN_CLOUD_URL_DEFAULT } from '../shared/constants'
import { createBootstrap } from './bootstrap'
import { buildCloudInstanceInfo, runtimeInfo } from './licensing/instance-info'
import { createLibsqlPlatform } from './platform/libsql'
import { createNodePlatform } from './platform/node'
import { type DeployPlatform, setDeployPlatform } from './runtime-platform'
import { syncPendingCloudTrafficReports } from './services/cloud-traffic-metering'
import { resetExpiredTrafficQuotas } from './services/effective-quota'
import { INSTANCE_TELEMETRY_CRON, reportInstanceTelemetry } from './services/instance-telemetry'
import { runLicensingRefresh } from './services/licensing-refresh-runner'
import { syncPendingRemoteDownloadUsageReports } from './services/remote-download-usage'
import { getSitePublicOrigin } from './services/site-public-origin'
const REFRESH_INTERVAL_MS = 6 * 60 * 60 * 1000 // 6 hours
const TRAFFIC_SYNC_INTERVAL_MS = 10 * 60 * 1000 // 10 minutes
const INSTANCE_TELEMETRY_INTERVAL_MS = 12 * 60 * 60 * 1000 // 12 hours
const QUOTA_RESET_INTERVAL_MS = 24 * 60 * 60 * 1000 // daily; idempotent, resets only stale periods
const appVersionGlobalKey = '__ZPAN_APP_VERSION__'
const appCommitGlobalKey = '__ZPAN_APP_COMMIT__'
// tsx runs this entry directly (dev + E2E) without the tsup build-time define,
// so resolve the version at runtime. In the built output the define inlines the
// constant, turning this condition into `if (false)`, so resolveAppVersion is
// never reached and git is never invoked in production. The assignment uses
// bracket access so the define does not rewrite it into an invalid literal LHS.
if (!globalThis.__ZPAN_APP_VERSION__) {
globalThis[appVersionGlobalKey] = resolveAppVersion()
}
if (globalThis.__ZPAN_APP_COMMIT__ === undefined) {
globalThis[appCommitGlobalKey] = resolveAppCommit()
}
// The Node entry serves Cloud Run, Docker, and bare Node. Cloud Run sets
// K_SERVICE; the Docker image sets ZPAN_RUNTIME=docker (falling back to the
// /.dockerenv marker); otherwise it is plain Node.
function detectNodePlatform(): DeployPlatform {
if (process.env.K_SERVICE) return 'cloud-run'
if (process.env.ZPAN_RUNTIME === 'docker' || existsSync('/.dockerenv')) return 'docker'
return 'node'
}
setDeployPlatform(detectNodePlatform())
const platform = process.env.TURSO_DATABASE_URL
? await createLibsqlPlatform({
TURSO_DATABASE_URL: process.env.TURSO_DATABASE_URL,
TURSO_AUTH_TOKEN: process.env.TURSO_AUTH_TOKEN,
})
: createNodePlatform()
const app = await createBootstrap(platform)
const server = new Hono()
server.route('/', app)
server.use('/*', serveStatic({ root: './dist' }))
server.get('/*', serveStatic({ root: './dist', path: 'index.html' }))
const port = Number(process.env.PORT) || 8222
console.log(`ZPan server running on http://localhost:${port}`)
serve({ fetch: server.fetch, port })
// Start licensing refresh background scheduler
const cloudBaseUrl = process.env.ZPAN_CLOUD_URL ?? ZPAN_CLOUD_URL_DEFAULT
function envAllowsIp(value: string | undefined): boolean {
return !['0', 'false', 'no', 'off'].includes(value?.trim().toLowerCase() ?? '')
}
function isGitHubActionsE2E(): boolean {
return process.env.GITHUB_ACTIONS === 'true' && process.env.BETTER_AUTH_URL === 'http://localhost:5185'
}
console.log('licensing.refresh.scheduler.started interval=6h')
setInterval(() => {
// runLicensingRefresh handles all errors internally and never rejects.
void (async () => {
const instanceUrl = await getSitePublicOrigin(platform.db)
const instance = instanceUrl
? await buildCloudInstanceInfo(platform.db, {
url: instanceUrl,
runtime: runtimeInfo(platform),
})
: undefined
await runLicensingRefresh(platform.db, cloudBaseUrl, instance)
})()
}, REFRESH_INTERVAL_MS)
console.log('traffic.sync.scheduler.started interval=10m')
setInterval(() => {
void syncPendingCloudTrafficReports({ db: platform.db, cloudBaseUrl })
void syncPendingRemoteDownloadUsageReports({ db: platform.db, cloudBaseUrl })
}, TRAFFIC_SYNC_INTERVAL_MS)
function reportNodeInstanceTelemetry(): void {
if (isGitHubActionsE2E()) return
void (async () => {
try {
await reportInstanceTelemetry({
db: platform.db,
config: {
allowIp: envAllowsIp(process.env.ZPAN_TELEMETRY_ALLOW_IP),
},
cron: INSTANCE_TELEMETRY_CRON,
trigger: 'runtime',
runtime: {
runtime: 'node',
platform: detectNodePlatform(),
osPlatform: process.platform,
osArch: process.arch,
osRelease: osRelease(),
nodeVersion: process.version,
},
})
} catch (err) {
const code = err instanceof Error ? err.message : String(err)
console.error(`instance.telemetry.error code=${code}`)
}
})()
}
console.log('instance.telemetry.scheduler.started interval=12h')
reportNodeInstanceTelemetry()
setInterval(reportNodeInstanceTelemetry, INSTANCE_TELEMETRY_INTERVAL_MS)
console.log('quota.reset.scheduler.started interval=24h')
// Run once at boot to catch a month boundary crossed while the server was down.
void resetExpiredTrafficQuotas(platform.db)
setInterval(() => {
void resetExpiredTrafficQuotas(platform.db)
}, QUOTA_RESET_INTERVAL_MS)