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: add endpoints accessing datamodel schema to sync endpoints #14427

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

Conversation

Jondyr
Copy link
Member

@Jondyr Jondyr commented Jan 15, 2025

Description

Add endpoints to namesync endpoint list. Also sort the list alphabetically.
Removed code setting attributes on files before reading.

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

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

Summary by CodeRabbit

  • Bug Fixes
    • Updated endpoint name synchronization whitelist for AppDevelopmentController.
    • Refined allowed actions for specific controller endpoints.
    • Added new actions to the whitelist for DatamodelsController and PreviewController.
  • Refactor
    • Simplified the file reading process in the GitRepository class by removing error handling complexity.

Copy link

coderabbitai bot commented Jan 15, 2025

📝 Walkthrough

Walkthrough

The pull request involves modifications to the EndpointNameSyncEvaluator.cs file in the backend, specifically updating the whitelist entries for the AppDevelopmentController. The changes include removing certain actions from the whitelist and adding new actions, while maintaining the overall structure and logic of the class. Additionally, new entries have been added for DatamodelsController and PreviewController. The GitRepository.cs file has been updated to simplify the ReadTextByRelativePathAsync method by removing the try-catch block and fallback logic, streamlining the file reading process.

Changes

File Change Summary
backend/src/Designer/Middleware/.../EndpointNameSyncEvaluator.cs - Removed whitelist actions: AddLayoutSet, DeleteFormLayout, DeleteLayoutSet, UpdateLayoutSetName
- Added whitelist actions: AddLayoutSet, DeleteFormLayout, DeleteLayoutSet, GetModelMetadata, Get (for DatamodelsController), Datamodel (for PreviewController)
- Kept unchanged actions: SaveRuleHandler, SaveLayoutSettings, SaveRuleConfig
backend/src/Designer/Infrastructure/.../GitRepository.cs - Simplified ReadTextByRelativePathAsync method by removing try-catch block and fallback logic. Method signature updated to: protected async Task<string> ReadTextByRelativePathAsync(string relativeFilePath, CancellationToken cancellationToken = default)

📜 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 c70f123 and e571b10.

📒 Files selected for processing (1)
  • backend/src/Designer/Middleware/UserRequestSynchronization/Services/RequestSyncEvaluators/EndpointNameSyncEvaluator.cs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • backend/src/Designer/Middleware/UserRequestSynchronization/Services/RequestSyncEvaluators/EndpointNameSyncEvaluator.cs
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Run dotnet build and test (macos-latest)
  • GitHub Check: Run dotnet build and test (windows-latest)
  • GitHub Check: Analyze

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.

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.

@github-actions github-actions bot added solution/studio/designer Issues related to the Altinn Studio Designer solution. backend labels Jan 15, 2025
@Jondyr Jondyr linked an issue Jan 15, 2025 that may be closed by this pull request
@Jondyr Jondyr changed the title fix: add GetModelMetadata to sync endpoints and sort fix: add endpoints accessing datamodel schema to sync endpoints Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend solution/studio/designer Issues related to the Altinn Studio Designer solution.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error when opening the form editor
1 participant