Biz/dj 2890 fix enabledebugging state update issue

[bzwrk]

WHY

Summary by CodeRabbit

• Bug Fixes

  • Addressed an issue with the debugging state update to enhance stability.

• Chores

  • Updated the package version to 1.0.0-preview.29.
  • Upgraded the SDK dependency for the Next.js example.

• Refactor

  • Streamlined the debugging configuration process, making it optional for improved flexibility.

[linear]

DJ-2890 Fix enableDebugging state update issue

[coderabbitai]

Walkthrough

This pull request updates version numbers and refines the handling of the enableDebugging property in the React context. The changelog now includes a new entry for version [1.0.0-preview.29] documenting a bug fix. The main package's version is bumped accordingly, and the associated example project updates its @pipedream/sdk dependency. Additionally, the FormContext type and its provider have been modified to make the enableDebugging property optional, simplifying its usage.

Changes

File(s)	Change Summary
packages/connect-react/CHANGELOG.md	Added an entry for [1.0.0-preview.29] (dated 2025-02-10) documenting a bug fix for the enableDebugging state update.
packages/connect-react/package.json	Updated package version from 1.0.0-preview.28 to 1.0.0-preview.29.
packages/connect-react/src/hooks/form-context.tsx	Changed FormContext's enableDebugging from a required boolean to an optional boolean; adjusted its usage in FormContextProvider by removing redundant state handling.
packages/connect-react/.../nextjs/package.json	Updated @pipedream/sdk dependency version from ^1.3.2 to ^1.3.3.

Sequence Diagram(s)

sequenceDiagram
    participant C as Consumer Component
    participant F as FormContextProvider
    C->>F: Request form context
    F->>F: Retrieve formProps (including optional enableDebugging)
    F->>C: Return context (with or without enableDebugging)

Loading

Possibly related PRs

• Fix toggling optional props in Connect #15231: Addresses modifications to the enableDebugging property by managing optional properties within the context.
• Register fields with form to enable complete error checking #14869: Involves similar changes to the FormContext and its provider, focusing on property handling.
• Review and update prop validation logic for accuracy #14986: Refactors the FormContext type with additional error handling modifications, closely related to the enableDebugging adjustments.

Suggested labels

bug, javascript, tracked internally, prioritized

Suggested reviewers

• jverce

Poem

Hop, hop, I'm a code-savvy bunny,
Debugging optional now, isn't that funny?
Changelog hops to a preview state,
Dependencies bumped—oh, isn't it great?
With context refined and bugs out of sight,
I nibble on changes from morning till night!
🥕🐰 Happy coding in every byte!

---

📜 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 0e23d37 and 9f9ecbb.

⛔ Files ignored due to path filters (2)

• packages/connect-react/examples/nextjs/package-lock.json is excluded by !**/package-lock.json
• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (4)

• packages/connect-react/CHANGELOG.md (1 hunks)
• packages/connect-react/examples/nextjs/package.json (1 hunks)
• packages/connect-react/package.json (1 hunks)
• packages/connect-react/src/hooks/form-context.tsx (2 hunks)

✅ Files skipped from review due to trivial changes (3)

• packages/connect-react/CHANGELOG.md
• packages/connect-react/examples/nextjs/package.json
• packages/connect-react/package.json

🧰 Additional context used

🧠 Learnings (1)

packages/connect-react/src/hooks/form-context.tsx (1)

Learnt from: jverce
PR: PipedreamHQ/pipedream#15479
File: packages/connect-react/src/components/ComponentForm.tsx:23-24
Timestamp: 2025-02-05T21:58:03.118Z
Learning: In the connect-react package, the `enableDebugging` property should be of type `boolean` as it's used for toggling debugging features and conditional rendering.

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

• GitHub Check: pnpm publish
• GitHub Check: Lint Code Base
• GitHub Check: pnpm publish

🔇 Additional comments (3)

packages/connect-react/src/hooks/form-context.tsx (3)

44-44: LGTM! Making enableDebugging optional is a good improvement.

The change maintains type safety while providing flexibility in usage.

---

81-81: LGTM! Simplified variable naming.

Removing the underscore prefix improves readability and indicates proper state management.

---

561-561: LGTM! Properly exposed enableDebugging in context.

The debugging state is now correctly accessible to context consumers.

---

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?

❤️ 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. (Beta)
• @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]

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)			Feb 11, 2025 1:29am
pipedream-docs	⬜️ Ignored (Inspect)			Feb 11, 2025 1:29am
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Feb 11, 2025 1:29am