feat: Implement `det cmd describe` #9500

gt2345 · 2024-06-11T18:38:29Z

Ticket

Description

Implement det cmd describe so that user can use CLI to fetch metadata for a single command.
Also fix an error related to det cmd ls --csv

Test Plan

Start multiple commands using det cmd run ...
det cmd list would return the entire list of commands
Select one of the commands and pass it's ids to det cmd describe COMMAND_ID
You should only see selected command
Passing invalid id would display Failed to display command metadata
Other arguments such as --json/csv work as expected

Checklist

Changes have been manually QA'd
User-facing API changes need the "User-facing API Change" label.
Release notes should be added as a separate file under docs/release-notes/.
See Release Note for details.
Licenses should be included for new code which was copied and/or modified from any external code.

netlify · 2024-06-11T18:38:47Z

✅ Deploy Preview for determined-ui ready!

Name	Link
🔨 Latest commit	`624a713`
🔍 Latest deploy log	https://app.netlify.com/sites/determined-ui/deploys/668422bd3c9159000860a323
😎 Deploy Preview	https://deploy-preview-9500--determined-ui.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2024-06-11T18:53:28Z

Codecov Report

Attention: Patch coverage is 11.11111% with 16 lines in your changes missing coverage. Please review.

Project coverage is 51.64%. Comparing base (ebf2398) to head (624a713).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9500      +/-   ##
==========================================
- Coverage   51.64%   51.64%   -0.01%     
==========================================
  Files        1255     1255              
  Lines      152618   152631      +13     
  Branches     3092     3092              
==========================================
+ Hits        78816    78820       +4     
- Misses      73645    73654       +9     
  Partials      157      157

Flag	Coverage Δ
backend	`43.96% <ø> (+<0.01%)`	⬆️
harness	`72.76% <11.11%> (-0.04%)`	⬇️
web	`48.63% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
harness/determined/cli/command.py	`43.47% <ø> (ø)`
harness/determined/cli/render.py	`53.29% <50.00%> (+0.32%)`	⬆️
harness/determined/cli/ntsc.py	`50.23% <6.25%> (-3.65%)`	⬇️

... and 4 files with indirect coverage changes

NicholasBlaskey

lgtm

NicholasBlaskey · 2024-06-13T18:55:00Z

master/internal/command/command_service.go

+ if c.taskType == cmdType &&
+ ((len(users) == 0 && len(userIds) == 0) || users[username] || userIds[userID]) &&
+ (len(ids) == 0 || ids[id]) {


nit: this is kinda hard for me to understand

maybe we could split this up into seperate if statements, like workspaceID does

NicholasBlaskey · 2024-06-13T18:56:00Z

master/internal/command/command_service.go

@@ -158,6 +158,7 @@ func (cs *CommandService) listByType(
 reqUserIDs []int32,
 cmdType model.TaskType,
 workspaceID int32,
+ reqIDs *[]string,


nit: I think I prefer reqIDs being not a pointer, to match the style of reqUsers

It would be nice to be consistent, but I wanted to make it optional and use nil for non command task

azhou-determined · 2024-06-18T19:34:28Z

i know the JIRA for this suggests supporting a list of IDs is a good idea, but i disagree. the use case for filtering a list of command tasks by a list of IDs seems really weak to me.

commands aren't really objects that are intended to be created and processed in large numbers or batches. you run commands usually as one-off processes for debugging or other manual tasks. i really can't imagine someone a) having enough commands that the list is large enough that filtering is necessary, and b) wanting to take the time to copy and paste a batch of UUIDs just to filter that list.

if we did want to support filtering on commands, we shouldn't do it by IDs. it'd be more sensible to accept a filter like workspace ID, or ordering parameters to sort by timestamps, etc.

filtering by IDs might make sense for a batch operation on something like checkpoints, where you often want to delete/download a known batch of IDs. but here we're just filtering them to render, and i highly doubt anyone will have more than 1 or 2 active command tasks at any point in time. seems like a silly feature to me, we don't support this for any other object, doesn't make sense to support it for commands.

my vote is that we just don't support passing multiple --ids. we can support describing a single command by ID with something like:
det cmd describe COMMAND_ID
which is in line with the rest of the CLI's conventions, and more than sufficient for this use case IMO.

gt2345 · 2024-06-25T22:52:26Z

i know the JIRA for this suggests supporting a list of IDs is a good idea, but i disagree. the use case for filtering a list of command tasks by a list of IDs seems really weak to me.

commands aren't really objects that are intended to be created and processed in large numbers or batches. you run commands usually as one-off processes for debugging or other manual tasks. i really can't imagine someone a) having enough commands that the list is large enough that filtering is necessary, and b) wanting to take the time to copy and paste a batch of UUIDs just to filter that list.

if we did want to support filtering on commands, we shouldn't do it by IDs. it'd be more sensible to accept a filter like workspace ID, or ordering parameters to sort by timestamps, etc.

filtering by IDs might make sense for a batch operation on something like checkpoints, where you often want to delete/download a known batch of IDs. but here we're just filtering them to render, and i highly doubt anyone will have more than 1 or 2 active command tasks at any point in time. seems like a silly feature to me, we don't support this for any other object, doesn't make sense to support it for commands.

my vote is that we just don't support passing multiple --ids. we can support describing a single command by ID with something like: det cmd describe COMMAND_ID which is in line with the rest of the CLI's conventions, and more than sufficient for this use case IMO.

@azhou-determined Thanks for your comments, I agree with what you said and implement det cmd describe COMMAND_ID instead

tara-det-ai · 2024-07-01T18:48:54Z

docs/release-notes/cli-cmd-describe.rst

+
+**New Features**
+
+- CLI: Add the ability to fetch metadata of a single command using ``det cmd describe COMMAND_ID``.


Suggested change

- CLI: Add the ability to fetch metadata of a single command using ``det cmd describe COMMAND_ID``.

- CLI: Add a new command, ``det cmd describe COMMAND_ID`` to allow users to fetch the metadata of a single command.

- ```

tara-det-ai · 2024-07-01T18:52:09Z

docs/release-notes/cli-cmd-describe.rst

@@ -0,0 +1,5 @@
+:orphan:


add a bug fix note about Fix an error related to det cmd ls --csv

e.g.,

Bug Fixes

CLI: Fix a bug where....

azhou-determined · 2024-07-01T20:22:03Z

harness/determined/cli/ntsc.py

+ item = sess.get(f"api/v1/{RemoteTaskNewAPIs[args._command]}/{task_id}").json()["command"]
+
+ w_names = workspace.get_workspace_names(sess)
+ if item["state"].startswith("STATE_"):


this logic could be item["state"].replace("STATE_", "")

not important, but i feel it's a tiny bit cleaner

azhou-determined

lgtm

feat: Add --ids to cmd list

ecde6f8

gt2345 requested review from a team as code owners June 11, 2024 18:38

gt2345 requested review from stoksc and azhou-determined June 11, 2024 18:38

cla-bot bot added the cla-signed label Jun 11, 2024

gt2345 added 3 commits June 11, 2024 13:39

bindings

50876ef

fix type

d5372b5

fix type

74aad3f

gt2345 added 4 commits June 11, 2024 14:16

fix import

e478ee2

python lint

d562467

fix

5d42500

Merge branch 'main' into gt/139-list-cmd

fdc9050

gt2345 requested review from ioga and NicholasBlaskey and removed request for stoksc June 13, 2024 13:42

NicholasBlaskey approved these changes Jun 13, 2024

View reviewed changes

gt2345 added 4 commits June 25, 2024 11:18

Merge branch 'main' into gt/139-list-cmd

12452ae

use describe

0e5f1d5

fix test

7e247ad

bindings

2768350

gt2345 changed the title ~~feat: Add --ids to det cmd list~~ feat: Implement det cmd describe Jun 25, 2024

gt2345 added 4 commits June 25, 2024 14:23

fix csv output and add test

c72ba9a

lint

ddcc327

removed unused function

12bf1d2

remove print

cd22152

add release note

25c95cd

determined-ci requested a review from a team June 26, 2024 16:31

determined-ci added the documentation Improvements or additions to documentation label Jun 26, 2024

tara-det-ai reviewed Jul 1, 2024

View reviewed changes

azhou-determined reviewed Jul 1, 2024

View reviewed changes

azhou-determined approved these changes Jul 1, 2024

View reviewed changes

gt2345 added 2 commits July 1, 2024 15:36

Merge branch 'main' into gt/139-list-cmd

2957f42

fix docs

3118632

determined-ci requested a review from a team July 1, 2024 20:43

Merge branch 'main' into gt/139-list-cmd

624a713

gt2345 merged commit 2dc59ca into main Jul 2, 2024
85 of 99 checks passed

gt2345 deleted the gt/139-list-cmd branch July 2, 2024 16:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement `det cmd describe` #9500

feat: Implement `det cmd describe` #9500

gt2345 commented Jun 11, 2024 •

edited

Loading

netlify bot commented Jun 11, 2024 •

edited

Loading

codecov bot commented Jun 11, 2024 •

edited

Loading

NicholasBlaskey left a comment

NicholasBlaskey Jun 13, 2024

NicholasBlaskey Jun 13, 2024

gt2345 Jun 14, 2024

azhou-determined commented Jun 18, 2024

gt2345 commented Jun 25, 2024

tara-det-ai Jul 1, 2024 •

edited

Loading

tara-det-ai Jul 1, 2024 •

edited

Loading

azhou-determined Jul 1, 2024

azhou-determined left a comment


		New Features

		- CLI: Add the ability to fetch metadata of a single command using ``det cmd describe COMMAND_ID``.

	- CLI: Add the ability to fetch metadata of a single command using ``det cmd describe COMMAND_ID``.
	- CLI: Add a new command, ``det cmd describe COMMAND_ID`` to allow users to fetch the metadata of a single command.
	- ```

feat: Implement det cmd describe #9500

feat: Implement det cmd describe #9500

Conversation

gt2345 commented Jun 11, 2024 • edited Loading

Ticket

Description

Test Plan

Checklist

netlify bot commented Jun 11, 2024 • edited Loading

✅ Deploy Preview for determined-ui ready!

codecov bot commented Jun 11, 2024 • edited Loading

Codecov Report

NicholasBlaskey left a comment

Choose a reason for hiding this comment

NicholasBlaskey Jun 13, 2024

Choose a reason for hiding this comment

NicholasBlaskey Jun 13, 2024

Choose a reason for hiding this comment

gt2345 Jun 14, 2024

Choose a reason for hiding this comment

azhou-determined commented Jun 18, 2024

gt2345 commented Jun 25, 2024

tara-det-ai Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

tara-det-ai Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

azhou-determined Jul 1, 2024

Choose a reason for hiding this comment

azhou-determined left a comment

Choose a reason for hiding this comment

feat: Implement `det cmd describe` #9500

feat: Implement `det cmd describe` #9500

gt2345 commented Jun 11, 2024 •

edited

Loading

netlify bot commented Jun 11, 2024 •

edited

Loading

codecov bot commented Jun 11, 2024 •

edited

Loading

tara-det-ai Jul 1, 2024 •

edited

Loading

tara-det-ai Jul 1, 2024 •

edited

Loading