graphql-python / graphene-sqlalchemy

Graphene SQLAlchemy integration
http://docs.graphene-python.org/projects/sqlalchemy/en/latest/
MIT License
981 stars 228 forks source link

Query picking shadowed property when property name is `id` with different column name and second property vice versa. #412

Open usalu opened 3 months ago

usalu commented 3 months ago

Hello👋, this works as expected:

from sqlalchemy import create_engine
from sqlalchemy.orm import Session, mapped_column, Mapped, DeclarativeBase
from graphene import Field, ObjectType, Schema
from graphene_sqlalchemy import SQLAlchemyObjectType

class Base(DeclarativeBase):
    pass

class Foo(Base):
    __tablename__ = "foo"
    bar: Mapped[int] = mapped_column(
        "spam",
        primary_key=True,
    )
    spam: Mapped[str] = mapped_column("baz")

foo = Foo(bar=3, spam="ham")
engine = create_engine("sqlite:///test.sqlite3")
Base.metadata.create_all(engine)
with Session(engine) as session:
    session.add(foo)
    session.commit()

class FooNode(SQLAlchemyObjectType):
    class Meta:
        model = Foo

class Query(ObjectType):
    foo = Field(FooNode)

    def resolve_foo(self, info):
        with Session(engine) as session:
            return session.query(Foo).first()

schema = Schema(query=Query)

result = schema.execute(
    """
    {
        foo {
            spam
        }
    }
    """
)
print(result.data["foo"]["spam"])  # prints 'ham'

but as soon as you change spam to id it prints the value of the property bar:

from sqlalchemy import create_engine
from sqlalchemy.orm import Session, mapped_column, Mapped, DeclarativeBase
from graphene import Field, ObjectType, Schema
from graphene_sqlalchemy import SQLAlchemyObjectType

class Base(DeclarativeBase):
    pass

class Foo(Base):
    __tablename__ = "foo"
    bar: Mapped[int] = mapped_column(
        "id",
        primary_key=True,
    )
    id: Mapped[str] = mapped_column("baz")

foo = Foo(bar=3, id="ham")
engine = create_engine("sqlite:///test.sqlite3")
Base.metadata.create_all(engine)
with Session(engine) as session:
    session.add(foo)
    session.commit()

class FooNode(SQLAlchemyObjectType):
    class Meta:
        model = Foo

class Query(ObjectType):
    foo = Field(FooNode)

    def resolve_foo(self, info):
        with Session(engine) as session:
            return session.query(Foo).first()

schema = Schema(query=Query)

result = schema.execute(
    """
    {
        foo {
            id
        }
    }
    """
)
print(result.data["foo"]["id"])  # prints 3 but should print 'ham'

I believe that is a bug 🐛

Best, Ueli