fix: preview compatibility i18n is null #912
Conversation
WalkthroughThe changes introduce a new function, Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Warning Rate limit exceeded@lichunn has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 43 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
bug
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
packages/design-core/src/preview/src/preview/generate.js (2)
137-145: LGTM! Consider these enhancements for maintainability.The function successfully handles null/undefined i18n objects and ensures consistent structure. Consider these improvements:
+const SUPPORTED_LOCALES = { + EN_US: 'en_US', + ZH_CN: 'zh_CN' +} + +/** + * Ensures i18n object has valid structure with required locale properties + * @param {Object} i18n - The i18n configuration object + * @returns {Object} Structured i18n object with en_US and zh_CN properties + */ const compatibleI18n = (i18n) => { if (!i18n || typeof i18n !== 'object') { - return { en_US: {}, zh_CN: {} } + return Object.values(SUPPORTED_LOCALES).reduce((acc, locale) => { + acc[locale] = {} + return acc + }, {}) } - i18n.en_US = i18n.en_US && typeof i18n.en_US === 'object' ? i18n.en_US : {} - i18n.zh_CN = i18n.zh_CN && typeof i18n.zh_CN === 'object' ? i18n.zh_CN : {} + Object.values(SUPPORTED_LOCALES).forEach(locale => { + i18n[locale] = i18n[locale] && typeof i18n[locale] === 'object' ? i18n[locale] : {} + }) return i18n }
Line range hint
147-157: Add input validation and enhance documentation.The function handles CSS dependencies but could be more robust with validation and better documentation.
/** - * 处理css文件依赖 - * @param {*} code 源代码 - * @param {*} cssList css文件 - * @returns + * Process CSS dependencies by concatenating JS code with CSS file references + * @param {string} code - Source JavaScript code + * @param {string[]} cssList - List of CSS file URLs to be included + * @returns {string} Combined code with CSS references + * @throws {TypeError} If inputs are invalid */ export const processAppJsCode = (code, cssList) => { + if (typeof code !== 'string') { + throw new TypeError('code must be a string') + } + if (!Array.isArray(cssList)) { + throw new TypeError('cssList must be an array') + } + const sanitizedCssList = cssList.map(css => { + if (typeof css !== 'string') { + throw new TypeError('CSS items must be strings') + } + return css.trim() + }) - return `${code}${cssList.map((css) => `addCss('${css}')`).join('\n')}` + return `${code}${sanitizedCssList.map((css) => `addCss('${css}')`).join('\n')}` }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
packages/design-core/src/preview/src/preview/generate.js(2 hunks)
🔇 Additional comments (1)
packages/design-core/src/preview/src/preview/generate.js (1)
158-158: Verify integration with preview functionality.
The integration of compatibleI18n looks correct. Let's verify its usage across the codebase.
✅ Verification successful
Let me gather more specific information about the i18n compatibility integration.
Let me try to locate the compatibleI18n function definition since it wasn't found in the previous search.
Integration of compatibleI18n is correctly implemented
The function is properly defined and integrated:
- It ensures i18n data has required locales (en_US, zh_CN)
- Provides fallback empty objects for missing or invalid i18n data
- Correctly processes the data before passing to generateDefaultExport
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the integration and usage of i18n in preview functionality
# Check for direct i18n usage that might need compatibility handling
rg -l "\.i18n" --type js
# Look for preview-related files that might need similar handling
fd -e js -e vue preview
Length of output: 1169
Script:
#!/bin/bash
# Check the implementation of compatibleI18n function
ast-grep --pattern 'function compatibleI18n($_) { $$$ }'
# Check how i18n data is used in preview-related files
rg -A 5 "\.i18n" packages/design-core/src/preview/
# Look for any i18n transformations in preview components
rg -A 5 "i18n" packages/design-core/src/preview/src/preview/Preview.vue
Length of output: 790
Script:
#!/bin/bash
# Search for compatibleI18n function definition with different patterns
rg -A 10 "compatibleI18n" --type js
# Check imports to find where compatibleI18n might be defined
rg "import.*compatibleI18n" --type js
# Look for any exports of compatibleI18n
rg "export.*compatibleI18n" --type js
Length of output: 2054
English | 简体中文
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Background and solution
What is the current behavior?
当国际化数据为空时，java版本的后端会返回{ en_US: null, zh_CN: null }，导致前端预览报错
What is the new behavior?
前端添加数据判空处理
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
These updates improve the handling of multi-language support and streamline the integration of styles with application code.