Disallow creating objects with custom id

[AveryanAlex]

@strawchemy.create_input(Role, include="all", exclude=["id"])
class RoleCreateInput: ...

Doesn't work - I still can set id in creation data. Setting READ_ONLY breaks relations.
Using include=["name", "parent", "childrens", "chats"] instead of all gives errors:

❌ Input Object type RoleChatInput must define one or more fields.

❌ Enum type RoleChatsConflictFields must define one or more values.

❌ Enum type RoleParentConflictFields must define one or more values.

❌ Enum type RoleChildrensConflictFields must define one or more values.

What can I do?

[gazorby]

Hi @AveryanAlex!
Would you mind sharing relevant part of the db schema associated with the query? It's difficult to see what's going on without it.

[AveryanAlex]

Oh, ahaha, I spent ~15 mins to write answer and forgot to post

[AveryanAlex]

Simple example:

class Base(DeclarativeBase):
    __abstract__ = True

    id: Mapped[uuid.UUID] = mapped_column(
        SqlUUID, primary_key=True, default=uuid.uuid4, info=READ_ONLY
    )

    created_at: Mapped[datetime.datetime] = mapped_column(
        DateTime(timezone=True),
        server_default=func.now(),
        nullable=False,
        info=READ_ONLY,
    )

    updated_at: Mapped[datetime.datetime] = mapped_column(
        DateTime(timezone=True),
        server_default=func.now(),
        onupdate=func.now(),
        nullable=False,
        info=READ_ONLY,
    )

class Chat(Base):
    __tablename__ = "chats"

    name: Mapped[str] = mapped_column(String(255), nullable=False)

@strawchemy.create_input(Chat, include="all")
class ChatCreateInput: ...

I set id as READ_ONLY, I tried exclude=["id"], but only 1 thing works: setting include=["name"].

But, with my more complex schema:

class Base(DeclarativeBase):
    __abstract__ = True

    id: Mapped[uuid.UUID] = mapped_column(
        SqlUUID,
        primary_key=True,
        default=uuid.uuid4,  # info=READ_ONLY
    )

    created_at: Mapped[datetime.datetime] = mapped_column(
        DateTime(timezone=True),
        server_default=func.now(),
        nullable=False,
        info=READ_ONLY,
    )

    updated_at: Mapped[datetime.datetime] = mapped_column(
        DateTime(timezone=True),
        server_default=func.now(),
        onupdate=func.now(),
        nullable=False,
        info=READ_ONLY,
    )

class Role(Base):
    __tablename__ = "roles"

    name: Mapped[str] = mapped_column(String(255), nullable=False)

    chats: Mapped[list["Chat"]] = relationship("Chat", back_populates="role")

    parent_id: Mapped[uuid.UUID | None] = mapped_column(
        ForeignKey("roles.id", ondelete="SET NULL"), nullable=True
    )

    parent: Mapped["Role | None"] = relationship(
        "Role",
        remote_side="Role.id",
        back_populates="childrens",
    )

    childrens: Mapped[list["Role"]] = relationship(
        "Role",
        back_populates="parent",
    )

class Chat(Base):
    __tablename__ = "chats"

    name: Mapped[str] = mapped_column(String(255), nullable=False)

    role_id: Mapped[uuid.UUID] = mapped_column(ForeignKey("roles.id"), nullable=False)

    role: Mapped["Role"] = relationship("Role", back_populates="chats")

@strawchemy.create_input(Chat, include="all")
class ChatCreateInput: ...

@strawchemy.create_input(Role, include="all")
class RoleCreateInput: ...

If I set READ_ONLY on id, I get strawchemy.dto.exceptions.EmptyDTOError: Cannot generate RoleChatsIdFieldsInput input type from Chat model because primary key columns are disabled for write purpose.
If I set something like include=["name", "role"] in ChatCreateInput, relations mutation also breaks:

site-packages/strawberry/schema/schema.py", line 359, in __init__
    raise ValueError(f"Invalid Schema. Errors:\n\n{formatted_errors}")
ValueError: Invalid Schema. Errors:

❌ Input Object type ChatRoleInput must define one or more fields.

❌ Enum type ChatRoleConflictFields must define one or more values.

So, how can I disallow users to specify custom ID in create requests (also in nested relation creation, like creating chat with role)?

[gazorby]

Nevermind, i can reproduce it, will release a quick fix for this. Thanks for reporting!

[gazorby]

main should fix the issue, can test confirm it works for you?

[AveryanAlex]

Yes, using exclude=["id"] without include="all" now works. But with nested relations (i.e. creating chat with role) I still can set id for relation: autogenerated ChatRoleInput has id field. How can I fix it? Or somehow use my RoleCreateInput instead of autogen ChatRoleInput?
By the way, I think it will be more convenient to just set id as read-only field.

[gazorby]

@strawchemy.create_input(Role, include="all", override=True) # < override=True
class RoleCreateInput: ...

Should fix it. override force strawchemy to pick user defined type instead of generating new ones, but it's disabled by default (not sure if it's a sane one btw).

As for include/exclude rules, they only apply for top level fields, not nested ones. If you want nested types to define a specific set of fields, you can either define them with strawchemy using override=True, or set the info param on models attributes as needed. Keep in mind that the info way is not officially documented as of now.

[AveryanAlex]

Hm, this doesn't work. Creating

@strawchemy.create_input(Role, exclude=["id"], override=True)
class ChatRoleInput: ...

works, but requires manual creation and overriding of a lot of types.
Then I added

@strawchemy.create_input(Chat, exclude=["id"], override=True)
class RoleChatInput: ...

and got an error:

strawberry.exceptions.duplicated_type_name.DuplicatedTypeName: Type RoleChatInput is defined multiple times in the schema

Also it will be good to have recursive mutations with custom types, i.e. RoleCreateInput with nested parent created by my own RoleCreateInput and so on.

By the way, thanks for your work! I am surprised that nobody (afaik) before you created lib to auto-integrate orm and graphql (with mutations).

[gazorby]

Oh, I see. I'm working on that feature actually, so you will be able to scope any type/input either on schema level (the type is used everywhere) or on the type level (only used on the current scoped type and subtypes)

[gazorby]

This feature is now live with the 0.19.0 release!