fix: align collection name validation with zvec (allow hyphens) by webdevsamran · Pull Request #12 · zvec-ai/zvec-studio

webdevsamran · 2026-09-03T04:55:42Z

Fixes #9

Aligns Studio collection name validation with the underlying zvec engine to accept hyphens and numbers at the start of names.

Changes

Backend: updated _COLLECTION_NAME_RE in apps/backend/zvec_studio/schemas/collection.py from ^[A-Za-z][A-Za-z0-9_]{2,63}$ to ^[A-Za-z0-9_-]{3,64}$, including collection creation and snapshot import rename validation.
Frontend: updated COLLECTION_NAME_RE in apps/frontend/src/pages/collections/CreateCollectionDialog.tsx to /^[A-Za-z0-9_-]{3,64}$/.
Locales: updated error messages in en.json and zh.json.
Tests \u0026 Docs: updated unit tests in apps/backend/tests/unit/test_collections_schemas.py to verify valid hyphenated names (e.g., pr-new-collection, -start, end-, a-b) and documentation in docs/backend.md.

Signed-off-by: webdevsamran <samranwebdev2000@gmail.com>

feihongxu0824

This fixes the immediate mismatch, but it still copies Zvec's collection-name regex into Studio, which preserves the duplication that caused #9. Could we make Zvec/SDK the source of truth for engine-level name validation, pass the name through, and translate SDK validation failures into a stable Studio API error?

The remaining recent / open restrictions are caused by route layout rather than collection-domain rules: static endpoints such as /collections/recent and /collections/open share the /collections/{name} namespace. Those operations should move out of the resource-name namespace—for example, POST /collections:open and GET /workspace/recent-collections—after which _RESERVED_COLLECTION_NAMES can be removed. Existing routes can remain temporarily as deprecated aliases if compatibility is required.

feihongxu0824 · 2026-10-21T03:47:55Z

 import './CreateCollectionDialog.css';

-const COLLECTION_NAME_RE = /^[A-Za-z][A-Za-z0-9_]{2,63}$/;
+const COLLECTION_NAME_RE = /^[A-Za-z0-9_-]{3,64}$/;


Please avoid duplicating the engine regex in the frontend. Otherwise Studio can again block names accepted by a future Zvec version. The UI can check that the name is present and surface the normalized backend validation error; if exact client-side constraints are required, they should come from a shared or generated contract.

feihongxu0824 · 2026-10-21T03:47:55Z

+    await userEvent.type(screen.getByTestId('zv-create-path'), '/tmp/foo');
+    await userEvent.click(screen.getByTestId('zv-create-submit'));
+
+    expect(screen.queryByText(/Name must match/)).not.toBeInTheDocument();


This only asserts that an error is not currently visible. Please wait for and assert the POST request, including body.schema.name, so the test proves that the hyphenated name was actually accepted and submitted.

…lean frontend regex - Remove duplicated collection name regex from CreateCollectionDialog and let backend/SDK serve as single source of truth for name format validation. - Surface backend INVALID_SCHEMA/VALIDATION_ERROR directly to field error state and toast notification. - Update CreateCollectionDialog.test.tsx to assert POST schema payload with body.schema.name and verify backend error presentation. - Update CollectionSchema to enforce non-empty names and REST route path reservations while delegating format validation to Zvec SDK. Signed-off-by: Samran Asif <samranwebdev2000@gmail.com>

webdevsamran · 2026-10-21T04:24:04Z

Hi @feihongxu0824 👋 Thanks for the review and architectural guidance!

Addressed in commit \2407f60:

Frontend Regex Removed: Completely removed the duplicated engine regex from \CreateCollectionDialog.tsx. The UI now only checks that the name is present, delegating format validation entirely to the backend and Zvec SDK.
Normalized Backend Error Surfacing: When the backend/SDK rejects a collection schema with \INVALID_SCHEMA\ or \VALIDATION_ERROR, the normalized error is surfaced both directly on the name field error state and through the toast notification.
POST Payload Test Assertion: Updated \CreateCollectionDialog.test.tsx\ to wait for and assert the submitted POST request payload, verifying \�ody.schema.name === 'my-valid-collection', and added explicit coverage for backend validation error presentation.
Backend Single Source of Truth: Updated \CollectionSchema\ and \CollectionImportRequest\ to pass collection names through to the SDK (which maps engine validation failures to \InvalidSchemaError), while preserving REST gateway reserved route path guards (
ecent, \open).

feihongxu0824

Thanks—the validation ownership changes look good. The route coupling remains because recent and open are still reserved. Please create and link a follow-up issue or PR for the route migration so this architectural part is not lost.

One compatibility detail: GET /collections/recent cannot remain as a deprecated alias while also allowing a collection named recent, because the HTTP method and path are identical. Supporting both requires either a clean route break, API versioning, or moving item access to a different namespace. A clean target would be POST /collections:open, POST /collections:import, and GET /workspace/recent-collections, after which the reserved-name guards can be removed.

feihongxu0824 · 2026-10-21T05:50:55Z

+          err.error.code === 'VALIDATION_ERROR' ||
+          err.error.code === 'INVALID_SCHEMA'
+        ) {
+          setErrors((prev) => ({


INVALID_SCHEMA is not necessarily a collection-name error; it is also used for unrelated failures such as a missing parent directory, invalid fields, vectors, or index configuration. Mapping every INVALID_SCHEMA / VALIDATION_ERROR to errors.name can therefore display an unrelated error under the Name field. Please keep generic schema errors at the form/toast level, and only set errors.name when the backend returns an explicit field location such as schema.name.

… field location Signed-off-by: Samran Asif <samranwebdev2000@gmail.com>

webdevsamran · 2026-10-21T11:05:23Z

Thank you @feihongxu0824! I have opened follow-up issue #13 to track the route decoupling and removal of reserved collection names: #13

feihongxu0824 · 2026-10-22T01:01:05Z

CI is currently failing consistently across all backend matrices on the same test:

tests/unit/test_edge_cases.py::test_collection_name_exceeds_max_length_rejected
expected: 422
actual:   400

This appears to be an outdated assertion after moving engine-level collection-name validation from Pydantic to Zvec/SDK. The request now reaches the SDK and is normalized as INVALID_SCHEMA (400) rather than a Pydantic VALIDATION_ERROR (422). Please update the test to assert the new API contract, ideally including the stable error code:

assert resp.status_code == 400
assert resp.json()["code"] == "INVALID_SCHEMA"

Frontend Node 20/22 and E2E are green; the backend failures all point to this same expectation mismatch.

…NVALID_SCHEMA Signed-off-by: Samran Asif <samranwebdev2000@gmail.com>

webdevsamran · 2026-10-22T17:11:10Z

Hi @feihongxu0824 👋 Thanks for catching that!

Updated the expectation in tests/unit/test_edge_cases.py (test_collection_name_exceeds_max_length_rejected) in commit b8cca7f to assert resp.status_code == 400 and resp.json()["code"] == "INVALID_SCHEMA" per the new SDK validation normalization contract.

webdevsamran added 2 commits September 22, 2026 14:15

fix: align collection name validation with zvec (allow hyphens)

066ded1

Signed-off-by: webdevsamran <samranwebdev2000@gmail.com>

test(frontend): update collection name format test for hyphen support

9137732

Signed-off-by: webdevsamran <samranwebdev2000@gmail.com>

webdevsamran force-pushed the fix/issue-9 branch from a938dc8 to 9137732 Compare September 22, 2026 09:15

feihongxu0824 reviewed Oct 21, 2026

View reviewed changes

refactor(frontend): only set name error when backend returns explicit…

f33ef8c

… field location Signed-off-by: Samran Asif <samranwebdev2000@gmail.com>

webdevsamran mentioned this pull request Oct 21, 2026

refactor(routes): decouple static collection operations from /collections/{name} namespace #13

Open

test(backend): update collection name max length expectation to 400 I…

b8cca7f

…NVALID_SCHEMA Signed-off-by: Samran Asif <samranwebdev2000@gmail.com>

Navigation Menu

Repository navigation

fix: align collection name validation with zvec (allow hyphens) - #12

fix: align collection name validation with zvec (allow hyphens)#12
webdevsamran wants to merge 5 commits into
zvec-ai:mainfrom
webdevsamran:fix/issue-9

webdevsamran commented Sep 3, 2026

Uh oh!

feihongxu0824 left a comment

Uh oh!

feihongxu0824 Oct 21, 2026

Uh oh!

feihongxu0824 Oct 21, 2026

Uh oh!

webdevsamran commented Oct 21, 2026

Uh oh!

feihongxu0824 left a comment

Uh oh!

feihongxu0824 Oct 21, 2026

Uh oh!

webdevsamran commented Oct 21, 2026

Uh oh!

feihongxu0824 commented Oct 22, 2026

Uh oh!

webdevsamran commented Oct 22, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

webdevsamran commented Sep 3, 2026

Changes

Uh oh!

feihongxu0824 left a comment

Choose a reason for hiding this comment

Uh oh!

feihongxu0824 Oct 21, 2026

Choose a reason for hiding this comment

Uh oh!

feihongxu0824 Oct 21, 2026

Choose a reason for hiding this comment

Uh oh!

webdevsamran commented Oct 21, 2026

Uh oh!

feihongxu0824 left a comment

Choose a reason for hiding this comment

Uh oh!

feihongxu0824 Oct 21, 2026

Choose a reason for hiding this comment

Uh oh!

webdevsamran commented Oct 21, 2026

Uh oh!

feihongxu0824 commented Oct 22, 2026

Uh oh!

webdevsamran commented Oct 22, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants