[spaceship] Add get app availabilities v2 request #21901

lucgrabowski · 2024-02-29T15:10:02Z

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I see several green ci/circleci builds in the "All checks have passed" section of my PR (connect CircleCI to GitHub if not)
I've read the Contribution Guidelines
I've updated the documentation if necessary.
I've added or updated relevant unit tests.

Motivation and Context

As written in #21890, there is a need to implement a new request for app availabilities. It will allow for checking if app is available or removed from distribution.
PR should be considered after #21900 is handled.

Description

In this PR a request for app availabilities (https://developer.apple.com/documentation/appstoreconnectapi/read_app_availablity_territories) is implemented. It's a first request to v2 version in path.
Request is used in Pricing and Availability on AppStoreConnect.

Testing Steps

I added unit tests for models.
I also tested the request in spaceship playground.

…st - the same way as in open api specs

…h longer url with services-account

shernade · 2024-04-16T16:29:48Z

question: how are you going to know which territory corresponds to a territoryAvailability?

lucgrabowski · 2024-04-16T20:18:40Z

@shernade I took a look at the fixtures and I think that when you fetch appAvailabilities you can get territoryAvailabilities and as far as I remember ids are meaningful for them. If you want to know exactly how it works, you could login to AppstoreConnect in web browser with developer tools open and check network requests on "Pricing and Availability".

shernade · 2024-04-16T20:50:08Z

i see that doing a call like this:
client.tunes_request_client.get("v2/appAvailabilities/6497953632/territoryAvailabilities", client.tunes_request_client.build_params(filter: {}, includes: "territory", limit: 200 , sort: nil)) including territory the json data has territory info:

 =>
#<Spaceship::ConnectAPI::Response:0x00007f9abe72a2f8
 @body=
  {"data"=>
    [{"type"=>"territoryAvailabilities",
      "id"=>"eyJzIjoiNjQ5Nzk1MzYzMiIsInQiOiJEWkEifQ",
      "attributes"=>{"available"=>false, "availableInPast"=>false, "preOrderAvailableInPast"=>false, "releaseDate"=>nil, "preOrderEnabled"=>false, "preOrderPublishDate"=>nil, "contentStatuses"=>["CANNOT_SELL"]},
      "relationships"=>{"territory"=>{"data"=>{"type"=>"territories", "id"=>"DZA"}}},
      "links"=>{"self"=>"https://appstoreconnect.apple.com/iris/v1/territoryAvailabilities/eyJzIjoiNjQ5Nzk1MzYzMiIsInQiOiJEWkEifQ"}},
     {"type"=>"territoryAvailabilities",
      "id"=>"eyJzIjoiNjQ5Nzk1MzYzMiIsInQiOiJWRU4ifQ",
      "attributes"=>{"available"=>false, "availableInPast"=>false, "preOrderAvailableInPast"=>false, "releaseDate"=>nil, "preOrderEnabled"=>false, "preOrderPublishDate"=>nil, "contentStatuses"=>["CANNOT_SELL"]},
      "relationships"=>{"territory"=>{"data"=>{"type"=>"territories", "id"=>"VEN"}}},
      "links"=>{"self"=>"https://appstoreconnect.apple.com/iris/v1/territoryAvailabilities/eyJzIjoiNjQ5Nzk1MzYzMiIsInQiOiJWRU4ifQ"}},
     {"type"=>"territoryAvailabilities",

that model data seems a bit complicated to me,
thanks

max-ott · 2024-05-03T11:59:59Z

@lucgrabowski Let's get #21900 through the door first. I hope tests are passing now. Then there should be less changes here, and hopefully less warnings.

Could you provide me/us with some basic steps to test/reproduce this with the Spaceship playground? More than happy to review that so we can get this PR here over the finish lines as well! Thanks for your work in the meantime :)

jakub-przy · 2024-05-03T14:10:57Z

#21900
Has been merged 🥇

…-request

lucgrabowski · 2024-05-04T12:22:09Z

@max-ott Thanks for reviewing and merging other PRs. I don’t have an access to computer this weekend, but I have tried merging master through web interface, I hope it will be fine.

About testing steps in Spaceship playground. I logged in to developer account, fetched ConnectAPI::App and called get_app_availabitilites for this app. It’s also good to later check territory_availabilities for app availability. I used it in #21902

Also, using a network proxy may be useful and running playground with SPACESHIP_DEBUG=1 enabled, https://github.com/fastlane/fastlane/blob/master/spaceship/docs/Debugging.md)

jakub-przy · 2024-05-08T11:53:41Z

I have created my own fork with all the latest commits from master and then also applied the changes introduced in this PR - when running a test App Store deployment workflow - i'm still getting pretty much the same error:

> ************************/vendor/bundle/ruby/2.7.0/bundler/gems/fastlane_fork-e8fe2a941102/spaceship/lib/spaceship/connect_api/api_client.rb:223:in `handle_response': \e[31m[!] The provided entity includes an unknown attribute - 'availableInNewTerritories' is not an attribute on the resource 'apps' - /data/attributes/availableInNewTerritories (Spaceship::UnexpectedResponse)
> The provided entity includes an unknown relationship - 'prices' is not a relationship on the resource 'apps' - /data/relationships/prices
> The provided entity includes an unknown relationship - 'availableTerritories' is not a relationship on the resource 'apps' - /data/relationships/availableTerritories\e[0m

I just thought you'd like to know

max-ott · 2024-05-08T12:08:03Z

I think the problem is that you can only retrieve (get) the availabilities if they are already set. If they are empty, e.g. for a new app, there will be an error. I'm not 100% sure how other spaceship methods handle this. Ideally we would be able to get but also set / update the availabilities.

My test:

// login first
app = Spaceship::ConnectAPI::App.get(app_id: "123456789")
app.get_app_availabilities

Results

.../fastlane-2f8d1a77ff58/spaceship/lib/spaceship/connect_api/api_client.rb:223:in `handle_response': The specified resource does not exist - There is no resource of type 'appAvailabilities' with id '123456789' (Spaceship::UnexpectedResponse)
	from .../fastlane-2f8d1a77ff58/spaceship/lib/spaceship/connect_api/api_client.rb:114:in `get'
	from .../fastlane-2f8d1a77ff58/spaceship/lib/spaceship/connect_api/tunes/tunes.rb:425:in `get_app_availabilities'
	from .../forwardable.rb:240:in `get_app_availabilities'
	from .../fastlane-2f8d1a77ff58/spaceship/lib/spaceship/connect_api/models/app.rb:157:in `get_app_availabilities'
	from (irb):7:in `<main>'
...
	```

It works just fine for apps that already have set availabilities.

jakub-przy · 2024-05-08T13:17:00Z

@max-ott
You were absolutely right - it works! I guess we're gonna have to set those capabilities manually until a proper fix is in place. Still, this is great, cheers!

shernade

Looks good to me

Hantex9 · 2024-06-10T23:08:38Z

Hello 👋
Is there any news? The implementation of @lucgrabowski seems to be working correctly

shernade

I guess a high rated member should approve, right?

bkrijgsman · 2024-06-13T14:49:39Z

When I try to submit an app using your branche I still get the response of;
[!] The provided entity includes an unknown attribute - 'availableInNewTerritories' is not an attribute on the resource 'apps' - /data/attributes/availableInNewTerritories (Spaceship::UnexpectedResponse)

max-ott · 2024-06-13T15:10:55Z

@bkrijgsman Please keep in mind that this is only to retrieve the territories. If you have not previously set it, you will get this error message.

max-ott

Looking good to me!

bkrijgsman · 2024-06-13T15:18:36Z

@bkrijgsman Please keep in mind that this is only to retrieve the territories. If you have not previously set it, you will get this error message.

Ah check thanks.

Well if there is somehow who is good into this and can fix again that pricing & territories can be set from zero; would be very great. Maybe I can get a reward from my company, since this issue is now blocking our build street for some weeks.

jakub-przy · 2024-06-17T08:31:14Z

Ah check thanks.

Well if there is somehow who is good into this and can fix again that pricing & territories can be set from zero; would be very great. Maybe I can get a reward from my company, since this issue is now blocking our build street for some weeks.

@bkrijgsman

Similar situation here. Basically, now we're doing that initial part of the set-up manually, and then everything else is automated. Not as much of a pain as we initially thought (just 1-2 mins of manual work per workflow) but certainly not ideal.

france-workmail · 2024-06-20T17:31:13Z

Sorry kind of new to this. Is there any news on when this will. be available on deliver action?

muhammad67uzair · 2024-06-24T06:56:09Z

@lucgrabowski
can you show me an example of how can i set the app availability and pricing using spaceship?
the app availabilities are already manually set, i just need to update them

max-ott · 2024-06-24T08:00:25Z

@muhammad67uzair Please read through the thread. This functionality is only for retrieving set availabilities. Locking this thread to prevent non relevant discussions.

lucgrabowski added 7 commits February 27, 2024 23:53

Move endpoint version v1 from hostname to path to define it per reque…

814d92a

…st - the same way as in open api specs

Fix client tests

cb08060

Fix middleware tests and change services order in array to first matc…

9a453dd

…h longer url with services-account

Add first v2 request to get app availabilities

d21f455

require model files

85e29e3

Add ContentStatus enum values

a4147f0

Return first app availability from models array

cb668a8

github-actions bot added the tool: spaceship label Feb 29, 2024

lucgrabowski mentioned this pull request Feb 29, 2024

[spaceship] Check if app removed from sale #21902

Open

6 tasks

lucgrabowski added 2 commits February 29, 2024 17:12

Remove commas, run rubocop

039d68a

Add tests tor App's get_app_availabilities

7333e81

lucgrabowski mentioned this pull request Apr 12, 2024

AvailableTerritories is deprecated and fastlane is not upgraded to new api endpoints #21968

Open

4 tasks

lucgrabowski marked this pull request as ready for review May 4, 2024 09:13

lucgrabowski added 2 commits May 4, 2024 14:03

Merge branch 'master' into lucgrabowski-add-get-app-availabilities-v2…

13bb964

…-request

Merge fix

6da4002

Fix lint issue

2f8d1a7

shernade approved these changes May 21, 2024

View reviewed changes

shernade approved these changes Jun 11, 2024

View reviewed changes

max-ott approved these changes Jun 13, 2024

View reviewed changes

max-ott merged commit 511d57d into master Jun 23, 2024

fastlane locked as resolved and limited conversation to collaborators Jun 24, 2024

[spaceship] Add get app availabilities v2 request #21901

[spaceship] Add get app availabilities v2 request #21901

Uh oh!

Conversation

lucgrabowski commented Feb 29, 2024

Checklist

Motivation and Context

Description

Testing Steps

Uh oh!

shernade commented Apr 16, 2024

Uh oh!

lucgrabowski commented Apr 16, 2024

Uh oh!

shernade commented Apr 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

max-ott commented May 3, 2024

Uh oh!

jakub-przy commented May 3, 2024

Uh oh!

lucgrabowski commented May 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakub-przy commented May 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

max-ott commented May 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakub-przy commented May 8, 2024

Uh oh!

shernade left a comment

Choose a reason for hiding this comment

Uh oh!

Hantex9 commented Jun 10, 2024

Uh oh!

shernade left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bkrijgsman commented Jun 13, 2024

Uh oh!

max-ott commented Jun 13, 2024

Uh oh!

max-ott left a comment

Choose a reason for hiding this comment

Uh oh!

bkrijgsman commented Jun 13, 2024

Uh oh!

jakub-przy commented Jun 17, 2024

Uh oh!

france-workmail commented Jun 20, 2024

Uh oh!

muhammad67uzair commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

max-ott commented Jun 24, 2024

Uh oh!

Uh oh!

shernade commented Apr 16, 2024 •

edited

Loading

lucgrabowski commented May 4, 2024 •

edited

Loading

jakub-przy commented May 8, 2024 •

edited

Loading

max-ott commented May 8, 2024 •

edited

Loading

shernade left a comment •

edited

Loading

muhammad67uzair commented Jun 24, 2024 •

edited

Loading