VTAdmin: Workflow status endpoint

[beingnoble03]

Description

Currently, VTAdmin misses out on workflow status endpoint. This endpoint is important for fetching/monitoring the progress of the workflow.

Example: http://localhost:14200/api/workflow_status/local/customer/commerce2customer

{
  "result": {
    "shard_streams": {
      "customer/0": {
        "streams": [
          {
            "id": 1,
            "tablet": {
              "cell": "zone1",
              "uid": 201
            },
            "source_shard": "commerce/0",
            "position": "6d7be442-5964-11ef-8add-2ccc79fa7a75:1-54",
            "status": "Running",
            "info": "VStream Lag: 0s"
          }
        ]
      }
    },
    "traffic_state": "Reads Not Switched. Writes Not Switched"
  },
  "ok": true
}

Related Issue(s)

• VTAdmin: Workflow Details tab #16537

Checklist

• "Backport to:" labels have been added if this change should be back-ported to release branches
• If this change is to be back-ported to previous releases, a justification is included in the PR description
• Tests were added or are not required
• Did the new or modified tests pass consistently locally and on CI?
• Documentation was added or is not required

Deployment Notes

[codecov]

Codecov Report

Attention: Patch coverage is 4.16667% with 23 lines in your changes missing coverage. Please review.

Project coverage is 68.78%. Comparing base (0b7c0e4) to head (f865ef7).
Report is 31 commits behind head on main.

Files	Patch %	Lines
go/vt/vtadmin/api.go	6.25%	15 Missing ⚠️
go/vt/vtadmin/http/workflows.go	0.00%	8 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main   #16587    +/-   ##
========================================
  Coverage   68.78%   68.78%            
========================================
  Files        1556     1557     +1     
  Lines      199803   199915   +112     
========================================
+ Hits       137429   137511    +82     
- Misses      62374    62404    +30     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rohit-nayak-ps]

Looks good. I just had one comment about the API endpoint.

I tested the current endpoint locally and added the url/output to the description.

[rohit-nayak-ps]

We should probably do this like
/workflow/{cluster_id}/{keyspace}/{name}/status similar to the keyspace APIs, for example:

        router.HandleFunc("/keyspace/{cluster_id}", httpAPI.Adapt(vtadminhttp.CreateKeyspace)).Name("API.CreateKeyspace").Methods("POST")
	router.HandleFunc("/keyspace/{cluster_id}/{name}", httpAPI.Adapt(vtadminhttp.DeleteKeyspace)).Name("API.DeleteKeyspace").Methods("DELETE")
	router.HandleFunc("/keyspace/{cluster_id}/{name}", httpAPI.Adapt(vtadminhttp.GetKeyspace)).Name("API.GetKeyspace")
	router.HandleFunc("/keyspace/{cluster_id}/{name}/rebuild_keyspace_graph", httpAPI.Adapt(vtadminhttp.RebuildKeyspaceGraph)).Name("API.RebuildKeyspaceGraph").Methods("PUT", "OPTIONS")
	router.HandleFunc("/keyspace/{cluster_id}/{name}/remove_keyspace_cell", httpAPI.Adapt(vtadminhttp.RemoveKeyspaceCell)).Name("API.RemoveKeyspaceCell").Methods("PUT", "OPTIONS")
	router.HandleFunc("/keyspace/{cluster_id}/{name}/validate", httpAPI.Adapt(vtadminhttp.ValidateKeyspace)).Name("API.ValidateKeyspace").Methods("PUT", "OPTIONS")
	router.HandleFunc("/keyspace/{cluster_id}/{name}/validate/schema", httpAPI.Adapt(vtadminhttp.ValidateSchemaKeyspace)).Name("API.ValidateSchemaKeyspace").Methods("PUT", "OPTIONS")
	router.HandleFunc("/keyspace/{cluster_id}/{name}/validate/version", httpAPI.Adapt(vtadminhttp.ValidateVersionKeyspace)).Name("API.ValidateVersionKeyspace").Methods("PUT", "OPTIONS")

[beingnoble03]

Ah, makes sense! done.

[rohit-nayak-ps]

Nice work.

[notfelineit]

LGTM. So excited to see more workflow stuff in VTAdmin 😄