ui: Restructure repo to use tools/ui folder and ui / UI / llama-ui / LLAMA_UI naming (#23064)
* webui: Move static build output from `tools/server/public` to `build/ui` directory * refactor: Move to `tools/ui` * refactor: rename CMake variables and preprocessor defines - Rename LLAMA_BUILD_WEBUI -> LLAMA_BUILD_UI (old kept as deprecated) - Rename LLAMA_USE_PREBUILT_WEBUI -> LLAMA_USE_PREBUILT_UI (old kept as deprecated) - Backward compat: old vars auto-forward to new ones with DEPRECATION warning - Rename internal vars: WEBUI_SOURCE -> UI_SOURCE, WEBUI_SOURCE_DIR -> UI_SOURCE_DIR, etc. - Rename HF bucket: LLAMA_WEBUI_HF_BUCKET -> LLAMA_UI_HF_BUCKET - Emit both LLAMA_BUILD_WEBUI and LLAMA_BUILD_UI preprocessor defines - Emit both LLAMA_WEBUI_DEFAULT_ENABLED and LLAMA_UI_DEFAULT_ENABLED * refactor: rename CLI flags (--webui -> --ui) with backward compat - Add --ui/--no-ui (old --webui/--no-webui kept as deprecated aliases) - Add --ui-config (old --webui-config kept as deprecated alias) - Add --ui-config-file (old --webui-config-file kept as deprecated alias) - Add --ui-mcp-proxy/--no-ui-mcp-proxy (old --webui-mcp-proxy kept as deprecated) - Add new env vars: LLAMA_ARG_UI, LLAMA_ARG_UI_CONFIG, LLAMA_ARG_UI_CONFIG_FILE, LLAMA_ARG_UI_MCP_PROXY - C++ struct fields: params.ui, params.ui_config_json, params.ui_mcp_proxy added alongside old fields - Backward compat: old fields synced to new ones in g_params_to_internals * refactor: update C++ server internals with backward compat - Rename json_webui_settings -> json_ui_settings (both kept in server_context_meta) - Rename params.webui usage -> params.ui (both synced, old still works) - JSON API emits both "ui"/"ui_settings" and "webui"/"webui_settings" keys - Server routes use params.ui_mcp_proxy || params.webui_mcp_proxy - Preprocessor guards use #if defined(LLAMA_BUILD_UI) || defined(LLAMA_BUILD_WEBUI) * refactor: rename CI/CD workflows, artifacts, and build script - Rename webui-build.yml -> ui-build.yml; artifact webui-build -> ui-build - Rename webui-publish.yml -> ui-publish.yml; var HF_BUCKET_WEBUI_STATIC_OUTPUT -> HF_BUCKET_UI_STATIC_OUTPUT - Rename server-webui.yml -> server-ui.yml; job webui-build/checks -> ui-build/checks - Update server.yml: job/artifact refs webui-build -> ui-build - Update release.yml: all webui-build/publish refs -> ui-build/publish; HF_TOKEN_WEBUI_STATIC_OUTPUT -> HF_TOKEN_UI_STATIC_OUTPUT - Update server-self-hosted.yml: webui-build -> ui-build - Update build-self-hosted.yml: HF_WEBUI_VERSION -> HF_UI_VERSION - Rename webui-download.cmake -> ui-download.cmake (internal refs updated) - Update labeler.yml: server/webui -> server/ui path label * docs: update CODEOWNERS and server README docs - Update CODEOWNERS: team ggml-org/llama-webui -> ggml-org/llama-ui, path /tools/server/webui/ -> /tools/ui/ - Update server README.md: CLI tables show --ui flags with deprecated --webui aliases - Update server README-dev.md: "WebUI" -> "UI", paths updated to tools/ui/ * fix: Small fixes for UI build * fix: CMake.txt syntax * chore: Formatting * fix: `.editorconfig` for llama-ui * chore: Formatting * refactor: Use `APP_NAME` in Error route * refactor: Cleanup * refactor: Single migration service * make llama-ui a linkable target * fix: UI Build output * fix: Missing change * fix: separate llama-ui npm build output into build/tools/ui/dist subfolder + use cmake npm build instead of downloading ui-build.yml artifacts in CI * refactor: UI workflows cleanup --------- Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
This commit is contained in:
Aleksander Grygier
co-authored by
Xuan Son Nguyen
Xuan Son Nguyen
parent
49d1701bd2
commit
59778f0196
@@ -0,0 +1,198 @@
|
||||
import {
|
||||
TEMPLATE_EXPRESSION_REGEX,
|
||||
URI_SCHEME_SEPARATOR,
|
||||
URI_TEMPLATE_OPERATORS,
|
||||
URI_TEMPLATE_SEPARATORS,
|
||||
VARIABLE_EXPLODE_MODIFIER_REGEX,
|
||||
VARIABLE_PREFIX_MODIFIER_REGEX,
|
||||
LEADING_SLASHES_REGEX
|
||||
} from '../constants';
|
||||
|
||||
/**
|
||||
* Normalize a resource URI for comparison.
|
||||
*
|
||||
* URI template expansion (especially with path operators like {/var})
|
||||
* can produce URIs that differ from listed resource URIs in slash placement.
|
||||
* For example, the template `svelte://{/slug*}.md` with slug="svelte/$effect"
|
||||
* expands to `svelte:///svelte/$effect.md`, while the listed resource URI is
|
||||
* `svelte://svelte/$effect.md`.
|
||||
*
|
||||
* This function strips extra leading slashes after the scheme to normalize
|
||||
* both forms to the same string for comparison purposes.
|
||||
*
|
||||
* @param uri - The URI to normalize
|
||||
* @returns Normalized URI string
|
||||
*/
|
||||
export function normalizeResourceUri(uri: string): string {
|
||||
const schemeEnd = uri.indexOf(URI_SCHEME_SEPARATOR);
|
||||
if (schemeEnd === -1) return uri;
|
||||
|
||||
const scheme = uri.substring(0, schemeEnd);
|
||||
const rest = uri
|
||||
.substring(schemeEnd + URI_SCHEME_SEPARATOR.length)
|
||||
.replace(LEADING_SLASHES_REGEX, '');
|
||||
|
||||
return `${scheme}${URI_SCHEME_SEPARATOR}${rest}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* A parsed variable from a URI template expression.
|
||||
*/
|
||||
export interface UriTemplateVariable {
|
||||
/** Variable name */
|
||||
name: string;
|
||||
/** Operator prefix (+, #, /, etc.) or empty string */
|
||||
operator: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract all variable names from a URI template string.
|
||||
*
|
||||
* @param template - URI template string (RFC 6570)
|
||||
* @returns Array of unique variable descriptors
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* extractTemplateVariables("file:///{path}")
|
||||
* // => [{ name: "path", operator: "" }]
|
||||
*
|
||||
* extractTemplateVariables("db://{schema}/{table}")
|
||||
* // => [{ name: "schema", operator: "" }, { name: "table", operator: "" }]
|
||||
* ```
|
||||
*/
|
||||
export function extractTemplateVariables(template: string): UriTemplateVariable[] {
|
||||
const variables: UriTemplateVariable[] = [];
|
||||
const seen = new Set<string>();
|
||||
|
||||
let match;
|
||||
TEMPLATE_EXPRESSION_REGEX.lastIndex = 0;
|
||||
|
||||
while ((match = TEMPLATE_EXPRESSION_REGEX.exec(template)) !== null) {
|
||||
const operator = match[1] || '';
|
||||
const varList = match[2];
|
||||
|
||||
// RFC 6570 allows comma-separated variable lists: {x,y,z}
|
||||
for (const varSpec of varList.split(',')) {
|
||||
// Strip explode modifier (*) and prefix modifier (:N)
|
||||
const name = varSpec
|
||||
.replace(VARIABLE_EXPLODE_MODIFIER_REGEX, '')
|
||||
.replace(VARIABLE_PREFIX_MODIFIER_REGEX, '')
|
||||
.trim();
|
||||
|
||||
if (name && !seen.has(name)) {
|
||||
seen.add(name);
|
||||
variables.push({ name, operator });
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return variables;
|
||||
}
|
||||
|
||||
/**
|
||||
* Expand a URI template with the given variable values.
|
||||
* Implements a simplified RFC 6570 Level 2 expansion.
|
||||
*
|
||||
* @param template - URI template string
|
||||
* @param values - Map of variable name to value
|
||||
* @returns Expanded URI string
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* expandTemplate("file:///{path}", { path: "src/main.rs" })
|
||||
* // => "file:///src/main.rs"
|
||||
* ```
|
||||
*/
|
||||
export function expandTemplate(template: string, values: Record<string, string>): string {
|
||||
TEMPLATE_EXPRESSION_REGEX.lastIndex = 0;
|
||||
|
||||
return template.replace(
|
||||
TEMPLATE_EXPRESSION_REGEX,
|
||||
(_match, operator: string, varList: string) => {
|
||||
const varNames = varList
|
||||
.split(',')
|
||||
.map((v: string) =>
|
||||
v
|
||||
.replace(VARIABLE_EXPLODE_MODIFIER_REGEX, '')
|
||||
.replace(VARIABLE_PREFIX_MODIFIER_REGEX, '')
|
||||
.trim()
|
||||
);
|
||||
|
||||
const expandedParts = varNames
|
||||
.map((name: string) => values[name] ?? '')
|
||||
.filter((v: string) => v !== '');
|
||||
|
||||
if (expandedParts.length === 0) return '';
|
||||
|
||||
switch (operator) {
|
||||
case URI_TEMPLATE_OPERATORS.RESERVED:
|
||||
// Reserved expansion: no encoding
|
||||
return expandedParts.join(URI_TEMPLATE_SEPARATORS.COMMA);
|
||||
case URI_TEMPLATE_OPERATORS.FRAGMENT:
|
||||
// Fragment expansion
|
||||
return (
|
||||
URI_TEMPLATE_OPERATORS.FRAGMENT + expandedParts.join(URI_TEMPLATE_SEPARATORS.COMMA)
|
||||
);
|
||||
case URI_TEMPLATE_OPERATORS.PATH_SEGMENT:
|
||||
// Path segments
|
||||
return URI_TEMPLATE_SEPARATORS.SLASH + expandedParts.join(URI_TEMPLATE_SEPARATORS.SLASH);
|
||||
case URI_TEMPLATE_OPERATORS.LABEL:
|
||||
// Label expansion
|
||||
return (
|
||||
URI_TEMPLATE_SEPARATORS.PERIOD + expandedParts.join(URI_TEMPLATE_SEPARATORS.PERIOD)
|
||||
);
|
||||
case URI_TEMPLATE_OPERATORS.PATH_PARAM:
|
||||
// Path-style parameters
|
||||
return varNames
|
||||
.filter((_: string, i: number) => expandedParts[i])
|
||||
.map(
|
||||
(name: string, i: number) =>
|
||||
`${URI_TEMPLATE_SEPARATORS.SEMICOLON}${name}=${expandedParts[i]}`
|
||||
)
|
||||
.join('');
|
||||
case URI_TEMPLATE_OPERATORS.FORM_QUERY:
|
||||
// Form-style query
|
||||
return (
|
||||
URI_TEMPLATE_SEPARATORS.QUERY_PREFIX +
|
||||
varNames
|
||||
.filter((_: string, i: number) => expandedParts[i])
|
||||
.map(
|
||||
(name: string, i: number) =>
|
||||
`${encodeURIComponent(name)}=${encodeURIComponent(expandedParts[i])}`
|
||||
)
|
||||
.join(URI_TEMPLATE_SEPARATORS.COMMA)
|
||||
);
|
||||
case URI_TEMPLATE_OPERATORS.FORM_CONTINUATION:
|
||||
// Form-style query continuation
|
||||
return (
|
||||
URI_TEMPLATE_SEPARATORS.QUERY_CONTINUATION +
|
||||
varNames
|
||||
.filter((_: string, i: number) => expandedParts[i])
|
||||
.map(
|
||||
(name: string, i: number) =>
|
||||
`${encodeURIComponent(name)}=${encodeURIComponent(expandedParts[i])}`
|
||||
)
|
||||
.join(URI_TEMPLATE_SEPARATORS.COMMA)
|
||||
);
|
||||
default:
|
||||
// Simple string expansion (default operator)
|
||||
return expandedParts
|
||||
.map((v: string) => encodeURIComponent(v))
|
||||
.join(URI_TEMPLATE_SEPARATORS.COMMA);
|
||||
}
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether all required variables in a template have been provided.
|
||||
*
|
||||
* @param template - URI template string
|
||||
* @param values - Map of variable name to value
|
||||
* @returns true if all variables have non-empty values
|
||||
*/
|
||||
export function isTemplateComplete(template: string, values: Record<string, string>): boolean {
|
||||
const variables = extractTemplateVariables(template);
|
||||
|
||||
return variables.every((v) => (values[v.name] ?? '').trim() !== '');
|
||||
}
|
||||
Reference in New Issue
Block a user