|
| 1 | +// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +import fs from "node:fs"; |
| 5 | +import { createRequire } from "node:module"; |
| 6 | +import path from "node:path"; |
| 7 | +import { fileURLToPath } from "node:url"; |
| 8 | +import type * as TypeScript from "typescript"; |
| 9 | +import { describe, expect, it } from "vitest"; |
| 10 | + |
| 11 | +const require = createRequire(import.meta.url); |
| 12 | +const ts = require("typescript") as typeof TypeScript; |
| 13 | +const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), ".."); |
| 14 | +const inferenceOptionsPath = path.join(repoRoot, "docs", "inference", "inference-options.mdx"); |
| 15 | +const inferenceConfigPath = path.join(repoRoot, "src", "lib", "inference", "config.ts"); |
| 16 | +const modelPromptsPath = path.join(repoRoot, "src", "lib", "inference", "model-prompts.ts"); |
| 17 | + |
| 18 | +/** |
| 19 | + * Removes TypeScript `as const` wrappers before inspecting literal AST nodes. |
| 20 | + */ |
| 21 | +function unwrapConstAssertion(expression: TypeScript.Expression): TypeScript.Expression { |
| 22 | + return ts.isAsExpression(expression) ? unwrapConstAssertion(expression.expression) : expression; |
| 23 | +} |
| 24 | + |
| 25 | +function readExportedConstInitializer( |
| 26 | + sourcePath: string, |
| 27 | + exportName: string, |
| 28 | +): { sourceFile: TypeScript.SourceFile; initializer: TypeScript.Expression } { |
| 29 | + const source = fs.readFileSync(sourcePath, "utf8"); |
| 30 | + const sourceFile = ts.createSourceFile(sourcePath, source, ts.ScriptTarget.Latest, true); |
| 31 | + |
| 32 | + const declaration = sourceFile.statements |
| 33 | + .filter( |
| 34 | + (statement): statement is TypeScript.VariableStatement => |
| 35 | + ts.isVariableStatement(statement) && |
| 36 | + (statement.modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.ExportKeyword) ?? |
| 37 | + false), |
| 38 | + ) |
| 39 | + .flatMap((statement) => Array.from(statement.declarationList.declarations)) |
| 40 | + .find((candidate) => candidate.name.getText(sourceFile) === exportName); |
| 41 | + expect(declaration).toBeTruthy(); |
| 42 | + |
| 43 | + const initializer = declaration?.initializer && unwrapConstAssertion(declaration.initializer); |
| 44 | + expect(initializer).toBeTruthy(); |
| 45 | + |
| 46 | + return { sourceFile, initializer: initializer as TypeScript.Expression }; |
| 47 | +} |
| 48 | + |
| 49 | +function readCuratedCloudModelIds(): string[] { |
| 50 | + const { sourceFile, initializer } = readExportedConstInitializer( |
| 51 | + inferenceConfigPath, |
| 52 | + "CLOUD_MODEL_OPTIONS", |
| 53 | + ); |
| 54 | + expect(ts.isArrayLiteralExpression(initializer)).toBe(true); |
| 55 | + |
| 56 | + return (initializer as TypeScript.ArrayLiteralExpression).elements.map((element) => { |
| 57 | + expect(ts.isObjectLiteralExpression(element)).toBe(true); |
| 58 | + const idProperty = (element as TypeScript.ObjectLiteralExpression).properties.find( |
| 59 | + (property) => |
| 60 | + ts.isPropertyAssignment(property) && |
| 61 | + property.name.getText(sourceFile) === "id" && |
| 62 | + ts.isStringLiteralLike(unwrapConstAssertion(property.initializer)), |
| 63 | + ); |
| 64 | + expect(idProperty).toBeTruthy(); |
| 65 | + const idInitializer = unwrapConstAssertion( |
| 66 | + (idProperty as TypeScript.PropertyAssignment).initializer, |
| 67 | + ); |
| 68 | + return (idInitializer as TypeScript.StringLiteral).text; |
| 69 | + }); |
| 70 | +} |
| 71 | + |
| 72 | +function readRemoteModelIds(providerKey: string): string[] { |
| 73 | + const { sourceFile, initializer } = readExportedConstInitializer( |
| 74 | + modelPromptsPath, |
| 75 | + "REMOTE_MODEL_OPTIONS", |
| 76 | + ); |
| 77 | + expect(ts.isObjectLiteralExpression(initializer)).toBe(true); |
| 78 | + |
| 79 | + const providerProperty = (initializer as TypeScript.ObjectLiteralExpression).properties.find( |
| 80 | + (property) => |
| 81 | + ts.isPropertyAssignment(property) && property.name.getText(sourceFile) === providerKey, |
| 82 | + ); |
| 83 | + expect(providerProperty).toBeTruthy(); |
| 84 | + |
| 85 | + const providerInitializer = unwrapConstAssertion( |
| 86 | + (providerProperty as TypeScript.PropertyAssignment).initializer, |
| 87 | + ); |
| 88 | + expect(ts.isArrayLiteralExpression(providerInitializer)).toBe(true); |
| 89 | + |
| 90 | + return (providerInitializer as TypeScript.ArrayLiteralExpression).elements.map((element) => { |
| 91 | + expect(ts.isStringLiteralLike(unwrapConstAssertion(element))).toBe(true); |
| 92 | + return (unwrapConstAssertion(element) as TypeScript.StringLiteral).text; |
| 93 | + }); |
| 94 | +} |
| 95 | + |
| 96 | +/** |
| 97 | + * Reads curated onboarding model IDs from source config instead of duplicating them in docs tests. |
| 98 | + */ |
| 99 | +function readCuratedOnboardingModelIds(): string[] { |
| 100 | + return [ |
| 101 | + ...readCuratedCloudModelIds(), |
| 102 | + ...readRemoteModelIds("openai"), |
| 103 | + ...readRemoteModelIds("anthropic"), |
| 104 | + ...readRemoteModelIds("gemini"), |
| 105 | + ]; |
| 106 | +} |
| 107 | + |
| 108 | +describe("inference options model task-fit docs (#4755)", () => { |
| 109 | + it("keeps a per-model task-fit comparison table for curated onboarding models", () => { |
| 110 | + const markdown = fs.readFileSync(inferenceOptionsPath, "utf8"); |
| 111 | + const start = markdown.indexOf("## Model Task-Fit Guide"); |
| 112 | + const end = markdown.indexOf("## Choosing the Right Option for Nemotron", start); |
| 113 | + expect(start).toBeGreaterThanOrEqual(0); |
| 114 | + expect(end).toBeGreaterThan(start); |
| 115 | + const section = markdown.slice(start, end); |
| 116 | + |
| 117 | + expect(section).toContain( |
| 118 | + "| Model | Best-for task type | Relative latency | Tool-use quality | Context-window fit | Relative cost |", |
| 119 | + ); |
| 120 | + expect(section).toContain("provider catalog remains authoritative"); |
| 121 | + expect(section).not.toMatch(/\bTBD\b|\bTODO\b/i); |
| 122 | + expect(section).not.toContain("Very large context"); |
| 123 | + |
| 124 | + for (const modelId of readCuratedOnboardingModelIds()) { |
| 125 | + expect(section).toContain(`| \`${modelId}\` |`); |
| 126 | + } |
| 127 | + }); |
| 128 | +}); |
0 commit comments