[yaml] Add enrichment transform to Beam YAML #32286

reeba212 · 2024-08-22T17:41:36Z

Added enrichment transform
Registered it in standard_providers.yaml
Added integration and unit tests for enrichment transform

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)

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

github-actions · 2024-08-22T20:34:46Z

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

sdks/python/apache_beam/yaml/yaml_enrichment.py

sdks/python/apache_beam/yaml/yaml_enrichment_test.py

github-actions · 2024-09-19T16:06:50Z

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

R: @shunping for label python.

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).

shunping · 2024-09-19T18:16:13Z

Thanks for contributing to Beam, @reeba212!

I see there is some lint problem you will need to fix in your code: https://github.com/apache/beam/actions/runs/10944933393/job/30387980829?pr=32286

Then, I also see the errors on when import feast package. Currently feast is not on our dependency list (i.e. setup.py), that's why those tests fail.

target/.tox-py310-cloud/py310-cloud/lib/python3.10/site-packages/apache_beam/yaml/yaml_enrichment.py:22: in <module>
    from apache_beam.transforms.enrichment_handlers.feast_feature_store import FeastFeatureStoreEnrichmentHandler
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

    #
    # Licensed to the Apache Software Foundation (ASF) under one or more
    # contributor license agreements.  See the NOTICE file distributed with
    # this work for additional information regarding copyright ownership.
    # The ASF licenses this file to You under the Apache License, Version 2.0
    # (the "License"); you may not use this file except in compliance with
    # the License.  You may obtain a copy of the License at
    #
    #    http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS,
    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    # See the License for the specific language governing permissions and
    # limitations under the License.
    #
    import logging
    import tempfile
    from pathlib import Path
    from typing import Any
    from typing import Callable
    from typing import List
    from typing import Mapping
    from typing import Optional
    
    import apache_beam as beam
    from apache_beam.io.filesystems import FileSystems
    from apache_beam.transforms.enrichment import EnrichmentSourceHandler
    from apache_beam.transforms.enrichment_handlers.utils import ExceptionLevel
>   from feast import FeatureStore
E   ModuleNotFoundError: No module named 'feast'

target/.tox-py310-cloud/py310-cloud/lib/python3.10/site-packages/apache_beam/transforms/enrichment_handlers/feast_feature_store.py:30: ModuleNotFoundError

@Polber, what's the plan for supporting the enrichment transform? To make tests green, we have a few options. For example:

including feast as the standard dependency of beam,
decorating yaml tests with "@pytest.mark.uses_feast", or
totally ignoring the feast handler.

What do you think?

Polber

Left a couple comments to hopefully get tests green!

sdks/python/apache_beam/yaml/yaml_enrichment.py

github-actions · 2024-09-27T12:14:24Z

Reminder, please take a look at this pr: @shunping

shunping

Some tests are still failing. Could you please fix them?

1. Added links for different handlers and removed code for unreachable conditions 2. Removed patch decorator in test

robertwb · 2024-10-03T20:30:43Z

sdks/python/apache_beam/yaml/integration_tests.py

@@ -69,7 +69,7 @@ def temp_bigquery_table(project, prefix='yaml_bq_it_'):
  dataset_id = '%s_%s' % (prefix, uuid.uuid4().hex)
  bigquery_client.get_or_create_dataset(project, dataset_id)
  logging.info("Created dataset %s in project %s", dataset_id, project)
-  yield f'{project}:{dataset_id}.tmp_table'
+  yield f'{project}.{dataset_id}.tmp_table'


Was this change needed?

IIRC this is reused by EnrichmentTransform's BQ handler which uses the non-legacy form and BigQueryIO accepts both, so this should be safe

robertwb · 2024-10-03T20:37:47Z

sdks/python/apache_beam/yaml/yaml_enrichment.py

+from apache_beam.yaml import options
+
+try:
+  from apache_beam.transforms.enrichment import Enrichment


Perhaps not to fix in this PR (but if not let's file a bug). It seems that Enrichment itself should not require GCP, only specific handlers.

+1

I think the only class imported is a custom Exception class

robertwb · 2024-10-03T20:39:46Z

sdks/python/apache_beam/yaml/yaml_provider.py

-        raise ValueError(
-            f'Unable to instantiate provider of type {type} '
-            f'at line {SafeLineLoader.get_line(spec)}: {exn}') from exn
+        if isinstance(exn, ModuleNotFoundError) and config.get('requires_gcp',


Why is this needed in addition to the import guards in yaml_enrichment.py?

It would also be better to get an error on an attempted use rather than a print statement whenever this is imported without [gcp] installed.

Ah you're right this isn't needed anymore. This was my initial solution for another test failure before I realized the imports needed to be disabled entirely to fix another test suite. I think this is redundant and misleading as you said at this point.

@reeba212 I added some comments on what to remove!

sdks/python/apache_beam/yaml/standard_providers.yaml

sdks/python/apache_beam/yaml/yaml_provider.py

Polber · 2024-10-08T19:58:58Z

@robertwb Do you mind taking another look?

github-actions · 2024-10-16T12:14:24Z

Reminder, please take a look at this pr: @shunping

github-actions bot added python yaml labels Aug 22, 2024

reeba212 changed the title ~~Add enrichment transform to Beam YAML~~ [yaml] Add enrichment transform to Beam YAML Aug 22, 2024

Polber suggested changes Aug 23, 2024

View reviewed changes

sdks/python/apache_beam/yaml/yaml_enrichment.py Outdated Show resolved Hide resolved

sdks/python/apache_beam/yaml/yaml_enrichment.py Outdated Show resolved Hide resolved

sdks/python/apache_beam/yaml/yaml_enrichment_test.py Outdated Show resolved Hide resolved

reeba212 force-pushed the enrichment-yaml branch from d9bff19 to 7ebba51 Compare September 19, 2024 15:16

github-actions bot added the Next Action: Reviewers label Sep 19, 2024

Polber suggested changes Sep 19, 2024

View reviewed changes

sdks/python/apache_beam/yaml/yaml_enrichment.py Outdated Show resolved Hide resolved

sdks/python/apache_beam/yaml/yaml_enrichment.py Show resolved Hide resolved

github-actions bot added the slow-review label Sep 27, 2024

shunping suggested changes Sep 30, 2024

View reviewed changes

reeba212 and others added 8 commits October 3, 2024 23:17

Create yaml_enrichment.py

54576c3

Create yaml_enrichment_test.py

02a22bc

Create enrichment integration test

f9fc865

Register enrichment transform in standard_providers.yaml

ba2b10e

minor changes

788e4a2

1. Added links for different handlers and removed code for unreachable conditions 2. Removed patch decorator in test

minor updates

e20166d

fixing lint failures

ee6258e

disable feast if not installed

c647e47

github-actions bot added java go build website infra examples docker io extensions labels Oct 3, 2024

github-actions bot removed infra examples docker io extensions runners learning spark dataflow gcp kafka mqtt typescript spanner bigtable prism labels Oct 3, 2024

reeba212 force-pushed the enrichment-yaml branch from b176898 to c647e47 Compare October 3, 2024 17:57

reeba212 added 2 commits October 3, 2024 23:36

fix failures

e917933

separate block for feast import error

e24ea06

Polber approved these changes Oct 3, 2024

View reviewed changes

robertwb reviewed Oct 3, 2024

View reviewed changes

Polber reviewed Oct 3, 2024

View reviewed changes

sdks/python/apache_beam/yaml/standard_providers.yaml Outdated Show resolved Hide resolved

Polber reviewed Oct 3, 2024

View reviewed changes

sdks/python/apache_beam/yaml/yaml_provider.py Outdated Show resolved Hide resolved

Polber reviewed Oct 3, 2024

View reviewed changes

sdks/python/apache_beam/yaml/yaml_provider.py Outdated Show resolved Hide resolved

minor changes

c288f1a

github-actions bot removed the slow-review label Oct 8, 2024

github-actions bot added the slow-review label Oct 16, 2024

liferoad merged commit 33fdb23 into apache:master Oct 17, 2024
93 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[yaml] Add enrichment transform to Beam YAML #32286

[yaml] Add enrichment transform to Beam YAML #32286

reeba212 commented Aug 22, 2024

github-actions bot commented Aug 22, 2024

github-actions bot commented Sep 19, 2024

shunping commented Sep 19, 2024

Polber left a comment

github-actions bot commented Sep 27, 2024

shunping left a comment

robertwb Oct 3, 2024

Polber Oct 3, 2024

robertwb Oct 3, 2024

Polber Oct 3, 2024

robertwb Oct 3, 2024

Polber Oct 3, 2024

Polber commented Oct 8, 2024

github-actions bot commented Oct 16, 2024

[yaml] Add enrichment transform to Beam YAML #32286

[yaml] Add enrichment transform to Beam YAML #32286

Conversation

reeba212 commented Aug 22, 2024

GitHub Actions Tests Status (on master branch)

github-actions bot commented Aug 22, 2024

github-actions bot commented Sep 19, 2024

shunping commented Sep 19, 2024

Polber left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 27, 2024

shunping left a comment

Choose a reason for hiding this comment

robertwb Oct 3, 2024

Choose a reason for hiding this comment

Polber Oct 3, 2024

Choose a reason for hiding this comment

robertwb Oct 3, 2024

Choose a reason for hiding this comment

Polber Oct 3, 2024

Choose a reason for hiding this comment

robertwb Oct 3, 2024

Choose a reason for hiding this comment

Polber Oct 3, 2024

Choose a reason for hiding this comment

Polber commented Oct 8, 2024

github-actions bot commented Oct 16, 2024