Implement Actions API. by K0Te · Pull Request #459 · haskell-github/github · GitHub

Closes #458

I've implemented just ~5% of Actions API at the moment. I have many questions and need your guidance before proceeding further:

GitHub has changed documentation URLs, I am using new ones in the PR. Is it ok? It's probably worth changing all URLs in the repo, as GitHub has broken redirect a little bit, for example, https://developer.github.com/v3/pulls/#get-a-single-pull-request is forwarded to https://docs.github.com/en/rest/reference/pulls#get-a-single-pull-request instead of https://docs.github.com/en/rest/reference/pulls#get-a-pull-request . This should probably be a separate issue/PR.
Response style is different for actions API, JSON includes tagged item list and a total count:

{
  "artifacts": [
   ...
  ],
  "total_count": 13676
}

I see three ways of handling this:

A separate Response type for each list endpoint, it's simple but need a lot of code:

data ArtifactList = ArtifactList
    { artifactListArtifacts :: !(Vector Artifact)
    , artifactListTotalCount :: !Int
    }
    deriving (Show, Data, Typeable, Eq, Ord, Generic

Tag as a type-level symbol, this looks nicer, but needs extensions and moves tag towards Endpoints instead of Data:

data PaginatedWithTotalCount a (tag :: Symbol) = PaginatedWithTotalCount
    { paginatedWithTotalCountItems :: !(Vector a)
    , paginatedWithTotalCountTotalCount :: !Int
    }

Tag defined in instance declaration for each paginated type. This approach seems best, but might break if GitHub API uses different tags for the same type - in this case, the library would need new types, which will be confusing...

data WithTotalCount a = WithTotalCount
    { withTotalCountItems :: !(Vector a)
    , withTotalCountTotalCount :: !Int
    } deriving (Show, Data, Typeable, Eq, Ord, Generic)

instance Semigroup (WithTotalCount a) where
    (WithTotalCount items1 count1) <> (WithTotalCount items2 _) =
        WithTotalCount (items1 <> items2) count1

instance Foldable WithTotalCount where
    foldMap f (WithTotalCount items _) = foldMap f items

instance FromJSON (WithTotalCount Artifact) where
    parseJSON = withObject "ArtifactList" $ \o -> WithTotalCount
        <$> o .: "artifacts"
        <*> o .: "total_count

Tests. I have implemented tests for reading the artifact list. Downloading is more complex - it needs workflow permissions and does not work with an empty token. Even if https://github.com/phadej/github contained actions with artifacts, other users won't be able to run integration tests with download and deletion. Should I test only API with minimal required permissions?

What are these? Is artifacts pagination different then for everything else?

Yes, please check my comment above. At least I didn't find existing implementation for this pagination style.

Hi @andreasabel ,

I got back to this issue and hope to implement full support for GitHub Actions.
Hope you could review this PR once it's ready and help to merge it.
There is one more interesting issue with the Actions API - https://docs.github.com/en/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key defines a DELETE request with query parameters but at the moment only Queries support query parameters. Adding query parameters to command or Command would require changing lots of code, could there be a better approach?

Hi @K0Te, good to have you back on track!

Hope you could review this PR once it's ready and help to merge it.

I'll do my best. I am not really an expert on this package.
Make sure your functionality is covered by tests or examples, remember to document, and adhere to the current style of the API, please.

There is one more interesting issue ... at the moment only Queries support query parameters.
Adding query parameters to command or Command would require changing lots of code, could there be a better approach?

I suppose you are referring to this code:

github/src/GitHub/Data/Request.hs

Lines 155 to 164 in 01c1154

    
           data GenRequest (mt :: MediaType *) (rw :: RW) a where 
        
               Query        :: Paths -> QueryString -> GenRequest mt rw a 
        
               PagedQuery   :: (a ~ t b, Foldable t, Semigroup a) => Paths -> QueryString -> FetchCount -> GenRequest mt rw a 
        
               -- | Command 
        
               Command 
        
                   :: CommandMethod           -- ^ command 
        
                   -> Paths                   -- ^ path 
        
                   -> LBS.ByteString          -- ^ body 
        
                   -> GenRequest mt 'RW a

github/src/GitHub/Data/Request.hs

Lines 174 to 181 in 01c1154

    
           query :: Paths -> QueryString -> Request mt a 
        
           query ps qs = Query ps qs 
        
           pagedQuery :: FromJSON a => Paths -> QueryString -> FetchCount -> Request mt (Vector a) 
        
           pagedQuery ps qs fc = PagedQuery ps qs fc 
        
           command :: CommandMethod -> Paths -> LBS.ByteString -> Request 'RW a 
        
           command m ps body = Command m ps body

To keep API breakage at bay, I'd add it to Command but keep the smart constructor command as-is. Add a new smart constructor (e.g. paramCommand) that exposes the full feature set of Command.

I resolved the conflicts with master so that CI can run.

Hi @andreasabel ,

This PR is finally ready for review! 🚀
I have tested all endpoints added in the scope of this PR, everything seems to work fine on my test repo.
Some GitHub Actions API features are missing, so implementation does not cover all available API. However, I think that is should be enough for most use cases. Missing endpoints:

https://docs.github.com/en/rest/actions/self-hosted-runner-groups
https://docs.github.com/en/rest/actions/self-hosted-runners
https://docs.github.com/en/rest/actions/permissions
Enterprise-level endpoints for Cache
https://docs.github.com/en/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key - see discussions above, cache can be deleted by Id using an alternative endpoint

@andreasabel reminding about this PR ^_^

Conflicts: .gitignore src/GitHub/Data/Options.hs

Thanks for the PR! and sorry for the delayed review.

I had some stylistic requests but fixed them myself.

What remains is to document the WithTotalCount type.

Candidate for 0.29 at: https://hackage.haskell.org/package/github-0.29/candidate

Addressed the last bits.

Good to go!

Published at https://hackage.haskell.org/package/github-0.29

Big thanks, @K0Te !

Implement actions->artifacts API.

91b9f67

phadej reviewed Oct 9, 2021

View reviewed changes

Up

f1e9513

K0Te marked this pull request as draft July 16, 2022 23:58

K0Te changed the title Implement actions->artifacts API. Implement Actions API. Jul 16, 2022

Cleanup

b1ab2df

Actions - cache.

d094b17

K0Te and others added 5 commits October 30, 2022 17:06

Actions - artifacts and cache.

7b18e83

Secrets

9cf8f3b

Workflows.

e74a861

WorkflowJobs.

6352003

Merge branch 'master' into github-actions-2

afad670

andreasabel self-assigned this Nov 12, 2022

andreasabel added the API change label Nov 12, 2022

K0Te added 8 commits November 12, 2022 17:09

WorkflowRuns.

2811abb

Format

0661ca1

Artifacts QA.

ed61cc1

Cache QA.

50f7fa1

Secrets QA.

d02bed9

WorkflowJobs QA.

90ac4b4

Workflows QA.

d56b38d

Format.

1012da2

K0Te marked this pull request as ready for review November 21, 2022 05:51

K0Te added 3 commits November 20, 2022 21:59

Drop slack-related files.

3f83775

Format JSON

7212468

Support workflow name in workflowRunsForWorkflowR.

72acb62

K0Te added 6 commits November 28, 2022 15:38

Support workflow name in Workflows.hs.

c329f88

Fix

42418cc

Fix

7d7ea3c

Do not parse pull requests from workflow runs.

c6833bf

Avoid parsing 'trigerring_actor', it is sometimes missing.

4c995da

Fix workflow run conclusion parsing.

7838a81

andreasabel added 10 commits June 23, 2023 15:48

Merge branch 'master' into github-actions-2

0071e3d

Whitespace and lexical changes only

a24393c

Merge branch 'master' into github-actions-2

148d0f4

Conflicts: .gitignore src/GitHub/Data/Options.hs

Remove outdated maintainer from module headers

c4ac51c

Whitespace: align code

21f2904

Merge branch 'master' into github-actions-2

62bec02

Bump cabal-version to 2.4 for globbing

9e2b148

Cosmetics: use (<&>)

6b9d05e

Restore upper bounds for openssl etc. in .cabal file

6a03ecc

Whitespace

2a4ddc0

andreasabel requested changes Jun 23, 2023

View reviewed changes

andreasabel added this to the 0.29 milestone Jun 23, 2023

Add haddocks for WithTotalCount

8efa8b6

Changelog for PR haskell-github#459

9837d4c

andreasabel approved these changes Jun 24, 2023

View reviewed changes

andreasabel merged commit 5a26a8c into haskell-github:master Jun 24, 2023

AdrianBunk mentioned this pull request Oct 12, 2024

0.29 testsuite failure on 32-bit #512

Open

Implement Actions API. by K0Te · Pull Request #459 · haskell-github/github · GitHub

Uh oh!

Implement Actions API. - #459

Implement Actions API.#459andreasabel merged 38 commits intohaskell-github:masterhaskell-github/github:masterfrom K0Te:github-actions-2K0Te/github:github-actions-2Copy head branch name to clipboard

Conversation

K0Te commented Jun 22, 2021

Uh oh!

phadej Oct 9, 2021

Choose a reason for hiding this comment

Uh oh!

K0Te Nov 10, 2021

Choose a reason for hiding this comment

Uh oh!

K0Te commented Jul 17, 2022

Uh oh!

andreasabel commented Jul 17, 2022

Uh oh!

andreasabel commented Nov 12, 2022

Uh oh!

K0Te commented Nov 21, 2022

Uh oh!

K0Te commented Apr 15, 2023

Uh oh!

andreasabel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andreasabel commented Jun 24, 2023

Uh oh!

andreasabel left a comment

Choose a reason for hiding this comment

Uh oh!

andreasabel commented Jun 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Implement Actions API.#459
andreasabel merged 38 commits into
haskell-github:masterfrom
K0Te:github-actions-2