Skip to content

Conversation

@michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Jul 7, 2025

Adds the includeTabsContent prop to allow retrieving tabs content.

Summary by CodeRabbit

  • New Features

    • Added an optional setting to retrieve raw tab content when getting a Google Doc, allowing more flexible document data access.
  • Chores

    • Updated version numbers for multiple Google Docs actions and sources to reflect the latest changes.
    • Incremented the package version for the Google Docs integration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 7, 2025

Walkthrough

The changes primarily consist of version number increments across multiple Google Docs action and source components, as well as the package manifest. Additionally, the getDocument method and its usage were updated to support an optional includeTabsContent parameter, allowing retrieval of raw document tab data when specified.

Changes

File(s) Change Summary
components/google_docs/actions/append-image/append-image.mjs,
.../replace-image/replace-image.mjs,
.../replace-text/replace-text.mjs
Incremented version numbers by one patch version; no logic changes.
components/google_docs/actions/append-text/append-text.mjs,
.../create-document/create-document.mjs
Incremented version numbers by one patch version; no logic changes.
components/google_docs/actions/create-document-from-template/create-document-from-template.mjs,
.../find-document/find-document.mjs
Incremented version numbers by one patch version; no logic changes.
components/google_docs/sources/new-document-created/new-document-created.mjs,
.../new-or-updated-document/new-or-updated-document.mjs
Incremented version numbers by one patch version; no logic changes.
components/google_docs/actions/get-document/get-document.mjs Added optional includeTabsContent boolean prop (default false); passes to getDocument method.
components/google_docs/google_docs.app.mjs Updated getDocument to accept includeTabsContent; returns raw or processed doc data accordingly.
components/google_docs/package.json Bumped package version from 0.4.2 to 0.4.3.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GetDocumentAction
    participant GoogleDocsApp
    participant GoogleDocsAPI
    participant Utils

    User->>GetDocumentAction: Invoke (includeTabsContent: true/false)
    GetDocumentAction->>GoogleDocsApp: getDocument(documentId, includeTabsContent)
    GoogleDocsApp->>GoogleDocsAPI: Fetch document (with includeTabsContent flag)
    GoogleDocsAPI-->>GoogleDocsApp: Document data
    alt includeTabsContent is true
        GoogleDocsApp-->>GetDocumentAction: Return raw document data
    else includeTabsContent is false
        GoogleDocsApp->>Utils: addTextContentToDocument(document)
        Utils-->>GoogleDocsApp: Processed document
        GoogleDocsApp-->>GetDocumentAction: Return processed document
    end
    GetDocumentAction-->>User: Document result
Loading

Poem

In the docs of Google, a patch hops by,
Version numbers leap, reaching for the sky.
Tabs content now, with a single flag true,
Brings raw document data, shiny and new!
A bunny’s delight—small changes, neat,
Versioned and ready, the cycle’s complete!
🐇✨

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/google_docs/actions/append-image/append-image.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:202:49)

components/google_docs/actions/append-text/append-text.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:202:49)

components/google_docs/actions/create-document/create-document.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:202:49)

  • 8 others

📜 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 7224a54 and fc676d4.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (12)
  • components/google_docs/actions/append-image/append-image.mjs (1 hunks)
  • components/google_docs/actions/append-text/append-text.mjs (1 hunks)
  • components/google_docs/actions/create-document-from-template/create-document-from-template.mjs (1 hunks)
  • components/google_docs/actions/create-document/create-document.mjs (1 hunks)
  • components/google_docs/actions/find-document/find-document.mjs (1 hunks)
  • components/google_docs/actions/get-document/get-document.mjs (2 hunks)
  • components/google_docs/actions/replace-image/replace-image.mjs (1 hunks)
  • components/google_docs/actions/replace-text/replace-text.mjs (1 hunks)
  • components/google_docs/google_docs.app.mjs (1 hunks)
  • components/google_docs/package.json (1 hunks)
  • components/google_docs/sources/new-document-created/new-document-created.mjs (1 hunks)
  • components/google_docs/sources/new-or-updated-document/new-or-updated-document.mjs (1 hunks)
🧰 Additional context used
🧠 Learnings (5)
components/google_docs/actions/create-document-from-template/create-document-from-template.mjs (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14467
File: components/gainsight_px/actions/create-account/create-account.mjs:4-6
Timestamp: 2024-10-30T15:24:39.294Z
Learning: In `components/gainsight_px/actions/create-account/create-account.mjs`, the action name should be "Create Account" instead of "Create Memory".
components/google_docs/actions/create-document/create-document.mjs (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14467
File: components/gainsight_px/actions/create-account/create-account.mjs:4-6
Timestamp: 2024-10-30T15:24:39.294Z
Learning: In `components/gainsight_px/actions/create-account/create-account.mjs`, the action name should be "Create Account" instead of "Create Memory".
components/google_docs/package.json (1)
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
components/google_docs/sources/new-document-created/new-document-created.mjs (1)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.
components/google_docs/sources/new-or-updated-document/new-or-updated-document.mjs (1)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/name-updated/name-updated.mjs:6-6
Timestamp: 2025-01-23T03:55:15.166Z
Learning: Source names in Monday.com components don't need to start with "New" if they emit events for updated items (e.g., "Name Updated", "Column Value Updated") rather than new items. This follows the component guidelines exception where the "New" prefix is only required when emits are limited to new items.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Lint Code Base
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
🔇 Additional comments (12)
components/google_docs/sources/new-document-created/new-document-created.mjs (1)

8-8: LGTM - Version increment aligns with coordinated release.

The version bump from 0.0.3 to 0.0.4 is appropriate for the coordinated release that adds tabs content support to the Google Docs integration.

components/google_docs/sources/new-or-updated-document/new-or-updated-document.mjs (1)

12-12: LGTM - Version increment aligns with coordinated release.

The version bump from 0.0.3 to 0.0.4 is appropriate for the coordinated release that adds tabs content support to the Google Docs integration.

components/google_docs/google_docs.app.mjs (1)

105-113: LGTM - Well-implemented enhancement for tabs content support.

The addition of the optional includeTabsContent parameter correctly implements the new functionality while maintaining backward compatibility. The conditional logic appropriately handles both cases:

  • When true: returns raw API data including tabs content
  • When false (default): processes data through existing utility function

This aligns perfectly with the PR objectives to add tabs content support to the get-document functionality.

components/google_docs/actions/replace-image/replace-image.mjs (1)

7-7: LGTM - Version increment aligns with coordinated release.

The version bump from 0.0.6 to 0.0.7 is appropriate for the coordinated release. The existing getDocument call on line 40 will continue to work correctly with the new parameter's default value.

components/google_docs/actions/append-text/append-text.mjs (1)

7-7: LGTM - Version increment aligns with coordinated release.

The version bump from 0.1.5 to 0.1.6 is appropriate for the coordinated release. The existing getDocument call on line 34 will continue to work correctly with the new parameter's default value.

components/google_docs/actions/create-document/create-document.mjs (1)

55-57: Good practice: already awaiting getDocument

This action correctly awaits getDocument, avoiding the bug found in other actions.

components/google_docs/actions/find-document/find-document.mjs (1)

17-17: Version bump only – no issues spotted

No functional changes besides the version increment.

components/google_docs/actions/create-document-from-template/create-document-from-template.mjs (1)

16-16: Version bump only – looks fine

Nothing else changed in this file.

components/google_docs/actions/get-document/get-document.mjs (3)

7-7: LGTM: Version bump is appropriate.

The version increment follows semantic versioning practices for a minor feature addition.


17-23: LGTM: Well-documented property definition.

The new includeTabsContent property is properly defined with:

  • Correct type specification (boolean)
  • Clear label and description
  • Appropriate default value for backward compatibility
  • Optional flag to maintain existing behavior

26-26: Confirmed support for includeTabsContent in getDocument
The getDocument method in components/google_docs/google_docs.app.mjs is declared as:

async getDocument(documentId, includeTabsContent = false) {  }

so it correctly accepts the second parameter. No further changes are required.

components/google_docs/package.json (1)

3-3: LGTM: Appropriate version bump.

The patch version increment from 0.4.2 to 0.4.3 correctly reflects the addition of new optional functionality while maintaining backward compatibility.

✨ 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.

@vercel
Copy link

vercel bot commented Jul 7, 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 Jul 7, 2025 3:09pm
pipedream-docs ⬜️ Ignored (Inspect) Jul 7, 2025 3:09pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Jul 7, 2025 3:09pm

@michelle0927 michelle0927 marked this pull request as ready for review July 7, 2025 15:12
@michelle0927 michelle0927 moved this to Ready for PR Review in Component (Source and Action) Backlog Jul 7, 2025
@lcaresia lcaresia moved this from Ready for PR Review to Ready for QA in Component (Source and Action) Backlog Jul 7, 2025
@vunguyenhung vunguyenhung moved this from Ready for QA to In QA in Component (Source and Action) Backlog Jul 8, 2025
@vunguyenhung vunguyenhung moved this from In QA to Ready for Release in Component (Source and Action) Backlog Jul 8, 2025
@vunguyenhung
Copy link
Collaborator

Hi everyone, all test cases are passed! Ready for release!

Test report
https://vunguyenhung.notion.site/Google-Docs-add-support-for-tabs-content-to-get-document-229bf548bb5e8187a623f32a46f9dda3

@michelle0927 michelle0927 merged commit b68121d into master Jul 8, 2025
11 checks passed
@michelle0927 michelle0927 deleted the google-docs-includeTabsContent branch July 8, 2025 14:36
@github-project-automation github-project-automation bot moved this from Ready for Release to Done in Component (Source and Action) Backlog Jul 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants