[
https://issues.apache.org/jira/browse/BEAM-14347?focusedWorklogId=767916&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-767916
]
ASF GitHub Bot logged work on BEAM-14347:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 09/May/22 14:04
Start Date: 09/May/22 14:04
Worklog Time Spent: 10m
Work Description: damccorm commented on code in PR #17574:
URL: https://github.com/apache/beam/pull/17574#discussion_r868052710
##########
sdks/go/pkg/beam/registration/registration_test.go:
##########
@@ -155,6 +157,48 @@ func TestRegister_RegistersTypes(t *testing.T) {
}
}
+func TestEmitter1(t *testing.T) {
+ Emitter1[int]()
+ if !exec.IsEmitterRegistered(reflect.TypeOf((*func(int))(nil)).Elem()) {
+
t.Fatalf("exec.IsEmitterRegistered(reflect.TypeOf((*func(int))(nil)).Elem()) =
false, want true")
+ }
+}
+
+func TestEmitter2(t *testing.T) {
+ Emitter2[int, string]()
+ if !exec.IsEmitterRegistered(reflect.TypeOf((*func(int,
string))(nil)).Elem()) {
+ t.Fatalf("exec.IsEmitterRegistered(reflect.TypeOf((*func(int,
string))(nil)).Elem()) = false, want true")
+ }
+}
+
+func TestEmitter2_WithTimestamp(t *testing.T) {
+ Emitter2[typex.EventTime, string]()
+ if !exec.IsEmitterRegistered(reflect.TypeOf((*func(typex.EventTime,
string))(nil)).Elem()) {
+
t.Fatalf("exec.IsEmitterRegistered(reflect.TypeOf((*func(typex.EventTime,
string))(nil)).Elem()) = false, want true")
+ }
+}
+
+func TestEmitter3(t *testing.T) {
+ Emitter3[typex.EventTime, int, string]()
Review Comment:
> since the exec.make* calls are unexported, that makes it slightly more
difficult.
Yeah, that's why I didn't do this.
> I think even instantiating them manually only loses coverage of the
factory closures anyway so we're probably fine if we were to do it that way.
This way we'll be testing everything that is instantiated by users too.
I did this - its probably more high value than I initially thought
##########
sdks/go/pkg/beam/registration/iter.go:
##########
@@ -0,0 +1,129 @@
+// 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 registration
+
+import (
+ "fmt"
+ "io"
+ "reflect"
+
+ "github.com/apache/beam/sdks/v2/go/pkg/beam/core/runtime/exec"
+)
+
+type iter1[T any] struct {
+ s exec.ReStream
+
+ // cur is the "current" stream, if any.
+ cur exec.Stream
+}
+
+func (v *iter1[T]) Init() error {
+ cur, err := v.s.Open()
+ if err != nil {
+ return err
+ }
+ v.cur = cur
+ return nil
+}
+
+func (v *iter1[T]) Value() interface{} {
+ return v.invoke
+}
+
+func (v *iter1[T]) Reset() error {
+ if err := v.cur.Close(); err != nil {
+ return err
+ }
+ v.cur = nil
+ return nil
+}
+
+func (v *iter1[T]) invoke(value *T) bool {
+ elm, err := v.cur.Read()
+ if err != nil {
+ if err == io.EOF {
+ return false
+ }
+ panic(fmt.Sprintf("broken stream: %v", err))
+ }
+ *value = elm.Elm.(T)
+ return true
+}
+
+type iter2[T1, T2 any] struct {
+ s exec.ReStream
+
+ // cur is the "current" stream, if any.
+ cur exec.Stream
+}
+
+func (v *iter2[T1, T2]) Init() error {
+ cur, err := v.s.Open()
+ if err != nil {
+ return err
+ }
+ v.cur = cur
+ return nil
+}
+
+func (v *iter2[T1, T2]) Value() interface{} {
+ return v.invoke
+}
+
+func (v *iter2[T1, T2]) Reset() error {
+ if err := v.cur.Close(); err != nil {
+ return err
+ }
+ v.cur = nil
+ return nil
+}
+
+func (v *iter2[T1, T2]) invoke(key *T1, value *T2) bool {
+ elm, err := v.cur.Read()
+ if err != nil {
+ if err == io.EOF {
+ return false
+ }
+ panic(fmt.Sprintf("broken stream: %v", err))
+ }
+ *key = elm.Elm.(T1)
+ *value = elm.Elm2.(T2)
+ return true
+}
+
+// Iter1 registers parameters from your DoFn with a
+// signature func(*T) bool and optimizes their execution.
+// This must be done by passing in type parameters of all inputs as
constraints,
+// aka: registration.Iter1[T]()
Review Comment:
So I think T _must_ be a pointer for all iters, right? I did add an example
though.
##########
sdks/go/pkg/beam/registration/emitter.go:
##########
@@ -0,0 +1,173 @@
+// 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 registration
+
+import (
+ "context"
+ "reflect"
+
+ "github.com/apache/beam/sdks/v2/go/pkg/beam/core/runtime/exec"
+ "github.com/apache/beam/sdks/v2/go/pkg/beam/core/typex"
+)
+
+type emit1[T any] struct {
+ n exec.ElementProcessor
+
+ ctx context.Context
+ ws []typex.Window
+ et typex.EventTime
+ value exec.FullValue
+}
+
+func (e *emit1[T]) Init(ctx context.Context, ws []typex.Window, et
typex.EventTime) error {
+ e.ctx = ctx
+ e.ws = ws
+ e.et = et
+ return nil
+}
+
+func (e *emit1[T]) Value() interface{} {
+ return e.invoke
+}
+
+func (e *emit1[T]) invoke(val T) {
+ e.value = exec.FullValue{Windows: e.ws, Timestamp: e.et, Elm: val}
+ if err := e.n.ProcessElement(e.ctx, &e.value); err != nil {
+ panic(err)
+ }
+}
+
+type emit2[T1, T2 any] struct {
+ n exec.ElementProcessor
+
+ ctx context.Context
+ ws []typex.Window
+ et typex.EventTime
+ value exec.FullValue
+}
+
+func (e *emit2[T1, T2]) Init(ctx context.Context, ws []typex.Window, et
typex.EventTime) error {
+ e.ctx = ctx
+ e.ws = ws
+ e.et = et
+ return nil
+}
+
+func (e *emit2[T1, T2]) Value() interface{} {
+ return e.invoke
+}
+
+func (e *emit2[T1, T2]) invoke(key T1, val T2) {
+ e.value = exec.FullValue{Windows: e.ws, Timestamp: e.et, Elm: key,
Elm2: val}
+ if err := e.n.ProcessElement(e.ctx, &e.value); err != nil {
+ panic(err)
+ }
+}
+
+type emit1WithTimestamp[T any] struct {
+ n exec.ElementProcessor
+
+ ctx context.Context
+ ws []typex.Window
+ et typex.EventTime
+ value exec.FullValue
+}
+
+func (e *emit1WithTimestamp[T]) Init(ctx context.Context, ws []typex.Window,
et typex.EventTime) error {
+ e.ctx = ctx
+ e.ws = ws
+ e.et = et
+ return nil
+}
+
+func (e *emit1WithTimestamp[T]) Value() interface{} {
+ return e.invoke
+}
+
+func (e *emit1WithTimestamp[T]) invoke(et typex.EventTime, val T) {
+ e.value = exec.FullValue{Windows: e.ws, Timestamp: et, Elm: val}
+ if err := e.n.ProcessElement(e.ctx, &e.value); err != nil {
+ panic(err)
+ }
+}
+
+type emit2WithTimestamp[T1, T2 any] struct {
+ n exec.ElementProcessor
+
+ ctx context.Context
+ ws []typex.Window
+ et typex.EventTime
+ value exec.FullValue
+}
+
+func (e *emit2WithTimestamp[T1, T2]) Init(ctx context.Context, ws
[]typex.Window, et typex.EventTime) error {
+ e.ctx = ctx
+ e.ws = ws
+ e.et = et
+ return nil
+}
+
+func (e *emit2WithTimestamp[T1, T2]) Value() interface{} {
+ return e.invoke
+}
+
+func (e *emit2WithTimestamp[T1, T2]) invoke(et typex.EventTime, key T1, val
T2) {
+ e.value = exec.FullValue{Windows: e.ws, Timestamp: et, Elm: key, Elm2:
val}
+ if err := e.n.ProcessElement(e.ctx, &e.value); err != nil {
+ panic(err)
+ }
+}
+
+// Emitter1 registers parameters from your DoFn with a
+// signature func(T) and optimizes their execution.
+// This must be done by passing in type parameters of all inputs as
constraints,
+// aka: registration.Emitter1[T]()
+func Emitter1[T1 any]() {
+ e := (*func(T1))(nil)
+ registerFunc := func(n exec.ElementProcessor) exec.ReusableEmitter {
+ return &emit1[T1]{n: n}
+ }
+ exec.RegisterEmitter(reflect.TypeOf(e).Elem(), registerFunc)
+}
+
+// Emitter2 registers parameters from your DoFn with a
+// signature func(T1, T2) and optimizes their execution.
+// This must be done by passing in type parameters of all inputs as
constraints,
+// aka: registration.Emitter2[T1, T2]()
+func Emitter2[T1, T2 any]() {
+ e := (*func(T1, T2))(nil)
+ registerFunc := func(n exec.ElementProcessor) exec.ReusableEmitter {
+ return &emit2[T1, T2]{n: n}
+ }
+ if reflect.TypeOf(e).Elem().In(0) == typex.EventTimeType {
+ registerFunc = func(n exec.ElementProcessor)
exec.ReusableEmitter {
+ return &emit1WithTimestamp[T2]{n: n}
+ }
+ }
+ exec.RegisterEmitter(reflect.TypeOf(e).Elem(), registerFunc)
+}
+
+// Emitter3 registers parameters from your DoFn with a
+// signature func(T1, T2, T3) and optimizes their execution.
+// This must be done by passing in type parameters of all inputs as
constraints,
+// aka: registration.Emitter3[T1, T2, T3]()
+func Emitter3[T1, T2, T3 any]() {
Review Comment:
I think I prefer just updating the doc comments (and the constraint in this
case) - I think that's a reasonably clean experience for users (just pick the
function that matches your input arity), and that way we don't end up with 2
separate functions for emitters with 2 inputs. I updated the comments for
clarity.
Issue Time Tracking
-------------------
Worklog Id: (was: 767916)
Time Spent: 10h (was: 9h 50m)
> [Go SDK] Allow users to optimize DoFns with a single generic registration
> function
> ----------------------------------------------------------------------------------
>
> Key: BEAM-14347
> URL: https://issues.apache.org/jira/browse/BEAM-14347
> Project: Beam
> Issue Type: New Feature
> Components: sdk-go
> Reporter: Danny McCormick
> Assignee: Danny McCormick
> Priority: P2
> Time Spent: 10h
> Remaining Estimate: 0h
>
> Right now, to optimize DoFn execution, users have to use the code generator.
> This updates to allow them to use generics instead.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
