Skip to content

feat: v2 api hidden event types #22715

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

RadheyMugdal
Copy link

What does this PR do?

This PR adds support for creating and updating hidden event types via API v2.

Summary of Changes

  • Adds hidden?: boolean field to:
    • BaseCreateEventTypeInput
    • BaseUpdateEventTypeInput
  • Returns the hidden field in:
    • BaseEventTypeOutput_2024_06_14
    • getResponseEventType() service
  • Adds E2E tests for:
    • Creating a hidden event type
    • Updating the hidden property of an event type

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

  • E2E tests have been added to cover the functionality:

  • Location:
    apps/api/v2/src/ee/event-types/event-types_2024_06_14/controllers/event-types.controller.e2e-spec.ts

  • What’s covered:

    • Creating an event type with hidden: true and verifying it in the response.
    • Updating an existing event type to hidden: false and verifying the updated value.

@RadheyMugdal RadheyMugdal requested review from a team as code owners July 24, 2025 13:00
Copy link

vercel bot commented Jul 24, 2025

@RadheyMugdal is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Jul 24, 2025

Walkthrough

The changes introduce support for a new optional boolean property, hidden, for event types in API version 2024_06_14. This property is added to the input DTO classes for creating and updating event types, as well as to the output DTO class. The service responsible for formatting event type responses is updated to include the hidden property in its output. Additionally, the type alias for event types in the organizations module is extended to include hidden. New end-to-end tests are added to verify that event types can be created and updated with the hidden property, and that the API responses correctly reflect its value.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Complexity: Simple. The changes are localized to DTOs, a service method, a type alias, and new test cases. No complex logic or refactoring is involved.
  • Estimated review time: ~8 minutes, primarily to verify correct property wiring, decorator usage, and test coverage.

Assessment against linked issues

Objective Addressed Explanation
Add optional hidden property to BaseCreateEventTypeInput and BaseUpdateEventTypeInput classes (issue #22377)
Include hidden property in the output DTO class BaseEventTypeOutput_2024_06_14 (issue #22377)
Modify getResponseEventType method in output-event-types.service.ts to return the hidden property (issue #22377)
Add end-to-end tests for creating and updating event types with the hidden property in event-types.controller.e2e-spec.ts (issue #22377)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were identified. All code changes directly relate to the objectives specified in the linked issue #22377.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • CAL-22377: Entity not found: Issue - Could not find referenced Issue.

📜 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 c360cc8 and 2dc513a.

📒 Files selected for processing (2)
  • apps/api/v2/src/ee/event-types/event-types_2024_06_14/controllers/event-types.controller.e2e-spec.ts (1 hunks)
  • packages/platform/types/event-types/event-types_2024_06_14/inputs/create-event-type.input.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/platform/types/event-types/event-types_2024_06_14/inputs/create-event-type.input.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/api/v2/src/ee/event-types/event-types_2024_06_14/controllers/event-types.controller.e2e-spec.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Install dependencies / Yarn install & cache
  • GitHub Check: Codacy Static Code Analysis
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 generate unit tests to generate unit tests for 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.

@graphite-app graphite-app bot added the community Created by Linear-GitHub Sync label Jul 24, 2025
@github-actions github-actions bot added the api area: API, enterprise API, access token, OAuth label Jul 24, 2025
@graphite-app graphite-app bot requested a review from a team July 24, 2025 13:00
@github-actions github-actions bot added event-types area: event types, event-types High priority Created by Linear-GitHub Sync platform Anything related to our platform plan Private Created by Linear-GitHub Sync ✨ feature New feature or request labels Jul 24, 2025
Copy link

graphite-app bot commented Jul 24, 2025

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (07/24/25)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add community label" took an action on this PR • (07/24/25)

1 label was added to this PR based on Keith Williams's automation.

"Add ready-for-e2e label" took an action on this PR • (08/08/25)

1 label was added to this PR based on Keith Williams's automation.

@kart1ka
Copy link
Contributor

kart1ka commented Jul 25, 2025

@RadheyMugdal can you pls attach a loom video showing your fix?

Copy link
Contributor

@kart1ka kart1ka left a comment

Choose a reason for hiding this comment

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

I am still getting the following type error. This issue is still not fixed. Can you pls look into it?

src/modules/organizations/event-types/services/output.service.ts:92:7 - error TS2345: Argument of type 'Input' is not assignable to parameter of type 'Input'.
  Property 'hidden' is missing in type 'Input' but required in type 'Input'.

92       databaseEventType,
         ~~~~~~~~~~~~~~~~~

  ../../../node_modules/.prisma/client/index.d.ts:14553:7
    14553       hidden: boolean
                ~~~~~~
    'hidden' is declared here.

[8:37:38 am] Found 1 error. Watching for file changes.

@kart1ka kart1ka marked this pull request as draft July 25, 2025 03:10
@RadheyMugdal
Copy link
Author

RadheyMugdal commented Jul 25, 2025

I am still getting the following type error. This issue is still not fixed. Can you pls look into it?

src/modules/organizations/event-types/services/output.service.ts:92:7 - error TS2345: Argument of type 'Input' is not assignable to parameter of type 'Input'.
  Property 'hidden' is missing in type 'Input' but required in type 'Input'.

92       databaseEventType,
         ~~~~~~~~~~~~~~~~~

  ../../../node_modules/.prisma/client/index.d.ts:14553:7
    14553       hidden: boolean
                ~~~~~~
    'hidden' is declared here.

[8:37:38 am] Found 1 error. Watching for file changes.

Fixed this error in latest commit. Let me know if anything else is needed.

@RadheyMugdal RadheyMugdal marked this pull request as ready for review July 27, 2025 08:30
Copy link
Contributor

@volnei volnei left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

github-actions bot commented Aug 8, 2025

E2E results are ready!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api area: API, enterprise API, access token, OAuth community Created by Linear-GitHub Sync event-types area: event types, event-types ✨ feature New feature or request High priority Created by Linear-GitHub Sync platform Anything related to our platform plan Private Created by Linear-GitHub Sync ready-for-e2e
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: v2 api hidden event types
3 participants