[spaceship] Add language name in stack trace when localization operations fail #20581

ccaruceru · 2022-08-21T13:21:12Z

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. (not required)

Motivation and Context

Resolves #20336

Description

When executing fastlane deliver and uploading localizations and screenshots there is no way of knowing which language is the one that failed any of the App Store validations. This change adds an additional error with a message about which locale failed to update.

Testing Steps

do a fastlane deliver init on any app (preferably one for testing purposes)
change any of the metadata/<language>/ txt files to fail Apple app info requirements
- e.g. use an existing app name from App Store in name.txt or add text longer than 30 characters in subtitle.txt
run fastlane deliver

Sample errors before

using an existing app name from another account:

#<Thread:0x00000001053a3648@/Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/fastlane_core/lib/fastlane_core/queue_worker.rb:37 run> terminated with exception (report_on_exception is true):
/Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/api_client.rb:204:in `handle_response': The provided entity includes an attribute with a value that has already been used on a different account. - The app name you entered is already being used. If you have trademark rights to this name and would like it released for your use, submit a claim. - /data/attributes/name (Spaceship::UnexpectedResponse)
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/api_client.rb:135:in `patch'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/tunes/tunes.rb:730:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/2.6.0/forwardable.rb:230:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:34:in `update'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'

using an existing app name from your account:

#<Thread:0x00000001366c1f38@/Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/fastlane_core/lib/fastlane_core/queue_worker.rb:37 run> terminated with exception (report_on_exception is true):
/Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/api_client.rb:204:in `handle_response': The provided entity includes an attribute with a value that has already been used on this account. - The app name you entered is already being used for another app in your account. If you would like to use the name for this app you will need to submit an update to your other app to change the name, or remove it from App Store Connect. - /data/attributes/name (Spaceship::UnexpectedResponse)
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/api_client.rb:135:in `patch'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/tunes/tunes.rb:730:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/2.6.0/forwardable.rb:230:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:34:in `update'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start

using a subtitle longer than 30 characters:

#<Thread:0x0000000147787fb0@/Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/fastlane_core/lib/fastlane_core/queue_worker.rb:37 run> terminated with exception (report_on_exception is true):
/Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/api_client.rb:204:in `handle_response': An attribute value is too long. - 'subtitle' cannot be longer than '30' characters. - /data/attributes/subtitle (Spaceship::UnexpectedResponse)
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/api_client.rb:135:in `patch'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/tunes/tunes.rb:730:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/2.6.0/forwardable.rb:230:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:34:in `update'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/gems/2.6.0/gems/fastlane-2.209.0/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'

Sample errors after

using an existing app name from another account:

#<Thread:0x0000000104163910@/Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:37 run> terminated with exception (report_on_exception is true):
/Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:37:in `rescue in update': en-US (Spaceship::AppStoreLocalizationError)
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:32:in `update'
	from /Users/cristian/git/fastlane/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'
/Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/api_client.rb:204:in `handle_response': The provided entity includes an attribute with a value that has already been used on a different account. - The app name you entered is already being used. If you have trademark rights to this name and would like it released for your use, submit a claim. - /data/attributes/name (Spaceship::UnexpectedResponse)
An attribute value is too long. - 'subtitle' cannot be longer than '30' characters. - /data/attributes/subtitle
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/api_client.rb:135:in `patch'
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/tunes/tunes.rb:730:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/2.6.0/forwardable.rb:230:in `patch_app_info_localization'
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:35:in `update'
	from /Users/cristian/git/fastlane/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'

[!] An exception occurred for locale: en-US. Check the localization requirements here: https://help.apple.com/app-store-connect/en.lproj/static.html#dev354659071

using an existing app name from your account:

#<Thread:0x00000001169bf520@/Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:37 run> terminated with exception (report_on_exception is true):
/Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:37:in `rescue in update': en-US (Spaceship::AppStoreLocalizationError)
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:32:in `update'
	from /Users/cristian/git/fastlane/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'
/Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/api_client.rb:204:in `handle_response': The provided entity includes an attribute with a value that has already been used on this account. - The app name you entered is already being used for another app in your account. If you would like to use the name for this app you will need to submit an update to your other app to change the name, or remove it from App Store Connect. - /data/attributes/name (Spaceship::UnexpectedResponse)
An attribute value is too long. - 'subtitle' cannot be longer than '30' characters. - /data/attributes/subtitle
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/api_client.rb:135:in `patch'
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/tunes/tunes.rb:730:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/2.6.0/forwardable.rb:230:in `patch_app_info_localization'
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:35:in `update'
	from /Users/cristian/git/fastlane/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'

[!] An exception occurred for locale: en-US. Check the localization requirements here: https://help.apple.com/app-store-connect/en.lproj/static.html#dev354659071

using a subtitle longer than 30 characters:

#<Thread:0x00000001178997d0@/Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:37 run> terminated with exception (report_on_exception is true):
/Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:37:in `rescue in update': en-US (Spaceship::AppStoreLocalizationError)
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:32:in `update'
	from /Users/cristian/git/fastlane/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'
/Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/api_client.rb:204:in `handle_response': An attribute value is too long. - 'subtitle' cannot be longer than '30' characters. - /data/attributes/subtitle (Spaceship::UnexpectedResponse)
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/api_client.rb:135:in `patch'
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/tunes/tunes.rb:730:in `patch_app_info_localization'
	from /Users/cristian/.rbenv/versions/2.6.8/lib/ruby/2.6.0/forwardable.rb:230:in `patch_app_info_localization'
	from /Users/cristian/git/fastlane/spaceship/lib/spaceship/connect_api/models/app_info_localization.rb:35:in `update'
	from /Users/cristian/git/fastlane/deliver/lib/deliver/upload_metadata.rb:218:in `block in upload'
	from /Users/cristian/git/fastlane/fastlane_core/lib/fastlane_core/queue_worker.rb:40:in `block (2 levels) in start'

[!] An exception occurred for locale: en-US. Check the localization requirements here: https://help.apple.com/app-store-connect/en.lproj/static.html#dev354659071

…sage-for-meta-upload

ccaruceru · 2022-11-14T18:11:58Z

@joshdholtz would you/someone like to have a look at this one? it's just a small QOL improvement 🙂

…sage-for-meta-upload

ccaruceru · 2022-12-17T22:09:44Z

maybe @getaaron can have a quick look at this one? 🙏🏻

vanniktech · 2022-12-29T20:16:17Z

I just ran into this again. Would really like this to be merged and shipped. Gentle push

…sage-for-meta-upload

ccaruceru · 2023-01-20T13:10:55Z

@revolter can you help us with this review? 🙏🏻

getaaron · 2023-01-20T14:23:03Z

This looks good to me. Two questions:

Do you think we should change An exception occurred for language to An exception occurred for locale?
Do you think we should create a custom error class so we don't have to duplicate the string in a bunch of places? https://www.honeybadger.io/blog/ruby-custom-exceptions/

Let me know what you think. And thanks for the PR!

revolter · 2023-01-21T08:49:48Z

I vote yes for both of Aaron's points.

And I think that the custom error class should go into the https://github.com/fastlane/fastlane/blob/master/spaceship/lib/spaceship/errors.rb file 🤔

ccaruceru · 2023-01-21T13:58:33Z

Thank you for the suggestions! Added a couple of error classes with some extra links in the error message for pointing out the Apple docs in case of failure 📓

…sage-for-meta-upload

revolter

LGTM 😁

ccaruceru · 2023-02-14T12:54:02Z

@getaaron addressed the suggestions you mentioned. Can you have a 👀 ?

getaaron · 2023-02-14T19:24:53Z

Looks awesome! Thanks so much for your work on this.

vanniktech · 2023-02-14T21:54:13Z

Thanks for finally merging it!

ccaruceru and others added 4 commits August 20, 2022 22:09

show locale in exception message

cd1c51b

add exception over existing

b0241ca

fix grammar

20cd675

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

43fec10

…sage-for-meta-upload

fastlane-bot added the status: needs-attention label Sep 4, 2022

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

2138eac

…sage-for-meta-upload

vanniktech approved these changes Sep 19, 2022

View reviewed changes

ccaruceru added 3 commits September 22, 2022 12:48

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

7519b41

…sage-for-meta-upload

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

0f1b69c

…sage-for-meta-upload

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

ce8cf67

…sage-for-meta-upload

ccaruceru added 3 commits November 17, 2022 11:51

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

de85497

…sage-for-meta-upload

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

4c0f6ba

…sage-for-meta-upload

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

50612de

…sage-for-meta-upload

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

a35cca1

…sage-for-meta-upload

add error classes with help messages

09f3c67

Merge branch 'fastlane:master' into fix/deliver-add-lang-in-error-mes…

67810aa

…sage-for-meta-upload

revolter approved these changes Jan 31, 2023

View reviewed changes

getaaron merged commit e161ef7 into fastlane:master Feb 14, 2023

ccaruceru deleted the fix/deliver-add-lang-in-error-message-for-meta-upload branch February 14, 2023 20:20

joshdholtz mentioned this pull request Feb 19, 2023

Version bump to 2.212.0 #21063

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[spaceship] Add language name in stack trace when localization operations fail #20581

[spaceship] Add language name in stack trace when localization operations fail #20581

ccaruceru commented Aug 21, 2022 •

edited

ccaruceru commented Nov 14, 2022

ccaruceru commented Dec 17, 2022

vanniktech commented Dec 29, 2022

ccaruceru commented Jan 20, 2023

getaaron commented Jan 20, 2023

revolter commented Jan 21, 2023

ccaruceru commented Jan 21, 2023

revolter left a comment

ccaruceru commented Feb 14, 2023

getaaron commented Feb 14, 2023

vanniktech commented Feb 14, 2023

[spaceship] Add language name in stack trace when localization operations fail #20581

[spaceship] Add language name in stack trace when localization operations fail #20581

Conversation

ccaruceru commented Aug 21, 2022 • edited

Checklist

Motivation and Context

Description

Testing Steps

ccaruceru commented Nov 14, 2022

ccaruceru commented Dec 17, 2022

vanniktech commented Dec 29, 2022

ccaruceru commented Jan 20, 2023

getaaron commented Jan 20, 2023

revolter commented Jan 21, 2023

ccaruceru commented Jan 21, 2023

revolter left a comment

Choose a reason for hiding this comment

ccaruceru commented Feb 14, 2023

getaaron commented Feb 14, 2023

vanniktech commented Feb 14, 2023

ccaruceru commented Aug 21, 2022 •

edited