Configurez l’agent React Native pour EAS Build

Si vous compilez votre application React Native avec EAS Build, la Continuous Native Generation (CNG) d’Expo régénère vos dossiers android/ et ios/ à partir de zéro à chaque étape expo prebuild — à la fois localement et sur les serveurs de compilation d’EAS. Cela signifie qu’un fichier newrelic.properties ajouté manuellement ou une phase de compilation Xcode Run Script ajoutée à la main est effacé lors de la prochaine compilation.

Le plug-in de configuration newrelic-react-native-agent résout ce problème en régénérant la configuration de build New Relic à chaque prebuild, de sorte que le téléchargement du fichier de modélisation Android et de la source map et le téléchargement du dSYM iOS et de la source map continuent de fonctionner à travers les builds EAS. Le plug-in lit les identifiants à partir des variables d’environnement au moment du build et ne les valide jamais dans votre référentiel (repository).

Avant de commencer

Obtenez les éléments suivants à partir du même compte New Relic :

• Une clé API utilisateur.
• Votre jeton d’application Android et/ou iOS (le même jeton que vous transmettez à NewRelic.startAgent()). Si vous déployez sur les deux plateformes, vous aurez besoin d’un jeton par plateforme.

Définissez les variables d’environnement EAS

Enregistrez votre clé API utilisateur et vos jetons d’application en tant que variables d’environnement EAS, limitées aux environnements avec lesquels vous compilez :

$
eas env:create --environment production --name NEWRELIC_USER_API_KEY --value <YOUR_USER_API_KEY> --visibility sensitive
$
eas env:create --environment production --name NEWRELIC_ANDROID_APP_TOKEN --value <YOUR_ANDROID_APP_TOKEN> --visibility sensitive
$
eas env:create --environment production --name NEWRELIC_IOS_APP_TOKEN --value <YOUR_IOS_APP_TOKEN> --visibility sensitive

Android : téléversement automatique du fichier de modélisation et de la source map

Sans configuration supplémentaire, le plug-in lit votre clé API utilisateur à partir de NEWRELIC_USER_API_KEY et votre jeton d’application Android à partir de NEWRELIC_ANDROID_APP_TOKEN, et les écrit dans android/app/newrelic.properties lors de chaque prebuild :

{
  "name": "my app",
  "plugins": ["newrelic-react-native-agent"]
}

Ces propriétés sont ce que les tâches Gradle newrelicMapUploadRelease et newrelicReactNativeSourceMapUploadRelease de l’agent lisent pour authentifier le téléversement de votre fichier de modélisation ProGuard/R8 et de la source map React Native après chaque compilation de sortie. Pour en savoir plus sur le fonctionnement de ce téléversement (et comment téléverser manuellement si nécessaire), consultez la section Signalement des erreurs JavaScript React Native.

Si une seule des deux variables d’environnement est définie, le plug-in écrit tout de même cette propriété unique, et la tâche Gradle indique dans le log celle qui manque plutôt que de faire échouer la compilation. Si aucune n’est définie, le plug-in laisse newrelic.properties intact et les deux tâches ignorent le téléversement avec un message de log.

Utilisez des noms de variables d’environnement personnalisés (Android)

Pour récupérer la clé et le jeton à partir de variables d'environnement nommées différemment, passez-les explicitement :

{
  "name": "my app",
  "plugins": [
    [
      "newrelic-react-native-agent",
      {
        "android": {
          "apiKeyEnvName": "MY_NR_USER_API_KEY",
          "appTokenEnvName": "MY_NR_ANDROID_APP_TOKEN"
        }
      }
    ]
  ]
}

iOS : téléversement automatique des dSYM et des source maps

Contrairement à Android, les scripts de téléversement de dSYM et de source map React Native (run-symbol-tool et upload-react-native-sourcemap, du dossier dsym-upload-tools) ne sont pas inclus dans le CocoaPod NewRelicAgent, et nécessitent normalement une phase de build Run Script ajoutée à la main dans Xcode — ce qui ne survit pas à la régénération de ios/ par expo prebuild. À chaque prebuild, le plug-in va plutôt :

• Copie les deux scripts dans ios/dsym-upload-tools.
• Ajoute une phase de compilation Run Script nommée « Upload dSYMs and Source Maps to New Relic » (après « Bundle React Native code and images ») qui les invoque, en lisant les identifiants à partir des variables d’environnement au moment de la compilation — le script généré référence uniquement les identifiants par leur nom et ne les écrit jamais dans un fichier.
• S’assure que la phase "Bundle React Native code and images" exporte SOURCEMAP_FILE, car le modèle par défaut d’Expo ne le définit pas et Expo ne générerait pas le source map autrement.

Sans configuration supplémentaire, la phase de build lit le jeton de votre application iOS à partir de NEWRELIC_IOS_APP_TOKEN et votre clé API utilisateur à partir de NEWRELIC_USER_API_KEY (partagée avec la valeur par défaut d’Android) :

{
  "name": "my app",
  "plugins": ["newrelic-react-native-agent"]
}

Pour plus d’informations sur ce que font ces scripts et sur le fonctionnement de l’importation de dSYM en dehors d’Expo, consultez Importer des dSYM.

Utilisez des noms de variables d’environnement personnalisés (iOS)

Pour récupérer le jeton et la clé à partir de variables d’environnement nommées différemment, passez-les explicitement :

{
  "name": "my app",
  "plugins": [
    [
      "newrelic-react-native-agent",
      {
        "ios": {
          "appTokenEnvName": "MY_NR_IOS_APP_TOKEN",
          "apiKeyEnvName": "MY_NR_USER_API_KEY"
        }
      }
    ]
  ]
}

Vérifiez le téléversement

Après avoir exécuté un build EAS, vérifiez les logs de build pour chaque plateforme :

• Android: recherchez les tâches Gradle newrelicMapUploadRelease et newrelicReactNativeSourceMapUploadRelease dans le log. Une exécution réussie signale que le fichier de modélisation et la source map ont été trouvés et téléversés, sans avertissement de configuration manquante.
• iOS: recherchez l’étape d’exécution de script « Upload dSYMs and Source Maps to New Relic ». Si un identifiant est manquant, il indique dans le log lequel et ignore ce téléversement (par exemple, NEWRELIC_IOS_APP_TOKEN not set, skipping...) plutôt que de faire échouer la compilation. Lorsque les identifiants sont présents, il indique dans le log qu’il traite les dSYM et la source map et les téléverse vers New Relic.

Une fois qu'un build a réussi, confirmez que la source map est bien arrivée dans New Relic en consultant Lister et supprimer les source maps React Native.

Dépannage