Refactor formula engine and validator into separate plugin packages by Copilot · Pull Request #252 · objectstack-ai/objectql

Copilot · 2026-01-29T12:09:56Z

Extracted formula engine and validator from monolithic @objectql/core into dedicated plugins, improving modularity and bundle size with clean separation of concerns.

Changes

New Packages

@objectql/plugin-formula - FormulaEngine and FormulaPlugin (573 LOC, 109 tests)
@objectql/plugin-validator - Validator and ValidatorPlugin (744 LOC, 52 tests)

Core Package Updates

Added dependencies on new plugins (for internal use)
No re-exports - enforces explicit dependencies
Updated internal imports (repository.ts, ai-agent.ts, plugin.ts)
Removed 1,317 lines (moved to plugins)

Migration Path

Breaking Change: Applications must update imports to use dedicated packages:

// Before
import { FormulaEngine, Validator } from '@objectql/core';

// After
import { FormulaEngine } from '@objectql/plugin-formula';
import { Validator } from '@objectql/plugin-validator';

const kernel = new ObjectStackKernel([
  myApp,
  new FormulaPlugin({ enable_cache: false }),
  new ValidatorPlugin({ language: 'en' })
]);

Architecture

Before:

@objectql/core (monolithic)
├── Repository + Query
├── Formula Engine
└── Validator

After:

@objectql/plugin-formula (focused)
@objectql/plugin-validator (focused)
@objectql/core (lean, focused on core repository logic)

Follows existing pattern from @objectql/plugin-security. Enables tree-shaking and optional feature inclusion. Enforces clean architectural boundaries with explicit dependencies.

Testing

All 282 tests passing (no regressions)
CodeQL security scan: 0 alerts

Documentation

MIGRATION_GUIDE.md with migration instructions
Comprehensive READMEs for both plugins
PLUGIN_REFACTORING_SUMMARY.md with metrics

Original prompt

公式引擎和validator是否建议分拆为单独的插件软件包。

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

vercel · 2026-01-29T12:10:00Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
objectql	Ready	Preview, Comment	Jan 30, 2026 5:35am

- Created @objectql/plugin-formula package with FormulaEngine and FormulaPlugin - Created @objectql/plugin-validator package with Validator and ValidatorPlugin - Updated @objectql/core to depend on and re-export from new plugins - Moved all source files and tests to appropriate plugin packages - Updated imports throughout the codebase - All packages build successfully Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>

…ixes - Fixed test imports and added mock-driver to plugin test directories - Created comprehensive MIGRATION_GUIDE.md - Fixed code formatting issues identified in review - All 282 tests passing (109 formula, 52 validator, 121 core) - CodeQL security scan passed with no alerts - Backward compatibility maintained through core package re-exports Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>

hotlong · 2026-01-29T16:11:20Z

不需要Re-exports components for backward compatibility @copilot

Per feedback, the @objectql/core package no longer re-exports components from plugin-formula and plugin-validator. Users must now explicitly import from the plugin packages they use, enforcing clean separation of concerns. Breaking change: Applications must update imports: - Before: import { FormulaEngine, Validator } from '@objectql/core'; - After: import { FormulaEngine } from '@objectql/plugin-formula'; import { Validator } from '@objectql/plugin-validator'; Updated MIGRATION_GUIDE.md and PLUGIN_REFACTORING_SUMMARY.md to reflect this change and remove references to backward compatibility. Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot · 2026-01-29T16:16:45Z

不需要Re-exports components for backward compatibility @copilot

Done. Removed backward compatibility re-exports from @objectql/core. Users must now explicitly import from @objectql/plugin-formula and @objectql/plugin-validator. This enforces clean separation of concerns.

Updated documentation (MIGRATION_GUIDE.md and PLUGIN_REFACTORING_SUMMARY.md) to reflect this breaking change.

All 282 tests still passing. Commit: 73822a4

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

fastdl.mongodb.org
- Triggering command: /usr/local/bin/node node ./postinstall.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

- Add plugin-validator and plugin-formula to root tsconfig references - Update core package tsconfig to reference plugin packages - Fix CLI import to use plugin-validator directly - Add plugin-validator dependency to CLI package Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…n-references

github-actions · 2026-01-29T16:43:06Z

⚠️ No Changeset Found

This PR does not include a changeset file.
If this PR includes user-facing changes, please add a changeset by running:

pnpm changeset

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

- Revert core re-exports to avoid circular dependency - Update test to import from @objectql/plugin-validator - Add plugin-validator as devDependency to platform-node Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

- Remove validation.test.ts from platform-node (not its responsibility) - Remove plugin-validator devDependency from platform-node - Validation tests already exist in plugin-validator package (52 tests) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

- Add comprehensive validation tests to plugin-validator (uniqueness, business rules, cross-field, state machine, triggers, severity) - Remove validation.test.ts from platform-node (tests now in correct package) - Platform-node tests pass (5 tests) - focused on platform responsibilities - Plugin-validator now has 71 tests total (some failing due to incomplete implementation - to be fixed separately) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…rocessing

github-actions · 2026-01-30T00:01:20Z

⚠️ No Changeset Found

This PR does not include a changeset file.
If this PR includes user-facing changes, please add a changeset by running:

pnpm changeset

+import {
+    ValidationContext,
+    CrossFieldValidationRule,
+    StateMachineValidationRule,
+    UniquenessValidationRule,
+    BusinessRuleValidationRule,
+    CustomValidationRule,
+    FieldConfig,
+    AnyValidationRule,
+} from '@objectql/types';


Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…on-run

github-actions · 2026-01-30T05:34:28Z

⚠️ No Changeset Found

This PR does not include a changeset file.
If this PR includes user-facing changes, please add a changeset by running:

pnpm changeset

Copilot

Pull request overview

Refactors ObjectQL by extracting the formula engine and validation engine from @objectql/core into two dedicated plugin packages, improving modularity and enabling explicit, opt-in dependencies.

Changes:

Introduced @objectql/plugin-formula and @objectql/plugin-validator packages (engines + plugin wrappers + tests/docs).
Updated @objectql/core to depend on (but not re-export) the new plugins; updated internal imports accordingly.
Updated CLI and shared type definitions to reflect the new plugin-based architecture.

Reviewed changes

Copilot reviewed 30 out of 39 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tsconfig.json	Adds TS project references for the new plugin packages.
packages/tools/cli/tsconfig.json	Adds plugin-validator reference so CLI builds with the new dependency.
packages/tools/cli/src/commands/ai.ts	Switches Validator import from core to `@objectql/plugin-validator`.
packages/tools/cli/package.json	Adds `@objectql/plugin-validator` dependency.
packages/foundation/types/src/validation.ts	Extends validation schema types (business-rule shorthand + cross-field shorthand).
packages/foundation/plugin-validator/tsconfig.json	New TS config for validator plugin package.
packages/foundation/plugin-validator/test/validator.test.ts	New validator engine tests in plugin package.
packages/foundation/plugin-validator/test/validator-plugin.test.ts	New validator plugin wrapper tests.
packages/foundation/plugin-validator/test/validation-spec-compliance.test.ts	Spec compliance coverage for validator behavior.
packages/foundation/plugin-validator/src/validator.ts	Validator engine implementation moved into plugin package + enhancements.
packages/foundation/plugin-validator/src/validator-plugin.ts	Validator plugin wrapper (kernel integration hooks).
packages/foundation/plugin-validator/src/index.ts	Plugin package public exports.
packages/foundation/plugin-validator/package.json	New plugin package manifest.
packages/foundation/plugin-validator/jest.config.js	Jest config for plugin package tests.
packages/foundation/plugin-validator/README.md	Plugin documentation and usage examples.
packages/foundation/plugin-formula/tsconfig.json	New TS config for formula plugin package.
packages/foundation/plugin-formula/test/mock-driver.ts	Test helper driver for formula integration tests.
packages/foundation/plugin-formula/test/formula-spec-compliance.test.ts	Spec compliance tests for formula behavior.
packages/foundation/plugin-formula/test/formula-plugin.test.ts	New formula plugin wrapper tests.
packages/foundation/plugin-formula/test/formula-integration.test.ts	Updates integration test import to use `@objectql/core`.
packages/foundation/plugin-formula/test/formula-engine.test.ts	Formula engine unit tests moved into plugin package.
packages/foundation/plugin-formula/src/index.ts	Plugin package public exports.
packages/foundation/plugin-formula/src/formula-plugin.ts	Formula plugin wrapper (kernel provider + hook registration).
packages/foundation/plugin-formula/src/formula-engine.ts	Formula engine implementation moved into plugin package.
packages/foundation/plugin-formula/package.json	New plugin package manifest.
packages/foundation/plugin-formula/jest.config.js	Jest config for plugin package tests.
packages/foundation/plugin-formula/README.md	Plugin documentation and usage examples.
packages/foundation/platform-node/test/validation.test.ts	Removes platform-node validation tests migrated to plugin-validator.
packages/foundation/core/tsconfig.json	Adds TS project references to the new plugin packages.
packages/foundation/core/test/validator.test.ts	Removes core validator tests migrated to plugin-validator.
packages/foundation/core/test/plugin-integration.test.ts	Updates integration tests to import/mocks from new plugin packages.
packages/foundation/core/src/repository.ts	Switches internal imports to plugin-based Validator/FormulaEngine.
packages/foundation/core/src/plugin.ts	Switches internal imports to plugin-based ValidatorPlugin/FormulaPlugin.
packages/foundation/core/src/index.ts	Stops re-exporting validator/formula engines & plugins from core.
packages/foundation/core/src/ai-agent.ts	Switches Validator import from core-local to plugin package.
packages/foundation/core/package.json	Adds dependencies on `@objectql/plugin-formula` and `@objectql/plugin-validator`.
PLUGIN_REFACTORING_SUMMARY.md	Adds refactor summary/metrics and migration overview.
MIGRATION_GUIDE.md	Adds migration guide and new import paths/examples.

Comments suppressed due to low confidence (8)

packages/foundation/core/src/ai-agent.ts:24

Unused imports AnyValidationRule, ObjectConfig, ValidationContext, ValidationResult.

import { 
    ObjectConfig, 
    AnyValidationRule, 
    ValidationContext,
    ValidationResult 
} from '@objectql/types';

packages/foundation/core/src/repository.ts:9

Unused import Filter.

import { ObjectQLContext, IObjectQL, ObjectConfig, Driver, UnifiedQuery, ActionContext, HookAPI, RetrievalHookContext, MutationHookContext, UpdateHookContext, ValidationContext, ValidationError, ValidationRuleResult, FormulaContext, Filter } from '@objectql/types';

packages/foundation/core/src/repository.ts:457

Unused variable driver.

        const driver = this.getDriver();

packages/tools/cli/src/commands/ai.ts:395

Unused variable validator.
packages/foundation/core/src/ai-agent.ts:258
The value assigned to parsedMetadata here is unused.

                parsedMetadata = yaml.load(options.metadata);

packages/foundation/core/src/ai-agent.ts:271

The value assigned to parsedMetadata here is unused.

            parsedMetadata = options.metadata;

packages/foundation/core/src/plugin.ts:97

This write to property 'config' is useless, since another property write always overrides it.

  constructor(private config: ObjectQLPluginConfig = {}, ql?: any) {

packages/foundation/plugin-validator/src/validator.ts:637

This use of variable 'valid' always evaluates to true.

Copilot · 2026-01-30T06:31:37Z

+    /** Shorthand: Field to check (alternative to using rule property) */
+    field?: string;
+    /** Shorthand: Comparison operator (alternative to using rule property) */
+    operator?: ValidationOperator;
+    /** Shorthand: Value to compare against (mutually exclusive with compare_to) */


The new shorthand operator is typed as ValidationOperator, but the implementation now normalizes aliases like gte, lte, eq, etc. If those aliases are supported inputs (e.g., from YAML), the type should be widened to include them (or alias normalization removed) so TypeScript and runtime behavior stay consistent.

Copilot · 2026-01-30T06:31:37Z

+2. Review the [API Documentation](../../docs/api/)
+3. Open a new issue if needed
+
+## Additional Resources
+
+- [Formula Plugin README](../packages/foundation/plugin-formula/README.md)
+- [Validator Plugin README](../packages/foundation/plugin-validator/README.md)
+- [API Documentation](../../docs/api/)
+- [Examples](../../examples/)


These documentation links are broken as written. From the repository root, ../../docs/api/ points outside the repo, and the examples link ../../examples/ also points outside the repo. Update them to valid in-repo paths (or to the published docs site URLs if that’s the intent).

Suggested change

2. Review the [API Documentation](../../docs/api/)

3. Open a new issue if needed

## Additional Resources

- [Formula Plugin README](../packages/foundation/plugin-formula/README.md)

- [Validator Plugin README](../packages/foundation/plugin-validator/README.md)

- [API Documentation](../../docs/api/)

- [Examples](../../examples/)

2. Review the [API Documentation](./api/)

3. Open a new issue if needed

## Additional Resources

- [Formula Plugin README](../packages/foundation/plugin-formula/README.md)

- [Validator Plugin README](../packages/foundation/plugin-validator/README.md)

- [API Documentation](./api/)

- [Examples](../examples/)

Copilot · 2026-01-30T06:31:37Z

+2. Review the [API Documentation](../../docs/api/)
+3. Open a new issue if needed
+
+## Additional Resources
+
+- [Formula Plugin README](../packages/foundation/plugin-formula/README.md)
+- [Validator Plugin README](../packages/foundation/plugin-validator/README.md)
+- [API Documentation](../../docs/api/)
+- [Examples](../../examples/)


The “Additional Resources” links use ../packages/... from the repo root, which resolves outside the repo and will 404 on GitHub. These should be ./packages/... (or another correct relative path).

Suggested change

2. Review the [API Documentation](../../docs/api/)

3. Open a new issue if needed

## Additional Resources

- [Formula Plugin README](../packages/foundation/plugin-formula/README.md)

- [Validator Plugin README](../packages/foundation/plugin-validator/README.md)

- [API Documentation](../../docs/api/)

- [Examples](../../examples/)

2. Review the [API Documentation](./docs/api/)

3. Open a new issue if needed

## Additional Resources

- [Formula Plugin README](./packages/foundation/plugin-formula/README.md)

- [Validator Plugin README](./packages/foundation/plugin-validator/README.md)

- [API Documentation](./docs/api/)

- [Examples](./examples/)

Copilot · 2026-01-30T06:31:38Z

+import {
+    ValidationContext,
+    CrossFieldValidationRule,
+    StateMachineValidationRule,
+    UniquenessValidationRule,
+    BusinessRuleValidationRule,
+    CustomValidationRule,
+    FieldConfig,
+    AnyValidationRule,
+} from '@objectql/types';


Unused import AnyValidationRule.

Initial plan

5ad4b92

Copilot AI assigned Copilot and xuyushun441-sys Jan 29, 2026

Copilot started work on behalf of xuyushun441-sys January 29, 2026 12:10 View session

vercel Bot deployed to Preview January 29, 2026 12:11 View deployment

vercel Bot deployed to Preview January 29, 2026 12:20 View deployment

Copilot AI and others added 2 commits January 29, 2026 12:23

Add comprehensive refactoring summary document

8b3de2c

vercel Bot deployed to Preview January 29, 2026 12:27 View deployment

Copilot AI changed the title ~~[WIP] Evaluate splitting official engine and validator into separate plugins~~ Refactor formula engine and validator into separate plugin packages Jan 29, 2026

Copilot AI requested a review from xuyushun441-sys January 29, 2026 12:28

Copilot finished work on behalf of xuyushun441-sys January 29, 2026 12:28

github-actions Bot added 🏗️ foundation 🧪 tests 📦 dependencies 📚 documentation size/L labels Jan 29, 2026

Copilot started work on behalf of hotlong January 29, 2026 16:11 View session

Copilot AI requested a review from hotlong January 29, 2026 16:17

Copilot finished work on behalf of hotlong January 29, 2026 16:17

vercel Bot deployed to Preview January 29, 2026 16:31 View deployment

Copilot AI and others added 4 commits January 29, 2026 16:33

Initial plan

cab9964

Upgrade pnpm lockfile to v9.0 for pnpm v10 compatibility

9a1c4ce

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Merge pull request #253 from objectstack-ai/copilot/update-actions-ru…

7b3a560

…n-references

github-actions Bot added 🔧 tooling ⚙️ configuration labels Jan 29, 2026

vercel Bot deployed to Preview January 29, 2026 16:45 View deployment

Copilot AI and others added 6 commits January 29, 2026 17:16

Initial plan

dbcc86a

Fix Validator import by re-exporting from plugin packages

193c640

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Merge pull request #254 from objectstack-ai/copilot/fix-bug-in-data-p…

3e4e539

…rocessing

github-actions Bot added the size/XL label Jan 30, 2026

github-code-quality Bot found potential problems Jan 30, 2026

View reviewed changes

vercel Bot deployed to Preview January 30, 2026 00:15 View deployment

Copilot AI and others added 4 commits January 30, 2026 00:53

Initial plan

b4f0566

Fix validator business rule constraints and cross-field validation

603c27b

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Improve validation documentation and clarify field presence checks

aaee5d9

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Merge pull request #256 from objectstack-ai/copilot/fix-issue-in-acti…

8bc3242

…on-run

vercel Bot deployed to Preview January 30, 2026 05:35 View deployment

hotlong marked this pull request as ready for review January 30, 2026 06:17

Copilot AI review requested due to automatic review settings January 30, 2026 06:17

hotlong merged commit 789e00d into main Jan 30, 2026
4 checks passed

hotlong deleted the copilot/discuss-splitting-plugins branch January 30, 2026 06:17

Copilot started reviewing on behalf of hotlong January 30, 2026 06:17 View session

Copilot AI reviewed Jan 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor formula engine and validator into separate plugin packages#252

Refactor formula engine and validator into separate plugin packages#252
hotlong merged 19 commits into
mainfrom
copilot/discuss-splitting-plugins

Copilot AI commented Jan 29, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jan 29, 2026 •

edited

Loading

Uh oh!

hotlong commented Jan 29, 2026

Uh oh!

Copilot AI commented Jan 29, 2026 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions Bot commented Jan 29, 2026

Uh oh!

github-actions Bot commented Jan 30, 2026

Uh oh!

github-actions Bot commented Jan 30, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Copilot AI commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

New Packages

Core Package Updates

Migration Path

Architecture

Testing

Documentation

Uh oh!

vercel Bot commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hotlong commented Jan 29, 2026

Uh oh!

Copilot AI commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions Bot commented Jan 29, 2026

⚠️ No Changeset Found

Uh oh!

github-actions Bot commented Jan 30, 2026

⚠️ No Changeset Found

Uh oh!

github-actions Bot commented Jan 30, 2026

⚠️ No Changeset Found

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jan 29, 2026 •

edited

Loading

vercel Bot commented Jan 29, 2026 •

edited

Loading

Copilot AI commented Jan 29, 2026 •

edited

Loading