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(web): sort the order of tags when saving an item #1330

Merged
merged 2 commits into from
Dec 5, 2024
Merged

Conversation

caichi-t
Copy link
Contributor

@caichi-t caichi-t commented Dec 3, 2024

Overview

This PR fixes to sort the order of tags when saving an item and styling of the tag field.

Memo

I'm going to refactor web/src/components/molecules/Schema/FieldModal/hooks.ts in the future.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new styled component, TagWrapper, for improved tag display in selection modes.
    • Enhanced handling of tags in forms, allowing for better processing of tag-related data.
  • Bug Fixes

    • Improved logic for filtering tags based on user selections, ensuring accurate default values.
  • Documentation

    • Updated type definitions to allow for flexible default values in tag properties.
  • Refactor

    • Streamlined metadata field handling and updates, enhancing clarity and correctness in tag management.

@caichi-t caichi-t requested a review from nourbalaha as a code owner December 3, 2024 05:24
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Walkthrough

The changes in this pull request primarily focus on enhancing the TagField component and related functionalities within the form handling system. A new styled component, TagWrapper, is introduced to improve the layout of tags in both single and multiple selection modes. Additionally, the inputValueGet function is updated to process tag fields more effectively, and a new utility function, selectedTagIdsGet, is added to filter tags based on their IDs. These modifications aim to refine the handling of tag-related data across various components.

Changes

File Change Summary
web/src/components/molecules/Content/Form/fields/FieldComponents/TagField.tsx Added TagWrapper styled component; updated StyledMultipleSelect for overflow handling.
web/src/components/molecules/Content/Form/index.tsx Updated inputValueGet to accept a Field parameter; refined logic for handling tag fields and group fields; updated metaFieldsGet accordingly.
web/src/components/molecules/Content/utils.ts Added selectedTagIdsGet function to filter tags based on IDs; new import for Tag type.
web/src/components/molecules/Schema/FieldModal/FieldDefaultInputs/TagField/index.tsx Introduced TagWrapper styled component; updated rendering logic for tags in non-multiple select mode.
web/src/components/molecules/Schema/FieldModal/hooks.ts Updated typePropertyGet to filter tags based on defaultValue; adjusted handleSubmit to reflect new tag handling logic.
web/src/components/molecules/Schema/types.ts Updated defaultValue type in FieldTypePropertyInput to accept `string
web/src/components/organisms/Project/Content/ContentList/hooks.ts Added import for selectedTagIdsGet; updated handleMetaItemUpdate to use metaFieldsMap and refine tag value handling.

Possibly related PRs

Suggested labels

web

Suggested reviewers

  • nourbalaha

🐰 In the fields where tags do play,
A wrapper's grace keeps chaos at bay.
With styles that flow and logic refined,
Our forms now dance, beautifully aligned.
So hop along, let the tags take flight,
In this code garden, everything's just right! 🌼


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.

@github-actions github-actions bot added the web label Dec 3, 2024
Copy link

netlify bot commented Dec 3, 2024

Deploy Preview for reearth-cms ready!

Name Link
🔨 Latest commit 32c13e2
🔍 Latest deploy log https://app.netlify.com/sites/reearth-cms/deploys/674e9613a5b8510008f1f253
😎 Deploy Preview https://deploy-preview-1330--reearth-cms.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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 (5)
web/src/components/organisms/Project/Content/ContentList/hooks.ts (1)

205-208: Consider destructuring metaFieldsMap entries for clarity

In the mapping over metaFieldsMap, you're using field[1] to access the field object, which can be unclear. Destructure the entries for better readability.

Apply this diff to improve clarity:

-const fields = [...metaFieldsMap].map(field => ({
-  value: field[1].id === key ? value : "",
-  type: field[1].type as SchemaFieldType,
+const fields = [...metaFieldsMap].map(([fieldId, fieldObj]) => ({
+  value: fieldId === key ? value : "",
+  type: fieldObj.type as SchemaFieldType,
web/src/components/molecules/Schema/FieldModal/FieldDefaultInputs/TagField/index.tsx (1)

69-72: Reusability of TagWrapper component

Since TagWrapper is used in multiple files, consider extracting it into a shared component to promote reusability.

web/src/components/molecules/Content/Form/fields/FieldComponents/TagField.tsx (1)

84-88: Extract TagWrapper to a shared component

Similar to the previous file, consider making TagWrapper a shared component to maintain consistency and reduce code duplication.

web/src/components/molecules/Content/Form/index.tsx (1)

Line range hint 403-416: Consider extracting group field handling logic.

The group field handling logic in the submit handler is becoming complex. Consider extracting it into a separate function for better maintainability.

+const handleGroupField = (
+  value: unknown,
+  key: string,
+  groupFields: Map<string, Field>,
+): ItemField[] => {
+  const fields: ItemField[] = [];
+  if (typeof value === "object" && value !== null) {
+    for (const [groupFieldKey, groupFieldValue] of Object.entries(value)) {
+      const groupField = groupFields.get(key);
+      if (groupField) {
+        fields.push({
+          value: inputValueGet(groupFieldValue, groupField),
+          schemaFieldId: key,
+          itemGroupId: groupFieldKey,
+          type: groupField.type,
+        });
+      }
+    }
+  }
+  return fields;
+};
web/src/components/molecules/Schema/FieldModal/hooks.ts (1)

200-213: Optimize tag filtering performance

The current implementation uses separate filter and map operations, which creates unnecessary iterations over the tags array.

Consider combining the operations into a single reduce:

      case "Tag": {
        const defaultValue =
          Array.isArray(values.defaultValue) && values.defaultValue.length
-            ? values.tags
-                ?.filter(tag => values.defaultValue.includes(tag.name))
-                .map(({ name }) => name)
+            ? values.tags?.reduce((acc, { name }) => {
+                if (values.defaultValue.includes(name)) {
+                  acc.push(name);
+                }
+                return acc;
+              }, [] as string[])
            : (values.tags?.some(tag => tag.name === values.defaultValue)
               ? values.defaultValue
               : undefined);
        return {
          tag: {
            defaultValue,
            tags: values.tags ?? [],
          },
        };
      }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eeca1e8 and 32c13e2.

📒 Files selected for processing (7)
  • web/src/components/molecules/Content/Form/fields/FieldComponents/TagField.tsx (3 hunks)
  • web/src/components/molecules/Content/Form/index.tsx (5 hunks)
  • web/src/components/molecules/Content/utils.ts (2 hunks)
  • web/src/components/molecules/Schema/FieldModal/FieldDefaultInputs/TagField/index.tsx (3 hunks)
  • web/src/components/molecules/Schema/FieldModal/hooks.ts (1 hunks)
  • web/src/components/molecules/Schema/types.ts (1 hunks)
  • web/src/components/organisms/Project/Content/ContentList/hooks.ts (5 hunks)
🔇 Additional comments (7)
web/src/components/organisms/Project/Content/ContentList/hooks.ts (2)

254-256: Potential mismatch in value assignment

In the fields array, you're checking field[1].id === key but assigning value to value: field[1].id === key ? value : "". If multiple fields share the same key, this may cause issues.

Run the following script to verify that field.id is unique across all fields:


229-230: Ensure tags is defined before calling selectedTagIdsGet

There is a possibility that tags may be undefined if metaFieldsMap.get(key) returns undefined. This could lead to unexpected behavior.

Run the following script to check if tags can be undefined:

web/src/components/molecules/Content/utils.ts (1)

12-13: Clarify the purpose and parameters of selectedTagIdsGet

The function selectedTagIdsGet may cause confusion regarding whether value contains tag IDs or tag names. Ensure that value consistently contains tag IDs.

Run the following script to check where selectedTagIdsGet is called and what type of data value holds:

Consider renaming the function or adding JSDoc comments to clarify its usage.

web/src/components/molecules/Schema/FieldModal/FieldDefaultInputs/TagField/index.tsx (1)

46-49: Ensure consistent overflow styling for tag display

The added overflow styles improve tag display, but make sure that it doesn't negatively affect other components or create horizontal scroll issues.

Test the component with a large number of tags to ensure the UI remains user-friendly.

web/src/components/molecules/Content/Form/fields/FieldComponents/TagField.tsx (1)

62-65: Review the impact of overflow styles on accessibility

While the overflow settings improve the layout, ensure that they don't hinder keyboard navigation or screen reader accessibility.

Test the component using keyboard navigation and screen readers.

web/src/components/molecules/Schema/types.ts (1)

112-112: ⚠️ Potential issue

Update documentation and usage for defaultValue type change

The defaultValue in FieldTypePropertyInput now accepts string | string[]. Ensure that all usages and documentation reflect this change to prevent type errors.

Apply this diff to update the type definition:

 typeProperty: FieldTypePropertyInput;
 };

 export type FieldTypePropertyInput = {
   text?: { defaultValue?: string; maxLength?: number };
   textArea?: { defaultValue?: string; maxLength?: number };
   markdownText?: { defaultValue?: string; maxLength?: number };
   asset?: { defaultValue?: string };
   date?: { defaultValue: string };
   bool?: { defaultValue?: boolean };
   select?: { defaultValue: string; values: string[] };
   tag?: {
-    defaultValue?: string;
+    defaultValue?: string | string[];
     tags: Tag[];
   };

Check all components that use defaultValue for tag fields to ensure they handle both string and string[] types.

web/src/components/molecules/Content/Form/index.tsx (1)

337-347: LGTM! Improved tag handling with proper type checking.

The refactored inputValueGet function now properly handles tag fields by:

  1. Using the new selectedTagIdsGet utility for tag type fields
  2. Maintaining proper type safety with explicit checks
  3. Handling both multiple and single selection cases

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