feat(forms.cmdb-instance-select): 支持proxy外部数据源 #397
Conversation
Refs CMDB_CONSUME-438
Walkthrough本次提交的更改主要集中在 Changes
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 (
|
![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)
bricks/forms/src/cmdb-instance-select/index.tsx (1)
388-396: 建议完善属性的默认值和文档说明该属性的文档注释缺少以下关键信息：
- 默认值说明不准确，注释写的是
@default false但代码中未设置默认值- 缺少具体的使用场景说明
- 缺少与其他属性的关联说明，特别是与
externalSourceId的关系建议补充完善文档注释：
/** - * @default false + * @default undefined * @required * @description 使用外部数据源 + * @group advanced + * @example + * // 启用外部数据源时，需要同时设置 externalSourceId + * { + * "useExternalCmdbApi": true, + * "externalSourceId": "source-001" + * } */bricks/forms/src/cmdb-instance-select/CmdbInstanceSelect.tsx (1)
Line range hint
196-225: 优化handleSearch函数中的代码复用在
handleSearch函数中，根据是否使用外部 API，构建了不同的请求逻辑。建议提取公共的请求参数和处理逻辑，减少代码重复，从而提高代码的可读性和可维护性。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
bricks/forms/src/cmdb-instance-select/CmdbInstanceSelect.tsx(7 hunks)bricks/forms/src/cmdb-instance-select/index.tsx(2 hunks)
🔇 Additional comments (4)
bricks/forms/src/cmdb-instance-select/index.tsx (2)
513-514: 属性传递正确，但建议添加类型验证
属性传递给子组件的方式正确。但建议在子组件 CmdbInstanceSelect 中添加相应的类型定义和验证逻辑。
398-406: 建议完善属性的文档说明和类型定义
该属性的文档注释和实现存在以下问题：
- 默认值说明与实际代码不符
- 缺少类型说明
- 缺少使用示例
- 缺少验证逻辑，当
useExternalCmdbApi为 true 时应该验证该值不为空
建议按如下方式优化：
/**
- * @default false
+ * @kind string
+ * @default ""
* @required
* @description 外部数据源id
+ * @group advanced
+ * @example
+ * // 配置外部数据源ID
+ * {
+ * "externalSourceId": "source-001"
+ * }
*/运行以下脚本验证是否有其他组件依赖这两个新属性：
✅ Verification successful
Let me generate additional scripts to check the validation logic and type definitions:
Let me try a different pattern to check the validation logic:
属性文档和类型定义需要优化
根据代码分析，建议按如下方式修改属性文档：
- 默认值说明与实际代码不符，应修改为：
/**
- * @default false
+ * @kind string
+ * @default ""
* @required
* @description 外部数据源id
*/- 属性验证逻辑已在代码中实现：
useExternalCmdbApi为 true 时，会使用externalPostSearchV3API 并传入externalSourceId- 不需要额外添加验证逻辑
- 建议补充使用示例和分组信息：
/**
* @kind string
* @default ""
* @required
* @description 外部数据源id
+ * @group advanced
+ * @example
+ * // 配置外部数据源ID
+ * {
+ * "externalSourceId": "source-001"
+ * }
*/🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for usages of the new properties
echo "Checking for useExternalCmdbApi usage..."
rg "useExternalCmdbApi" --type ts
echo "Checking for externalSourceId usage..."
rg "externalSourceId" --type ts
Length of output: 1464
Script:
#!/bin/bash
# Check validation logic for useExternalCmdbApi and externalSourceId
ast-grep --pattern 'if ($useExternalCmdbApi) {
$$$
}'
# Check property decorators and type definitions
ast-grep --pattern '@property({
$$$
})
$_'
Length of output: 104
Script:
#!/bin/bash
# Check the implementation file for validation logic
echo "Checking CmdbInstanceSelect.tsx implementation..."
cat bricks/forms/src/cmdb-instance-select/CmdbInstanceSelect.tsx
# Check the component definition
echo "Checking index.tsx implementation..."
cat bricks/forms/src/cmdb-instance-select/index.tsx
Length of output: 25116
bricks/forms/src/cmdb-instance-select/CmdbInstanceSelect.tsx (2)
63-64: 新属性的添加增强了组件的功能
在 CmdbInstanceSelectProps 接口中，添加了 useExternalCmdbApi 和 externalSourceId 属性，成功支持了外部 API 的集成，提升了组件的灵活性和适用性。
217-225: 确保外部和内部 API 的响应格式一致
在第 217-225 行，代码根据 useExternalCmdbApi 的值调用不同的 API。请确认 externalPostSearchV3.query 与 InstanceApi_postSearchV3 返回的数据格式一致，以确保后续数据处理不会出现问题。
Refs CMDB_CONSUME-438
依赖检查
组件之间的依赖声明，是微服务组件架构下的重要信息，请确保其正确性。
请勾选以下两组选项其中之一：
或者：
提交信息检查
Git 提交信息将决定包的版本发布及自动生成的 CHANGELOG，请检查工作内容与提交信息是否相符，并在以下每组选项中都依次确认。
破坏性变更：
feat作为提交类型。BREAKING CHANGE: 你的变更说明。新特性：
feat作为提交类型。问题修复：
fix作为提交类型。杂项工作：
即所有对下游使用者无任何影响、且没有必要显示在 CHANGELOG 中的改动，例如修改注释、测试用例、开发文档等：
chore,docs,test等作为提交类型。Summary by CodeRabbit
新功能
CmdbInstanceSelect组件，支持通过外部 API 获取数据。useExternalCmdbApi和externalSourceId，允许用户选择外部数据源。改进