Sanity.io - new components #19137
Sanity.io - new components #19137
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
WalkthroughAdds a Sanity integration: new actions (create/get/query documents), a webhook source (new-document-event) with a webhook base, shared constants and utils (parseObject), and updates the Sanity app client with API methods and prop definitions. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Workflow as Pipedream Workflow
participant Source as New Document Source
participant Base as Webhook Base
participant Sanity as Sanity API
User->>Workflow: Configure source (on, includeDrafts...)
Workflow->>Base: activate()
Base->>Source: getWebhookArgs()
Base->>Sanity: createWebhook(name, url, dataset, apiVersion, webhookArgs)
Sanity-->>Base: { id, ... }
Base->>Base: _setHookId(id)
Sanity->>Base: POST /hooks (document event)
Base->>Base: run({ body }) — respond 200
Base->>Source: generateMeta(body)
Base->>Workflow: emit(body, meta)
User->>Workflow: Disable source
Workflow->>Base: deactivate()
Base->>Base: _getHookId()
Base->>Sanity: deleteWebhook(hookId)
Sanity-->>Base: Success
sequenceDiagram
participant User
participant Action as Pipedream Action
participant App as Sanity App Client
participant API as Sanity API
User->>Action: Run "Create Document" (documentId,type,additionalFields)
Action->>App: parseObject(additionalFields)
App->>API: POST /data/actions/{dataset} { actions: [{ actionType: "sanity.action.document.create", publishedId, document: {...} }] }
API-->>App: response
App-->>Action: response
Action->>Action: $.export("$summary","Successfully created document")
Action-->>User: Result + Summary
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (10)
components/sanity/actions/create-document/create-document.mjs(1 hunks)components/sanity/actions/get-document/get-document.mjs(1 hunks)components/sanity/actions/query-dataset/query-dataset.mjs(1 hunks)components/sanity/common/constants.mjs(1 hunks)components/sanity/common/utils.mjs(1 hunks)components/sanity/package.json(2 hunks)components/sanity/sanity.app.mjs(1 hunks)components/sanity/sources/common/base.mjs(1 hunks)components/sanity/sources/new-document-event/new-document-event.mjs(1 hunks)components/sanity/sources/new-document-event/test-event.mjs(1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📚 Learning: 2025-10-20T01:01:02.970Z
Learnt from: js07
Repo: PipedreamHQ/pipedream PR: 18744
File: components/slack_v2/actions/send-large-message/send-large-message.mjs:49-64
Timestamp: 2025-10-20T01:01:02.970Z
Learning: In components/slack_v2/actions/send-large-message/send-large-message.mjs, the metadata_event_payload prop is typed as string, so the code only needs to handle string-to-JSON parsing and does not need to handle object inputs.
Applied to files:
components/sanity/sources/new-document-event/test-event.mjs
📚 Learning: 2024-10-08T15:33:38.240Z
Learnt from: GTFalcao
Repo: PipedreamHQ/pipedream PR: 12697
File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71
Timestamp: 2024-10-08T15:33:38.240Z
Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.
Applied to files:
components/sanity/sources/new-document-event/new-document-event.mjscomponents/sanity/sources/common/base.mjs
📚 Learning: 2024-10-10T19:18:27.998Z
Learnt from: GTFalcao
Repo: PipedreamHQ/pipedream PR: 14265
File: components/the_magic_drip/sources/common.mjs:35-43
Timestamp: 2024-10-10T19:18:27.998Z
Learning: In `components/the_magic_drip/sources/common.mjs`, when processing items in `getAndProcessData`, `savedIds` is intentionally updated with IDs of both emitted and non-emitted items to avoid emitting retroactive events upon first deployment and ensure only new events are emitted as they occur.
Applied to files:
components/sanity/sources/new-document-event/new-document-event.mjs
📚 Learning: 2025-09-12T07:58:39.628Z
Learnt from: matyascimbulka
Repo: PipedreamHQ/pipedream PR: 18308
File: components/apify/actions/run-task-synchronously/run-task-synchronously.mjs:95-0
Timestamp: 2025-09-12T07:58:39.628Z
Learning: The Apify ActorRun object always contains the defaultDatasetId property according to the official documentation, so conditional checks for its existence are not needed when calling listDatasetItems.
Applied to files:
components/sanity/actions/query-dataset/query-dataset.mjs
📚 Learning: 2025-09-15T22:01:11.472Z
Learnt from: GTFalcao
Repo: PipedreamHQ/pipedream PR: 18362
File: components/leonardo_ai/actions/generate-image/generate-image.mjs:103-105
Timestamp: 2025-09-15T22:01:11.472Z
Learning: In Pipedream components, pipedream/platform's axios implementation automatically excludes undefined values from HTTP requests, so there's no need to manually check for truthiness before including properties in request payloads.
Applied to files:
components/sanity/sanity.app.mjs
📚 Learning: 2024-12-12T19:23:09.039Z
Learnt from: jcortes
Repo: PipedreamHQ/pipedream PR: 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.
Applied to files:
components/sanity/package.json
🧬 Code graph analysis (6)
components/sanity/common/constants.mjs (1)
components/sanity/sources/common/base.mjs (1)
API_VERSION(42-50)
components/sanity/actions/query-dataset/query-dataset.mjs (3)
components/sanity/actions/create-document/create-document.mjs (1)
response(41-53)components/sanity/actions/get-document/get-document.mjs (1)
response(33-37)components/sanity/sanity.app.mjs (1)
response(22-27)
components/sanity/sanity.app.mjs (5)
components/sanity/actions/create-document/create-document.mjs (1)
response(41-53)components/sanity/actions/get-document/get-document.mjs (1)
response(33-37)components/sanity/actions/query-dataset/query-dataset.mjs (1)
response(30-36)components/sanity/common/constants.mjs (2)
DEFAULT_LIMIT(2-2)API_VERSION(1-1)components/sanity/sources/common/base.mjs (1)
API_VERSION(42-50)
components/sanity/actions/get-document/get-document.mjs (3)
components/sanity/actions/create-document/create-document.mjs (1)
response(41-53)components/sanity/actions/query-dataset/query-dataset.mjs (1)
response(30-36)components/sanity/sanity.app.mjs (1)
response(22-27)
components/sanity/actions/create-document/create-document.mjs (4)
components/sanity/common/utils.mjs (1)
parseObject(1-27)components/sanity/actions/get-document/get-document.mjs (1)
response(33-37)components/sanity/actions/query-dataset/query-dataset.mjs (1)
response(30-36)components/sanity/sanity.app.mjs (1)
response(22-27)
components/sanity/sources/common/base.mjs (1)
components/sanity/common/constants.mjs (1)
API_VERSION(1-1)
🪛 Gitleaks (8.29.0)
components/sanity/sources/new-document-event/test-event.mjs
[high] 11-11: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
[high] 14-14: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ 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). (4)
- GitHub Check: Lint Code Base
- GitHub Check: pnpm publish
- GitHub Check: Publish TypeScript components
- GitHub Check: Verify TypeScript components
🔇 Additional comments (11)
components/sanity/package.json (1)
3-3: LGTM!The version bump to 0.1.0 is appropriate for the addition of new actions and sources. The @pipedream/platform dependency is correctly included.
Also applies to: 15-17
components/sanity/sources/new-document-event/test-event.mjs (1)
1-24: LGTM! Static analysis false positive.The test event structure is valid for a Sanity document. The static analysis warnings about "Generic API Keys" on lines 11 and 14 are false positives—these are Sanity document
_keyidentifiers (e.g.,EvPfkr19v0Rx2q9dajuwVI), not sensitive credentials.components/sanity/actions/get-document/get-document.mjs (1)
1-42: LGTM!The action is well-structured with proper prop definitions and dependencies. The documentId prop correctly depends on the dataset prop for dynamic option loading.
components/sanity/common/constants.mjs (1)
1-1: No issues found. The API version is current and recommended.The API version "v2025-02-19" is the latest stable Sanity API version as of November 19, 2025 and is the version shown in official Sanity documentation as the default. The code is properly configured.
components/sanity/sanity.app.mjs (1)
33-91: Fix webhook base URL — critical issue found.The webhook endpoints will fail because they use the wrong base URL. Webhooks management API requires
https://api.sanity.io/{apiVersion}/hooks/projects/{projectId}/..., but the code's_baseUrl()method constructshttps://{projectId}.api.sanity.io/{version}for all requests.Lines 51-66 (createWebhook, deleteWebhook): These methods need a different base URL construction. Either:
- Create a separate method for webhook base URLs, or
- Pass the correct base URL as a parameter to
_makeRequest()Example fix:
_webhookBaseUrl(version = API_VERSION) { return `https://api.sanity.io/${version}`; }Then use it in webhook methods:
createWebhook(opts = {}) { return this._makeRequest({ baseUrl: this._webhookBaseUrl(), path: `/hooks/projects/${this._projectId()}`, method: "POST", ...opts, }); }The other endpoints (
/data/doc,/data/query,/data/actions) are correct and match the API documentation.⛔ Skipped due to learnings
Learnt from: GTFalcao Repo: PipedreamHQ/pipedream PR: 12697 File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71 Timestamp: 2024-07-24T02:06:47.016Z Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.Learnt from: GTFalcao Repo: PipedreamHQ/pipedream PR: 12697 File: components/salesforce_rest_api/sources/common-webhook-methods.mjs:1-71 Timestamp: 2024-10-08T15:33:38.240Z Learning: The `common-webhook-methods.mjs` object is designed to be extended, similar to an abstract class, and intentionally does not implement certain methods like `generateWebhookMeta` and `getEventType` to enforce implementation in subclasses.components/sanity/actions/create-document/create-document.mjs (3)
1-15: LGTM! Clean imports and metadata.The imports are appropriate, and the metadata follows Pipedream conventions with clear documentation linking to Sanity's HTTP reference.
16-34: Excellent documentation in the document prop.The comprehensive example in the description clearly demonstrates the expected structure including required fields and nested objects.
35-39: Good validation logic.Properly validates required fields before making the API call, providing a clear error message to users.
components/sanity/sources/common/base.mjs (3)
6-24: LGTM! Standard webhook props.The props are well-structured for webhook sources, with
customResponse: trueproperly enabling manual response handling in the run method.
25-38: Appropriate base class pattern.The placeholder methods that throw
ConfigurationErrorfollow the expected pattern for base modules, enforcing implementation in derived sources.Based on learnings
39-61: Well-structured webhook lifecycle management.The activate/deactivate hooks properly manage webhook creation and cleanup, with safe deletion checking for the stored hook ID.
components/sanity/sources/new-document-event/new-document-event.mjs
Outdated
Show resolved
Hide resolved
jcortes
left a comment
jcortes
left a comment
There was a problem hiding this comment.
Hi @michelle0927 lgtm! Ready for QA!
For Integration QA:
|
|
Hello everyone, I have tested this PR and there're some test cases failed or needed improvement. Please check test reports below for more information:
|
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
components/sanity/actions/create-document/create-document.mjs(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-10-30T15:24:39.294Z
Learnt from: jcortes
Repo: PipedreamHQ/pipedream PR: 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".
Applied to files:
components/sanity/actions/create-document/create-document.mjs
🧬 Code graph analysis (1)
components/sanity/actions/create-document/create-document.mjs (3)
components/sanity/actions/query-dataset/query-dataset.mjs (1)
response(30-36)components/sanity/actions/get-document/get-document.mjs (1)
response(33-37)components/sanity/common/utils.mjs (1)
parseObject(1-27)
⏰ 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). (4)
- GitHub Check: pnpm publish
- GitHub Check: Publish TypeScript components
- GitHub Check: Verify TypeScript components
- GitHub Check: Lint Code Base
🔇 Additional comments (3)
components/sanity/actions/create-document/create-document.mjs (3)
1-2: LGTM: Imports are clean and necessary.Both imports are used appropriately in the code.
4-14: LGTM: Action metadata is well-configured.The annotations correctly reflect that this action creates data via external API calls.
15-22: LGTM: Standard Pipedream prop definitions.Using propDefinition for dataset is the correct pattern for reusing app-level prop logic.
Resolves #6147
Summary by CodeRabbit
New Features
Chores
✏️ Tip: You can customize this high-level summary in your review settings.