Switch description from query parameter to form data sending deploy description to dag server #1726
Conversation
pgvishnuram
requested review from
neel-astro,
jeremybeard and
kushalmalani
as code owners
pkg/fileutil/files_test.go
Outdated
| @@ -814,6 +820,7 @@ func (s *Suite) TestUploadFile() { | |||
| TargetURL: server.URL, | |||
| FormFileFieldName: "file", | |||
| Headers: headers, | |||
| Description: "This is a test description", | |||
There was a problem hiding this comment.
Can we update this test case to check the contents of the request, to verify the file contents and the description are in there?
pkg/fileutil/files_test.go
Outdated
| @@ -632,6 +632,7 @@ func (s *Suite) TestUploadFile() { | |||
| TargetURL: "http://localhost:8080/upload", | |||
| FormFileFieldName: "file", | |||
| Headers: map[string]string{}, | |||
| Description: "This is a test description", | |||
There was a problem hiding this comment.
We should also include a test with the description set to an empty string and Jeremy's comment to ensure regression is intact.
for more information, see https://pre-commit.ci
…ub.com/astronomer/astro-cli into add-description-to-uploadfile-formdata
| req.Header.Set(k, v) | ||
| } | ||
| setHeaders(req, headers) | ||
|
|
||
| client := &http.Client{} | ||
| response, err := client.Do(req) |
There was a problem hiding this comment.
I only tested for no description. I was unable to fully test the description. When logging the request body just before and after this line response, err := client.Do(req), I noticed that no data is logged after the request is sent.
Given this, simulating and testing for the description field and even file did not quite work.
|
I do not have the permission to merge. I need help merging this @neel-astro |
…escription to dag server (#1726) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: pgvishnuram <vishnu@astronomer.io> Co-authored-by: Neel Dalsania <neel.dalsania@astronomer.io>
Description
This PR modifies the way the
descriptionis handled in theUploadFilefunction. Previously, thedescriptionwas passed as a query parameter in the URL. It is now switched to be sent as form data along with the file in the multipart request.Key changes:
descriptionfrom a query parameter to form data.descriptionfield to theUploadFileArgumentsstruct.UploadFilefunction to handle thedescriptionas form data.This change improves the handling of spaces and special characters in the
description, avoiding issues caused by URL encoding.Related astronomer/issues/issues/6663
🧪 Functional Testing
TestUploadFileto reflect this change.📸 Screenshots
📋 Checklist
make testbefore taking out of draftmake lintbefore taking out of draft