apache/beam

Migrate common_job_properties.groovy to use Maps for keyword argument style calls instead of positional arguments

Open

#18768 opened on Jun 3, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (7,313 stars) (4,097 forks)batch import
P3good first issueimprovementtests

Description

This follows the the style defined within build_rules.gradle as it is much simpler to read the following method with keyword arguments: setCommonJobProperties(context: context, maxWorkers: 3)

This also simplifies the usage of methods with multiple default arguments.

Imported from Jira BEAM-4235. Original Jira may contain additional context. Reported by: lcwik.

Contributor guide

Tech stack
groovy
Domain
developer experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Groovy language fundamentalsFamiliarity with Apache Beam project structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine common job properties.groovy in the repository to identify all function calls that use positional arguments. Refer to the style guide in build rules.gradle (line 397) for the target keyword argument style using maps. Update each call accordingly, ensuring default arguments are handled correctly. No linked PRs or comments exist, so confirm with maintainers if the change is still wanted before proceeding.