LibreChat/scripts/eslint/chat.mjs
Marco Beretta 8e60a4185a
Some checks are pending
Backend Unit Tests / Build packages (push) Waiting to run
Backend Unit Tests / Codegraph select (push) Waiting to run
Backend Unit Tests / TypeScript type checks (push) Blocked by required conditions
Backend Unit Tests / Circular dependency checks (push) Waiting to run
Backend Unit Tests / Tests: api (shard 1/3) (push) Blocked by required conditions
Backend Unit Tests / Tests: api (shard 2/3) (push) Blocked by required conditions
Backend Unit Tests / Tests: api (shard 3/3) (push) Blocked by required conditions
Backend Unit Tests / Tests: data-provider (push) Blocked by required conditions
Backend Unit Tests / Tests: data-schemas (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 1/4) (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 2/4) (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 3/4) (push) Blocked by required conditions
Backend Unit Tests / Tests: @librechat/api (shard 4/4) (push) Blocked by required conditions
Codegraph E2E Votes / vote (full suite) (push) Waiting to run
Docker Dev Branch Images Build / publish (push) Waiting to run
Frontend Unit Tests / Client build recovery regression (push) Waiting to run
Frontend Unit Tests / Codegraph select (push) Waiting to run
Frontend Unit Tests / Build packages (push) Waiting to run
Frontend Unit Tests / TypeScript type checks (client) (push) Blocked by required conditions
Frontend Unit Tests / Tests: @librechat/chat (push) Blocked by required conditions
Frontend Unit Tests / Tests: @librechat/client (push) Blocked by required conditions
Frontend Unit Tests / Tests: Ubuntu (shard 1/2) (push) Blocked by required conditions
Frontend Unit Tests / Tests: Ubuntu (shard 2/2) (push) Blocked by required conditions
Frontend Unit Tests / Vite build verification (push) Blocked by required conditions
Sync Locize Translations & Create Translation PR / Sync Translation Keys with Locize (push) Waiting to run
Sync Locize Translations & Create Translation PR / Create Translation PR on Version Published (push) Blocked by required conditions
Main Promotion Policy Tests / Main promotion denial and fast-forward tests (push) Waiting to run
🧱 refactor: Judge Chat Package Imports on the Resolved Module (#16975)
* refactor: Judge chat imports on the resolved target with one boundary rule

scripts/eslint/chat.mjs replaces the import patterns and load selectors: every
specifier is normalized (extension, trailing slash, /index, package name)
before it is judged, across static imports, re-exports, import(), require(),
import-equals and import types, so any spelling of the /react or /components
entry or a UI package is rejected from core. A RuleTester table and a
table-driven scenario cover the spellings.

* fix: Anchor the chat boundary root to the config directory

* fix: Keep bare app paths and bare core entries behind the chat boundary

* fix: Treat aliased react paths in core as the /react entry
2026-10-11 01:06:07 +02:00

147 lines
6.3 KiB
JavaScript

import path from 'node:path';
/**
* `chat/boundary`: what a `@librechat/chat` source may load. Every way of naming a module is
* reduced to one target before it is judged, so the rule holds however the specifier is spelled:
* a relative path is resolved against the file and stripped of its extension, trailing slash and
* `/index`; a bare specifier is reduced to its package name. Static imports, re-exports, `import()`
* and `require()` of a literal or a substitution-free template, `import x = require()` and
* `import('...')` types are all checked.
*
* - Anywhere in the package: nothing outside the package's own sources (the app's `~/` alias,
* `client/src`, `@librechat/frontend`), no Recoil, and no import through the package's own name.
* - In the core (`index.ts` and `core/**`): no UI framework (React, React DOM, Jotai, React Query,
* `@librechat/client`, or any subpath of them) and none of the `/react` or `/components` entries.
* A core `import()` or `require()` whose specifier cannot be read statically is reported too,
* since the rule could not tell what it loads.
*/
const EXTENSION = /\.(?:[cm]?[jt]sx?)$/;
const UI_PACKAGES = new Set(['react', 'react-dom', 'jotai', '@librechat/client']);
const UI_SCOPES = ['@tanstack/'];
const ENTRIES = new Set(['react', 'components']);
const packageName = (specifier) => {
const parts = specifier.split('/');
return specifier.startsWith('@') ? parts.slice(0, 2).join('/') : parts[0];
};
/** `dir/react.ts`, `dir/react/`, `dir/react/index.mjs` all name `dir/react`. */
const normalizePath = (target) => {
let normalized = target.replace(/[\\/]+$/, '').replace(EXTENSION, '');
normalized = normalized.replace(/[\\/]index$/, '');
return normalized;
};
const specifierOf = (node) => {
if (!node) return { known: false };
if (node.type === 'Literal' && typeof node.value === 'string') {
return { known: true, value: node.value };
}
if (node.type === 'TemplateLiteral' && node.expressions.length === 0) {
return { known: true, value: node.quasis[0].value.cooked };
}
if (node.type === 'TSLiteralType') return specifierOf(node.literal);
return { known: false };
};
const boundary = {
meta: {
type: 'problem',
docs: { description: 'Keeps @librechat/chat self-contained and its core free of UI code.' },
schema: [
{
type: 'object',
properties: {
sourceRoot: { type: 'string' },
packageName: { type: 'string' },
},
additionalProperties: false,
},
],
messages: {
app: '@librechat/chat cannot load {{specifier}}; take what it needs from the host instead.',
recoil:
'@librechat/chat holds no Recoil state; per-pane run state is Jotai in the React binding.',
self: '@librechat/chat imports its own modules by relative path, not through {{specifier}}.',
ui: 'The @librechat/chat core has no UI dependency; {{specifier}} belongs in the /react entry.',
entry: 'The core cannot load {{specifier}}; the /{{entry}} entry builds on the core.',
opaque: 'The @librechat/chat core loads only specifiers the boundary can read.',
},
},
create(context) {
const options = context.options[0] ?? {};
const self = options.packageName ?? '@librechat/chat';
const root = path.resolve(context.cwd, options.sourceRoot ?? 'packages/chat/src');
const filename = path.resolve(context.filename);
const relativeFile = path.relative(root, filename);
if (relativeFile.startsWith('..') || path.isAbsolute(relativeFile)) return {};
const segments = relativeFile.split(path.sep);
const isCore =
(segments.length === 1 && /^index\.[cm]?[jt]sx?$/.test(segments[0])) ||
(segments[0] === 'core' &&
!segments.includes('__tests__') &&
!/\.(spec|test)\./.test(relativeFile));
const judge = (node, specifier) => {
const report = (messageId, data = {}) =>
context.report({ node, messageId, data: { specifier, ...data } });
if (specifier.startsWith('.') || path.isAbsolute(specifier)) {
const target = normalizePath(path.resolve(path.dirname(filename), specifier));
const fromRoot = path.relative(root, target);
if (fromRoot.startsWith('..') || path.isAbsolute(fromRoot)) return report('app');
const entry = fromRoot.split(path.sep)[0];
if (isCore && ENTRIES.has(entry)) return report('entry', { entry });
return;
}
if (specifier === '~' || specifier.startsWith('~/')) return report('app');
const bareSegments = normalizePath(specifier).split('/');
/** A path alias (`baseUrl`, a bundler alias) can still name the app or an entry bare. */
if (
bareSegments.some(
(segment, index) => segment === 'client' && bareSegments[index + 1] === 'src',
)
) {
return report('app');
}
const name = packageName(specifier);
if (name === '@librechat/frontend') return report('app');
if (name === 'recoil') return report('recoil');
if (name === self) return report('self');
/** `react` itself is the UI package; any other bare path through `react` or `components`
* (`src/react`, `@/components`) is an alias for an entry. */
const bareEntry =
name === 'react' ? undefined : bareSegments.find((segment) => ENTRIES.has(segment));
if (isCore && bareEntry) return report('entry', { entry: bareEntry });
if (isCore && (UI_PACKAGES.has(name) || UI_SCOPES.some((scope) => name.startsWith(scope)))) {
return report('ui');
}
};
const check = (node, sourceNode) => {
const { known, value } = specifierOf(sourceNode);
if (known) return judge(node, value);
if (isCore) context.report({ node, messageId: 'opaque' });
};
return {
ImportDeclaration: (node) => check(node, node.source),
ExportNamedDeclaration: (node) => node.source && check(node, node.source),
ExportAllDeclaration: (node) => check(node, node.source),
ImportExpression: (node) => check(node, node.source),
TSImportType: (node) => check(node, node.argument),
TSExternalModuleReference: (node) => check(node, node.expression),
CallExpression(node) {
if (node.callee.type !== 'Identifier' || node.callee.name !== 'require') return;
check(node, node.arguments[0]);
},
};
},
};
export default {
meta: { name: 'chat' },
rules: { boundary },
};