fix: i18n create empty entries error

[gene9831]

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

Background and solution

i18n插件中创建空词条，content中的属性会设置成undefined，导致请求体中的content没有属性，请求接口会报错（看下方current behavior截图）
方案：创建空词条时，给content中的属性设置空字符串（看下方new behavior截图）

有关联的pr #1254 ，这个pr修复了初始化词条不加载的问题

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

[coderabbitai]

Walkthrough

This change updates the ensureI18n function in the useTranslate.ts file. The modification revises the way the contents variable is populated by introducing a fallback mechanism. If a locale’s value is missing or falsy in the source object, it now defaults to an empty string ('') instead of risking an undefined value. This ensures that each locale key in the returned structure always has a defined value.

Changes

File	Change Summary
packages/.../useTranslate.ts	Updated the mapping over locales in the ensureI18n function to provide an empty string as a fallback for undefined or falsy values in the i18n data.

Possibly related PRs

• fix: 修复文案为空时 i18n 下的文案为 null 导致出码异常 #1211: Addresses similar issues by ensuring fallback values for i18n content, closely aligning with the changes in this PR.

Suggested labels

bug

Suggested reviewers

• hexqi

Poem

Hi there, I'm your coding bunny, so spry and neat,
I hopped through code and found a clever treat.
With fallbacks now in every line,
No undefined values to dine!
Gearing up for smoother i18n with a skip and a beat!
🐇💻

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/plugins/i18n/src/composable/useTranslate.ts (2)

227-230: Consider applying the same fallback pattern here.

For consistency, I recommend applying the same fallback pattern to handle potentially undefined values in the batchCreateI18n function:

  const entries = Object.entries(langs).map(([key, message]) => ({
    key,
-    contents: Object.fromEntries(locales.map(({ lang }) => [lang, message[lang]]))
+    contents: Object.fromEntries(locales.map(({ lang }) => [lang, message[lang] || '']))
  }))

This would prevent similar issues when batch creating entries with missing language values.

---

65-65: Consider adding a comment for future reference.

To help future developers understand the purpose of this fallback mechanism, consider adding a brief comment:

+  // Ensure each language has at least an empty string to prevent errors when creating entries
  const contents = Object.fromEntries(locales.map(({ lang }) => [lang, obj[lang] || '']))

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 730bfb9 and 5802359.

📒 Files selected for processing (1)

• packages/plugins/i18n/src/composable/useTranslate.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: push-check

🔇 Additional comments (1)

packages/plugins/i18n/src/composable/useTranslate.ts (1)

65-65: Good fix for the empty entries error.

This change ensures that when obj[lang] is undefined or falsy, it defaults to an empty string. This effectively fixes the issue where creating empty entries results in an error if the content in the request body lacks properties.