feat: add options to output registered entity summary #3028

paullongtan · 2025-01-02T00:47:26Z

Tracking issue

Why are the changes needed?

Currently, pyflyte register does not have an option to output registered entities to a file. This PR creates such functionality.

What changes were proposed in this pull request?

Added two options --summary-format and --summary-dir to pyflyte register in flytekit/flytekit/clis/sdk_in_container/register.py.

--summary-format: Sets output format for registration summary. Lists registered workflows, tasks, and launch plans. 'json' and 'yaml' supported.
--summary-dir: Directory to save registration summary. Uses current working directory if not specified.

Collects registered entity information in flytekit/flytekit/tools/repo.py. Results are then saved to designated directory in selected file format.
Updated the unit test for register.py.

How was this patch tested?

Unit testing
Built and run some Flytekit test

Setup process

Screenshots

Check all the applicable boxes

I updated the documentation accordingly.
All new and existing tests passed.
All commits are signed-off.

Related PRs

Docs link

Summary by Bito

Enhanced pyflyte register command with new summary output capabilities, adding --summary-format (JSON/YAML) and --summary-dir options. Implementation includes registration result collection and flexible output formats. Added comprehensive test suite to validate summary file generation, output data structure, and proper handling of required fields (id, type, version, status) in registration summaries.

Unit tests added: True

Estimated effort to review (1-5, lower is better): 2

welcome · 2025-01-02T00:47:29Z

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
Sign off your commits (Reference: DCO Guide).

flyte-bot · 2025-01-02T00:47:39Z

Code Review Agent Run Status

Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

flyte-bot · 2025-01-02T01:58:45Z

Code Review Agent Run Status

Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

Signed-off-by: paullongtan <[email protected]>

Mecoli1219

Nice first PR! I think you can add more unit tests.

yaml
testing registration without specifying --summary-dir

Mecoli1219 · 2025-01-02T05:43:24Z

flytekit/tools/repo.py

+        else:
+            summary_dir = os.getcwd()
+
+        summary_file = f"registration_summary.{summary_format}"


Does this mean that the other registration may overwrite the summary? I think we could name the file with other unique names (ie. tmp file, py file name, wf name, version number)

Yes! The summary will be overwritten if the registration is rerun.

tests/flytekit/unit/cli/pyflyte/test_register.py

Mecoli1219 · 2025-01-02T05:50:11Z

flytekit/tools/repo.py


                except Exception as e:
                    if not skip_errors:
                        raise e
                    print_registration_status(og_id, success=False)
+                    result["status"] = "failed"


If it fails, what will the values of other keys be?

The values of the other keys(id, type, version) are pre-computed before registration. Thus, the values will not be empty even if the registration fails.

The values are from:

result = {
"id": og_id.name,
"type": og_id.resource_type_name(),
"version": og_id.version,
"status": "skipped", # default status
}
where og_id is the id of the entity's template / entity itself.

flyte-bot · 2025-01-02T05:58:47Z

Code Review Agent Run #9a3edb

Actionable Suggestions - 3

flytekit/tools/repo.py - 2
- Consider enhancing registration result information · Line 341-346
- Consider using set for format checking · Line 402-404
flytekit/clis/sdk_in_container/register.py - 1
- Consider validating summary format and directory · Line 146-159

Additional Suggestions - 1

tests/flytekit/unit/cli/pyflyte/test_register.py - 1
- Consider fixing typo in test name · Line 196-196

Review Details

Files reviewed - 3 · Commit Range: f51be71..9bba92f
- flytekit/clis/sdk_in_container/register.py
- flytekit/tools/repo.py
- tests/flytekit/unit/cli/pyflyte/test_register.py
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful

AI Code Review powered by

flyte-bot · 2025-01-02T06:03:53Z

Changelist by Bito

This pull request implements the following key changes.

Key Change	Files Impacted
Feature Improvement - Enhanced Registration Output Capabilities	- `register.py` - Added new CLI options for summary format and directory specification - `repo.py` - Implemented registration result collection and output formatting functionality - `test_register.py` - Added comprehensive tests for new summary output features

flyte-bot · 2025-01-02T06:03:54Z

flytekit/tools/repo.py

+        result = {
+            "id": og_id.name,
+            "type": og_id.resource_type_name(),
+            "version": og_id.version,
+            "status": "skipped",  # default status
+        }


Consider enhancing registration result information

Consider adding more detailed status information in the result dictionary. The current status field only captures high-level states ('skipped', 'success', 'failed'). Additional fields like error_message and timestamp could provide more context for debugging and monitoring.

Code suggestion

Check the AI-generated fix before applying

Suggested change

result = {

"id": og_id.name,

"type": og_id.resource_type_name(),

"version": og_id.version,

"status": "skipped", # default status

}

result = {

"id": og_id.name,

"type": og_id.resource_type_name(),

"version": og_id.version,

"status": "skipped", # default status

"timestamp": datetime.datetime.now().isoformat(),

"error_message": "",

"details": {}

}

Code Review Run #9a3edb

Is this a valid issue, or was it incorrectly flagged by the Agent?

it was incorrectly flagged

flyte-bot · 2025-01-02T06:03:55Z

flytekit/tools/repo.py

+        supported_format = ["json", "yaml"]
+        if summary_format not in supported_format:
+            raise ValueError(f"Unsupported file format: {summary_format}")


Consider using set for format checking

Consider using a set for supported_format instead of a list since we're only checking membership. This would provide O(1) lookup instead of O(n). Could be defined as supported_format = {'json', 'yaml'}.

Code suggestion

Check the AI-generated fix before applying

Suggested change

supported_format = ["json", "yaml"]

if summary_format not in supported_format:

raise ValueError(f"Unsupported file format: {summary_format}")

if summary_format not in {"json", "yaml"}:

raise ValueError(f"Unsupported file format: {summary_format}")

Code Review Run #9a3edb

Is this a valid issue, or was it incorrectly flagged by the Agent?

it was incorrectly flagged

flyte-bot · 2025-01-02T06:03:56Z

flytekit/clis/sdk_in_container/register.py

+    "--summary-format",
+    "-f",
+    required=False,
+    type=click.Choice(["json", "yaml"], case_sensitive=False),
+    default=None,
+    help="Set output format for registration summary. Lists registered workflows, tasks, and launch plans. 'json' and 'yaml' supported.",
+)
+@click.option(
+    "--summary-dir",
+    required=False,
+    type=click.Path(dir_okay=True, file_okay=False, writable=True, resolve_path=True),
+    default=None,
+    help="Directory to save registration summary. Uses current working directory if not specified.",
+)


Consider validating summary format and directory

Consider adding validation for summary-format and summary-dir options. When summary-format is specified but summary-dir is not, the summary may not be saved correctly. Consider making summary-dir required when summary-format is provided.

Code suggestion

Check the AI-generated fix before applying

Suggested change

"--summary-format",

"-f",

required=False,

type=click.Choice(["json", "yaml"], case_sensitive=False),

default=None,

help="Set output format for registration summary. Lists registered workflows, tasks, and launch plans. 'json' and 'yaml' supported.",

)

@click.option(

"--summary-dir",

required=False,

type=click.Path(dir_okay=True, file_okay=False, writable=True, resolve_path=True),

default=None,

help="Directory to save registration summary. Uses current working directory if not specified.",

)

"--summary-format",

"-f",

required=False,

type=click.Choice(["json", "yaml"], case_sensitive=False),

default=None,

help="Set output format for registration summary. Lists registered workflows, tasks, and launch plans. 'json' and 'yaml' supported.",

callback=validate_summary_options,

)

"--summary-dir",

required=False,

type=click.Path(dir_okay=True, file_okay=False, writable=True, resolve_path=True),

default=None,

help="Directory to save registration summary. Uses current working directory if not specified.",

callback=validate_summary_options,

)

Code Review Run #9a3edb

Is this a valid issue, or was it incorrectly flagged by the Agent?

it was incorrectly flagged

Signed-off-by: paullongtan <[email protected]>

…mmary-dir testings to unit test Signed-off-by: paullongtan <[email protected]>

flyte-bot · 2025-01-02T07:28:48Z

Code Review Agent Run #a2cf6a

Actionable Suggestions - 0

Review Details

Files reviewed - 1 · Commit Range: 9bba92f..db9f744
- tests/flytekit/unit/cli/pyflyte/test_register.py
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful

AI Code Review powered by

paullongtan · 2025-01-02T17:55:50Z

Nice first PR! I think you can add more unit tests.

yaml

testing registration without specifying --summary-dir

Thanks!
I have added unit tests for both yaml and registration without specifying --summary-dir.

paullongtan force-pushed the feat/add_register_output_format branch from 47d8b92 to dda078c Compare January 2, 2025 00:51

paullongtan force-pushed the feat/add_register_output_format branch from ef2743a to 0395846 Compare January 2, 2025 04:57

paullongtan added 3 commits January 1, 2025 21:01

feat: add options to output registered entity summary

f51be71

Signed-off-by: paullongtan <[email protected]>

refactor: do registrated summary format checking earlier

104783e

Signed-off-by: paullongtan <[email protected]>

fix: fix unit test

9bba92f

Signed-off-by: paullongtan <[email protected]>

paullongtan force-pushed the feat/add_register_output_format branch from 0395846 to 9bba92f Compare January 2, 2025 05:01

paullongtan marked this pull request as ready for review January 2, 2025 05:37

paullongtan requested review from wild-endeavor, kumare3, eapolinario, pingsutw, cosmicBboy, samhita-alla, thomasjpfan and Future-Outlier as code owners January 2, 2025 05:37

Mecoli1219 reviewed Jan 2, 2025

View reviewed changes

flyte-bot reviewed Jan 2, 2025

View reviewed changes

paullongtan added 2 commits January 1, 2025 22:38

chore: code clean up

f1be205

Signed-off-by: paullongtan <[email protected]>

test: add yaml output format and registration without specifying --su…

db9f744

…mmary-dir testings to unit test Signed-off-by: paullongtan <[email protected]>

paullongtan force-pushed the feat/add_register_output_format branch from 2bbe0d1 to db9f744 Compare January 2, 2025 06:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add options to output registered entity summary #3028

feat: add options to output registered entity summary #3028

paullongtan commented Jan 2, 2025 •

edited

Loading

welcome bot commented Jan 2, 2025

flyte-bot commented Jan 2, 2025

flyte-bot commented Jan 2, 2025

Mecoli1219 left a comment

Mecoli1219 Jan 2, 2025

paullongtan Jan 3, 2025

Mecoli1219 Jan 2, 2025

paullongtan Jan 3, 2025

flyte-bot commented Jan 2, 2025 •

edited

Loading

Code Review Agent Run #9a3edb

flyte-bot commented Jan 2, 2025 •

edited

Loading

Changelist by Bito

flyte-bot Jan 2, 2025

flyte-bot Jan 2, 2025

flyte-bot Jan 2, 2025

flyte-bot commented Jan 2, 2025 •

edited

Loading

Code Review Agent Run #a2cf6a

paullongtan commented Jan 2, 2025

feat: add options to output registered entity summary #3028

Are you sure you want to change the base?

feat: add options to output registered entity summary #3028

Conversation

paullongtan commented Jan 2, 2025 • edited Loading

Tracking issue

Why are the changes needed?

What changes were proposed in this pull request?

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

Related PRs

Docs link

Summary by Bito

welcome bot commented Jan 2, 2025

flyte-bot commented Jan 2, 2025

Code Review Agent Run Status

flyte-bot commented Jan 2, 2025

Code Review Agent Run Status

Mecoli1219 left a comment

Choose a reason for hiding this comment

Mecoli1219 Jan 2, 2025

Choose a reason for hiding this comment

paullongtan Jan 3, 2025

Choose a reason for hiding this comment

Mecoli1219 Jan 2, 2025

Choose a reason for hiding this comment

paullongtan Jan 3, 2025

Choose a reason for hiding this comment

flyte-bot commented Jan 2, 2025 • edited Loading

Code Review Agent Run #9a3edb

flyte-bot commented Jan 2, 2025 • edited Loading

Changelist by Bito

flyte-bot Jan 2, 2025

Choose a reason for hiding this comment

flyte-bot Jan 2, 2025

Choose a reason for hiding this comment

flyte-bot Jan 2, 2025

Choose a reason for hiding this comment

flyte-bot commented Jan 2, 2025 • edited Loading

Code Review Agent Run #a2cf6a

paullongtan commented Jan 2, 2025

paullongtan commented Jan 2, 2025 •

edited

Loading

flyte-bot commented Jan 2, 2025 •

edited

Loading

flyte-bot commented Jan 2, 2025 •

edited

Loading

flyte-bot commented Jan 2, 2025 •

edited

Loading