Add search action for spotify #18791

[lcaresia]

WHY

Summary by CodeRabbit

• New Features
  • Added Spotify Search: search across tracks, albums, artists, playlists, shows, and episodes with query, type selection, market, limit/offset pagination, and optional external audio inclusion.
• Improvements
  • Expanded type selection options for more precise searches.
• Chores
  • Spotify component version updated for release.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
pipedream-docs	Ignored			Dec 3, 2025 5:09pm
pipedream-docs-redirect-do-not-edit	Ignored			Dec 3, 2025 5:09pm

[coderabbitai]

Walkthrough

Adds a new Spotify "Search" action and supporting constant, exposes a new search method on the Spotify app, and includes multiple Spotify component version bumps.

Changes

Cohort / File(s)	Summary
Search Action Implementation components/spotify/actions/search/search.mjs	New action "spotify-search": metadata, props for spotify, query, type, market, limit, offset, includeExternal; input validation (non-empty query, ≥1 type); maps params and calls this.spotify.search; returns response and sets $summary.
Spotify App API components/spotify/spotify.app.mjs	Added async search(params) method that performs a GET to /search via the existing _makeRequest helper and returns response data.
Constants Definition components/spotify/consts.mjs	Added ITEM_TYPES_LIST export: array of { label, value } entries mapping Album/Artist/Playlist/Track/Show/Episode to ITEM_TYPES values; used for type prop options and defaults.
Actions & Sources Version Bumps components/spotify/actions/.../*.mjs, components/spotify/sources/.../*.mjs	Multiple actions and sources had only their exported version incremented (e.g., add-items-to-playlist, create-playlist, get-playlist, get-playlist-items, get-recommendations, get-track, remove-items-from-playlist, remove-user-saved-tracks, save-track, get-artist-top-tracks, get-audio-features-for-a-track, get-categorys-playlist, get-currently-playing-track, get-all-tracks-by-artist, get-album-tracks, plus sources new-playlist, new-saved-track, new-track-by-artist, new-track-in-playlist). No behavioral changes.
Package Version components/spotify/package.json	Bumped package version from 0.7.3 to 0.7.4.

Sequence Diagram(s)

sequenceDiagram
  participant User as Action (Search)
  participant App as Spotify App
  participant API as Spotify API

  User->>App: call this.spotify.search({ q, type, market, limit, offset, include_external })
  App->>API: GET /search?q=...&type=...&market=...&limit=...&offset=...&include_external=...
  API-->>App: 200 OK (search results)
  App-->>User: returns results

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20–30 minutes

• Review input validation and type handling in search.mjs (ensuring ITEM_TYPES_LIST mapping and defaults are correct).
• Verify parameter mapping to Spotify API keys (include_external naming and type comma-joining).
• Inspect spotify.app.mjs _makeRequest usage and error propagation in new search method.
• Quick scan of version-only bumps to ensure no unintended edits.

Suggested labels

User submitted

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is incomplete; the 'WHY' section is present but entirely empty with only the comment placeholder.	Complete the 'WHY' section to explain the purpose, motivation, and reasoning behind adding the search action for Spotify.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add search action for spotify #18791' clearly summarizes the main change: introducing a new search action for the Spotify integration.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch issue-18791

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ac28627 and bdb4a75.

📒 Files selected for processing (19)

• components/spotify/actions/add-items-to-playlist/add-items-to-playlist.mjs (1 hunks)
• components/spotify/actions/create-playlist/create-playlist.mjs (1 hunks)
• components/spotify/actions/get-album-tracks/get-album-tracks.mjs (1 hunks)
• components/spotify/actions/get-all-tracks-by-artist/get-all-tracks-by-artist.mjs (1 hunks)
• components/spotify/actions/get-artist-top-tracks/get-artist-top-tracks.mjs (1 hunks)
• components/spotify/actions/get-audio-features-for-a-track/get-audio-features-for-a-track.mjs (1 hunks)
• components/spotify/actions/get-categorys-playlist/get-categorys-playlist.mjs (1 hunks)
• components/spotify/actions/get-currently-playing-track/get-currently-playing-track.mjs (1 hunks)
• components/spotify/actions/get-playlist-items/get-playlist-items.mjs (1 hunks)
• components/spotify/actions/get-playlist/get-playlist.mjs (1 hunks)
• components/spotify/actions/get-recommendations/get-recommendations.mjs (1 hunks)
• components/spotify/actions/get-track/get-track.mjs (1 hunks)
• components/spotify/actions/remove-items-from-playlist/remove-items-from-playlist.mjs (1 hunks)
• components/spotify/actions/remove-user-saved-tracks/remove-user-saved-tracks.mjs (1 hunks)
• components/spotify/actions/save-track/save-track.mjs (1 hunks)
• components/spotify/sources/new-playlist/new-playlist.mjs (1 hunks)
• components/spotify/sources/new-saved-track/new-saved-track.mjs (1 hunks)
• components/spotify/sources/new-track-by-artist/new-track-by-artist.mjs (1 hunks)
• components/spotify/sources/new-track-in-playlist/new-track-in-playlist.mjs (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 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/spotify/actions/get-recommendations/get-recommendations.mjs

⏰ 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: Publish TypeScript components
• GitHub Check: Verify TypeScript components
• GitHub Check: Lint Code Base

🔇 Additional comments (23)

components/spotify/actions/get-playlist-items/get-playlist-items.mjs (1)

9-9: Version bump to 0.1.4 looks consistent and safe

Only the action version field changed; with no logic modifications, this is a straightforward metadata bump and is fine to ship.

components/spotify/actions/remove-user-saved-tracks/remove-user-saved-tracks.mjs (1)

8-8: Version bump to 0.1.4 looks appropriate

Only the public version field changed; runtime behavior is untouched, so a patch-level bump is consistent and safe.

components/spotify/actions/save-track/save-track.mjs (1)

9-9: Version bump is appropriate.

The patch version increment (0.1.3 → 0.1.4) is reasonable as part of this PR's broader component versioning update accompanying the new Spotify search action feature.

components/spotify/actions/get-currently-playing-track/get-currently-playing-track.mjs (1)

10-10: Version bump is a side effect of unreviewed changes.

Only a version bump has been provided for this file, yet the AI summary indicates the PR also introduces a new search action, a new constant, and app-level method changes. This version bump appears to be a cascading change, but without reviewing the core search implementation and supporting infrastructure, I cannot assess the full impact of this PR.

To properly review this PR, I need access to all changed files, particularly:

• The new search action: components/spotify/actions/search/search.mjs
• Updated constants: components/spotify/consts.mjs (new ITEM_TYPES_LIST export)
• Updated app interface: components/spotify/spotify.app.mjs (new search method)
• Updated package manifest: components/spotify/package.json (if version bumped)

Can you provide the complete set of changed files for this PR?

components/spotify/actions/add-items-to-playlist/add-items-to-playlist.mjs (1)

9-9: Version bump for action consistency.

Line 9 bumps the version from 0.1.3 to 0.1.4, which aligns with the broader PR objective to add new Spotify capabilities. The existing code logic and behavior remain unchanged.

Please verify that this version increment is coordinated across all other Spotify actions being bumped in this PR to ensure consistency with your versioning strategy.

components/spotify/actions/get-recommendations/get-recommendations.mjs (1)

8-8: Version bump aligns with PR pattern.

The version bump from 0.1.3 to 0.1.4 is consistent with the broader metadata updates across multiple Spotify action files in this PR, as indicated by the PR context.

components/spotify/actions/get-all-tracks-by-artist/get-all-tracks-by-artist.mjs (1)

8-8: Version bump appropriate for coordinated Spotify feature additions.

Line 8 shows the version appropriately bumped from 0.1.3 to 0.1.4 as part of the search action feature addition to the Spotify integration. The existing action code remains unchanged and compatible.

components/spotify/actions/get-audio-features-for-a-track/get-audio-features-for-a-track.mjs (2)

1-35: LGTM on code logic and structure.

The action implementation is sound: proper use of axios through Pipedream's platform, correct API path construction, and safe field access via lodash/get. No logic, security, or runtime concerns.

---

9-9: Clarify the rationale for the version bump.

The version is being incremented from 0.1.3 to 0.1.4 despite no changes to the action's logic or behavior. Per the PR description, this is part of "multiple Spotify component version bumps," but best practice typically reserves version increments for actual code or behavior changes.

Please confirm whether this version bump is:

• Intentional for package-wide consistency/release strategy, or
• Part of the new search action feature's versioning alignment.

components/spotify/actions/get-categorys-playlist/get-categorys-playlist.mjs (1)

9-9: Verify the rationale for version bump without code changes.

This file's version is being incremented from "0.1.3" to "0.1.4" with no accompanying functional changes. While this may be part of a coordinated module-wide version update strategy, it's worth confirming whether this bump is necessary, as semantic versioning typically reserves patch increments for actual bug fixes or changes.

If this is part of a dependency update (e.g., the Spotify app or shared constants changed), consider documenting that pattern. Otherwise, unnecessary version bumps can create confusion in the version history.

components/spotify/sources/new-track-by-artist/new-track-by-artist.mjs (1)

10-10: LGTM: Version bump aligns with PR objectives.

The version increment from 0.1.2 to 0.1.3 is a metadata-only change that aligns with the broader component updates in this PR.

components/spotify/sources/new-playlist/new-playlist.mjs (1)

9-9: LGTM: Version bump is consistent with other source updates.

The patch version increment is metadata-only and aligns with the component-wide version updates in this PR.

components/spotify/actions/get-playlist/get-playlist.mjs (1)

7-7: LGTM: Version bump is appropriate.

The patch version increment from 0.0.4 to 0.0.5 is a metadata-only change consistent with the component updates.

components/spotify/sources/new-track-in-playlist/new-track-in-playlist.mjs (1)

10-10: LGTM: Version bump is consistent.

The version increment to 0.1.3 is a metadata-only change that maintains consistency with other source components.

components/spotify/actions/remove-items-from-playlist/remove-items-from-playlist.mjs (1)

9-9: LGTM: Version bump aligns with action updates.

The patch version increment from 0.1.3 to 0.1.4 is metadata-only and consistent with other action version updates in this PR.

components/spotify/actions/create-playlist/create-playlist.mjs (1)

8-8: LGTM: Version bump is appropriate.

The version increment to 0.1.4 is a metadata-only change consistent with the component-wide updates.

components/spotify/actions/get-artist-top-tracks/get-artist-top-tracks.mjs (1)

9-9: LGTM: Version bump follows the consistent pattern.

The patch version increment from 0.1.3 to 0.1.4 is metadata-only and aligns with other action version updates.

components/spotify/sources/new-saved-track/new-saved-track.mjs (1)

9-9: LGTM: Version bump completes the consistent update pattern.

The version increment to 0.1.3 is metadata-only and maintains consistency with the other source component updates in this PR.

components/spotify/actions/get-album-tracks/get-album-tracks.mjs (3)

1-68: Request comprehensive file coverage for this PR.

The PR description mentions adding a search action and updating multiple Spotify components. However, only this file (get-album-tracks) was provided for review, which shows only a version bump with no functional changes.

To provide a thorough review of the PR objectives, please provide the other modified files, particularly:

• components/spotify/actions/search/search.mjs (new search action)
• components/spotify/consts.mjs (new constants)
• components/spotify/spotify.app.mjs (updated app with search method)

---

10-10: ITEM_TYPES import is valid; clarify the justification for the version bump.

The import of ITEM_TYPES from consts.mjs (line 3) is valid—the constant is properly exported. However, the version bump to "0.0.4" appears unrelated to changes in this file per the AI summary. Confirm this version bump is coordinated with changes in other files updated in this PR (e.g., the search action, app.mjs, or package.json).

---

52-60: Pagination logic is correct and handles edge cases properly.

The implementation correctly retrieves all album tracks through offset-based pagination. The loop terminates when the API returns fewer items than the requested limit, which is the standard behavior for Spotify's paginated endpoints. The offset is properly incremented within each iteration, and this pattern aligns with other pagination implementations in the Spotify component.

components/spotify/actions/get-track/get-track.mjs (2)

2-2: Update imports and version to support defensive property access.

The addition of the lodash/get import and version bump are appropriate for safely handling the trackId property extraction. The pattern used on line 40 gracefully handles both object values (with { value, label } structure from prop definitions) and primitive strings.

Also applies to: 9-9

---

40-40: The get(trackId, "value", trackId) pattern is standard across Spotify actions and requires no changes.

This defensive pattern is consistent across multiple Spotify actions (get-playlist-items, get-audio-features-for-a-track, get-artist-top-tracks, and others) and correctly handles props with useQuery and withLabel features, which automatically convert string values to objects with {value, label} properties. The fallback to trackId ensures backward compatibility with direct string values. However, this action lacks test coverage, which is consistent across the entire Spotify component.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[lcaresia]

Related with #18791

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17afb0a and ac28627.

📒 Files selected for processing (4)

• components/spotify/actions/search/search.mjs (1 hunks)
• components/spotify/consts.mjs (1 hunks)
• components/spotify/package.json (1 hunks)
• components/spotify/spotify.app.mjs (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-10-20T00:28:38.772Z

Learnt from: js07
Repo: PipedreamHQ/pipedream PR: 18744
File: components/slack/slack.app.mjs:0-0
Timestamp: 2025-10-20T00:28:38.772Z
Learning: In components/slack/slack.app.mjs, the assistantSearch method uses sdk().apiCall() directly instead of makeRequest because the slack/web-api npm package doesn't expose assistant.search.context as a method on WebClient. This direct usage is intentional and necessary when Slack API methods are not yet exposed in the SDK.

Applied to files:

• components/spotify/spotify.app.mjs

🧬 Code graph analysis (1)

components/spotify/actions/search/search.mjs (2)

components/spotify/consts.mjs (4)

• ITEM_TYPES_LIST (10-35)
• ITEM_TYPES_LIST (10-35)
• ITEM_TYPES (1-8)
• ITEM_TYPES (1-8)

components/spotify/spotify.app.mjs (6)

• res (343-343)
• res (361-361)
• res (365-365)
• res (369-369)
• res (373-373)
• res (378-378)

⏰ 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: Publish TypeScript components
• GitHub Check: Verify TypeScript components
• GitHub Check: pnpm publish
• GitHub Check: Lint Code Base

🔇 Additional comments (3)

components/spotify/package.json (1)

3-3: Version bump aligns with new functionality

Package version increment to 0.7.4 is consistent with the addition of a new action and app method; no issues found.

components/spotify/consts.mjs (1)

10-35: ITEM_TYPES_LIST is consistent and avoids string duplication

The new ITEM_TYPES_LIST cleanly reuses ITEM_TYPES values and provides clear labels for all supported item types; this should work well as a shared options source.

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

389-392: search() wrapper is consistent with existing app methods

The new search(params) method follows the same _makeRequest + { data } pattern as other helpers (e.g., getGenres, getRecommendations), and is an appropriate low-level wrapper for the action to consume.

[GTFalcao]

LGTM!

[vunguyenhung]

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

Test reports

• Add search action for spotify Add search action for spotify #18791 - Actions Batch 2: https://www.notion.so/Add-search-action-for-spotify-18791-Actions-Batch-2-2-2bebf548bb5e81f697b3ead7bc4c684a