Skip to content

Add filter() method to PCollection in TypeScript SDK#37408

Merged
damccorm merged 1 commit intoapache:masterfrom
junaiddshaukat:add-filter-method-typescript-sdk
Jan 26, 2026
Merged

Add filter() method to PCollection in TypeScript SDK#37408
damccorm merged 1 commit intoapache:masterfrom
junaiddshaukat:add-filter-method-typescript-sdk

Conversation

@junaiddshaukat
Copy link
Contributor

Description:

Adds a filter() method to the PCollection class in the TypeScript SDK, addressing a TODO from README-dev.md.

Fixes #37407

Changes

  • Added filter() method to PCollection class in pvalue.ts
  • Added 5 test cases for the filter functionality in primitives_test.ts

Usage Examples

// Basic filtering
const evens = pcoll.filter(x => x % 2 === 0);

// Filter with context
const filtered = pcoll.filter((x, threshold) => x > threshold, 5);

// Filter strings
const aWords = words.filter(s => s.startsWith('a'));

Implementation Details

  • Follows the same pattern as existing map() and flatMap() methods
  • Uses parDo internally with a process function that returns [element] or []
  • Supports optional context parameter for side inputs, counters, etc.
  • Added proper TypeScript constraint (ContextT extends Object | undefined) to match parDo signature

Tests Added

Test Case Description
runs a filter Basic even number filtering
runs a filter with predicate returning false for all Empty result case
runs a filter with predicate returning true for all All elements pass
runs a filter with context Context parameter support
runs a filter on strings Non-numeric type support

Checklist

  • Tests added and passing (297 tests total)
  • Follows existing code patterns (map, flatMap)
  • Documentation added (JSDoc comments with examples)
  • Mention the appropriate issue in your description

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

- Add filter() method following same pattern as map() and flatMap()
- Add 5 test cases covering various filtering scenarios
- Support optional context parameter for side inputs
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @junaiddshaukat, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the TypeScript SDK by introducing a filter() method to the PCollection class. This addition provides a familiar and powerful way to selectively process data within a pipeline, allowing users to easily retain only the elements that meet specific criteria. The implementation is robust, leveraging existing primitives and supporting flexible predicate functions, including those that require additional context.

Highlights

  • New filter() method for PCollection: A filter() method has been added to the PCollection class in the TypeScript SDK, allowing users to filter elements based on a provided predicate function. This addresses a TODO item from README-dev.md and mirrors the functionality of JavaScript's Array.filter().
  • Internal Implementation using parDo: The filter() method is implemented internally using the existing parDo primitive. It leverages a process function that returns the element wrapped in an array if the predicate is true, or an empty array if false, effectively filtering the PCollection.
  • Context Parameter Support: The new filter() method supports an optional context parameter, allowing the predicate function to access side inputs, counters, or other contextual data, aligning with the parDo signature.
  • Comprehensive Test Coverage: Five new test cases have been added to primitives_test.ts to validate the filter() functionality. These tests cover basic filtering, cases where all or no elements pass, filtering with context, and filtering on string types.
  • Documentation and Code Patterns: The filter() method includes JSDoc comments with usage examples. Its implementation follows the established patterns of existing map() and flatMap() methods within the SDK.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@junaiddshaukat
Copy link
Contributor Author

Hi @damccorm

This PR adds a filter() method to PCollection, addressing the TODO in README-dev.md. It follows the same pattern as map() and flatMap() with 5 test cases covering various scenarios.

Fixes #37407

Would appreciate your review when you have time. Thanks!

@github-actions
Copy link
Contributor

Assigning reviewers:

R: @damccorm added as fallback since no labels match configuration

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

@damccorm
Copy link
Contributor

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a filter() method to the PCollection class in the TypeScript SDK, which is a great and much-needed addition. The implementation correctly follows the pattern of existing methods like map() and flatMap(), and it's backed by a comprehensive set of test cases that cover various scenarios including edge cases and context usage.

I have one suggestion to refine the implementation by using a generator function. This would align it more closely with the map() method's implementation and could offer a minor performance benefit by avoiding unnecessary array allocations.

Overall, this is a solid contribution. Well done!

Copy link
Contributor

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM

@damccorm damccorm merged commit 911ec6a into apache:master Jan 26, 2026
7 checks passed
aIbrahiim pushed a commit to aIbrahiim/beam that referenced this pull request Jan 28, 2026
- Add filter() method following same pattern as map() and flatMap()
- Add 5 test cases covering various filtering scenarios
- Support optional context parameter for side inputs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request]: Add filter() method to PCollection in TypeScript SDK

2 participants