Allow FPMs to add engagements while the project is discussing changes to plan

[CarsonF]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces several changes related to engagement access policies and data handling. A new database migration updates the access policy for the Engagement type by adding conditions based on role membership and by accepting either a project status of 'InDevelopment' or a project step of 'DiscussingChangeToPlan'. In parallel, the authorization policy for engagement creation is modified to allow both conditions. Additionally, the Engagement DTO and repository functions are updated to include and hydrate a new project property, step, ensuring that this attribute is part of the returned engagement data.

Changes

File(s)	Change Summary
dbschema/migrations/00017-m1d2nmz.edgeql src/components/.../engagements-create-delete.policy.ts	Access Policy Update: A new migration and policy logic update were implemented to modify the CanInsertGeneratedFromAppPoliciesForEngagement policy. Conditions now check for specified role membership and require the project status to be 'InDevelopment' or the project step to be 'DiscussingChangeToPlan'.
src/components/.../engagement.dto.ts src/components/.../engagement.gel.repository.ts src/components/.../engagement.repository.ts	Engagement DTO & Hydration Update: The Engagement DTO's project property type is updated to include the step field (sourced from UnsecuredDto<IProject>). Repository methods are modified to hydrate and return the step property as part of the Engagement query results.

---

📜 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 05f35e0 and ab8a31b.

📒 Files selected for processing (5)

• dbschema/migrations/00017-m1d2nmz.edgeql (1 hunks)
• src/components/authorization/policies/by-feature/engagements-create-delete.policy.ts (1 hunks)
• src/components/engagement/dto/engagement.dto.ts (1 hunks)
• src/components/engagement/engagement.gel.repository.ts (1 hunks)
• src/components/engagement/engagement.repository.ts (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (3)

src/components/authorization/policies/by-feature/engagements-create-delete.policy.ts (2)

src/components/authorization/policies/conditions/member.condition.ts (1)

• member (132-132)

src/components/authorization/policies/conditions/enum-field.condition.ts (1)

• field (91-110)

src/components/engagement/engagement.repository.ts (1)

src/core/database/query/matching.ts (1)

• ACTIVE (27-27)

src/components/engagement/dto/engagement.dto.ts (2)

src/core/resources/resource.loader.ts (1)

• LinkTo (34-39)

src/common/secured-property.ts (1)

• UnsecuredDto (57-59)

⏰ 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: Generate (head)
• GitHub Check: E2E Tests (neo4j 1/6)
• GitHub Check: Generate (base)
• GitHub Check: lint
• GitHub Check: Clean
• GitHub Check: Unit

🔇 Additional comments (6)

src/components/engagement/engagement.gel.repository.ts (1)

25-25: Adding project step to hydration looks good

This change correctly adds the step property to the project object in the baseHydrate function, ensuring it's included in the hydrated Engagement data. This is necessary to support the new authorization rules.

dbschema/migrations/00017-m1d2nmz.edgeql (1)

4-6: Clear and correctly implemented migration

This migration alters the access policy for Engagement creation to allow either:

1. Project status is 'InDevelopment' OR
2. Project step is 'DiscussingChangeToPlan'

This correctly implements the PR objective of allowing FPMs to add engagements during the "discussing changes to plan" phase.

src/components/authorization/policies/by-feature/engagements-create-delete.policy.ts (1)

6-12: Well-structured policy change

The policy for Engagement creation has been expanded to permit creation when:

1. The user is a member AND
2. Either the project status is 'InDevelopment' OR the project step is 'DiscussingChangeToPlan'

This implementation correctly uses the any utility to create an OR condition between the two field conditions, aligning with the database migration changes.

src/components/engagement/dto/engagement.dto.ts (1)

78-79: Type definition update matches hydration changes

The type of the project property has been correctly updated to include the step property from UnsecuredDto<IProject>, ensuring type safety and consistency with the hydration changes in the repository file.

src/components/engagement/engagement.repository.ts (2)

169-176: Well-structured query modification to include project step.

The match statement has been refactored to use a cleaner nested array structure, and a new match for project step has been added. This provides the necessary data to support the PR objective of allowing engagement creation during the "DiscussingChangeToPlan" step.

---

191-191: Good addition of the project step to the returned DTO.

Adding the step property to the project object ensures that the engagement's project step is available for authorization policies. This is consistent with the PR objective and works in conjunction with the updated access policy mentioned in the PR summary.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.