GitHub App: track extra metadata

[stsewd]

We could also make these extra properties that dynamically get the information from extra_data as well (they are present in all objects). Since we weren't updating the extra data field after the integration was created we will need to update all of them (we have less than 2K installations).

from readthedocs.oauth.clients import get_gh_app_client
client = get_gh_app_client()
for installation in GitHubAppInstallation.objects.iterator():
    gh_installation = client.get_app_installation(installation.installation_id)
    gh_installation.extra_data = {"installation": gh_installation.raw_data}
    gh_installation.save()

Closes https://github.com/readthedocs/readthedocs-corporate/issues/2046

[humitos]

    gh_installation.extra_data = {"installation": gh_installation.raw_data}

Why are we saving this data under a installation key, the object is the installation already, there is no need to have a nested field inside it. We should just do gh_installation.extra_data = gh_installation.raw_data for simplification.

[humitos]

What are the options for this field? user and organization only?

[stsewd]

This is the login of the user/organization.

[humitos]

I don't follow you.

[stsewd]

the username of the user/organization.

[humitos]

Suggested change

	default="",
	null=True,
	null=True,
	blank=True,

Remove the default="" so it uses None by default. Also add blank so we can define it from the admin.

[stsewd]

All objects in production will have this field populated after the data migration.

[stsewd]

Why are we saving this data under a installation key, the object is the installation already, there is no need to have a nested field inside it. We should just do gh_installation.extra_data = gh_installation.raw_data for simplification.

Extra data can contain more info related to event when the installation was created.

[humitos]

Extra data can contain more info related to event when the installation was created.

In that case, we should call gh_installation.extra_data.update(extra_data) to avoid overriding other fields in the JSON, shouldn't we?

[stsewd]

In that case, we should call gh_installation.extra_data.update(extra_data) to avoid overriding other fields in the JSON, shouldn't we?

During the migration yeah, after that it's fine to override.

[humitos]

In that case, after the migration we won't have other fields inside the JSON... that goes back to my original question? Why are we saving it as = {"installation": data} instead of just = data?

[stsewd]

In that case, after the migration we won't have other fields inside the JSON.

After the migration we will still have extra fields in the data field, that's from when the installation was updated

readthedocs.org/readthedocs/oauth/tasks.py

Line 819 in 8221425

data = self.data.copy()

At the end, this is just extra metadata to debug, or make it easy to inspect some fields without re-fetching the installation.