Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(glue): PythonRayExecutableProps has innaccurate properties #28625

Merged
merged 4 commits into from
Mar 8, 2024
Merged

fix(glue): PythonRayExecutableProps has innaccurate properties #28625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cde94af
fix(glue): added RayExecutableProps which supports s3PythonModules
moomindani Jan 9, 2024
ff41e85
Merge branch 'main' into fix-glueray-props
moomindani Feb 5, 2024
91ab22e
@see expects a url after the tag, and nothing else
moomindani Feb 14, 2024
8b3a29a
Merge branch 'main' into fix-glueray-props
paulhcsun Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 54 additions & 13 deletions packages/@aws-cdk/aws-glue-alpha/lib/job-executable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,14 +169,32 @@ interface PythonExecutableProps {
/**
* Additional Python files that AWS Glue adds to the Python path before executing your script.
* Only individual files are supported, directories are not supported.
* Equivalent to a job parameter `--extra-py-files`.
*
* @default - no extra python files and argument is not set
*
* @see `--extra-py-files` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraPythonFiles?: Code[];
}

interface RayExecutableProps {
/**
* The Python version to use.
*/
readonly pythonVersion: PythonVersion;

/**
* Additional Python modules that AWS Glue adds to the Python path before executing your script.
* Equivalent to a job parameter `--s3-py-modules`.
*
* @default - no extra python files and argument is not set
*
* @see https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html
*/
readonly s3PythonModules?: Code[];
}

interface SharedJobExecutableProps {
/**
* Runtime. It is required for Ray jobs.
Expand All @@ -199,10 +217,11 @@ interface SharedJobExecutableProps {
/**
* Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.
* Only individual files are supported, directories are not supported.
* Equivalent to a job parameter `--extra-files`.
*
* @default [] - no extra files are copied to the working directory
*
* @see `--extra-files` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraFiles?: Code[];
}
Expand All @@ -211,19 +230,21 @@ interface SharedSparkJobExecutableProps extends SharedJobExecutableProps {
/**
* Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script.
* Only individual files are supported, directories are not supported.
* Equivalent to a job parameter `--extra-jars`.
*
* @default [] - no extra jars are added to the classpath
*
* @see `--extra-jars` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraJars?: Code[];

/**
* Setting this value to true prioritizes the customer's extra JAR files in the classpath.
* Equivalent to a job parameter `--user-jars-first`.
*
* @default false - priority is not given to user-provided jars
*
* @see `--user-jars-first` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraJarsFirst?: boolean;
}
Expand All @@ -234,8 +255,9 @@ interface SharedSparkJobExecutableProps extends SharedJobExecutableProps {
export interface ScalaJobExecutableProps extends SharedSparkJobExecutableProps {
/**
* The fully qualified Scala class name that serves as the entry point for the job.
* Equivalent to a job parameter `--class`.
*
* @see `--class` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly className: string;
}
Expand All @@ -253,7 +275,7 @@ export interface PythonShellExecutableProps extends SharedJobExecutableProps, Py
/**
* Props for creating a Python Ray job executable
*/
export interface PythonRayExecutableProps extends SharedJobExecutableProps, PythonExecutableProps {}
export interface PythonRayExecutableProps extends SharedJobExecutableProps, RayExecutableProps {}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens to PythonExecutableProps? a) is it used elsewhere and b) we are not dropping support for any properties right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we are dropping support for properties (as the attached issue suggests) it should have been called out in PR description as a BREAKING CHANGE.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a) is it used elsewhere
Yes. There are three job types; Spark, Python shell, and Ray. PythonExecutableProps is used for the first two.

b) we are not dropping support for any properties right?
Right. We are not dropping any or working properties.
Only the property we are dropping is extraPythonFiles which was not working for Ray job. This is not breaking change.


/**
* The executable properties related to the Glue job's GlueVersion, JobType and code
Expand Down Expand Up @@ -377,14 +399,17 @@ export class JobExecutable {
if (JobLanguage.PYTHON !== config.language && config.extraPythonFiles) {
throw new Error('extraPythonFiles is not supported for languages other than JobLanguage.PYTHON');
}
if (config.extraPythonFiles && type === JobType.RAY.name) {
throw new Error('extraPythonFiles is not supported for Ray jobs');
}
if (config.pythonVersion === PythonVersion.THREE_NINE && type !== JobType.PYTHON_SHELL.name && type !== JobType.RAY.name) {
throw new Error('Specified PythonVersion PythonVersion.THREE_NINE is only supported for JobType Python Shell and Ray');
}
if (config.pythonVersion === PythonVersion.THREE && type === JobType.RAY.name) {
throw new Error('Specified PythonVersion PythonVersion.THREE is not supported for Ray');
}
if (config.runtime === undefined && type === JobType.RAY.name) {
throw new Error('Runtime is required for Ray jobs.');
throw new Error('Runtime is required for Ray jobs');
}
this.config = config;
}
Expand All @@ -410,8 +435,9 @@ export interface JobExecutableConfig {

/**
* The language of the job (Scala or Python).
* Equivalent to a job parameter `--job-language`.
*
* @see `--job-language` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly language: JobLanguage;

Expand Down Expand Up @@ -441,46 +467,61 @@ export interface JobExecutableConfig {

/**
* The Scala class that serves as the entry point for the job. This applies only if your the job langauage is Scala.
* Equivalent to a job parameter `--class`.
*
* @default - no scala className specified
*
* @see `--class` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly className?: string;

/**
* Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script.
* Equivalent to a job parameter `--extra-jars`.
*
* @default - no extra jars specified.
*
* @see `--extra-jars` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraJars?: Code[];

/**
* Additional Python files that AWS Glue adds to the Python path before executing your script.
* Equivalent to a job parameter `--extra-py-files`.
*
* @default - no extra python files specified.
*
* @see `--extra-py-files` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraPythonFiles?: Code[];

/**
* Additional Python modules that AWS Glue adds to the Python path before executing your script.
* Equivalent to a job parameter `--s3-py-modules`.
*
* @default - no extra python files specified.
*
* @see https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html
*/
readonly s3PythonModules?: Code[];

/**
* Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.
* Equivalent to a job parameter `--extra-files`.
*
* @default - no extra files specified.
*
* @see `--extra-files` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraFiles?: Code[];

/**
* Setting this value to true prioritizes the customer's extra JAR files in the classpath.
* Equivalent to a job parameter `--user-jars-first`.
*
* @default - extra jars are not prioritized.
*
* @see `--user-jars-first` in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly extraJarsFirst?: boolean;
}
10 changes: 7 additions & 3 deletions packages/@aws-cdk/aws-glue-alpha/lib/job.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,10 +598,11 @@ export interface JobProps {

/**
* Enables the collection of metrics for job profiling.
* Equivalent to a job parameter `--enable-metrics`.
*
* @default - no profiling metrics emitted.
*
* @see `--enable-metrics` at https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*/
readonly enableProfilingMetrics? :boolean;

Expand Down Expand Up @@ -801,6 +802,9 @@ export class Job extends JobBase {
if (config.extraPythonFiles && config.extraPythonFiles.length > 0) {
args['--extra-py-files'] = config.extraPythonFiles.map(code => this.codeS3ObjectUrl(code)).join(',');
}
if (config.s3PythonModules && config.s3PythonModules.length > 0) {
args['--s3-py-modules'] = config.s3PythonModules.map(code => this.codeS3ObjectUrl(code)).join(',');
}
if (config.extraFiles && config.extraFiles.length > 0) {
args['--extra-files'] = config.extraFiles.map(code => this.codeS3ObjectUrl(code)).join(',');
}
Expand Down Expand Up @@ -886,8 +890,8 @@ export class Job extends JobBase {
}

/**
* Create a CloudWatch Metric that's based on Glue Job events
* {@see https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types}
* Create a CloudWatch Metric that's based on Glue Job events.
* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types
* The metric has namespace = 'AWS/Events', metricName = 'TriggeredRules' and RuleName = rule.ruleName dimension.
*
* @param rule for use in setting RuleName dimension value
Expand Down
Binary file added ...ob.js.snapshot/asset.1c055910db2de9d0fcf53321842cab491bb6985900b80e05d634fceef328c5c4.zip
View file
Open in desktop
Binary file not shown.
4 changes: 4 additions & 0 deletions ...job.js.snapshot/asset.9120cd4aa376310a46a09d707c5e0c75c164b9014f1740e4c5a3637a34dfafe7.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 29 additions & 3 deletions packages/@aws-cdk/aws-glue-alpha/test/integ.job.js.snapshot/aws-glue-job.assets.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading