Unify Google API clients for Google Play and Firebase #443

priitlatt · 2025-02-13T10:26:21Z

Unify Google APIs usage under a common package codemagic.google which can be used for both firebase-app-distribution and google-play tools.

Note

This PR contains some breaking changes to internal Python APIs, but all CLI usage remains backwards compatible.

Updated actions:

firebase-app-distribution get-latest-build-version
firebase-app-distribution releases list
google-play get-latest-build-number
google-play tracks get
google-play tracks list
google-play tracks promote-release

For more detailed list of changes refer to CHANGELOG.md.

QA

Full feature parity with current production version is ensured on updated actions.

…facor/unify-google-api-clients

priitlatt · 2025-02-19T14:27:13Z

src/codemagic/apple/resources/resource.py

-    _OMIT_KEYS: Tuple[str, ...] = ("_raw",)
-    _OMIT_IF_NONE_KEYS: Tuple[str, ...] = tuple()
-
+class AppleDictSerializable(DictSerializable):


DictSerializable is now defined in codemagic.models. It is identical to what is here apart from how datetime objects are serialized.

priitlatt · 2025-02-19T14:28:24Z

src/codemagic/cli/argument/typed_cli_argument.py

+    def __init__(cls, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        deprecated_environment_variable_key = getattr(cls, "deprecated_environment_variable_key", None)
+        environment_variable_key = getattr(cls, "environment_variable_key", None)
+        if deprecated_environment_variable_key and not environment_variable_key:
+            raise ValueError(
+                "deprecated_environment_variable_key can only be set if environment_variable_key is also set",
+            )


Hard check to ensure that deprecated environment variable keys can only be defined in case environment_variable_key is defined to avoid developer errors.

priitlatt · 2025-02-19T14:29:51Z

src/codemagic/google/google_play_client.py

Replaces GooglePlayDeveloperAPIClient from codemagic.google_play.

priitlatt · 2025-02-19T14:30:59Z

src/codemagic/google/resource_managers/firebase/firebase_releases_manager.py

Functionally identical to old ReleaseManager that was defined in src/codemagic/google/resource_managers/release_manager.py.

priitlatt · 2025-02-19T14:33:18Z

src/codemagic/google/resource_managers/mixins/listing_manager_mixin.py

Google services are different enough that such an abstraction is just a burden. Request execution lives now in the base ResourceManager class but request building and response handling is left for manager implementations.

priitlatt · 2025-02-19T14:34:02Z

src/codemagic/google/resource_managers/resource_manager.py

+    def resource_type(self) -> Type[ResourceT]:
+        raise NotImplementedError()
+
+    def _execute_request(


Used to be part of ActingManagerMixin which is removed.

priitlatt · 2025-02-19T14:34:55Z

src/codemagic/google/resources/__init__.py

As there are naming conflicts between different services, then it is better to isolate service specific definitions into relevant namespaces.

priitlatt · 2025-02-19T14:36:58Z

src/codemagic/google/resources/identifiers/__init__.py

All this was very Firebase specific and could not be extended to other APIs. It was removed altogether.

priitlatt · 2025-02-19T14:41:07Z

src/codemagic/google/resources/resource.py

This Resource definition combines old implementations of Firebase and Google Play resources so that all needs are covered. String representation is modified slightly to be easier to read by following some patterns from Yaml.

priitlatt · 2025-02-19T15:07:59Z

src/codemagic/tools/google_play/argument_types.py


 from codemagic import cli


-class CredentialsArgument(cli.EnvironmentArgumentValue[str]):
-    environment_variable_key = "GCLOUD_SERVICE_ACCOUNT_CREDENTIALS"


Environment variable name GCLOUD_SERVICE_ACCOUNT_CREDENTIALS is ambiguous and can be confusing. Use GOOGLE_PLAY_SERVICE_ACCOUNT_CREDENTIALS instead, but keep the old version also functional with deprecation warning.

priitlatt · 2025-02-20T10:12:53Z

src/codemagic/google/resource_managers/__init__.py

Package codemagic.google.resource_managers was refactored to codemagic.google.services to better reflect how Google organizes their APIs.

priitlatt · 2025-02-20T10:15:30Z

src/codemagic/google/resources/identifiers/app_identifier.py

This isn't needed at all. Service can build the parent URI from explicit project number and app ID arguments without another layer of abstraction.

priitlatt · 2025-02-20T10:15:59Z

src/codemagic/google/services/firebase/releases_service.py

That used to be ReleasesManager before.

priitlatt · 2025-02-20T10:19:27Z

src/codemagic/google/services/resource_service.py

Method _execute_request from here was moved to new base service class ResourceService.

fran-tirapu

Good refactoring job and nice comments to help the reviewing job.
I left couple of comments.

CHANGELOG.md

fran-tirapu · 2025-02-20T12:16:31Z

src/codemagic/google/resources/resource.py

-class Resource(ABC):
-    __google_api_label__: ClassVar[Optional[str]] = None
+class Resource(DictSerializable, JsonSerializable):
+    @staticmethod


is there any other purpose than the str representation of the object for all these code?
Now the object is DictSerializable/JsonSerializable so probably we can get rid of all this and just use a prettify version of the dict/json.

Base Resource class is indeed mostly just to have a nice string representation of the object which is displayed to the user.

Screenshot

JsonSerializable is just nice to have and adds a convenience method resource.json(**dump_options), which is just a shorthand for json.dumps(resource.dict(), **dump_options). As it exists and is also widely used for App Store Connect resources, then I don't see any reasons not to have it here.

DictSerializable does a little more than just dataclasses.asdict though. It generates a dictionary representation of the resource in a way that the dictionary can be directly passed along to different API calls which require the dictionary to be JSON serializable. That is, the whole dictionary is recursively transformed to contain only basic JSON serializable types. For example ISO8601 representation is used for datetimes, enums are converted to their respective values etc.

Co-authored-by: fran-tirapu <129050941+fran-tirapu@users.noreply.github.com>

priitlatt added 21 commits February 13, 2025 12:25

Extract Firebase resources into dedicated modules

0027367

Merge branch 'master' of github.com:codemagic-ci-cd/cli-tools into re…

f4df41e

…facor/unify-google-api-clients

Merge branch 'master' of github.com:codemagic-ci-cd/cli-tools into re…

711fec3

…facor/unify-google-api-clients

Improve loading argument values from environment variables and files

7efd6be

Fix with statement for Python 3.8

fb0d57c

Rename FirebaseReleaseManager to FirebaseReleasesManager

88c2fdb

Use unified google package for accessing Google APIs

65f431c

Cleanup

68e2f58

Simplify module names

ec5c679

Revert codemagic.tools.google_play.arguments changes

226e1b1

Update changelog

bbc4f81

Fix TracksActionGroup tests

395133d

Fix GetLatestBuildNumberAction tests

c94d89c

Update docs

e082b57

Strip trailing whitespaces from mutually exclusive argument group docs

1cd0046

Check error messages in tests

13b67a1

Reuse reource printer for google-play

35be71f

Fix tests

c55873e

Fix release promotion

dcac40e

Update docs

61828bc

Print errors to stderr stream

9c20c68

priitlatt added firebase google-play labels Feb 19, 2025

priitlatt marked this pull request as ready for review February 19, 2025 14:24

priitlatt commented Feb 19, 2025

View reviewed changes

src/codemagic/google/google_play_client.py Outdated

Copy link

Contributor Author

priitlatt Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaces GooglePlayDeveloperAPIClient from codemagic.google_play.

priitlatt commented Feb 19, 2025

View reviewed changes

priitlatt requested a review from fran-tirapu February 19, 2025 15:50

Match Google Play resource names with API names

c25c8b9

priitlatt added 3 commits February 20, 2025 11:47

Get rid of AppIdentifier

0066055

Rename ResourceManager to ResourceService

9e29fa6

Simplify service names

ac20c4b

priitlatt commented Feb 20, 2025

View reviewed changes

priitlatt added 3 commits February 20, 2025 12:25

Update changelog

44b4e04

Update changelog

0b93fa4

Remove business logic from Track resource

ef99613

fran-tirapu approved these changes Feb 20, 2025

View reviewed changes

Update CHANGELOG.md

6903450

Co-authored-by: fran-tirapu <129050941+fran-tirapu@users.noreply.github.com>

priitlatt merged commit 6ac7b77 into master Feb 21, 2025
13 checks passed

priitlatt deleted the refacor/unify-google-api-clients branch February 21, 2025 10:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify Google API clients for Google Play and Firebase #443

Unify Google API clients for Google Play and Firebase #443

priitlatt commented Feb 13, 2025 •

edited

Loading

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 19, 2025

priitlatt Feb 20, 2025

priitlatt Feb 20, 2025

priitlatt Feb 20, 2025

priitlatt Feb 20, 2025

fran-tirapu left a comment

fran-tirapu Feb 20, 2025

priitlatt Feb 20, 2025

Unify Google API clients for Google Play and Firebase #443

Unify Google API clients for Google Play and Firebase #443

Conversation

priitlatt commented Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fran-tirapu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

priitlatt commented Feb 13, 2025 •

edited

Loading