from_neo4j_ontology drops an empty object or list description in Python but TypeScript rejects it

Aperta Adatta ai principianti
#381 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
74/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python, typescript
Ambito
api, backend

Direzione di ricerca

Leggi src/selfgraph/_neo4j_schema.py e typescript/src/neo4jSchema.ts, concentrandoti sulla gestione delle descrizioni nelle righe citate nell’issue. Confronta il modo in cui ciascun SDK tratta gli oggetti e gli array vuoti, quindi esegui i test pertinenti di convalida dello schema per entrambi. L’obiettivo è che entrambi gli SDK rifiutino in modo coerente le descrizioni che non sono stringhe né null per i tipi di nodo e di relazione.

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

Descrizione

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

Summary

Schema.from_neo4j_ontology treats a description of {} or [] differently in the two SDKs. Python drops it and accepts the document; TypeScript keeps it and rejects the document.

Reproduction (0.2.2, main at 5a277c9)

from selfgraph import Schema

Schema.from_neo4j_ontology({"node_types": [{"label": "Person", "description": {}}]})
# accepted, description None

Schema.from_neo4j_ontology({
    "node_types": [{"label": "Person", "properties": [{"name": "age", "description": []}]}],
})
# accepted, property description None
import { fromNeo4jOntology } from "@hydradb/selfgraph";

fromNeo4jOntology({ node_types: [{ label: "Person", description: {} }] });
// ValidationError: invalid schema: entities[0].description: expected string

fromNeo4jOntology({ node_types: [{ label: "Person", properties: [{ name: "age", description: [] }] }] });
// ValidationError: invalid schema: entities[0].properties[0].description: expected string

The same applies to relationship types.

Cause

Python src/selfgraph/_neo4j_schema.py:128 and :133 use value or None, and an empty dict or list is falsy in Python. TypeScript typescript/src/neo4jSchema.ts:128 and :133 use value || null, and an empty object or array is truthy in JavaScript, so it reaches schema validation.

Expected

Both SDKs give the same result. Since a description must be a string, the clearest fix is to reject any non-string, non-null description in both, rather than silently dropping some values.

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.