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 | 73x 73x 61x 10x 10x 11x 11x 10x 10x 10x 10x 10x 10x 10x 106x 101x 101x 101x 102x 104x 2x 2x 102x 1x 1x 101x 106x 106x 106x 106x 106x 106x 106x 2x 2x 106x 106x 106x 106x 106x 36x 36x 36x 36x 36x 92x 92x 92x 92x 1x 1x 91x 90x 90x 90x 90x 86x 24x 22x 22x 62x 62x 61x 61x 1x 1x 36x 5x 5x 5x 5x 5x 3x 3x 3x 3x 36x 9x 9x 9x 9x 1x 1x 8x 8x 8x 8x 8x 6x 6x 6x 9x 26x 19x 98x 98x 93x 98x 1x 1x 92x 5x 5x 2x 2x 3x 87x 87x 87x 98x 98x 6x 6x 81x 81x 6x 3x 1x 1x 2x 6x 3x | import type { Express, Request, Response } from "express";
import { randomUUID } from "node:crypto";
import {
tutorDialogRequestSchema,
tutorModelsRequestSchema,
tutorQuestionRequestSchema,
} from "@shared/tutor";
import { config } from "../config";
import { Logger } from "@shared/logger";
import { getTutorRateLimiter } from "../services/rate-limiter";
import { KiconnectProvider } from "../services/tutor/kiconnect-provider";
import {
TutorProviderError,
} from "../services/tutor/llm-provider";
import { TutorService } from "../services/tutor/tutor-service";
import { createTutorService } from "../services/tutor/tutor-service-factory";
import type { RequestIdentity } from "../security/access-control";
import {
prepareTutorCourseContentSession,
TutorCourseContentSessionStore,
type PinnedTutorCourseContent,
type ResolvedTutorCourseContent,
type TutorCourseContentResolver,
} from "../services/course-content/course-content-session";
import { ExamplesError } from "../services/examples/examples-error";
import type { RequestContext } from "../services/examples/source-provider";
import type { TutorCourseContentContext } from "@shared/tutor";
type TutorRouteDeps = {
readonly service?: TutorService;
readonly logger?: Pick<Logger, "warn" | "error">;
readonly rateLimiter?: { checkLimit: (identity: string) => { allowed: true } | { allowed: false; retryAfter: number } };
readonly disableRateLimit?: boolean;
readonly courseContent?: TutorCourseContentResolver;
readonly sessionStore?: TutorCourseContentSessionStore;
};
function responseError(
res: Response,
status: number,
code: "CREDENTIAL_REQUIRED" | "CREDENTIAL_INVALID" | "PROVIDER_UNAVAILABLE" | "PROVIDER_TIMEOUT" | "RATE_LIMITED" | "MODEL_UNAVAILABLE" | "INVALID_PROVIDER_RESPONSE" | "INVALID_REQUEST" | "COURSE_CONTENT_STALE",
message: string,
retryAfter?: number,
): void {
Iif (retryAfter !== undefined) res.setHeader("Retry-After", String(retryAfter));
res.status(status).json({ error: { code, message, ...(retryAfter === undefined ? {} : { retryAfter }) } });
}
function mapProviderError(res: Response, error: TutorProviderError): void {
switch (error.kind) {
case "credential-invalid":
responseError(res, 401, "CREDENTIAL_INVALID", "Der Tutor-Zugang wurde abgelehnt.");
return;
case "provider-timeout":
responseError(res, 504, "PROVIDER_TIMEOUT", "Der Tutor-Dienst hat zu lange nicht geantwortet.");
return;
case "rate-limited":
responseError(res, 429, "RATE_LIMITED", "Das Tutor-Kontingent ist momentan erschöpft.", error.retryAfter);
return;
case "model-unavailable":
responseError(res, 502, "MODEL_UNAVAILABLE", "Das konfigurierte Tutor-Modell ist nicht verfügbar.");
return;
case "invalid-response":
responseError(res, 502, "INVALID_PROVIDER_RESPONSE", "Der Tutor-Dienst hat keine gültige Lernfrage geliefert.");
return;
default:
responseError(res, 502, "PROVIDER_UNAVAILABLE", "Der Tutor-Dienst ist momentan nicht erreichbar.");
}
}
function enforceTutorRateLimit(res: Response, deps: TutorRouteDeps): boolean {
Eif (!deps.rateLimiter || deps.disableRateLimit) return true;
const identity = res.locals.unosimIdentity as RequestIdentity | undefined;
if (!identity) {
responseError(res, 500, "PROVIDER_UNAVAILABLE", "Tutor-Anfrage konnte nicht autorisiert werden.");
return false;
}
const result = deps.rateLimiter.checkLimit(identity.subject);
if (!result.allowed) {
responseError(res, 429, "RATE_LIMITED", "Zu viele Tutor-Anfragen. Bitte später erneut versuchen.", result.retryAfter);
return false;
}
return true;
}
function isLoopbackRequest(req: Request): boolean {
const address = req.ip || req.socket.remoteAddress || "";
const normalizedAddress = address.startsWith("::ffff:") ? address.slice("::ffff:".length) : address;
return normalizedAddress === "127.0.0.1" || normalizedAddress === "::1";
}
function hasSafeCredentialTransport(req: Request): boolean {
return req.secure || isLoopbackRequest(req) || config.dockerTestBypassGateway;
}
function requireRequestCredential(req: Request, res: Response, credential: string | undefined): boolean {
if (!credential?.trim()) {
responseError(res, 400, "CREDENTIAL_REQUIRED", "Für den Pilotbetrieb wird ein persönlicher Tutor-Key benötigt.");
return false;
}
if (!hasSafeCredentialTransport(req)) {
responseError(res, 400, "INVALID_REQUEST", "Persönliche Tutor-Keys werden außerhalb von Loopback nur über HTTPS übertragen.");
return false;
}
return true;
}
function bindRequestAbortSignal(req: Request, res: Response): AbortSignal {
const controller = new AbortController();
const abort = () => controller.abort(new DOMException("Request aborted", "AbortError"));
const cleanup = () => {
req.off("aborted", abort);
res.off("close", onClose);
res.off("finish", cleanup);
};
const onClose = () => {
Eif (!res.writableEnded) abort();
cleanup();
};
req.once("aborted", abort);
res.once("close", onClose);
res.once("finish", cleanup);
Iif ((req.destroyed && !req.complete) || res.destroyed) abort();
return controller.signal;
}
export function registerTutorRoutes(app: Express, deps: TutorRouteDeps = {}): void {
const logger = deps.logger ?? new Logger("TutorRoutes");
const service = deps.service ?? createTutorService(new KiconnectProvider());
const rateLimiter = deps.rateLimiter ?? (deps.disableRateLimit ? undefined : getTutorRateLimiter());
const sessionStore = deps.sessionStore ?? new TutorCourseContentSessionStore();
app.post("/api/tutor/question", async (req, res) => {
const signal = bindRequestAbortSignal(req, res);
Iif (!enforceTutorRateLimit(res, { ...deps, rateLimiter })) return;
const parsed = tutorQuestionRequestSchema.safeParse(req.body);
if (!parsed.success) {
responseError(res, 400, "INVALID_REQUEST", "Sketch, Zugang und Modellangaben sind ungültig.");
return;
}
if (!requireRequestCredential(req, res, parsed.data.credential)) return;
try {
const content = await resolveTutorContent(req, res, parsed.data.courseContent, parsed.data.courseContentSession, deps.courseContent, sessionStore, signal);
Iif (signal.aborted) return;
if (res.headersSent) return;
const generated = await service.generateQuestion(
parsed.data.code,
parsed.data.credential,
parsed.data.model,
parsed.data.difficulty,
content?.content,
signal,
);
if (signal.aborted) return;
const session = commitTutorSession(content, sessionStore);
res.json({
...generated.result,
provider: config.tutor.provider,
model: generated.model,
...(session ? { courseContentSession: session } : {}),
});
} catch (error) {
Iif (signal.aborted) return;
if (error instanceof TutorProviderError) {
mapProviderError(res, error);
return;
}
logger.error("Tutor request failed without exposing provider details");
responseError(res, 500, "PROVIDER_UNAVAILABLE", "Die Tutor-Anfrage ist fehlgeschlagen.");
}
});
app.post("/api/tutor/models", async (req, res) => {
const signal = bindRequestAbortSignal(req, res);
Iif (!enforceTutorRateLimit(res, { ...deps, rateLimiter })) return;
const parsed = tutorModelsRequestSchema.safeParse(req.body);
Iif (!parsed.success) {
responseError(res, 400, "INVALID_REQUEST", "Der Tutor-Zugang ist ungültig.");
return;
}
if (!requireRequestCredential(req, res, parsed.data.credential)) return;
try {
const models = await service.getAvailableModels(parsed.data.credential, signal);
Iif (signal.aborted) return;
res.json({ models });
} catch (error) {
if (signal.aborted) return;
if (error instanceof TutorProviderError) {
mapProviderError(res, error);
return;
}
logger.error("Tutor model discovery failed without exposing provider details");
responseError(res, 500, "PROVIDER_UNAVAILABLE", "Die Tutor-Modelle konnten nicht geladen werden.");
}
});
app.post("/api/tutor/dialog", async (req, res) => {
const signal = bindRequestAbortSignal(req, res);
Iif (!enforceTutorRateLimit(res, { ...deps, rateLimiter })) return;
const parsed = tutorDialogRequestSchema.safeParse(req.body);
if (!parsed.success) {
responseError(res, 400, "INVALID_REQUEST", "Dialogverlauf, Antwort, Sketch oder Modellangaben sind ungültig.");
return;
}
Iif (!requireRequestCredential(req, res, parsed.data.credential)) return;
try {
const content = await resolveTutorContent(req, res, parsed.data.courseContent, parsed.data.courseContentSession, deps.courseContent, sessionStore, signal);
Iif (signal.aborted) return;
if (res.headersSent) return;
const generated = await service.generateDialogResponse(
parsed.data.code,
parsed.data.history,
parsed.data.question,
parsed.data.answer,
parsed.data.credential,
parsed.data.model,
parsed.data.difficulty,
content?.content,
signal,
);
Iif (signal.aborted) return;
// A provider-free fallback verified no credential: it may use an existing session but not create one.
const session = generated.withoutProvider ? content?.session : commitTutorSession(content, sessionStore);
res.json({
...generated.result,
provider: config.tutor.provider,
model: generated.model,
...(session ? { courseContentSession: session } : {}),
});
} catch (error) {
if (signal.aborted) return;
if (error instanceof TutorProviderError) {
mapProviderError(res, error);
return;
}
logger.error("Tutor dialog request failed without exposing provider details");
responseError(res, 500, "PROVIDER_UNAVAILABLE", "Die Tutor-Anfrage ist fehlgeschlagen.");
}
});
}
type TutorRequestContent = {
readonly identity: string;
readonly content: PinnedTutorCourseContent;
/** Present for an existing session; absent while a new session is only request-scoped. */
readonly session?: string;
};
/**
* A new Course Content session becomes visible only here, after the Tutor request
* succeeded and before its response is sent. Failed, rejected, or aborted requests
* therefore never leave a session behind.
*/
function commitTutorSession(content: TutorRequestContent | undefined, sessions: TutorCourseContentSessionStore): string | undefined {
if (!content) return undefined;
return content.session ?? sessions.commit(content.identity, content.content);
}
/**
* Returns undefined for the free Tutor, or after an error response was sent;
* callers tell both apart by `res.headersSent`.
*/
async function resolveTutorContent(
req: Request,
res: Response,
request: TutorCourseContentContext | undefined,
sessionHandle: string | undefined,
resolver: TutorCourseContentResolver | undefined,
sessions: TutorCourseContentSessionStore,
signal: AbortSignal,
): Promise<TutorRequestContent | undefined> {
Iif (signal.aborted) return undefined;
if (sessionHandle === undefined && request === undefined) return undefined;
// Sessions are owned by the authenticated subject; without one there is no owner to bind them to.
const identity = (res.locals.unosimIdentity as RequestIdentity | undefined)?.subject;
if (!identity) {
responseError(res, 500, "PROVIDER_UNAVAILABLE", "Tutor-Anfrage konnte nicht autorisiert werden.");
return undefined;
}
if (sessionHandle !== undefined) {
const pinned = sessions.get(identity, sessionHandle);
if (!pinned) {
responseError(res, 400, "INVALID_REQUEST", "Der Tutor-Kontext ist abgelaufen oder ungültig.");
return undefined;
}
return { identity, content: pinned, session: sessionHandle };
}
Iif (request === undefined) return undefined;
Iif (!resolver) {
responseError(res, 400, "INVALID_REQUEST", "Der Course-Content-Kontext ist nicht verfügbar.");
return undefined;
}
const context: RequestContext = {
identity,
requestId: req.header("x-request-id") ?? randomUUID(),
signal,
};
let resolved: ResolvedTutorCourseContent;
try {
resolved = await resolver.resolveTutorContent(request, context);
} catch (error) {
Eif (!signal.aborted) respondToUnresolvedContent(res, error);
return undefined;
}
Iif (signal.aborted) return undefined;
return { identity, content: prepareTutorCourseContentSession(resolved) };
}
/** Sends the error response for unresolved Course Content; the free Tutor needs none. */
function respondToUnresolvedContent(res: Response, error: unknown): void {
// Course Content SSOT 11, case G: without the current revision the free Tutor answers.
if (isSnapshotUnavailable(error)) return;
if (isStaleCourseContent(error)) {
// The example's revision is neither a validated snapshot of its selection nor the current one.
responseError(res, 409, "COURSE_CONTENT_STALE", "Der Kursinhalt wurde aktualisiert. Bitte das Beispiel neu laden.");
return;
}
responseError(res, 400, "INVALID_REQUEST", "Der Course-Content-Kontext ist ungültig oder nicht mehr aktiv.");
}
function isSnapshotUnavailable(error: unknown): boolean {
return error instanceof ExamplesError
&& (error.code === "SOURCE_UNAVAILABLE" || error.code === "RATE_LIMITED" || error.code === "LOAD_CAPACITY_EXCEEDED");
}
function isStaleCourseContent(error: unknown): boolean {
return error instanceof ExamplesError && (error.code === "INVALID_REVISION" || error.code === "EXAMPLE_NOT_FOUND");
}
|