Skip to content
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

fix(graphql): Add missing activity types #1684

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

oskogstad
Copy link
Collaborator

Description

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

@oskogstad oskogstad requested a review from a team as a code owner January 14, 2025 12:23
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the ActivityType enum across multiple files. The changes primarily involve updating descriptions of existing enum values from "Refers to" to "Indicates that" and adding several new enum values related to dialog management. These additions include DIALOG_DELETED, DIALOG_RESTORED, SENT_TO_SIGNING, SENT_TO_FORM_FILL, SENT_TO_SEND_IN, and SENT_TO_PAYMENT. A corresponding unit test was also added to ensure consistency between domain and GraphQL enum types.

Changes

File Change Summary
docs/schema/V1/schema.verified.graphql - Updated descriptions for DIALOG_CREATED, DIALOG_CLOSED, TRANSMISSION_OPENED, and DIALOG_OPENED from "Refers to" to "Indicates that"
- Added new enum values: DIALOG_DELETED, DIALOG_RESTORED, SENT_TO_SIGNING, SENT_TO_FORM_FILL, SENT_TO_SEND_IN, and SENT_TO_PAYMENT
src/Digdir.Domain.Dialogporten.GraphQL/EndUser/Common/ObjectTypes.cs - Updated descriptions for DialogCreated, DialogClosed, TransmissionOpened, and DialogOpened
- Added new enum members: DialogDeleted, DialogRestored, SentToSigning, SentToFormFill, SentToSendIn, and SentToPayment
tests/Digdir.Domain.Dialogporten.GraphQl.Unit.Tests/ObjectTypes/ActivityTests.cs - Added new test class ActivityTests
- Implemented Activity_Types_In_GraphQl_Must_Match_Domain_Types() method to validate enum consistency

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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. (Beta)
  • @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.

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.

@oskogstad oskogstad merged commit a0697ae into main Jan 14, 2025
21 of 22 checks passed
@oskogstad oskogstad deleted the fix/add-missing-activity-types-gql branch January 14, 2025 12:24
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/Digdir.Domain.Dialogporten.GraphQl.Unit.Tests/ObjectTypes/ActivityTests.cs (1)

8-22: Consider strengthening the enum comparison test.

While the test verifies basic enum consistency, it could be more robust:

  1. The current implementation relies on enum order matching
  2. It doesn't verify enum values or descriptions

Consider this more thorough implementation:

 [Fact]
 public void Activity_Types_In_GraphQl_Must_Match_Domain_Types()
 {
     // Arrange
     var domainTypes = Enum.GetValues(typeof(DialogActivityType.Values)).Cast<DialogActivityType.Values>().ToList();
     var graphQlTypes = Enum.GetValues(typeof(ActivityType)).Cast<ActivityType>().ToList();

     // Assert
     Assert.Equal(domainTypes.Count, graphQlTypes.Count);
-    for (var i = 0; i < domainTypes.Count; i++)
-    {
-        Assert.Equal(domainTypes[i].ToString(), graphQlTypes[i].ToString());
-    }
+    foreach (var domainType in domainTypes)
+    {
+        var graphQlType = graphQlTypes.FirstOrDefault(x => 
+            x.ToString().Equals(domainType.ToString(), StringComparison.OrdinalIgnoreCase) && 
+            (int)x == (int)domainType);
+        Assert.NotNull(graphQlType);
+    }
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9f6e77 and 0bada07.

📒 Files selected for processing (3)
  • docs/schema/V1/schema.verified.graphql (1 hunks)
  • src/Digdir.Domain.Dialogporten.GraphQL/EndUser/Common/ObjectTypes.cs (2 hunks)
  • tests/Digdir.Domain.Dialogporten.GraphQl.Unit.Tests/ObjectTypes/ActivityTests.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Dry run deploy apps / Deploy service to test
  • GitHub Check: build / build-and-test
🔇 Additional comments (2)
src/Digdir.Domain.Dialogporten.GraphQL/EndUser/Common/ObjectTypes.cs (1)

76-92: LGTM! New activity types follow consistent naming and description patterns.

The new enum values are well-documented and follow the established pattern:

  • Consistent "Indicates that" prefix in descriptions
  • Clear and descriptive names
  • Sequential enum values
docs/schema/V1/schema.verified.graphql (1)

321-332: Verify GraphQL enum value naming convention.

The new enum values follow GraphQL naming conventions with SCREAMING_SNAKE_CASE. However, let's verify the usage patterns across the codebase.

✅ Verification successful

GraphQL enum values follow correct naming convention

All enum values in the schema, including the new ones (DIALOG_DELETED, DIALOG_RESTORED, etc.), correctly follow the GraphQL convention of using SCREAMING_SNAKE_CASE.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any GraphQL enum values not following SCREAMING_SNAKE_CASE
rg -g '*.graphql' '[a-z][A-Z]' docs/schema

Length of output: 11535

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.

2 participants