external_ids accepts empty and whitespace keys that properties rejects

Aperta Adatta ai principianti
#391 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python, typescript

Direzione di ricerca

Inizia da _require_str_mapping in src/selfgraph/_ops.py e requireStrMapping in typescript/src/validate.ts; confrontali con i validator di mapping JSON affini menzionati nell’issue. Controlla i test di validazione per entrambi gli SDK e aggiungi casi per le chiavi external_ids vuote e composte solo da spazi. Il lavoro è completato quando entrambi gli SDK rifiutano queste chiavi con lo stesso messaggio di properties.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

approved-for-pr area: parity area: write bug effort: S P3

Summary

external_ids accepts an empty or whitespace-only key, while properties rejects the same key. The two sibling fields validate keys differently, in both SDKs.

Reproduction (0.2.2, Kuzu backend)

await g.entities.create("A", "Person", properties={"": 1})
# ValidationError: properties keys cannot be empty or whitespace

await g.entities.create("B", "Person", external_ids={"": "v"})
# stored; get() returns external_ids == {"": "v"}

await g.entities.create("C", "Person", external_ids={"  ": "v"})
# also stored

A whitespace-only key behaves the same way. Control-character keys (NUL, newline, tab) are rejected for both fields; only the empty and whitespace case diverges.

Cause

properties goes through _require_json_mapping, which rejects empty or whitespace keys:

if any(not key.strip() for key in value):
    raise ValidationError(f"{name} keys cannot be empty or whitespace")

external_ids goes through _require_str_mapping (src/selfgraph/_ops.py around line 464), which checks only that the values are strings and never checks the keys. The TypeScript port is identical: requireJsonMapping rejects blank keys but requireStrMapping does not (typescript/src/validate.ts around lines 384 and 399), so both SDKs share the gap.

This is the complement of #339 (which is about an empty property key rejecting a whole insert.text): there the empty key is rejected, here it is silently accepted. A single decision about empty keys could cover both.

Expected

external_ids keys are validated like properties keys, so an empty or whitespace-only key raises ValidationError with the same message, in both SDKs.

Lingua principale
TypeScript
Stelle
173
Fork
58
Merge medio
6h
PR unite (30g)
120

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hydra-db/selfgraph

Tutte le issue di hydra-db/selfgraph

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.