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: remove error div from studio search #14414

Merged
merged 6 commits into from
Jan 15, 2025

Conversation

standeren
Copy link
Contributor

@standeren standeren commented Jan 14, 2025

Description

When adding StudioSearch component, it did not fit in with the content library.

Prod:
Skjermbilde 2025-01-14 kl  09 44 24

This PR:
Skjermbilde 2025-01-14 kl  09 44 58

Add css in StudioSearch to visually remove a div that will be in the DOM, and occupy some height, also when the component has no error.
OBS: this will also hide the error if the component would ever return an error that we want to display. None of our usages of the StudioSearch are performing any error-handling per today, but maybe an issue in the future if we need the handle an error before we update to the next version of DS where this issue is fixed.

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)

Summary by CodeRabbit

  • Style

    • Updated styling for StudioSearch component by adding a new CSS rule for empty div elements.
    • Removed .searchField class from CodeListsActionsBar.
    • Modified vertical alignment of elements in text editor's top row and filter/search section.
  • Refactor

    • Simplified StudioSearch component by removing custom className prop.

@standeren standeren added skip-releasenotes Issues that do not make sense to list in our release notes frontend team/studio-domain1 skip-documentation Issues where updating documentation is not relevant labels Jan 14, 2025
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-storybook".

(The package "eslint-plugin-storybook" was not found when loaded as a Node module from the directory "/frontend/libs/studio-components".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-storybook@latest --save-dev

The plugin "eslint-plugin-storybook" was referenced from the config file in "frontend/libs/studio-components/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

📝 Walkthrough

Walkthrough

The pull request introduces changes to several frontend components and their associated CSS modules. The modifications primarily involve styling adjustments for the StudioSearch component, the removal of a search field class in the CodeListsActionsBar, and alignment changes in the text editor's CSS. These changes focus on refining the visual presentation and layout of various UI components within the studio and content library sections.

Changes

File Change Summary
frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.module.css Added CSS rule .studioSearch div:empty { display: contents; }
frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.tsx Added CSS module import and applied className prop to Search component
frontend/libs/studio-content-library/src/ContentLibrary/LibraryBody/pages/CodeListPage/CodeListsActionsBar/CodeListsActionsBar.module.css Removed .searchField class
frontend/libs/studio-content-library/src/ContentLibrary/LibraryBody/pages/CodeListPage/CodeListsActionsBar/CodeListsActionsBar.tsx Removed className prop from StudioSearch component
frontend/packages/text-editor/src/TextEditor.module.css Changed align-items from center to flex-end for .textEditorTopRow and .filterAndSearch classes

Possibly related PRs

Suggested labels

area/content-library

Suggested reviewers

  • TomasEng
  • ErlingHauan

📜 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 dbee8e1 and 0622b95.

📒 Files selected for processing (1)
  • frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.tsx

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 area/text-editor Area: Related to creating, translating and editing texts. solution/studio/designer Issues related to the Altinn Studio Designer solution. quality/testing Tests that are missing, needs to be created or could be improved. backend labels Jan 14, 2025
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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a514966 and 25fe64f.

📒 Files selected for processing (8)
  • backend/src/Designer/Controllers/AppDevelopmentController.cs (1 hunks)
  • backend/src/Designer/Infrastructure/GitRepository/AltinnAppGitRepository.cs (1 hunks)
  • backend/tests/Designer.Tests/Controllers/OptionsController/GetOptionListsReferencesTests.cs (3 hunks)
  • frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.module.css (1 hunks)
  • frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.tsx (2 hunks)
  • frontend/libs/studio-content-library/src/ContentLibrary/LibraryBody/pages/CodeListPage/CodeListsActionsBar/CodeListsActionsBar.module.css (0 hunks)
  • frontend/libs/studio-content-library/src/ContentLibrary/LibraryBody/pages/CodeListPage/CodeListsActionsBar/CodeListsActionsBar.tsx (1 hunks)
  • frontend/packages/text-editor/src/TextEditor.module.css (1 hunks)
💤 Files with no reviewable changes (1)
  • frontend/libs/studio-content-library/src/ContentLibrary/LibraryBody/pages/CodeListPage/CodeListsActionsBar/CodeListsActionsBar.module.css
✅ Files skipped from review due to trivial changes (2)
  • frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.module.css
  • frontend/libs/studio-content-library/src/ContentLibrary/LibraryBody/pages/CodeListPage/CodeListsActionsBar/CodeListsActionsBar.tsx
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Run dotnet build and test (macos-latest)
  • GitHub Check: Build environment and run e2e test
  • GitHub Check: Run dotnet build and test (windows-latest)
  • GitHub Check: Analyze
  • GitHub Check: Run dotnet build and test (ubuntu-latest)
  • GitHub Check: Run integration tests against actual gitea and db
  • GitHub Check: Testing
🔇 Additional comments (5)
backend/tests/Designer.Tests/Controllers/OptionsController/GetOptionListsReferencesTests.cs (1)

92-111: LGTM! Well-structured test for edge case.

The test properly verifies the API's behavior when no options are present in the application. It covers the setup, execution, and assertion phases clearly.

backend/src/Designer/Controllers/AppDevelopmentController.cs (1)

550-557: LGTM! Improved error handling with proper HTTP status codes.

The changes align with RESTful practices by:

  1. Removing unnecessary exception handling.
  2. Using 204 No Content when no options are found.
backend/src/Designer/Infrastructure/GitRepository/AltinnAppGitRepository.cs (1)

801-801: LGTM! Verify C# version compatibility.

The change improves error handling by returning an empty array instead of throwing an exception. The use of collection expression syntax [] is clean but requires C# 12.

Run the following script to verify the C# version used in the project:

✅ Verification successful

Collection expression syntax is compatible with project configuration

The codebase targets .NET 9.0 which includes C# 12 by default, making the collection expression syntax [] fully supported.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check C# language version in project files
# Test: Search for LangVersion in csproj files. Expect: preview or 12.0 or higher

rg -l 'LangVersion' --glob '*.csproj'

Length of output: 82


Script:

#!/bin/bash
# Find the project file containing AltinnAppGitRepository.cs
fd AltinnAppGitRepository.cs --exec dirname {} | xargs -I {} find {} -maxdepth 1 -name "*.csproj"

# Check content of all relevant project files and global props
echo "=== Project files content ==="
fd . -e csproj -e props --exec cat {}

Length of output: 33978

frontend/libs/studio-components/src/components/StudioSearch/StudioSearch.tsx (1)

4-4: Verify the CSS implementation for error div removal.

The CSS module import has been added, but the actual CSS implementation that removes the error div is not visible in the provided files. Please ensure that the CSS changes don't affect other critical styling aspects of the component.

✅ Verification successful

CSS implementation for error div removal is correct

The CSS module correctly hides error elements using a scoped selector, which is a clean and safe implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for the StudioSearch.module.css file and its contents
fd "StudioSearch.module.css" | xargs cat

Length of output: 96

frontend/packages/text-editor/src/TextEditor.module.css (1)

21-21: Verify the necessity of alignment changes.

The alignment changes from center to flex-end in .textEditorTopRow and .filterAndSearch classes appear unrelated to the PR's objective of removing the error div from StudioSearch. Please clarify if these changes should be in a separate PR focused on layout improvements.

Also applies to: 28-28

✅ Verification successful

Alignment changes are consistent with codebase patterns

The changes from center to flex-end align with the established UI patterns across the codebase, where similar interactive components and action bars consistently use flex-end alignment. These changes appear to be valid improvements for UI consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any related alignment changes or discussions
rg "align-items.*flex-end" --type css

Length of output: 1081

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.66%. Comparing base (15bd10a) to head (a178228).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14414   +/-   ##
=======================================
  Coverage   95.66%   95.66%           
=======================================
  Files        1880     1880           
  Lines       24447    24448    +1     
  Branches     2810     2810           
=======================================
+ Hits        23387    23388    +1     
  Misses        800      800           
  Partials      260      260           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@standeren standeren assigned TomasEng and unassigned standeren Jan 14, 2025
@TomasEng TomasEng assigned standeren and unassigned TomasEng Jan 14, 2025
@standeren standeren assigned TomasEng and unassigned standeren Jan 14, 2025
@ErlingHauan ErlingHauan self-assigned this Jan 15, 2025
Copy link
Contributor

@ErlingHauan ErlingHauan left a comment

Choose a reason for hiding this comment

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

Testet OK 😊

@ErlingHauan ErlingHauan merged commit 60ea6c6 into main Jan 15, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/text-editor Area: Related to creating, translating and editing texts. backend frontend quality/testing Tests that are missing, needs to be created or could be improved. skip-documentation Issues where updating documentation is not relevant skip-releasenotes Issues that do not make sense to list in our release notes solution/studio/designer Issues related to the Altinn Studio Designer solution. team/studio-domain1
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants