fix: Apify: actor -> Actor, add @apify/consts, tracking headers #17396
Conversation
This reverts commit 11e0ed2.
# Conflicts: # pnpm-lock.yaml
|
@drobnikj is attempting to deploy a commit to the Pipedreamers Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
WalkthroughThis update primarily consists of minor formatting improvements, version bumps, and string capitalization corrections across multiple components. Several files now include a newline at the end, and various Apify-related files have updated version numbers, improved descriptions, and now use constants for event types. Additionally, a new dependency was added to the Apify package, and a custom HTTP header was introduced in the Apify app component. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ApifyComponent
participant ApifyAPI
User->>ApifyComponent: Trigger action or event
ApifyComponent->>ApifyAPI: Send request with custom headers
ApifyAPI-->>ApifyComponent: Respond with data
ApifyComponent-->>User: Return processed result
Poem
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
components/apify/apify.app.mjsOops! Something went wrong! :( ESLint: 8.57.1 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified. |
drobnikj
changed the title
|
We will probably have more changes in the Apify integration in the following weeks, let me know if PR like this are ok. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
components/apify/actions/get-dataset-items/get-dataset-items.mjs (1)
8-8: Confirm downstream consumers are ready for the version bump
Only the version string changed. Double-check that:
components/apify/package.jsonlists this new action version (if you publish individual component versions).- Any docs / CHANGELOG reference
0.0.3.No code issues.
components/apify/actions/scrape-single-url/scrape-single-url.mjs (1)
8-8: Version updated without functional change – ensure semantic intent
The patch release (0.0.4) is fine for a non-breaking metadata tweak. Just verify the coordinated version bumps across all related components land in the registry at the same time to avoid mismatched dependency graphs.components/apify/actions/run-task-synchronously/run-task-synchronously.mjs (1)
7-7: Keep CHANGELOG in sync
Same note as above—add an entry explaining the bump (even if it’s “internal consistency / tracking header rollout”) so consumers don’t wonder why they pulled a new patch with no code diff.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (27)
components/adtraction/adtraction.app.mjs(1 hunks)components/apify/README.md(1 hunks)components/apify/actions/get-dataset-items/get-dataset-items.mjs(1 hunks)components/apify/actions/run-actor/run-actor.mjs(4 hunks)components/apify/actions/run-task-synchronously/run-task-synchronously.mjs(1 hunks)components/apify/actions/scrape-single-url/scrape-single-url.mjs(1 hunks)components/apify/actions/set-key-value-store-record/set-key-value-store-record.mjs(1 hunks)components/apify/apify.app.mjs(3 hunks)components/apify/package.json(2 hunks)components/apify/sources/common/base.mjs(3 hunks)components/apify/sources/new-finished-actor-run-instant/new-finished-actor-run-instant.mjs(2 hunks)components/apify/sources/new-finished-task-run-instant/new-finished-task-run-instant.mjs(1 hunks)components/asters/asters.app.mjs(1 hunks)components/bitget/bitget.app.mjs(1 hunks)components/explorium/explorium.app.mjs(1 hunks)components/joggai/joggai.app.mjs(1 hunks)components/mumble/mumble.app.mjs(1 hunks)components/neetoform/neetoform.app.mjs(1 hunks)components/order_sender/order_sender.app.mjs(1 hunks)components/pinghome/pinghome.app.mjs(1 hunks)components/prepr_graphql/prepr_graphql.app.mjs(1 hunks)components/prodatakey/prodatakey.app.mjs(1 hunks)components/salesforge/salesforge.app.mjs(1 hunks)components/sign_plus/sign_plus.app.mjs(1 hunks)components/themarketer/themarketer.app.mjs(1 hunks)components/vincario/vincario.app.mjs(1 hunks)components/zenedu/zenedu.app.mjs(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
components/apify/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/apify/actions/run-actor/run-actor.mjs (5)
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".
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-07-04T18:11:59.822Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#15376
File: components/monday/sources/column-value-updated/column-value-updated.mjs:17-24
Timestamp: 2025-01-23T03:55:51.998Z
Learning: Alert props in Pipedream components are a special case that do not require a label property, and use the 'content' property as a replacement for description.
Learnt from: js07
PR: PipedreamHQ/pipedream#17375
File: components/zerobounce/actions/get-validation-results-file/get-validation-results-file.mjs:23-27
Timestamp: 2025-07-01T17:07:48.143Z
Learning: "dir" props in Pipedream components are hidden in the component form and not user-facing, so they don't require labels or descriptions for user clarity.
components/apify/sources/new-finished-actor-run-instant/new-finished-actor-run-instant.mjs (3)
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.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-07-04T18:11:59.822Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
components/apify/sources/common/base.mjs (4)
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#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.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#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
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-10-08T15:33:38.240Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
Learnt from: GTFalcao
PR: PipedreamHQ/pipedream#12731
File: components/hackerone/actions/get-members/get-members.mjs:3-28
Timestamp: 2024-07-04T18:11:59.822Z
Learning: When exporting a summary message in the `run` method of an action, ensure the message is correctly formatted. For example, in the `hackerone-get-members` action, the correct format is `Successfully retrieved ${response.data.length} members`.
🔇 Additional comments (34)
components/joggai/joggai.app.mjs (1)
11-11: Consistent newline addition – LGTMTrailing newline aligns with POSIX/text-editor conventions and keeps diffs clean. No further action needed.
components/pinghome/pinghome.app.mjs (1)
11-11: Consistent newline addition – LGTMSame harmless formatting tweak, improves diff clarity.
components/asters/asters.app.mjs (1)
11-11: Consistent newline addition – LGTMNo functional impact; keeps file endings uniform across repo.
components/neetoform/neetoform.app.mjs (1)
11-11: Consistent newline addition – LGTMMatches formatting standards; nothing else to note.
components/zenedu/zenedu.app.mjs (1)
11-11: Consistent newline addition – LGTMUniform file ending maintained; no code changes required.
components/bitget/bitget.app.mjs (1)
11-12: Trailing newline added – no issuesOnly a formatting touch; functionality stays unchanged.
components/prepr_graphql/prepr_graphql.app.mjs (1)
11-12: Trailing newline added – no issuesPurely stylistic; implementation is intact.
components/vincario/vincario.app.mjs (1)
11-12: Trailing newline added – no issuesLGTM; nothing else to address.
components/explorium/explorium.app.mjs (1)
11-12: Trailing newline added – no issuesNo functional impact detected.
components/sign_plus/sign_plus.app.mjs (1)
11-12: Trailing newline added – no issuesLooks good; consistent formatting gain.
components/prodatakey/prodatakey.app.mjs (1)
11-12: Newline at EOF improves tooling compatibilityAdding a trailing newline silences common linters and aligns with POSIX text-file conventions. No further action needed.
components/mumble/mumble.app.mjs (1)
11-12: Consistent trailing newline retainedSame minor formatting fix as in sibling components—keeps diff noise low in future commits.
components/adtraction/adtraction.app.mjs (1)
11-12: Trailing newline addition acknowledgedNo functional changes; helps maintain uniform file endings across the repo.
components/themarketer/themarketer.app.mjs (1)
11-12: EOF newline keeps linters happyNothing else to flag here.
components/salesforge/salesforge.app.mjs (1)
11-12: Formatting tweak acceptedTrailing newline is a harmless, beneficial style update.
components/order_sender/order_sender.app.mjs (1)
11-12: Consistent newline at EOF looks goodAdding the trailing newline maintains POSIX compliance and keeps formatting consistent across components.
components/apify/sources/new-finished-task-run-instant/new-finished-task-run-instant.mjs (1)
9-9: Patch version looks good
No functional deltas detected. 👍components/apify/README.md (1)
9-9: Consistency win
Capitalizing “Actor” improves branding consistency. Nice catch.components/apify/actions/set-key-value-store-record/set-key-value-store-record.mjs (1)
8-8: Version increment looks good.The version bump from "0.0.3" to "0.0.4" is appropriate for this maintenance update and aligns with coordinated version increments across other Apify components.
components/apify/package.json (2)
3-3: Package version increment is appropriate.The version bump from "0.2.1" to "0.2.2" correctly reflects the coordinated maintenance updates across Apify components.
16-16: Good addition of constants dependency.Adding
@apify/constsdependency supports the replacement of hardcoded webhook event type strings with constants, improving code maintainability and consistency.components/apify/sources/new-finished-actor-run-instant/new-finished-actor-run-instant.mjs (3)
8-8: Good capitalization consistency improvement.Capitalizing "actor" to "Actor" in the description improves branding consistency across user-facing strings.
9-9: Version increment is consistent.The version bump from "0.0.3" to "0.0.4" aligns with coordinated updates across Apify components.
30-30: Consistent capitalization in summary message.Capitalizing "Actor" in the summary message maintains consistency with the description and other user-facing strings.
components/apify/actions/run-actor/run-actor.mjs (5)
9-9: Excellent branding consistency in description.Capitalizing "Actor" in the main description improves consistency with Apify's branding standards.
10-10: Version increment is properly coordinated.The version bump from "0.0.3" to "0.0.4" aligns with the coordinated maintenance updates across Apify components.
33-33: Consistent capitalization in property description.Capitalizing "Actor" in the runAsynchronously property description maintains consistency with other user-facing strings.
165-165: Proper capitalization in fallback description.Capitalizing "Actor" in the properties fallback description ensures consistency across all user-facing text.
244-245: Consistent capitalization in summary messages.Capitalizing "Actor" in both success summary messages maintains branding consistency and aligns with other user-facing strings throughout the component.
components/apify/apify.app.mjs (2)
53-53: Consistent branding improvement.Capitalizing "Actor" in the userActorId description maintains consistency with the branding improvements made across other Apify components.
166-166: Excellent addition of tracking header.Adding the
"x-apify-integration-platform": "pipedream"header aligns perfectly with the PR objectives to enhance monitoring and tracking of the Pipedream integration on the Apify platform.components/apify/sources/common/base.mjs (3)
1-1: LGTM! Good practice importing constants from shared package.This import eliminates magic strings and aligns with the PR objective of using constants from shared packages for standardization.
19-22: Excellent refactoring to use constants instead of hardcoded strings.Replacing the hardcoded event type strings with constants from
@apify/constsprovides several benefits:
- Eliminates risk of typos in event type strings
- Improves maintainability through centralized definitions
- Provides better IDE support with autocompletion
- Ensures consistency across the codebase
40-40: Good consistency using the TEST constant.The use of
WEBHOOK_EVENT_TYPES.TESTmaintains consistency with the other event type constants used throughout the file.
|
Deployment failed with the following error: |
dannyroosevelt
moved this to Ready for PR Review
in Component (Source and Action) Backlog
lcaresia
moved this from Ready for PR Review
to Ready for QA
in Component (Source and Action) Backlog
WHY
Into the Apify integration, we add small stuff:
Updated actor -> Actor naming
Use some consts from shared packages
Add tracking header to better deng and track pipedream integration on Apify
Summary by CodeRabbit