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

Improve color palette for tree colors #8228

Merged
merged 10 commits into from
Dec 2, 2024
Merged

Conversation

philippotto
Copy link
Member

@philippotto philippotto commented Nov 22, 2024

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Steps to test:

  • create new trees and check that the colors look alright

Issues:


(Please delete unneeded items, merge only when none are left open)

@philippotto philippotto self-assigned this Nov 22, 2024
Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces several updates to the WEBKNOSSOS application, including a new feature for pasting remote URIs from Neuroglancer, asynchronous reading of image files, improved error messages for job management, and the removal of bounding box restrictions for super users. Additionally, it enhances default colors for skeleton trees and fixes multiple bugs related to tree deletion and NML file imports. The integration of Google Analytics has also been removed.

Changes

File Path Change Summary
CHANGELOG.unreleased.md Updated to include new features, performance improvements, bug fixes, and removal of Google Analytics.
frontend/javascripts/libs/color_generator.ts Replaced rawRgbs array content, updated export statement with type assertion for rgbs variable.
frontend/javascripts/oxalis/view/right-border-tabs/segments_tab/segment_list_item.tsx Enhanced SegmentListItem with new margin property, error handling, and additional context menu items.
frontend/javascripts/test/reducers/skeletontracing_reducer.spec.ts Added tests for node and tree management, including creation, deletion, and error handling scenarios.

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • MichaelBuessemeyer
  • dieknolle3333

Poem

In the garden where colors play,
New features bloom, brightening the day.
Bugs are fixed, and trees stand tall,
With joy we code, and together we call!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9c378e1 and 95f002c.

📒 Files selected for processing (1)
  • CHANGELOG.unreleased.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.unreleased.md

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 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.

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

🧹 Outside diff range and nitpick comments (2)
CHANGELOG.unreleased.md (1)

20-20: Enhance the changelog entry to better reflect the changes and their impact

The current entry "Improved the default colors for skeleton trees" could be more descriptive about the specific improvements and their user impact, especially given that this addresses user feedback about color contrast issues.

Consider expanding the entry to something like:

- Improved the default colors for skeleton trees. [#8228](https://github.com/scalableminds/webknossos/pull/8228)
+ Enhanced the color palette for skeleton trees to improve contrast between dark and bright colors, making trees more visually distinguishable. [#8228](https://github.com/scalableminds/webknossos/pull/8228)
frontend/javascripts/libs/color_generator.ts (1)

Line range hint 71-88: Consider optimizing random color generation

The current implementation shuffles colors for each request. Consider caching the shuffled colors to improve performance when repeatedly requesting random colors.

 const ColorGenerator = {
+  _shuffledCache: null as Vector3[] | null,
+
   distinctColorForId(id: number): Vector3 {
     return rgbs[(id - 1 + rgbs.length) % rgbs.length];
   },

   getNRandomColors(n: number): Vector3[] {
-    let shuffledColors: Vector3[] = [];
+    // Reset cache if it doesn't exist
+    if (!this._shuffledCache) {
+      this._shuffledCache = _.shuffle([...rgbs]);
+    }
+
+    let result: Vector3[] = [];
     let remainingColorCount = n;

     while (remainingColorCount > 0) {
       // Take the first k colors
       const batchSize = Math.min(remainingColorCount, rgbs.length);
-      shuffledColors = shuffledColors.concat(rgbs.slice(0, batchSize));
+      result = result.concat(this._shuffledCache.slice(0, batchSize));
       remainingColorCount -= batchSize;
+
+      // Reshuffle cache if we need more colors
+      if (remainingColorCount > 0) {
+        this._shuffledCache = _.shuffle([...rgbs]);
+      }
     }

-    return _.shuffle(shuffledColors);
+    return result;
   },
 };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cb46bf5 and 004a812.

📒 Files selected for processing (2)
  • CHANGELOG.unreleased.md (1 hunks)
  • frontend/javascripts/libs/color_generator.ts (2 hunks)
🔇 Additional comments (1)
frontend/javascripts/libs/color_generator.ts (1)

68-68: LGTM! Type-safe color mapping implementation

The color mapping implementation correctly:

  • Groups RGB values into triplets
  • Normalizes values to 0-1 range
  • Ensures type safety with Vector3 assertion

frontend/javascripts/libs/color_generator.ts Outdated Show resolved Hide resolved
Copy link
Member

@hotzenklotz hotzenklotz 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

@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

🧹 Outside diff range and nitpick comments (3)
frontend/javascripts/test/reducers/skeletontracing_reducer.spec.ts (1)

841-841: Avoid hardcoding default color values in tests

In line 841, the test asserts that the new tree's color is [0, 0, 1]. Hardcoding the default color value may make the test brittle if the default color changes in the future.

Consider retrieving the default color from the relevant configuration or constants to ensure the test remains valid even if the default color changes. For example:

         treeId: 2,
-        color: [0, 0, 1],
+        color: DEFAULT_TREE_COLOR,
       });

Where DEFAULT_TREE_COLOR is imported from the module where the default color is defined.

frontend/javascripts/oxalis/view/right-border-tabs/segments_tab/segment_list_item.tsx (2)

Line range hint 377-385: Simplify the Toast message handling

Wrapping the Toast message in <React.Fragment> is unnecessary since it contains only a single text node.

Consider simplifying the code by removing the <React.Fragment> wrapper:

            if (!segment.somePosition) {
-              Toast.info(
-                <React.Fragment>
-                  Cannot load a mesh for this segment, because its position is unknown.
-                </React.Fragment>,
-              );
+              Toast.info('Cannot load a mesh for this segment, because its position is unknown.');
               hideContextMenu();
               return;
             }

This makes the code cleaner and easier to read.


Line range hint 429-437: Simplify the Toast message handling

Similar to a previous comment, the use of <React.Fragment> here is unnecessary.

Simplify the code by removing the fragment:

      if (!segment.somePosition) {
-        Toast.info(
-          <React.Fragment>
-            Cannot load a mesh for this segment, because its position is unknown.
-          </React.Fragment>,
-        );
+        Toast.info('Cannot load a mesh for this segment, because its position is unknown.');
         hideContextMenu();
         return;
       }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 004a812 and 5c7f7dd.

📒 Files selected for processing (4)
  • CHANGELOG.unreleased.md (1 hunks)
  • frontend/javascripts/libs/color_generator.ts (2 hunks)
  • frontend/javascripts/oxalis/view/right-border-tabs/segments_tab/segment_list_item.tsx (1 hunks)
  • frontend/javascripts/test/reducers/skeletontracing_reducer.spec.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • frontend/javascripts/libs/color_generator.ts
  • CHANGELOG.unreleased.md
🔇 Additional comments (8)
frontend/javascripts/oxalis/view/right-border-tabs/segments_tab/segment_list_item.tsx (8)

65-65: Consistent spacing for icon alignment

The addition of marginLeft: 1 improves the alignment of the colored dot icon. Ensure that this margin aligns well with other elements in different contexts and screen sizes.


Line range hint 333-334: Correctly display context menu based on selection

The logic correctly displays the multi-select menu when multiple segments are selected and the current segment is among them.


Line range hint 388-392: Ensure proper handling of optional parameters in withMappingActivationConfirmation

You're passing mappingName, which may be undefined if currentMeshFile is null. Ensure that withMappingActivationConfirmation can handle an undefined mappingName without causing errors.


Line range hint 407-407: Improved user feedback with descriptive tooltip

Providing a clear tooltip message when there is no mesh file enhances user feedback.


Line range hint 447-450: Enhanced user experience with dynamic menu item

The addition of isActiveSegment and dynamic title provides immediate feedback to the user about the segment's activation state.


Line range hint 471-478: Display metadata icon for segments with assigned properties

Including an icon to indicate when a segment has metadata properties improves user awareness and interaction.


Line range hint 543-544: Efficient determination of centered segment

The addition efficiently checks whether the segment is currently centered in the view.


Line range hint 834-840: Correctly disable 'Delete Segment's Data' option when unsupported

The updated disabled condition ensures that the 'Delete Segment's Data' menu item is only enabled when supported, preventing unintended actions.

@philippotto philippotto enabled auto-merge (squash) December 2, 2024 11:35
@philippotto philippotto merged commit 4dbd203 into master Dec 2, 2024
3 checks passed
@philippotto philippotto deleted the improve-tree-colors branch December 2, 2024 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants