Skip to content

Fix inheritance on ID/ResourceName types #3434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 19, 2025
Merged

Conversation

CarsonF
Copy link
Member

@CarsonF CarsonF commented May 19, 2025

I think this must've changed when we removed the static Props declarations.
Previously comparing static types worked, probably because of the static Props list.

Now comparing instance types appears to work, which seems more correct anyway.

However, this uses duck typing / shape matching, not actual inheritance.
So we had a problem with Pinnable & Actor, both of which only require an id prop.
I "fixed", worked around this by declaring the __typename string literals for Actor/User/SystemAgent.
This is more feasible than enumerating the concrete types of Pinnable & doing the same on them.
It's working now, but not the most stable situation to be in. Will continue pondering other ways to address this.

CarsonF added 3 commits May 19, 2025 11:08
I think this must've changed when we removed the static Props declarations.
Previously comparing static types worked, probably because of the static Prop list.

Now comparing instance types appears to work, which seems more correct anyway.
@CarsonF CarsonF force-pushed the bugfix/id-types-inheritance branch from 8e9c1e8 to dd5eb22 Compare May 19, 2025 16:14
Copy link

coderabbitai bot commented May 19, 2025

📝 Walkthrough

Walkthrough

The changes introduce stricter and more explicit typing for type discriminator properties such as type and __typename across several DTO classes, ensuring these fields are always present and correctly typed. Repository methods were refactored for improved type safety and query construction, and a type alias was reworked to use instance type inference for subclass logic.

Changes

File(s) Change Summary
src/components/project/dto/project.dto.ts The TranslationProject class now explicitly declares its type property as a union of 'MultiplicationTranslation' and 'MomentumTranslation'.
src/components/user/dto/actor.dto.ts The Actor class now declares a readonly __typename property as `'User'
src/components/user/dto/user.dto.ts The User class now explicitly declares a readonly __typename property with the value 'User'.
src/components/user/system-agent.gel.repository.ts The upsertAgent method was refactored from raw EdgeQL string queries to programmatic query construction using the e API, with explicit addition of the __typename field. Imports were updated to support this. No public API changes.
src/components/user/system-agent.neo4j.repository.ts The upsertAgent method now returns a SystemAgent-typed object with a __typename property, using a merge helper for the Cypher query. Imports were adjusted and return typing improved. No public API changes.
src/core/resources/resource-name.types.ts The ResourceNameFromStatic type alias was refactored to use InstanceType inference for determining subclass relationships, with updated conditional logic and handling for generic cases.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e9c1e8 and dd5eb22.

📒 Files selected for processing (5)
  • src/components/project/dto/project.dto.ts (1 hunks)
  • src/components/user/dto/actor.dto.ts (2 hunks)
  • src/components/user/dto/user.dto.ts (1 hunks)
  • src/components/user/system-agent.gel.repository.ts (2 hunks)
  • src/components/user/system-agent.neo4j.repository.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
  • src/components/project/dto/project.dto.ts
  • src/components/user/dto/user.dto.ts
  • src/components/user/dto/actor.dto.ts
  • src/components/user/system-agent.neo4j.repository.ts
  • src/components/user/system-agent.gel.repository.ts
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: E2E Tests (neo4j 6/6)
  • GitHub Check: E2E Tests (neo4j 5/6)
  • GitHub Check: E2E Tests (neo4j 4/6)
  • GitHub Check: E2E Tests (neo4j 3/6)
  • GitHub Check: E2E Tests (neo4j 2/6)
  • GitHub Check: Unit
  • GitHub Check: Generate (head)
  • GitHub Check: E2E Tests (neo4j 1/6)
  • GitHub Check: Generate (base)
  • GitHub Check: Clean
  • GitHub Check: lint
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

e.insert(e.SystemAgent, { name, roles }),
);
const query = e.select(upserted, (agent) => ({
__typename: e.str('SystemAgent' as const),
Copy link
Member Author

Choose a reason for hiding this comment

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

I had to rewrite this query to use the query builder, because EdgeQL doesn't understand string literals, so even though I could write the constant "SystemAgent" it would still be widened to a TS string, by the EdgeQL server.

@CarsonF CarsonF merged commit 155f3b8 into develop May 19, 2025
18 checks passed
@CarsonF CarsonF deleted the bugfix/id-types-inheritance branch May 19, 2025 16:36
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