Skip to content

New Components - odoo #17246

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

Merged
merged 3 commits into from
Jun 25, 2025
Merged

New Components - odoo #17246

merged 3 commits into from
Jun 25, 2025

Conversation

michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Jun 23, 2025

Resolves #15359

Summary by CodeRabbit

  • New Features

    • Introduced Odoo integration actions for creating, searching, reading, and updating records directly from the app.
    • Added dynamic property handling for Odoo models, allowing users to select and manage fields interactively.
    • Enabled paginated record selection and flexible filtering when searching Odoo records.
  • Improvements

    • Enhanced Odoo connectivity using XML-RPC for robust and secure communication.
    • Added utility for parsing input data automatically.
  • Chores

    • Updated package version and added new dependency for XML-RPC support.

Copy link

vercel bot commented Jun 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Jun 23, 2025 7:45pm
pipedream-docs ⬜️ Ignored (Inspect) Jun 23, 2025 7:45pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jun 23, 2025 7:45pm

Copy link
Contributor

coderabbitai bot commented Jun 23, 2025

Walkthrough

This change introduces a new Odoo integration with actions for creating, searching, reading, and updating records via XML-RPC. It implements dynamic property fetching, utility parsing, and Odoo API communication for the "res.partner" model. The package version is updated, and the "xmlrpc" dependency is added.

Changes

File(s) Change Summary
components/odoo/actions/create-record/create-record.mjs New action: Create Record. Allows creation of a new record in Odoo with dynamic field properties.
components/odoo/actions/search-read-records/search-read-records.mjs New action: Search and Read Records. Enables searching and reading records with filters and field selection.
components/odoo/actions/update-record/update-record.mjs New action: Update Record. Permits updating an existing record with dynamic field and record selection.
components/odoo/common/utils.mjs Adds utility function parseObject for recursive parsing of input data.
components/odoo/odoo.app.mjs Implements full Odoo XML-RPC integration, dynamic field fetching, and CRUD operation methods.
components/odoo/package.json Bumps version to 0.1.0 and adds "xmlrpc" dependency.

Sequence Diagram(s)

Loading
sequenceDiagram
    participant User
    participant Action
    participant OdooApp
    participant OdooAPI

    User->>Action: Trigger (Create/Search/Update) Record
    Action->>OdooApp: Fetch dynamic props (fields, etc.)
    Action->>OdooApp: Call method (createRecord/searchAndReadRecords/updateRecord)
    OdooApp->>OdooAPI: XML-RPC request (authenticate, perform operation)
    OdooAPI-->>OdooApp: XML-RPC response (record ID, data, etc.)
    OdooApp-->>Action: Return result
    Action-->>User: Output summary/result

Assessment against linked issues

Objective Addressed Explanation
Implement "search-and-read-records" action (model, domain, fields, limit, offset) [#15359] The action does not expose props for model, domain, limit, or offset as required.
Implement "create-record" action (model, values) [#15359] The action does not expose a model prop; it is hardcoded to "res.partner".
Implement "update-records" action (model, ids, values) [#15359] The action only updates a single record and does not expose model or ids array props.
Use dynamic field fetching and XML-RPC for Odoo integration [#15359]

Assessment against linked issues: Out-of-scope changes

Code Change (file_path) Explanation
Utility function parseObject added (components/odoo/common/utils.mjs) No objective requests a generic input parsing utility; its addition is not directly specified.
Hardcoded "res.partner" model in all Odoo methods (components/odoo/odoo.app.mjs) The objectives require model to be user-configurable, not hardcoded.

Poem

(\(\
( -.-) Odoo hops anew,
o_(")(") With actions three—create, search, update too!
Fields fetched on the fly,
XML-RPC bunnies leap high,
Version bumped, dependencies in view—
This rabbit’s code is fresh as dew!

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

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.

components/odoo/actions/create-record/create-record.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9)
at packageResolve (node:internal/modules/esm/resolve:767:81)
at moduleResolve (node:internal/modules/esm/resolve:853:18)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at #link (node:internal/modules/esm/module_job:201:49)


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 44218cb and b933f84.

📒 Files selected for processing (1)
  • components/odoo/actions/create-record/create-record.mjs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/odoo/actions/create-record/create-record.mjs
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Lint Code Base
  • GitHub Check: pnpm publish
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
✨ 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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
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: 6

🧹 Nitpick comments (2)
components/odoo/odoo.app.mjs (2)

29-46: Consider caching the authenticated user ID.

The method authenticates on every call, which could impact performance. Consider caching the uid for the session duration.

You could implement a simple caching mechanism:

// Add to the app definition
_uid: null,

// Modify getUid method
async getUid() {
  if (this._uid) {
    return this._uid;
  }
  // ... existing authentication logic ...
  this._uid = uid;
  return uid;
}

This would reduce unnecessary authentication calls while maintaining the same interface.


88-102: Add JSDoc documentation for public methods.

The helper methods lack documentation. Adding JSDoc comments would improve maintainability and developer experience.

Example for one method:

+/**
+ * Search and read records from Odoo
+ * @param {Array} filter - Domain filter array for search
+ * @param {Object} args - Additional arguments (fields, limit, offset, etc.)
+ * @returns {Promise<Array>} Array of matching records
+ */
 searchAndReadRecords(filter = [], args = {}) {
   return this.makeRequest("search_read", filter, args);
 },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 42bbd53 and 44218cb.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (6)
  • components/odoo/actions/create-record/create-record.mjs (1 hunks)
  • components/odoo/actions/search-read-records/search-read-records.mjs (1 hunks)
  • components/odoo/actions/update-record/update-record.mjs (1 hunks)
  • components/odoo/common/utils.mjs (1 hunks)
  • components/odoo/odoo.app.mjs (1 hunks)
  • components/odoo/package.json (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: pnpm publish
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Lint Code Base
🔇 Additional comments (5)
components/odoo/package.json (2)

3-3: Appropriate version bump for new features.

The minor version increment from 0.0.1 to 0.1.0 correctly follows semantic versioning conventions for the addition of new functionality.


15-17: ```shell
#!/bin/bash

Check xmlrpc package for known security advisories via npm registry API

curl -s "https://registry.npmjs.org/-/npm/v1/security/advisories?module=xmlrpc" | jq '{total: .total, advisories: .objects}'


</details>
<details>
<summary>components/odoo/actions/search-read-records/search-read-records.mjs (1)</summary>

`1-37`: **Well-structured search and read action implementation.**

The action correctly handles optional parameters, uses the utility function for filter parsing, and provides appropriate user feedback. The conditional args construction and pluralization in the summary message demonstrate attention to detail.

</details>
<details>
<summary>components/odoo/actions/update-record/update-record.mjs (2)</summary>

`31-43`: **Well-implemented paginated record selection.**

The `getRecordIdOptions` method correctly implements pagination with limit and offset calculations, and properly handles the case where records might be null/undefined.

---

`45-61`: **Proper handling of unused variable and API call structure.**

The explicit ESLint disable comment for the unused `getRecordIdOptions` variable shows intentional design, and the record update API call structure correctly passes the record ID array and data payload.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@michelle0927 michelle0927 merged commit db67e3d into master Jun 25, 2025
11 checks passed
@michelle0927 michelle0927 deleted the issue-15359 branch June 25, 2025 15:03
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.

[Components] odoo
2 participants