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: improve mapping validation logic #180

Merged
merged 1 commit into from
Nov 25, 2024

Conversation

davidemarcoli
Copy link
Collaborator

@davidemarcoli davidemarcoli commented Nov 22, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced validation logic for file mappings based on media type (movies and TV shows).
    • Improved user interface with overflow styles for file display.
  • Bug Fixes

    • Confirm button now correctly reflects the validity of file mappings, enhancing user experience.

Copy link

coderabbitai bot commented Nov 22, 2024

📝 Walkthrough

Walkthrough

The changes in the media-file-selector.svelte component focus on enhancing the validation logic for file mappings based on media types. A new variable, isValidMapping, tracks the validity of selected files, with the validateMappings function updated to set this variable accordingly. The handleFileSelection function now ensures that mapping validity is checked upon file selection, and the UI rendering logic has been adjusted to improve user experience. The button for confirming selections is now disabled based on isValidMapping, streamlining the control flow.

Changes

File Change Summary
src/lib/components/media-file-selector.svelte - Added variable: let isValidMapping = false;
- Updated validateMappings function logic.
- Modified handleFileSelection to call validateMappings after file selection.
- Adjusted rendering logic for file display and button enabling/disabling based on isValidMapping.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MediaFileSelector
    participant Validation

    User->>MediaFileSelector: Select files
    MediaFileSelector->>Validation: validateMappings()
    Validation-->>MediaFileSelector: Set isValidMapping
    MediaFileSelector->>User: Update UI based on isValidMapping
    User->>MediaFileSelector: Confirm selection
Loading

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 (1.23.1)

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.

src/lib/components/media-file-selector.svelte

Oops! Something went wrong! :(

ESLint: 9.15.0

TypeError: Error while loading rule '@typescript-eslint/no-unused-expressions': Cannot read properties of undefined (reading 'allowShortCircuit')
Occurred while linting /src/lib/components/media-file-selector.svelte
at Object.create (/node_modules/.pnpm/[email protected]/node_modules/eslint/lib/rules/no-unused-expressions.js:75:13)
at create (/node_modules/.pnpm/@typescript-eslint+eslint-plugin@8.0.0-alpha.28_@typescript-eslint[email protected]_esli_3mavzqvvdjgnqjwkix3ck7lb2m/node_modules/@typescript-eslint/eslint-plugin/dist/rules/no-unused-expressions.js:28:32)
at Object.create (/node_modules/.pnpm/@typescript-eslint[email protected][email protected][email protected]/node_modules/@typescript-eslint/utils/dist/eslint-utils/RuleCreator.js:32:20)
at createRuleListeners (/node_modules/.pnpm/[email protected]/node_modules/eslint/lib/linter/linter.js:944:21)
at /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/linter/linter.js:1082:84
at Array.forEach ()
at runRules (/node_modules/.pnpm/[email protected]/node_modules/eslint/lib/linter/linter.js:1013:34)
at #flatVerifyWithoutProcessors (/node_modules/.pnpm/[email protected]/node_modules/eslint/lib/linter/linter.js:1911:31)
at Linter._verifyWithFlatConfigArrayAndWithoutProcessors (/node_modules/.pnpm/[email protected]/node_modules/eslint/lib/linter/linter.js:1993:49)
at /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/linter/linter.js:1609:29


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

@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: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between af4b2fb and 3df8f76.

📒 Files selected for processing (1)
  • src/lib/components/media-file-selector.svelte (4 hunks)
🔇 Additional comments (4)
src/lib/components/media-file-selector.svelte (4)

156-156: LGTM: Immediate validation after file selection

The addition of validateMappings() call ensures mapping validity is checked right after file selection, providing immediate feedback.


170-170: LGTM: Well-placed state variable for tracking mapping validity

The isValidMapping state variable provides a clear way to track and control the mapping validation state.


496-504: LGTM: Improved file display and removal handling

Good improvements:

  • Overflow handling for long filenames improves UI
  • Validation after file removal ensures consistency

543-543: LGTM: Improved button state management

The button's disabled state now correctly depends on both loading and mapping validity, preventing submission of invalid data.

Comment on lines +173 to +187
if (mediaType === 'movie') {
isValidMapping = true;
return true;
}

return selectedFilesMappings.every(
const isValid = selectedFilesMappings.every(
(file) =>
typeof file.season === 'number' &&
typeof file.episode === 'number' &&
file.season > 0 &&
file.episode > 0
);

isValidMapping = isValid;
return isValid;
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Consider enhancing the validation logic

While the current validation works, consider these improvements:

  1. Add upper bounds validation for season/episode numbers
  2. Consider validating for duplicate season/episode combinations
  3. Add validation for negative numbers (currently only checks > 0)
 function validateMappings(): boolean {
   if (mediaType === 'movie') {
     isValidMapping = true;
     return true;
   }

+  // Check for duplicates
+  const episodeMap = new Set();
   const isValid = selectedFilesMappings.every(
-    (file) =>
-      typeof file.season === 'number' &&
-      typeof file.episode === 'number' &&
-      file.season > 0 &&
-      file.episode > 0
+    (file) => {
+      if (
+        typeof file.season !== 'number' ||
+        typeof file.episode !== 'number' ||
+        file.season <= 0 ||
+        file.episode <= 0 ||
+        file.season > 100 || // reasonable upper bound
+        file.episode > 100   // reasonable upper bound
+      ) {
+        return false;
+      }
+      const key = `${file.season}-${file.episode}`;
+      if (episodeMap.has(key)) {
+        return false; // duplicate episode
+      }
+      episodeMap.add(key);
+      return true;
+    }
   );

   isValidMapping = isValid;
   return isValid;
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (mediaType === 'movie') {
isValidMapping = true;
return true;
}
return selectedFilesMappings.every(
const isValid = selectedFilesMappings.every(
(file) =>
typeof file.season === 'number' &&
typeof file.episode === 'number' &&
file.season > 0 &&
file.episode > 0
);
isValidMapping = isValid;
return isValid;
if (mediaType === 'movie') {
isValidMapping = true;
return true;
}
// Check for duplicates
const episodeMap = new Set();
const isValid = selectedFilesMappings.every(
(file) => {
if (
typeof file.season !== 'number' ||
typeof file.episode !== 'number' ||
file.season <= 0 ||
file.episode <= 0 ||
file.season > 100 || // reasonable upper bound
file.episode > 100 // reasonable upper bound
) {
return false;
}
const key = `${file.season}-${file.episode}`;
if (episodeMap.has(key)) {
return false; // duplicate episode
}
episodeMap.add(key);
return true;
}
);
isValidMapping = isValid;
return isValid;

@davidemarcoli davidemarcoli merged commit 3a9c5e1 into main Nov 25, 2024
5 checks passed
@davidemarcoli davidemarcoli deleted the bugfix/file-selection-validation branch November 25, 2024 16:37
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