Skip to content

Handle Def types in object constraint duck typing#994

Open
MillhioreBT wants to merge 2 commits intoEmmyLuaLs:mainfrom
MillhioreBT:fix/generic-object-constraint-def-type
Open

Handle Def types in object constraint duck typing#994
MillhioreBT wants to merge 2 commits intoEmmyLuaLs:mainfrom
MillhioreBT:fix/generic-object-constraint-def-type

Conversation

@MillhioreBT
Copy link
Contributor

What was happening?

check_object_type_compact only matched LuaType::Ref when checking if a class
satisfies a structural object constraint (e.g. { x: number, y: number, z: number }).

So when the type was inferred as LuaType::Def (like from return self without an
explicit @return), it fell through to the wildcard arm and incorrectly reported a
generic constraint mismatch — oops!

What does this fix do?

Adds LuaType::Def alongside LuaType::Ref in the match arm, so both representations
are checked structurally against the object constraint.

`check_object_type_compact` only matched `LuaType::Ref` when checking
if a class satisfies a structural object constraint (e.g. `{ x: number,
y: number, z: number }`). When the type was inferred as `LuaType::Def`
(e.g. from `return self` without an explicit `@return`), it fell through
to the wildcard arm and incorrectly reported a generic-constraint-mismatch.

Add `LuaType::Def` alongside `LuaType::Ref` in the match arm so both
representations are checked structurally against the object constraint.
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a bug in the type checking logic where LuaType::Def instances, particularly those inferred from 'return self' in class methods, were not correctly evaluated against structural object constraints. Previously, these types would incorrectly trigger a GenericConstraintMismatch diagnostic. The fix extends the structural duck typing mechanism to properly recognize and validate LuaType::Def types, ensuring accurate type inference and constraint satisfaction.

Highlights

  • Type Handling: LuaType::Def is now correctly handled in structural object constraint checks, resolving an issue where it previously caused incorrect GenericConstraintMismatch diagnostics.
  • Code Logic: The check_object_type_compact function was updated to include LuaType::Def in the match arm that performs structural type checking, aligning its behavior with LuaType::Ref.
  • Testing: A new test case (test_object_constraint_with_class_ref) was added to validate that LuaType::Def types correctly satisfy object constraints, preventing the previously reported GenericConstraintMismatch.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request extends the object type checking logic to include LuaType::Def alongside LuaType::Ref, enabling @class definitions to satisfy object constraints through structural duck typing. A new test case was added to validate this behavior. The reviewer suggested renaming the new test for improved clarity, as its current name might be misleading regarding the type it primarily validates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant