[ 
https://issues.apache.org/jira/browse/BEAM-6113?focusedWorklogId=168610&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-168610
 ]

ASF GitHub Bot logged work on BEAM-6113:
----------------------------------------

                Author: ASF GitHub Bot
            Created on: 22/Nov/18 01:32
            Start Date: 22/Nov/18 01:32
    Worklog Time Spent: 10m 
      Work Description: youngoli opened a new pull request #7120: [BEAM-6113] 
Small changes to avoid user errors around beam.Init()
URL: https://github.com/apache/beam/pull/7120
 
 
   Making some small changes that will help prevent users from forgetting
   or not knowing about calling beam.Init(). Making sure all examples
   include a call to beam.Init(), and that the direct runner (which
   currently runs if beam.Init() is not called) contains a warning about
   it.
   
   ------------------------
   
   Follow this checklist to help us incorporate your contribution quickly and 
easily:
   
    - [x] 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.
    - [ ] If this contribution is large, please file an Apache [Individual 
Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   It will help us expedite review of your Pull Request if you tag someone 
(e.g. `@username`) to look at it.
   
   Post-Commit Tests Status (on master branch)
   
------------------------------------------------------------------------------------------------
   
   Lang | SDK | Apex | Dataflow | Flink | Gearpump | Samza | Spark
   --- | --- | --- | --- | --- | --- | --- | ---
   Go | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Go_GradleBuild/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Go_GradleBuild/lastCompletedBuild/)
 | --- | --- | --- | --- | --- | ---
   Java | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_GradleBuild/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_GradleBuild/lastCompletedBuild/)
 | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Apex_Gradle/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Apex_Gradle/lastCompletedBuild/)
 | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Gradle/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Gradle/lastCompletedBuild/)
 | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Gradle/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Gradle/lastCompletedBuild/)
 [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_PVR_Flink/lastCompletedBuild/)
 | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Gearpump_Gradle/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Gearpump_Gradle/lastCompletedBuild/)
 | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza_Gradle/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza_Gradle/lastCompletedBuild/)
 | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark_Gradle/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark_Gradle/lastCompletedBuild/)
   Python | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Python_Verify/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Python_Verify/lastCompletedBuild/)
 | --- | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)
 </br> [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/)
 | [![Build 
Status](https://builds.apache.org/job/beam_PostCommit_Python_VR_Flink/lastCompletedBuild/badge/icon)](https://builds.apache.org/job/beam_PostCommit_Python_VR_Flink/lastCompletedBuild/)
 | --- | --- | ---
   
   
   
   
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


Issue Time Tracking
-------------------

            Worklog Id:     (was: 168610)
            Time Spent: 10m
    Remaining Estimate: 0h

> Streamline beam.Init() requirement for Go pipelines.
> ----------------------------------------------------
>
>                 Key: BEAM-6113
>                 URL: https://issues.apache.org/jira/browse/BEAM-6113
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-go
>            Reporter: Daniel Oliveira
>            Assignee: Daniel Oliveira
>            Priority: Minor
>              Labels: documentation, usability
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> When writing a Go pipeline it's necessary to call beam.Init() at the 
> beginning of your code, but right now there is nearly no validation or 
> checking around that. This makes it very easy for a new user of Beam Go to 
> accidentally leave it out and not get a clear signal for why their pipeline 
> isn't being executed as expected. This issue is for tracking progress towards 
> streamlining this requirement to improve the user experience.
> In the short term this can be easily improved by improving documentation and 
> examples to clearly communicate the necessity of beam.Init(), and also add 
> log warnings to provide some signal if the user forgot to call it.
> In the long term, the best solution to this would be to try avoiding the 
> problem all together (for example by removing the need for beam.Init(), or 
> having it called implicitly without relying on users to call it), or to 
> create a stronger failure state, for example by having pipelines without 
> beam.Init() immediately break with a clear message notifying the user that it 
> was not called.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to