You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2021/02/01 20:42:33 UTC
[GitHub] [beam] lostluck opened a new pull request #13872: [BEAM-9918] Support Tagged external PTransforms
lostluck opened a new pull request #13872:
URL: https://github.com/apache/beam/pull/13872
Support user side direction of cross language or external transforms.
Often the runners have their own mechanism for interpretting a URN + Payload, but that payload may contain data to specify how to route the inputs and outputs. ExternalTagged permits users to provide local tags for the input PCollections and output PCollection types to assist with this routing.
Later changes may want to add variadic Options to External and ExternalTagged to support Artifact provisioning, and Environment setting, though preferablly without using the beam protos directly in the API. (Similarly for ParDo as well).
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [ ] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
Post-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
Lang | SDK | Dataflow | Flink | Samza | Spark | Twister2
--- | --- | --- | --- | --- | --- | ---
Go | [](https://ci-beam.apache.org/job/beam_PostCommit_Go/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Spark/lastCompletedBuild/) | ---
Java | [](https://ci-beam.apache.org/job/beam_PostCommit_Java/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Java11/lastCompletedBuild/) | [](https://ci-beam
.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Java11/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Streaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Spark_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_SparkStructuredStreaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Twister2/lastCompletedBuild/)
Python | [](https://ci-beam.apache.org/job/beam_PostCommit_Python36/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python37/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python38/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_PVR_Flink_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Spark/lastCompletedBuild/) | ---
XLang | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Direct/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Dataflow/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Spark/lastCompletedBuild/) | ---
Pre-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
--- |Java | Python | Go | Website | Whitespace | Typescript
--- | --- | --- | --- | --- | --- | ---
Non-portable | [](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonLint_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocker_Cron/lastCompletedBuild/) <br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocs_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Website_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Whitespace_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Typescript_Cron/lastCompletedBuild/)
Portable | --- | [](https://ci-beam.apache.org/job/beam_PreCommit_Portable_Python_Cron/lastCompletedBuild/) | --- | --- | --- | ---
See [.test-infra/jenkins/README](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md) for trigger phrase, status and link of all Jenkins jobs.
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] lostluck commented on pull request #13872: [BEAM-9918] Support Tagged external PTransforms
Posted by GitBox <gi...@apache.org>.
lostluck commented on pull request #13872:
URL: https://github.com/apache/beam/pull/13872#issuecomment-771144647
R: @youngoli @robertwb
CC: @ananvay @tysonjh
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] lostluck commented on a change in pull request #13872: [BEAM-9918] Support Tagged external PTransforms
Posted by GitBox <gi...@apache.org>.
lostluck commented on a change in pull request #13872:
URL: https://github.com/apache/beam/pull/13872#discussion_r572323357
##########
File path: sdks/go/pkg/beam/external_test.go
##########
@@ -0,0 +1,104 @@
+// 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.
+
+package beam
+
+import (
+ "bytes"
+ "context"
+ "strings"
+ "testing"
+
+ "github.com/apache/beam/sdks/go/pkg/beam/core/runtime/graphx"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/typex"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/util/reflectx"
+ "github.com/apache/beam/sdks/go/pkg/beam/options/jobopts"
+)
+
+func TestExternalTagged(t *testing.T) {
+ urn := "my::test::urn"
+ payload := []byte("expected_payload")
+ inTag := "inTag"
+ outTag := "outTag"
+
+ p := NewPipeline()
+ s := p.Root()
+
+ col := Impulse(s)
+ ft := typex.New(reflectx.ByteSlice)
+ outMap := ExternalTagged(s, urn, payload, map[string]PCollection{inTag: col}, map[string]FullType{outTag: ft}, true)
+
+ // Validate the in-construction PCollection types for ExternalTagged.
+ if len(outMap) != 1 {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ out, ok := outMap[outTag]
+ if !ok {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ if !typex.IsEqual(out.Type(), ft) {
+ t.Fatalf("ExternalTagged()[%q].Type() = %v, want %v", outTag, out.Type(), ft)
+ }
+
+ // Validate the post-construction pipeline protocol buffer contents.
+
+ ctx := context.Background()
+ envUrn := jobopts.GetEnvironmentUrn(ctx)
Review comment:
In this case, you're right a filled in environment isn't necessary. Cleaned up.
##########
File path: sdks/go/pkg/beam/external_test.go
##########
@@ -0,0 +1,104 @@
+// 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.
+
+package beam
+
+import (
+ "bytes"
+ "context"
+ "strings"
+ "testing"
+
+ "github.com/apache/beam/sdks/go/pkg/beam/core/runtime/graphx"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/typex"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/util/reflectx"
+ "github.com/apache/beam/sdks/go/pkg/beam/options/jobopts"
+)
+
+func TestExternalTagged(t *testing.T) {
+ urn := "my::test::urn"
+ payload := []byte("expected_payload")
+ inTag := "inTag"
+ outTag := "outTag"
+
+ p := NewPipeline()
+ s := p.Root()
+
+ col := Impulse(s)
+ ft := typex.New(reflectx.ByteSlice)
+ outMap := ExternalTagged(s, urn, payload, map[string]PCollection{inTag: col}, map[string]FullType{outTag: ft}, true)
+
+ // Validate the in-construction PCollection types for ExternalTagged.
+ if len(outMap) != 1 {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ out, ok := outMap[outTag]
+ if !ok {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ if !typex.IsEqual(out.Type(), ft) {
+ t.Fatalf("ExternalTagged()[%q].Type() = %v, want %v", outTag, out.Type(), ft)
+ }
+
+ // Validate the post-construction pipeline protocol buffer contents.
+
+ ctx := context.Background()
+ envUrn := jobopts.GetEnvironmentUrn(ctx)
+ getEnvCfg := jobopts.GetEnvironmentConfig
+ environment, err := graphx.CreateEnvironment(ctx, envUrn, getEnvCfg)
+ if err != nil {
+ t.Fatalf("Couldn't create environment build: %v", err)
+ }
+
+ edges, _, err := p.Build()
+ if err != nil {
+ t.Fatalf("Pipeline couldn't build: %v", err)
+ }
+ pb, err := graphx.Marshal(edges, &graphx.Options{Environment: environment})
+ if err != nil {
+ t.Fatalf("Couldn't graphx.Marshal edges: %v", err)
+ }
+ components := pb.GetComponents()
+ transforms := components.GetTransforms()
+
+ foundExternalTagged := false
+ for _, transform := range transforms {
+ spec := transform.GetSpec()
Review comment:
Ooo good catch. Thanks!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] youngoli commented on a change in pull request #13872: [BEAM-9918] Support Tagged external PTransforms
Posted by GitBox <gi...@apache.org>.
youngoli commented on a change in pull request #13872:
URL: https://github.com/apache/beam/pull/13872#discussion_r569118176
##########
File path: sdks/go/pkg/beam/external_test.go
##########
@@ -0,0 +1,104 @@
+// 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.
+
+package beam
+
+import (
+ "bytes"
+ "context"
+ "strings"
+ "testing"
+
+ "github.com/apache/beam/sdks/go/pkg/beam/core/runtime/graphx"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/typex"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/util/reflectx"
+ "github.com/apache/beam/sdks/go/pkg/beam/options/jobopts"
+)
+
+func TestExternalTagged(t *testing.T) {
+ urn := "my::test::urn"
+ payload := []byte("expected_payload")
+ inTag := "inTag"
+ outTag := "outTag"
+
+ p := NewPipeline()
+ s := p.Root()
+
+ col := Impulse(s)
+ ft := typex.New(reflectx.ByteSlice)
+ outMap := ExternalTagged(s, urn, payload, map[string]PCollection{inTag: col}, map[string]FullType{outTag: ft}, true)
+
+ // Validate the in-construction PCollection types for ExternalTagged.
+ if len(outMap) != 1 {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ out, ok := outMap[outTag]
+ if !ok {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ if !typex.IsEqual(out.Type(), ft) {
+ t.Fatalf("ExternalTagged()[%q].Type() = %v, want %v", outTag, out.Type(), ft)
+ }
+
+ // Validate the post-construction pipeline protocol buffer contents.
+
+ ctx := context.Background()
+ envUrn := jobopts.GetEnvironmentUrn(ctx)
+ getEnvCfg := jobopts.GetEnvironmentConfig
+ environment, err := graphx.CreateEnvironment(ctx, envUrn, getEnvCfg)
+ if err != nil {
+ t.Fatalf("Couldn't create environment build: %v", err)
+ }
+
+ edges, _, err := p.Build()
+ if err != nil {
+ t.Fatalf("Pipeline couldn't build: %v", err)
+ }
+ pb, err := graphx.Marshal(edges, &graphx.Options{Environment: environment})
+ if err != nil {
+ t.Fatalf("Couldn't graphx.Marshal edges: %v", err)
+ }
+ components := pb.GetComponents()
+ transforms := components.GetTransforms()
+
+ foundExternalTagged := false
+ for _, transform := range transforms {
+ spec := transform.GetSpec()
Review comment:
This loop seems a bit strangely structured. From what I can tell it's just searching for the external transform by URN and then doing some checks, right? You could just put all the checks in the `if strings.Contains` statement and do all the validation at once, or if you want to avoid indentations, then reverse it by starting the loop with `if !strings.Contains { continue; }`.
##########
File path: sdks/go/pkg/beam/external_test.go
##########
@@ -0,0 +1,104 @@
+// 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.
+
+package beam
+
+import (
+ "bytes"
+ "context"
+ "strings"
+ "testing"
+
+ "github.com/apache/beam/sdks/go/pkg/beam/core/runtime/graphx"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/typex"
+ "github.com/apache/beam/sdks/go/pkg/beam/core/util/reflectx"
+ "github.com/apache/beam/sdks/go/pkg/beam/options/jobopts"
+)
+
+func TestExternalTagged(t *testing.T) {
+ urn := "my::test::urn"
+ payload := []byte("expected_payload")
+ inTag := "inTag"
+ outTag := "outTag"
+
+ p := NewPipeline()
+ s := p.Root()
+
+ col := Impulse(s)
+ ft := typex.New(reflectx.ByteSlice)
+ outMap := ExternalTagged(s, urn, payload, map[string]PCollection{inTag: col}, map[string]FullType{outTag: ft}, true)
+
+ // Validate the in-construction PCollection types for ExternalTagged.
+ if len(outMap) != 1 {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ out, ok := outMap[outTag]
+ if !ok {
+ t.Fatalf("ExternalTagged = %v, want 1 output with tag %q", outMap, outTag)
+ }
+ if !typex.IsEqual(out.Type(), ft) {
+ t.Fatalf("ExternalTagged()[%q].Type() = %v, want %v", outTag, out.Type(), ft)
+ }
+
+ // Validate the post-construction pipeline protocol buffer contents.
+
+ ctx := context.Background()
+ envUrn := jobopts.GetEnvironmentUrn(ctx)
Review comment:
It seems strange to use actual flags in a unit test unless they're meant to be set when calling `go test`. If you need the default flags, it seems better to explicitly set these to the default flag values in this function.
There is the situation where, if the default values are changed and it breaks this test then it will be caught, but that still feels more like something for an integration test to catch than a unit test.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] lostluck merged pull request #13872: [BEAM-9918] Support Tagged external PTransforms
Posted by GitBox <gi...@apache.org>.
lostluck merged pull request #13872:
URL: https://github.com/apache/beam/pull/13872
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org