fix: use --slurp with --paginate to concat pages into valid json #820
Conversation
Fixes: pwntester#819 The original arguments to `gh api` for certain commands are problematic. For instance: @@ -85,13 +95,14 @@ end function PullRequest:get_changed_files(callback) local url = string.format("repos/%s/pulls/%d/files", self.repo, self.number) gh.run { - args = { "api", "--paginate", url, "--jq", "." }, In the above arguments the returned results, if exceeds one pages, will be two separate JSON arrays. E.g. [{page1..}][{page2...}]. You cannot feed this directly to `vim.fn.jsondecode` since its not actually valid json, its two json arrays in a single string. Luckily, `gh` includes the `--slurp` argument to the `api` command which works similiarly to `jq`'s slurp command, concating sequential arrays. We can use this, with one catch. The results of any API call with `--slurp` is "an array of pages" and thus the data we want is nested one level deep. We simply write a `merge_pages` function which extracts all items into a 1d array, which is what Octo currently expects. Signed-off-by: ldelossa <[email protected]>
|
hmm, this could be seen as a breaking change, but only if you're using a I'll look for advice on how to handle that. |
|
Thanks for the PR @ldelossa Let me take a look at the code. As for the |
|
This ready to go? @ldelossa |
|
As a quick fix yes. I would like to make aggregate_pages work so we dont have this one off function like you mentioned, but I can do this as a follow up PR if you think thats good. |
Perfect. I will create an issue for this. There is no rush |
Fixes: #819
The original arguments to
gh apifor certain commands are problematic.For instance:
In the above arguments the returned results, if exceeds one pages, will be two separate JSON arrays. E.g. [{...}][{...}].
You cannot feed this directly to
vim.fn.jsondecodesince its not actually valid json, its two json arrays in a single string.Luckily,
ghincludes the--slurpargument to theapicommand which works similiarly tojq's slurp command, concating sequential arrays.We can use this, with one catch.
The results of any API call with
--slurpis "an array of pages" and thus the data we want is nested one level deep.We simply write a
merge_pagesfunction which extracts all items into a 1d array, which is what Octo currently expects.Describe what this PR does / why we need it
Does this pull request fix one issue?
Describe how you did it
Describe how to verify it
Special notes for reviews
Checklist