feat!: Widen CustomProperties type to map[string]interface{} to align with GitHub API

[spalberg]

Fixes: #3229.

BREAKING CHANGE: PushEventRepository.CustomProperties is changed from map[string]string to map[string]interface{}.

adds tests for json unmarshalling of projects

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[gmlewis]

Thank you, @spalberg !
Just one comment, then we should be able to merge after a second LGTM+Approval from any other contributor to this repo.

[gmlewis]

Instead of an actual response, how about if you just put one value of each type that you found, please?

[spalberg]

I minimized the json as you suggested to have a small partial project

[gmlewis]

Maybe @chapurlatn can review these changes?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.94%. Comparing base (2b8c7fa) to head (e6c19fd).
Report is 92 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3230      +/-   ##
==========================================
- Coverage   97.72%   92.94%   -4.78%     
==========================================
  Files         153      171      +18     
  Lines       13390    11633    -1757     
==========================================
- Hits        13085    10812    -2273     
- Misses        215      727     +512     
- Partials       90       94       +4     

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

[gmlewis]

How about this?

Suggested change

	data: []byte(`{"custom_properties":{"boolean":"false","text":"a","single-select":"a","multi-select":["a","b","c"]}}`),
	data: []byte(`{"custom_properties":{"boolean":false,"int":42,"key":"value","array":["a","b","c"]}}`),

[spalberg]

This would imply that there is a possible integer value when there is non (that we know of). I used the different custom property types offered by GitHub (see here) and observed their representation in the api, using their label in the github ui as key for this json.

I guess it depends on whats the goal - testing that the unmarshalling works according to the type or testing the possible values that github could send for the given field. What do you think?

[gmlewis]

Oh, I see, well at least please change the boolean from a string to false without the quotes.

[spalberg]

GitHub returns the value for boolean type custom properties as strings ("true" or "false"). Should I remove the quotes regardless?

[gmlewis]

Are you sure? We have hundreds of endpoints that return booleans, and none of them are strings.
What makes you say this? You made a boolean custom property and it is returning a string?!?

[spalberg]

Yes, I configured custom properties of all types and looked at the api response from github.
This is the actual response from the github api with one custom property (named accordingly) of each type configured:

{
  // ...
   "custom_properties": {
      "type-multi-select": [
        "a",
        "b"
      ],
      "type-single-select": "b",
      "type-text": "lala",
      "type-true-false": "true"
  },
  //...
}

[spalberg]

I'd love it if they would return an actual boolean here 😄

[gmlewis]

OK, bizarre.
Then it looks like there is one linting failure remaining... let me look.

[gmlewis]

It looks like the generated files are out-of-date if you could please update them.

[spalberg]

The whole integration of file generation is a really cool golang feature!
Just pushed the updated files 👍

[gmlewis]

Thank you, @spalberg !
LGTM

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

[arymoraes]

LGTM

And yeah I remember when I was doing #3200 that a boolean type custom property comes as string from the GitHub API.

[gmlewis]

Thank you, @arymoraes !
Merging.