feat: zentrale selfhost-dienste bereitstellen

This commit is contained in:
2026-08-02 16:34:10 +02:00
parent d3ad53bcf0
commit 8b8e0c97d3
30 changed files with 1818 additions and 74 deletions

View File

@@ -15,5 +15,12 @@ APNS_PRODUCTION=false
ANDROID_SENDER_ID=
FCM_PROJECT_ID=
FCM_SERVICE_ACCOUNT_JSON=
# Zentral betriebene, abrechenbare Dienste
OPENAI_API_KEY=
OPENAI_BASE_URL=https://api.openai.com/v1
GOCARDLESS_BASE_URL=https://bankaccountdata.gocardless.com/api/v2
GOCARDLESS_SECRET_ID=
GOCARDLESS_SECRET_KEY=
NUXT_PUBLIC_API_BASE=http://localhost:4020
NUXT_ADMIN_TOKEN=change-me-admin-token

View File

@@ -1,6 +1,6 @@
# FEDEO Push Server
# FEDEO Central Services
Eigenständiger Stack für den zentralen FEDEO Push-Transportdienst. Selfhosted FEDEO-Instanzen registrieren Geräte lokal und leiten nur technische Push-Aufträge an diesen Dienst weiter. Die Instanzen authentifizieren sich mit einem rotierbaren Schlüssel, der im Admin-Dashboard gepflegt wird.
Eigenständiger Stack für zentrale FEDEO-Dienste. Neben Push können Selfhost-Instanzen darüber freigeschaltete und verbrauchsabhängig erfasste KI- und Banking-Dienste verwenden. Die Instanzen authentifizieren sich mit einem rotierbaren HMAC-Schlüssel, der im Admin-Dashboard gepflegt wird.
## Bestandteile
@@ -9,6 +9,8 @@ Eigenständiger Stack für den zentralen FEDEO Push-Transportdienst. Selfhosted
- `packages/db`: Drizzle Schema und Migrationen für PostgreSQL
- `docker-compose.yml`: lokaler Stack aus Postgres, API und Admin
Provider-Schlüssel wie `OPENAI_API_KEY` und die GoCardless-Zugangsdaten liegen ausschließlich in diesem zentralen Stack. Selfhost-Instanzen erhalten nur Instanz-ID und Instanzschlüssel.
## Entwicklung
```bash
@@ -20,6 +22,16 @@ npm run dev:api
npm run dev:admin
```
Für den dauerhaften Betrieb:
```bash
cp .env.example .env
# .env mit sicheren Zugangsdaten und Provider-Schlüsseln befüllen
docker compose up -d --build
```
Der API-Container wendet Datenbankmigrationen vor jedem Start automatisch an. PostgreSQL-Daten liegen im Volume `push_postgres_data`. Für ein öffentliches Deployment müssen API und Admin hinter einem TLS-Reverse-Proxy betrieben und `PUBLIC_API_BASE_URL` auf die öffentliche API-Adresse gesetzt werden.
Standardports:
- API: `http://localhost:4020`
@@ -70,6 +82,13 @@ const signature = createHmac("sha256", clientSecret).update(canonical).digest("h
- `DELETE /v1/devices/:centralDeviceId`
- `POST /v1/push`
- `GET /v1/push/:deliveryJobId`
- `POST /v1/services/ai/chat-completions`
- `GET /v1/services/banking/institutions`
- `POST /v1/services/banking/requisitions`
- `GET /v1/services/banking/requisitions/:id`
- `GET /v1/services/banking/accounts/:id`
- `GET /v1/services/banking/accounts/:id/balances`
- `GET /v1/services/banking/accounts/:id/transactions`
Admin:
@@ -80,6 +99,19 @@ Admin:
- `POST /admin/instances/:id/rotate-secret`
- `GET /admin/instances/:id/devices`
- `GET /admin/instances/:id/jobs`
- `GET /admin/instances/:id/services`
- `PUT /admin/instances/:id/services/:service`
- `GET /admin/instances/:id/usage`
- `GET /admin/usage/summary`
## Freischaltung und Abrechnung
Die Dienste `ai` und `banking` sind für neue Instanzen standardmäßig gesperrt. Im Instanzdetail des Admin-Dashboards werden sie einzeln aktiviert. Pro Dienst können ein Monatslimit und ein Preis in Mikro-Euro je Einheit gepflegt werden.
- KI wird anhand der von OpenAI gemeldeten Gesamt-Token erfasst.
- Banking wird je erfolgreichem Provider-Aufruf erfasst.
- Fehlgeschlagene Aufrufe werden technisch protokolliert, aber mit `0` Einheiten und `0` Kosten verbucht.
- Usage Events enthalten technische Metadaten, aber keine Prompts, Bankumsätze oder sonstigen fachlichen Nutzdaten.
## Apple Push Notification service
@@ -106,6 +138,9 @@ Implementiert:
- Zustelljobs mit Idempotenzschlüssel
- APNs-Zustellung für iOS
- technische Status- und Fehlererfassung
- dienstbezogene Freischaltungen und Monatslimits
- unveränderliche Usage Events samt Kostenwert
- zentraler OpenAI- und GoCardless-Zugang
Vorbereitet, aber noch nicht vollständig implementiert:
@@ -113,3 +148,4 @@ Vorbereitet, aber noch nicht vollständig implementiert:
- FCM Zustellung
- asynchrone Queue/Worker-Verarbeitung
- produktive Rate-Limits pro Instanz
- Rechnungsstellung beziehungsweise Export an ein Buchhaltungssystem

View File

@@ -1,5 +1,5 @@
type FetchOptions = {
method?: "GET" | "POST" | "PATCH" | "DELETE";
method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
body?: unknown;
};

View File

@@ -6,7 +6,8 @@ const { data, pending, refresh, error } = await useAsyncData("summary", () => pu
instances: number;
devices: number;
jobs: number;
failedJobs: number;
failedJobs: number;
serviceUnits: number;
}>("/admin/summary"), { immediate: false });
onMounted(async () => {
@@ -26,12 +27,12 @@ watch(error, (nextError) => {
<div class="flex items-center justify-between">
<div>
<h2 class="text-2xl font-bold text-gray-950">Übersicht</h2>
<p class="text-sm text-gray-500">Technischer Zustand des zentralen Push-Gateways.</p>
<p class="text-sm text-gray-500">Technischer Zustand des zentralen FEDEO-Service-Gateways.</p>
</div>
<UButton icon="i-lucide-refresh-cw" variant="soft" :loading="pending" @click="refresh()">Aktualisieren</UButton>
</div>
<div class="grid gap-4 md:grid-cols-4">
<div class="grid gap-4 md:grid-cols-5">
<UCard>
<p class="text-sm text-gray-500">Instanzen</p>
<p class="mt-2 text-3xl font-bold">{{ data?.instances ?? 0 }}</p>
@@ -48,6 +49,10 @@ watch(error, (nextError) => {
<p class="text-sm text-gray-500">Fehler</p>
<p class="mt-2 text-3xl font-bold text-red-600">{{ data?.failedJobs ?? 0 }}</p>
</UCard>
<UCard>
<p class="text-sm text-gray-500">Service-Einheiten</p>
<p class="mt-2 text-3xl font-bold">{{ data?.serviceUnits ?? 0 }}</p>
</UCard>
</div>
</div>
</TokenGate>

View File

@@ -4,6 +4,7 @@ const pushApi = usePushApi();
const toast = useToast();
const id = route.params.id as string;
const testSubmitting = ref(false);
const serviceSaving = ref("");
const selectedDeviceIds = ref<string[]>([]);
const testForm = reactive({
title: "FEDEO Push-Test",
@@ -13,6 +14,12 @@ const testForm = reactive({
const { data: instance, refresh: refreshInstance } = await useAsyncData(`instance-${id}`, () => pushApi.request<Record<string, any>>(`/admin/instances/${id}`), { immediate: false });
const { data: devices, refresh: refreshDevices } = await useAsyncData(`devices-${id}`, () => pushApi.request<Record<string, any>[]>(`/admin/instances/${id}/devices`), { default: () => [], immediate: false });
const { data: jobs, refresh: refreshJobs } = await useAsyncData(`jobs-${id}`, () => pushApi.request<Record<string, any>[]>(`/admin/instances/${id}/jobs`), { default: () => [], immediate: false });
const { data: entitlements, refresh: refreshEntitlements } = await useAsyncData(`services-${id}`, () => pushApi.request<Record<string, any>[]>(`/admin/instances/${id}/services`), { default: () => [], immediate: false });
const { data: usage, refresh: refreshUsage } = await useAsyncData(`usage-${id}`, () => pushApi.request<Record<string, any>[]>(`/admin/instances/${id}/usage?limit=100`), { default: () => [], immediate: false });
const serviceForms = reactive({
ai: { enabled: false, monthlyLimit: null as number | null, unitPriceMicros: 0 },
banking: { enabled: false, monthlyLimit: null as number | null, unitPriceMicros: 0 },
});
const activeDevices = computed(() => (devices.value || []).filter((device) => device.status === "active"));
onMounted(async () => {
@@ -23,7 +30,30 @@ onMounted(async () => {
});
async function refreshAll() {
await Promise.all([refreshInstance(), refreshDevices(), refreshJobs()]);
await Promise.all([refreshInstance(), refreshDevices(), refreshJobs(), refreshEntitlements(), refreshUsage()]);
for (const entitlement of entitlements.value || []) {
const form = serviceForms[entitlement.service as "ai" | "banking"];
if (form) Object.assign(form, { enabled: entitlement.enabled, monthlyLimit: entitlement.monthlyLimit, unitPriceMicros: entitlement.unitPriceMicros });
}
}
async function saveService(service: "ai" | "banking") {
serviceSaving.value = service;
try {
const form = serviceForms[service];
await pushApi.request(`/admin/instances/${id}/services/${service}`, {
method: "PUT",
body: {
enabled: form.enabled,
monthlyLimit: Number(form.monthlyLimit) > 0 ? Number(form.monthlyLimit) : null,
unitPriceMicros: Math.max(0, Number(form.unitPriceMicros) || 0),
},
});
await Promise.all([refreshEntitlements(), refreshUsage()]);
toast.add({ title: `${service === "ai" ? "KI" : "Banking"}-Dienst gespeichert`, color: "success" });
} finally {
serviceSaving.value = "";
}
}
function toggleDevice(centralDeviceId: string, checked: boolean) {
@@ -96,6 +126,39 @@ async function sendTestPush() {
</UCard>
</div>
<UCard>
<template #header><h3 class="font-bold">Zentrale Dienste und Abrechnung</h3></template>
<div class="grid gap-4 lg:grid-cols-2">
<div v-for="service in (['ai', 'banking'] as const)" :key="service" class="space-y-3 rounded-lg border border-gray-200 p-4">
<div class="flex items-center justify-between gap-3">
<div>
<p class="font-semibold">{{ service === 'ai' ? 'KI' : 'Banking' }}</p>
<p class="text-xs text-gray-500">{{ service === 'ai' ? 'Einheit: Provider-Token' : 'Einheit: Provider-Aufruf' }}</p>
</div>
<USwitch v-model="serviceForms[service].enabled" />
</div>
<UFormField label="Monatslimit (leer = unbegrenzt)">
<UInput v-model.number="serviceForms[service].monthlyLimit" type="number" min="1" />
</UFormField>
<UFormField label="Preis pro Einheit in Mikro-Euro">
<UInput v-model.number="serviceForms[service].unitPriceMicros" type="number" min="0" />
</UFormField>
<UButton :loading="serviceSaving === service" @click="saveService(service)">Speichern</UButton>
</div>
</div>
<div class="mt-6 overflow-x-auto">
<table class="w-full text-left text-sm">
<thead class="text-gray-500"><tr><th class="py-2">Zeit</th><th>Dienst</th><th>Vorgang</th><th>Status</th><th>Einheiten</th><th>Kosten</th></tr></thead>
<tbody>
<tr v-for="event in usage" :key="event.id" class="border-t border-gray-100">
<td class="py-2">{{ new Date(event.createdAt).toLocaleString() }}</td><td>{{ event.service }}</td><td>{{ event.operation }}</td><td>{{ event.status }}</td><td>{{ event.units }}</td><td>{{ (Number(event.costMicros || 0) / 1_000_000).toLocaleString('de-DE', { style: 'currency', currency: 'EUR' }) }}</td>
</tr>
<tr v-if="!usage?.length"><td colspan="6" class="py-4 text-gray-500">Noch keine Nutzung erfasst.</td></tr>
</tbody>
</table>
</div>
</UCard>
<UCard>
<template #header>
<div class="flex flex-wrap items-center justify-between gap-3">

View File

@@ -12,11 +12,13 @@ RUN npm run build --workspace @fedeo/push-db && npm run build --workspace @fedeo
FROM node:22-alpine
WORKDIR /app
ENV NODE_ENV=production
ENV DRIZZLE_MIGRATIONS_FOLDER=/app/packages/db/drizzle
COPY --from=deps /app/node_modules ./node_modules
COPY --from=build /app/apps/api/dist ./apps/api/dist
COPY --from=build /app/packages/db/dist ./packages/db/dist
COPY --from=build /app/packages/db/drizzle ./packages/db/drizzle
COPY --from=build /app/package.json ./package.json
COPY --from=build /app/apps/api/package.json ./apps/api/package.json
COPY --from=build /app/packages/db/package.json ./packages/db/package.json
EXPOSE 4020
CMD ["node", "apps/api/dist/index.js"]
CMD ["sh", "-c", "node packages/db/dist/src/migrate.js && node apps/api/dist/index.js"]

View File

@@ -25,6 +25,11 @@ const envSchema = z.object({
ANDROID_SENDER_ID: z.string().optional().default(""),
FCM_PROJECT_ID: z.string().optional().default(""),
FCM_SERVICE_ACCOUNT_JSON: z.string().optional().default(""),
OPENAI_API_KEY: z.string().optional().default(""),
OPENAI_BASE_URL: z.string().url().default("https://api.openai.com/v1"),
GOCARDLESS_BASE_URL: z.string().url().default("https://bankaccountdata.gocardless.com/api/v2"),
GOCARDLESS_SECRET_ID: z.string().optional().default(""),
GOCARDLESS_SECRET_KEY: z.string().optional().default(""),
});
export const env = envSchema.parse(process.env);

View File

@@ -7,6 +7,7 @@ import { pool } from "./db/client.js";
import { adminRoutes } from "./routes/admin.js";
import { instanceRoutes } from "./routes/instance.js";
import { publicRoutes } from "./routes/public.js";
import { serviceRoutes } from "./routes/services.js";
const app = Fastify({
logger: true,
@@ -39,6 +40,7 @@ await app.register(cors, {
await app.register(publicRoutes);
await app.register(adminRoutes);
await app.register(instanceRoutes);
await app.register(serviceRoutes);
const close = async () => {
await app.close();

View File

@@ -1,7 +1,7 @@
import type { FastifyInstance } from "fastify";
import { and, desc, eq, sql } from "drizzle-orm";
import { z } from "zod";
import { auditLogs, deliveryJobs, pushDevices, pushInstances } from "@fedeo/push-db";
import { auditLogs, deliveryJobs, pushDevices, pushInstances, serviceEntitlements, serviceUsageEvents } from "@fedeo/push-db";
import { db } from "../db/client.js";
import { requireAdmin } from "../lib/auth.js";
import { encryptSecret } from "../lib/crypto.js";
@@ -29,6 +29,13 @@ const testPushSchema = z.object({
priority: z.enum(["normal", "high"]).default("high"),
});
const entitlementSchema = z.object({
enabled: z.boolean(),
monthlyLimit: z.number().int().positive().nullable().default(null),
unitPriceMicros: z.number().int().nonnegative().default(0),
metadata: z.record(z.string(), z.unknown()).default({}),
});
export async function adminRoutes(app: FastifyInstance): Promise<void> {
app.addHook("preHandler", requireAdmin);
@@ -37,11 +44,13 @@ export async function adminRoutes(app: FastifyInstance): Promise<void> {
const [devices] = await db.select({ count: sql<number>`count(*)::int` }).from(pushDevices);
const [jobs] = await db.select({ count: sql<number>`count(*)::int` }).from(deliveryJobs);
const [failedJobs] = await db.select({ count: sql<number>`count(*)::int` }).from(deliveryJobs).where(eq(deliveryJobs.status, "failed"));
const [usage] = await db.select({ units: sql<number>`coalesce(sum(${serviceUsageEvents.units}), 0)::bigint` }).from(serviceUsageEvents).where(eq(serviceUsageEvents.status, "succeeded"));
return {
instances: instances?.count || 0,
devices: devices?.count || 0,
jobs: jobs?.count || 0,
failedJobs: failedJobs?.count || 0,
serviceUnits: Number(usage?.units || 0),
};
});
@@ -130,6 +139,44 @@ export async function adminRoutes(app: FastifyInstance): Promise<void> {
return await db.select().from(deliveryJobs).where(eq(deliveryJobs.instanceId, params.id)).orderBy(desc(deliveryJobs.createdAt)).limit(100);
});
app.get("/admin/instances/:id/services", async (request) => {
const params = z.object({ id: z.string().uuid() }).parse(request.params);
return db.select().from(serviceEntitlements).where(eq(serviceEntitlements.instanceId, params.id));
});
app.put("/admin/instances/:id/services/:service", async (request, reply) => {
const params = z.object({ id: z.string().uuid(), service: z.enum(["ai", "banking"]) }).parse(request.params);
const body = entitlementSchema.parse(request.body);
const [instance] = await db.select({ id: pushInstances.id }).from(pushInstances).where(eq(pushInstances.id, params.id)).limit(1);
if (!instance) return reply.code(404).send({ error: "instance_not_found" });
const [saved] = await db.insert(serviceEntitlements).values({
instanceId: params.id,
service: params.service,
...body,
}).onConflictDoUpdate({
target: [serviceEntitlements.instanceId, serviceEntitlements.service],
set: { ...body, updatedAt: new Date() },
}).returning();
await audit("admin", "instance.service.updated", params.id, { service: params.service, enabled: body.enabled, monthlyLimit: body.monthlyLimit });
return saved;
});
app.get("/admin/instances/:id/usage", async (request) => {
const params = z.object({ id: z.string().uuid() }).parse(request.params);
const query = z.object({ limit: z.coerce.number().int().positive().max(1000).default(200) }).parse(request.query);
return db.select().from(serviceUsageEvents).where(eq(serviceUsageEvents.instanceId, params.id)).orderBy(desc(serviceUsageEvents.createdAt)).limit(query.limit);
});
app.get("/admin/usage/summary", async () => {
return db.select({
instanceId: serviceUsageEvents.instanceId,
service: serviceUsageEvents.service,
units: sql<number>`coalesce(sum(${serviceUsageEvents.units}), 0)::bigint`,
costMicros: sql<number>`coalesce(sum(${serviceUsageEvents.costMicros}), 0)::bigint`,
calls: sql<number>`count(*)::int`,
}).from(serviceUsageEvents).where(eq(serviceUsageEvents.status, "succeeded")).groupBy(serviceUsageEvents.instanceId, serviceUsageEvents.service);
});
app.post("/admin/instances/:id/test-push", async (request, reply) => {
const params = z.object({ id: z.string().uuid() }).parse(request.params);
const body = testPushSchema.parse(request.body || {});

View File

@@ -4,13 +4,13 @@ import { env } from "../config/env.js";
export async function publicRoutes(app: FastifyInstance): Promise<void> {
app.get("/health", async () => ({
status: "ok",
service: "fedeo-push-api",
service: "fedeo-central-services-api",
}));
app.get("/v1/public-config", async () => ({
webPushPublicKey: env.WEB_PUSH_PUBLIC_KEY || null,
iosBundleId: env.IOS_BUNDLE_ID,
androidSenderId: env.ANDROID_SENDER_ID || null,
capabilities: ["ios_push", "minimal_payload", "instance_hmac"],
capabilities: ["ios_push", "minimal_payload", "instance_hmac", "service_entitlements", "usage_metering", "central_ai", "central_banking"],
}));
}

View File

@@ -0,0 +1,131 @@
import type { FastifyInstance, FastifyRequest } from "fastify";
import { z } from "zod";
import { env } from "../config/env.js";
import { requireInstance } from "../lib/auth.js";
import { recordServiceUsage, requireCentralService } from "../services/central-services.js";
const aiSchema = z.object({
model: z.enum(["gpt-4o", "gpt-4o-mini"]),
messages: z.array(z.object({
role: z.enum(["system", "user", "assistant"]),
content: z.union([z.string(), z.array(z.unknown())]),
}).passthrough()).min(1).max(100),
response_format: z.record(z.string(), z.unknown()).optional(),
temperature: z.number().min(0).max(2).optional(),
max_tokens: z.number().int().positive().max(16_384).optional(),
}).passthrough();
const requisitionSchema = z.object({
institutionId: z.string().min(1).max(200),
redirect: z.string().url(),
userLanguage: z.string().length(2).default("de"),
});
let bankingToken: { access: string; expiresAt: number } | null = null;
async function providerJson(url: string, init: RequestInit) {
const response = await fetch(url, init);
const text = await response.text();
let data: any = null;
try { data = text ? JSON.parse(text) : null; } catch { data = { message: text }; }
if (!response.ok) {
const error = new Error(data?.detail || data?.message || `Provider antwortete mit HTTP ${response.status}`) as Error & { code?: string; status?: number };
error.code = data?.code || `provider_http_${response.status}`;
error.status = response.status;
throw error;
}
return { data, response };
}
async function getBankingToken() {
if (bankingToken && bankingToken.expiresAt > Date.now() + 60_000) return bankingToken.access;
if (!env.GOCARDLESS_SECRET_ID || !env.GOCARDLESS_SECRET_KEY) throw Object.assign(new Error("GoCardless ist zentral nicht konfiguriert."), { code: "banking_provider_not_configured" });
const { data } = await providerJson(`${env.GOCARDLESS_BASE_URL.replace(/\/$/, "")}/token/new/`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ secret_id: env.GOCARDLESS_SECRET_ID, secret_key: env.GOCARDLESS_SECRET_KEY }),
});
bankingToken = { access: data.access, expiresAt: Date.now() + Number(data.access_expires || 86_400) * 1000 };
return bankingToken.access;
}
async function bankingRequest(path: string, init: RequestInit = {}) {
const access = await getBankingToken();
return providerJson(`${env.GOCARDLESS_BASE_URL.replace(/\/$/, "")}${path}`, {
...init,
headers: { Accept: "application/json", Authorization: `Bearer ${access}`, ...(init.headers || {}) },
});
}
function safeProviderError(error: any) {
return { error: error?.code || "provider_error", message: error?.message || "Zentraler Provider-Aufruf fehlgeschlagen." };
}
async function withBankingUsage(request: FastifyRequest, reply: any, operation: string, handler: () => Promise<{ data: any; response: Response }>) {
const entitlement = await requireCentralService(request, reply, "banking");
if (!entitlement) return;
try {
const result = await handler();
const requestId = await recordServiceUsage({ request, service: "banking", operation, status: "succeeded", unitPriceMicros: entitlement.unitPriceMicros, provider: "gocardless", providerRequestId: result.response.headers.get("x-request-id") });
reply.header("X-Fedeo-Request-Id", requestId);
return result.data;
} catch (error: any) {
await recordServiceUsage({ request, service: "banking", operation, status: "failed", units: 0, unitPriceMicros: entitlement.unitPriceMicros, provider: "gocardless", errorCode: error?.code });
return reply.code(error?.status && error.status < 500 ? error.status : 502).send(safeProviderError(error));
}
}
export async function serviceRoutes(app: FastifyInstance): Promise<void> {
app.addHook("preHandler", requireInstance);
app.post("/v1/services/ai/chat-completions", async (request, reply) => {
const entitlement = await requireCentralService(request, reply, "ai");
if (!entitlement) return;
if (!env.OPENAI_API_KEY) return reply.code(503).send({ error: "ai_provider_not_configured", message: "OpenAI ist zentral nicht konfiguriert." });
const body = aiSchema.parse(request.body);
try {
const { data, response } = await providerJson(`${env.OPENAI_BASE_URL.replace(/\/$/, "")}/chat/completions`, {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: `Bearer ${env.OPENAI_API_KEY}` },
body: JSON.stringify(body),
});
const units = Number(data?.usage?.total_tokens || 0);
const requestId = await recordServiceUsage({ request, service: "ai", operation: "chat_completions", units, status: "succeeded", unitPriceMicros: entitlement.unitPriceMicros, provider: "openai", providerRequestId: response.headers.get("x-request-id"), metadata: { model: body.model, promptTokens: data?.usage?.prompt_tokens || 0, completionTokens: data?.usage?.completion_tokens || 0 } });
reply.header("X-Fedeo-Request-Id", requestId);
return data;
} catch (error: any) {
await recordServiceUsage({ request, service: "ai", operation: "chat_completions", units: 0, status: "failed", unitPriceMicros: entitlement.unitPriceMicros, provider: "openai", errorCode: error?.code, metadata: { model: body.model } });
return reply.code(error?.status && error.status < 500 ? error.status : 502).send(safeProviderError(error));
}
});
app.get("/v1/services/banking/institutions", async (request, reply) => {
const query = z.object({ country: z.string().length(2).default("DE") }).parse(request.query);
return withBankingUsage(request, reply, "institutions", () => bankingRequest(`/institutions/?country=${encodeURIComponent(query.country.toLowerCase())}`));
});
app.post("/v1/services/banking/requisitions", async (request, reply) => {
const body = requisitionSchema.parse(request.body);
if (new URL(body.redirect).origin !== new URL(request.pushInstance!.baseUrl).origin) {
return reply.code(400).send({ error: "redirect_origin_invalid", message: "Banking-Redirect muss zur registrierten Instanz gehören." });
}
return withBankingUsage(request, reply, "create_requisition", () => bankingRequest("/requisitions/", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ redirect: body.redirect, institution_id: body.institutionId, user_language: body.userLanguage }) }));
});
app.get("/v1/services/banking/requisitions/:id", async (request, reply) => {
const { id } = z.object({ id: z.string().min(1).max(200) }).parse(request.params);
return withBankingUsage(request, reply, "get_requisition", () => bankingRequest(`/requisitions/${encodeURIComponent(id)}/`));
});
app.get("/v1/services/banking/accounts/:id", async (request, reply) => {
const { id } = z.object({ id: z.string().min(1).max(200) }).parse(request.params);
return withBankingUsage(request, reply, "get_account", () => bankingRequest(`/accounts/${encodeURIComponent(id)}/`));
});
for (const resource of ["balances", "transactions"] as const) {
app.get(`/v1/services/banking/accounts/:id/${resource}`, async (request, reply) => {
const { id } = z.object({ id: z.string().min(1).max(200) }).parse(request.params);
return withBankingUsage(request, reply, `get_${resource}`, () => bankingRequest(`/accounts/${encodeURIComponent(id)}/${resource}/`));
});
}
}

View File

@@ -0,0 +1,84 @@
import { randomUUID } from "node:crypto";
import type { FastifyReply, FastifyRequest } from "fastify";
import { and, eq, gte, sql } from "drizzle-orm";
import { serviceEntitlements, serviceUsageEvents } from "@fedeo/push-db";
import { db } from "../db/client.js";
export type CentralServiceName = "ai" | "banking";
export async function requireCentralService(
request: FastifyRequest,
reply: FastifyReply,
service: CentralServiceName,
) {
const instance = request.pushInstance!;
const [entitlement] = await db
.select()
.from(serviceEntitlements)
.where(and(eq(serviceEntitlements.instanceId, instance.id), eq(serviceEntitlements.service, service)))
.limit(1);
if (!entitlement?.enabled) {
await reply.code(403).send({
error: "service_not_enabled",
message: `Der zentrale Dienst '${service}' ist für diese Instanz nicht freigeschaltet.`,
});
return null;
}
if (entitlement.monthlyLimit !== null) {
const monthStart = new Date();
monthStart.setUTCDate(1);
monthStart.setUTCHours(0, 0, 0, 0);
const [usage] = await db
.select({ units: sql<number>`coalesce(sum(${serviceUsageEvents.units}), 0)::bigint` })
.from(serviceUsageEvents)
.where(and(
eq(serviceUsageEvents.instanceId, instance.id),
eq(serviceUsageEvents.service, service),
eq(serviceUsageEvents.status, "succeeded"),
gte(serviceUsageEvents.createdAt, monthStart),
));
if (Number(usage?.units || 0) >= entitlement.monthlyLimit) {
await reply.code(429).send({
error: "service_monthly_limit_reached",
message: `Das Monatslimit für den zentralen Dienst '${service}' ist erreicht.`,
limit: entitlement.monthlyLimit,
used: Number(usage?.units || 0),
});
return null;
}
}
return entitlement;
}
export async function recordServiceUsage(input: {
request: FastifyRequest;
service: CentralServiceName;
operation: string;
units?: number;
status: "succeeded" | "failed";
unitPriceMicros: number;
provider?: string;
providerRequestId?: string | null;
errorCode?: string;
metadata?: Record<string, unknown>;
}) {
const requestId = String(input.request.headers["x-fedeo-request-id"] || randomUUID());
const units = Math.max(0, Math.trunc(input.units ?? 1));
await db.insert(serviceUsageEvents).values({
requestId,
instanceId: input.request.pushInstance!.id,
service: input.service,
operation: input.operation,
units,
costMicros: input.status === "succeeded" ? units * input.unitPriceMicros : 0,
status: input.status,
provider: input.provider,
providerRequestId: input.providerRequestId || null,
errorCode: input.errorCode,
metadata: input.metadata || {},
});
return requestId;
}

View File

@@ -4,7 +4,7 @@ services:
environment:
POSTGRES_DB: fedeo_push
POSTGRES_USER: fedeo_push
POSTGRES_PASSWORD: fedeo_push
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-fedeo_push}
ports:
- "5442:5432"
volumes:
@@ -16,29 +16,37 @@ services:
retries: 5
api:
restart: unless-stopped
build:
context: .
dockerfile: apps/api/Dockerfile
env_file: .env
env_file: ${CENTRAL_ENV_FILE:-.env}
environment:
DATABASE_URL: postgres://fedeo_push:fedeo_push@postgres:5432/fedeo_push
DATABASE_URL: postgres://fedeo_push:${POSTGRES_PASSWORD:-fedeo_push}@postgres:5432/fedeo_push
ports:
- "4020:4020"
depends_on:
postgres:
condition: service_healthy
healthcheck:
test: ["CMD", "wget", "-qO-", "http://localhost:4020/health"]
interval: 15s
timeout: 5s
retries: 5
admin:
restart: unless-stopped
build:
context: .
dockerfile: apps/admin/Dockerfile
env_file: .env
env_file: ${CENTRAL_ENV_FILE:-.env}
environment:
NUXT_PUBLIC_API_BASE: http://localhost:4020
NUXT_PUBLIC_API_BASE: ${PUBLIC_API_BASE_URL:-http://localhost:4020}
ports:
- "3020:3000"
depends_on:
- api
api:
condition: service_healthy
volumes:
push_postgres_data:

View File

@@ -1,21 +1,22 @@
# Selfhost-Instanz anbinden
# Selfhost-Instanz an FEDEO Central Services anbinden
1. Instanz im Admin-Dashboard anlegen.
2. `instanceId` und den einmalig angezeigten `clientSecret` in der Selfhost-Instanz speichern.
3. Selfhost-Instanz sendet regelmäßig `POST /v1/instances/heartbeat`.
4. Geräte werden über `POST /v1/devices` registriert.
5. Push-Auftge werden über `POST /v1/push` gesendet.
3. Im Instanzdetail die benötigten Dienste `ai` und/oder `banking` freischalten und Limits festlegen.
4. Selfhost-Instanz sendet regelmäßig `POST /v1/instances/heartbeat`.
5. Gete werden über `POST /v1/devices` registriert; weitere Dienste liegen unter `/v1/services`.
## Umgebungsvariablen der Selfhost-Instanz
```env
FEDEO_PUSH_MODE=central
FEDEO_PUSH_GATEWAY_URL=https://push.fedeo.cloud
FEDEO_PUSH_INSTANCE_ID=inst_...
FEDEO_PUSH_CLIENT_SECRET=fps_...
FEDEO_PUSH_PAYLOAD_MODE=minimal
FEDEO_CENTRAL_SERVICES_ENABLED=true
PUSH_SERVER_URL=https://services.fedeo.de
PUSH_SERVER_INSTANCE_ID=inst_...
PUSH_SERVER_SECRET=fps_...
```
Wenn `FEDEO_CENTRAL_SERVICES_ENABLED=false` bleibt, verwendet FEDEO wie bisher direkt konfigurierte OpenAI- und GoCardless-Zugangsdaten. Damit bleibt ein vollständig unabhängiger Betrieb möglich.
## Minimaler Push-Auftrag
```json

View File

@@ -8,7 +8,7 @@
],
"scripts": {
"dev": "npm run dev --workspace @fedeo/push-api",
"dev:api": "npm run dev --workspace @fedeo/push-api",
"dev:api": "npm run build --workspace @fedeo/push-db && npm run dev --workspace @fedeo/push-api",
"dev:admin": "npm run dev --workspace @fedeo/push-admin",
"build": "npm run build --workspaces --if-present",
"typecheck": "npm run typecheck --workspaces --if-present",

View File

@@ -0,0 +1,36 @@
CREATE TYPE "public"."central_service" AS ENUM('ai', 'banking');--> statement-breakpoint
CREATE TYPE "public"."usage_status" AS ENUM('succeeded', 'failed');--> statement-breakpoint
CREATE TABLE "service_entitlements" (
"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
"instance_id" uuid NOT NULL,
"service" "central_service" NOT NULL,
"enabled" boolean DEFAULT false NOT NULL,
"monthly_limit" bigint,
"unit_price_micros" bigint DEFAULT 0 NOT NULL,
"metadata" jsonb DEFAULT '{}'::jsonb NOT NULL,
"created_at" timestamp with time zone DEFAULT now() NOT NULL,
"updated_at" timestamp with time zone DEFAULT now() NOT NULL
);
--> statement-breakpoint
CREATE TABLE "service_usage_events" (
"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
"request_id" text NOT NULL,
"instance_id" uuid NOT NULL,
"service" "central_service" NOT NULL,
"operation" text NOT NULL,
"units" bigint DEFAULT 1 NOT NULL,
"cost_micros" bigint DEFAULT 0 NOT NULL,
"status" "usage_status" NOT NULL,
"provider" text,
"provider_request_id" text,
"error_code" text,
"metadata" jsonb DEFAULT '{}'::jsonb NOT NULL,
"created_at" timestamp with time zone DEFAULT now() NOT NULL,
CONSTRAINT "service_usage_events_request_id_unique" UNIQUE("request_id")
);
--> statement-breakpoint
ALTER TABLE "service_entitlements" ADD CONSTRAINT "service_entitlements_instance_id_push_instances_id_fk" FOREIGN KEY ("instance_id") REFERENCES "public"."push_instances"("id") ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
ALTER TABLE "service_usage_events" ADD CONSTRAINT "service_usage_events_instance_id_push_instances_id_fk" FOREIGN KEY ("instance_id") REFERENCES "public"."push_instances"("id") ON DELETE cascade ON UPDATE no action;--> statement-breakpoint
CREATE UNIQUE INDEX "service_entitlements_instance_service_idx" ON "service_entitlements" USING btree ("instance_id","service");--> statement-breakpoint
CREATE UNIQUE INDEX "service_usage_events_request_id_idx" ON "service_usage_events" USING btree ("request_id");--> statement-breakpoint
CREATE INDEX "service_usage_events_instance_service_created_idx" ON "service_usage_events" USING btree ("instance_id","service","created_at");

File diff suppressed because it is too large Load Diff

View File

@@ -8,6 +8,13 @@
"when": 1779461560095,
"tag": "0000_big_devos",
"breakpoints": true
},
{
"idx": 1,
"version": "7",
"when": 1785681122775,
"tag": "0001_central_services",
"breakpoints": true
}
]
}

View File

@@ -3,8 +3,10 @@
"version": "0.1.0",
"private": true,
"type": "module",
"main": "src/index.ts",
"main": "dist/src/index.js",
"types": "src/index.ts",
"scripts": {
"build": "tsc",
"db:generate": "drizzle-kit generate",
"db:migrate": "tsx src/migrate.ts",
"typecheck": "tsc --noEmit"

View File

@@ -8,7 +8,9 @@ import pg from "pg";
const { Pool } = pg;
const databaseUrl = process.env.DATABASE_URL || "postgres://fedeo_push:fedeo_push@localhost:5442/fedeo_push";
const migrationsFolder = resolve(dirname(fileURLToPath(import.meta.url)), "../drizzle");
const migrationsFolder = process.env.DRIZZLE_MIGRATIONS_FOLDER
? resolve(process.env.DRIZZLE_MIGRATIONS_FOLDER)
: resolve(dirname(fileURLToPath(import.meta.url)), "../drizzle");
const pool = new Pool({ connectionString: databaseUrl });
const db = drizzle(pool);

View File

@@ -1,5 +1,6 @@
import {
boolean,
bigint,
index,
integer,
jsonb,
@@ -19,6 +20,8 @@ export const deviceStatus = pgEnum("device_status", ["active", "disabled", "inva
export const deliveryStatus = pgEnum("delivery_status", ["accepted", "processing", "completed", "failed", "partial"]);
export const attemptStatus = pgEnum("attempt_status", ["pending", "sent", "failed", "skipped"]);
export const attemptProvider = pgEnum("attempt_provider", ["web_push", "apns", "fcm"]);
export const centralService = pgEnum("central_service", ["ai", "banking"]);
export const usageStatus = pgEnum("usage_status", ["succeeded", "failed"]);
export const pushInstances = pgTable(
"push_instances",
@@ -144,6 +147,51 @@ export const auditLogs = pgTable(
}),
);
export const serviceEntitlements = pgTable(
"service_entitlements",
{
id: uuid("id").primaryKey().defaultRandom(),
instanceId: uuid("instance_id")
.notNull()
.references(() => pushInstances.id, { onDelete: "cascade" }),
service: centralService("service").notNull(),
enabled: boolean("enabled").notNull().default(false),
monthlyLimit: bigint("monthly_limit", { mode: "number" }),
unitPriceMicros: bigint("unit_price_micros", { mode: "number" }).notNull().default(0),
metadata: jsonb("metadata").$type<Record<string, unknown>>().notNull().default(sql`'{}'::jsonb`),
createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
updatedAt: timestamp("updated_at", { withTimezone: true }).notNull().defaultNow(),
},
(table) => ({
instanceServiceIdx: uniqueIndex("service_entitlements_instance_service_idx").on(table.instanceId, table.service),
}),
);
export const serviceUsageEvents = pgTable(
"service_usage_events",
{
id: uuid("id").primaryKey().defaultRandom(),
requestId: text("request_id").notNull().unique(),
instanceId: uuid("instance_id")
.notNull()
.references(() => pushInstances.id, { onDelete: "cascade" }),
service: centralService("service").notNull(),
operation: text("operation").notNull(),
units: bigint("units", { mode: "number" }).notNull().default(1),
costMicros: bigint("cost_micros", { mode: "number" }).notNull().default(0),
status: usageStatus("status").notNull(),
provider: text("provider"),
providerRequestId: text("provider_request_id"),
errorCode: text("error_code"),
metadata: jsonb("metadata").$type<Record<string, unknown>>().notNull().default(sql`'{}'::jsonb`),
createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
},
(table) => ({
requestIdIdx: uniqueIndex("service_usage_events_request_id_idx").on(table.requestId),
instanceServiceCreatedIdx: index("service_usage_events_instance_service_created_idx").on(table.instanceId, table.service, table.createdAt),
}),
);
export type PushInstance = typeof pushInstances.$inferSelect;
export type NewPushInstance = typeof pushInstances.$inferInsert;
export type PushDevice = typeof pushDevices.$inferSelect;
@@ -152,3 +200,5 @@ export type DeliveryJob = typeof deliveryJobs.$inferSelect;
export type NewDeliveryJob = typeof deliveryJobs.$inferInsert;
export type DeliveryAttempt = typeof deliveryAttempts.$inferSelect;
export type NewDeliveryAttempt = typeof deliveryAttempts.$inferInsert;
export type ServiceEntitlement = typeof serviceEntitlements.$inferSelect;
export type ServiceUsageEvent = typeof serviceUsageEvents.$inferSelect;