feat(android, sdks)!: update to the latest gms:play-services-ads:20.5.0

[Mikenso]

Description

Android Update Banner, Interstitial, Rewarded add to be compatible with com.google.android.gms:play-services-ads:20.5.0

BREAKING CHANGES:
Please refer to upstream guides for suggestions on new usage. https://developers.google.com/admob/ios/migration and https://developers.google.com/admob/android/migration

• compileSdkVersion now 31, change your app android build.gradle to 31 if you have not already. Note that JDK11 is required for stable compilation on compileSdkVersion 31, JDK8 has internal compiler errors with SDK31
• onAdLeftApplication removed from the underlying SDK, use react-native built in AppState to determine app went to background
• Smart banner ads removed; use adaptive banner ads. Set height/width explicitly taking into account device size

[CLAassistant]

All committers have signed the CLA.

[docs-page]

To view this pull requests documentation preview, visit the following URL:

docs.page/invertase/react-native-google-ads~32

Documentation is deployed and generated using docs.page.

[codecov]

Codecov Report

Merging #32 (05511a8) into main (382f146) will not change coverage.
The diff coverage is n/a.

❗ Current head 05511a8 differs from pull request most recent head 4e51dac. Consider uploading reports for the commit 4e51dac to get more accurate results

@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage   19.70%   19.70%           
=======================================
  Files          21       21           
  Lines         665      665           
  Branches      167      167           
=======================================
  Hits          131      131           
  Misses        415      415           
  Partials      119      119           

[mikehardy]

Oh fantastic! That was next up on the todo list and it appears you have nailed it! Is this a breaking change? I did not see any changes to the javsascript layer so this appears to be all on the native side. Is that a correct guess? I have not reviewed though - just skimmed really quickly before approving the CI run

Can you sign the CLA agreement as well? Excited to move quickly on this one, and I really appreciate that you posted this

[RodolfoGS]

onAdLeftApplication will be removed? So, we'll not be able to know when a user left the app after tapped on an ad?

[mikehardy]

@RodolfoGS check the underlying SDK docs for reference https://developers.google.com/admob/android/migration
what do they say on the matter?

[RodolfoGS]

Mmm yes, I see, Leave application callback removal. Ok, thanks for the clarification!

[mikehardy]

no problem - I have not read it much myself so I was not actually sure, but I had the link handy ;-). Cheers

[mikehardy]

I marked this as a breaking change (with a title update on the PR including !) and that means we need to generate an excellent note for library consumers indicating what the breaking change(s) is/are, and how they need to react.

It seems like this one might simply be:

BREAKING CHANGE: onAdLeftApplication is removed from the underlying SDK, there is no replacement

[mikehardy]

@Mikenso also needs a bump to compileSdkVersion to 31 (that will be in the example app https://github.com/invertase/react-native-google-ads/blob/0770c96714a84725084acf4130e3c6a40b6d079d/example/android/build.gradle#L8 - unfortunately this means we also need to encourage use of JDK11 as compileSdkVersion 31 has internal compiler errors on JDK8)

Execution failed for task ':app:checkDebugAarMetadata'.
> A failure occurred while executing com.android.build.gradle.internal.tasks.CheckAarMetadataWorkAction
   > The minCompileSdk (31) specified in a
     dependency's AAR metadata (META-INF/com/android/build/gradle/aar-metadata.properties)
     is greater than this module's compileSdkVersion (android-30).
     Dependency: androidx.work:work-runtime:2.7.0.
     AAR metadata file: /Users/runner/.gradle/caches/transforms-3/4739effbb596877ca3318d6c0a41cf71/transformed/work-runtime-2.7.0/META-INF/com/android/build/gradle/aar-metadata.properties.

BREAKING CHANGE: compileSdkVersion now 31, change your app android build.gradle to 31 if you have not already. Note that JDK11 is required for stable compilation on compileSdkVersion 31, JDK8 has internal compiler errors with SDK31

[mikehardy]

@Mikenso run google java formatter locally and commit the result, it will fix the lint errors:

Error: google-java-format exited with exit code 1.
    at errorFromExitCode (/home/runner/work/react-native-google-ads/react-native-google-ads/node_modules/google-java-format/index.js:19:10)
    at ChildProcess.<anonymous> (/home/runner/work/react-native-google-ads/react-native-google-ads/node_modules/google-java-format/index.js:121:40)
    at ChildProcess.emit (events.js:400:28)
    at maybeClose (internal/child_process.js:1058:16)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:293:5)
error Command failed with exit code 1.

https://github.com/invertase/react-native-google-ads/blob/0770c96714a84725084acf4130e3c6a40b6d079d/package.json#L58

[mikehardy]

• lint errors
• example app update to compileSdkVersion 31
• needs a crystal clear description of all breaking changes, to help app developers deal with the changes

[dylancom]

I think that also here setting testDevices has to move to the overall configuration instead of per ad. And so it has to be set in: https://github.com/invertase/react-native-google-ads/blob/9569b98768cacd3f0d3e95b7b44d15d20e59681a/android/src/main/java/io/invertase/googleads/ReactNativeGoogleAdsModule.java

Besides that the key "testDevices" became: "testDeviceIdentifiers".

So this PR should match with setting test devices as follow:
admob().setRequestConfiguration({testDeviceIdentifiers: ["EMULATOR"]});

[mikehardy]

Agreed with Dylan's comment on making sure the test device stuff is in harmony with iOS changes as mentioned, thanks for the review Dylan

[Mikenso]

Hi @mikehardy, @dylancom, thanks for review

Where do I need to specify breaking changes?
It would be:

BREAKING CHANGES:

• compileSdkVersion now 31, change your app android build.gradle to 31 if you have not already. Note that JDK11 is required for stable compilation on compileSdkVersion 31, JDK8 has internal compiler errors with SDK31
• onAdLeftApplication is removed from the underlying SDK, there is no replacement
• Smart banner ads are deprecated in favor of adaptive banner ads.

[mikehardy]

Starting to look good - I still need to do a deeper look (in progress) but here's the results of a surface level scan - simple item of annotation style

[mikehardy]

Looks like it needs either yarn lint:prettier:fix or yarn:eslint:fix as well. The lint tasks need to pass

$ yarn lint:js && yarn lint:android && yarn lint:ios:check
$ eslint lib/ --ext .js,.jsx,.ts,.tsx --max-warnings=0

/home/runner/work/react-native-google-ads/react-native-google-ads/lib/index.d.ts
Error:   123:24  error  Delete `····`  prettier/prettier

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

[mikehardy]

looked good - I confirmed smart banners were gone on ios side as well, and left-app event was also gone on ios, so API is now consistent across platforms with both up to date on SDKs
This looks like a solid forward port, thank you

[mikehardy]

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀