Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Android/Fix: Read User Authentication token from the environment variable #3917

Merged
merged 5 commits into from
Jul 4, 2024

Conversation

lucas-zimerman
Copy link
Collaborator

@lucas-zimerman lucas-zimerman commented Jun 26, 2024

📢 Type of change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring

📜 Description

In short, use the authentication token if defined on sentry.properties, fallback to the environment variable if defined, otherwise build will fail.

💡 Motivation and Context

To fix #3795.

💚 How did you test it?

locally:
export SENTRY_AUTH_TOKEN="ABC" then ./gradlew assembleRelease
image
export SENTRY_AUTH_TOKEN="VALID TOKEN"
image

📝 Checklist

  • I reviewed submitted code
  • I added tests to verify changes
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled
  • All tests passing
  • No breaking changes

🔮 Next steps

Closes #3795

@lucas-zimerman lucas-zimerman marked this pull request as ready for review June 26, 2024 20:16
@lucas-zimerman lucas-zimerman changed the title Read User Authentication token from the environment variable Android/Fix: Read User Authentication token from the environment variable Jun 26, 2024
Copy link
Contributor

github-actions bot commented Jun 26, 2024

Android (legacy) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 402.04 ms 425.82 ms 23.78 ms
Size 17.73 MiB 19.95 MiB 2.21 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
70e6261 482.65 ms 495.70 ms 13.05 ms
86d6d2c+dirty 332.90 ms 352.45 ms 19.55 ms
5571a20 410.55 ms 441.06 ms 30.51 ms
1d86dd6 405.14 ms 411.06 ms 5.92 ms
d0bf494+dirty 375.37 ms 395.14 ms 19.77 ms
148f924 492.65 ms 500.28 ms 7.63 ms
27ef4ee 317.40 ms 321.70 ms 4.30 ms
5bb8d5f 431.21 ms 459.40 ms 28.19 ms
2534337 394.15 ms 415.12 ms 20.97 ms
80b2ce3 385.02 ms 387.36 ms 2.34 ms

App size

Revision Plain With Sentry Diff
70e6261 17.73 MiB 19.94 MiB 2.21 MiB
86d6d2c+dirty 17.73 MiB 20.04 MiB 2.31 MiB
5571a20 17.73 MiB 19.93 MiB 2.19 MiB
1d86dd6 17.73 MiB 19.86 MiB 2.12 MiB
d0bf494+dirty 17.73 MiB 19.75 MiB 2.02 MiB
148f924 17.73 MiB 19.94 MiB 2.21 MiB
27ef4ee 17.73 MiB 19.82 MiB 2.08 MiB
5bb8d5f 17.73 MiB 19.93 MiB 2.20 MiB
2534337 17.73 MiB 19.84 MiB 2.11 MiB
80b2ce3 17.73 MiB 19.75 MiB 2.02 MiB

Previous results on branch: feat/android-env-token

Startup times

Revision Plain With Sentry Diff
b664d49 441.00 ms 475.06 ms 34.06 ms

App size

Revision Plain With Sentry Diff
b664d49 17.73 MiB 19.94 MiB 2.21 MiB

Copy link
Contributor

github-actions bot commented Jun 26, 2024

iOS (legacy) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 1213.96 ms 1214.16 ms 0.20 ms
Size 2.36 MiB 3.04 MiB 698.51 KiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
148f924+dirty 1214.76 ms 1215.73 ms 0.97 ms
31fcca2+dirty 1209.17 ms 1216.21 ms 7.04 ms
3ffcddd+dirty 1244.47 ms 1264.14 ms 19.67 ms
27ef4ee+dirty 1293.52 ms 1296.08 ms 2.56 ms
e5c9b8b+dirty 1258.57 ms 1267.32 ms 8.75 ms
e2b64fe+dirty 1232.22 ms 1255.20 ms 22.98 ms
1d86dd6+dirty 1249.71 ms 1279.16 ms 29.45 ms
c398f67+dirty 1219.67 ms 1225.66 ms 5.99 ms
575f9da+dirty 1266.22 ms 1274.84 ms 8.62 ms
2534337+dirty 1225.08 ms 1230.26 ms 5.17 ms

App size

Revision Plain With Sentry Diff
148f924+dirty 2.36 MiB 3.04 MiB 696.25 KiB
31fcca2+dirty 2.36 MiB 2.90 MiB 552.95 KiB
3ffcddd+dirty 2.36 MiB 2.84 MiB 489.60 KiB
27ef4ee+dirty 2.36 MiB 2.85 MiB 500.03 KiB
e5c9b8b+dirty 2.36 MiB 2.87 MiB 520.43 KiB
e2b64fe+dirty 2.36 MiB 2.85 MiB 495.80 KiB
1d86dd6+dirty 2.36 MiB 2.89 MiB 535.43 KiB
c398f67+dirty 2.36 MiB 3.04 MiB 696.27 KiB
575f9da+dirty 2.36 MiB 2.87 MiB 520.20 KiB
2534337+dirty 2.36 MiB 2.88 MiB 525.47 KiB

Previous results on branch: feat/android-env-token

Startup times

Revision Plain With Sentry Diff
b664d49+dirty 1237.53 ms 1233.21 ms -4.32 ms

App size

Revision Plain With Sentry Diff
b664d49+dirty 2.36 MiB 3.04 MiB 698.34 KiB

Copy link
Contributor

github-actions bot commented Jun 26, 2024

iOS (new) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 1212.61 ms 1207.89 ms -4.72 ms
Size 2.92 MiB 3.61 MiB 705.53 KiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
148f924+dirty 1220.72 ms 1221.30 ms 0.58 ms
31fcca2+dirty 1222.04 ms 1226.51 ms 4.47 ms
3ffcddd+dirty 1272.22 ms 1273.98 ms 1.76 ms
27ef4ee+dirty 1236.41 ms 1244.90 ms 8.49 ms
e5c9b8b+dirty 1276.90 ms 1280.92 ms 4.02 ms
e2b64fe+dirty 1285.78 ms 1297.56 ms 11.78 ms
1d86dd6+dirty 1289.25 ms 1293.36 ms 4.11 ms
c398f67+dirty 1227.31 ms 1230.00 ms 2.69 ms
575f9da+dirty 1272.00 ms 1284.38 ms 12.38 ms
2534337+dirty 1220.87 ms 1221.47 ms 0.60 ms

App size

Revision Plain With Sentry Diff
148f924+dirty 2.92 MiB 3.60 MiB 701.88 KiB
31fcca2+dirty 2.92 MiB 3.46 MiB 557.31 KiB
3ffcddd+dirty 2.92 MiB 3.40 MiB 494.39 KiB
27ef4ee+dirty 2.92 MiB 3.41 MiB 503.72 KiB
e5c9b8b+dirty 2.92 MiB 3.43 MiB 524.50 KiB
e2b64fe+dirty 2.92 MiB 3.41 MiB 499.97 KiB
1d86dd6+dirty 2.92 MiB 3.44 MiB 538.27 KiB
c398f67+dirty 2.92 MiB 3.60 MiB 701.89 KiB
575f9da+dirty 2.92 MiB 3.43 MiB 524.26 KiB
2534337+dirty 2.92 MiB 3.43 MiB 529.76 KiB

Previous results on branch: feat/android-env-token

Startup times

Revision Plain With Sentry Diff
b664d49+dirty 1226.08 ms 1221.78 ms -4.31 ms

App size

Revision Plain With Sentry Diff
b664d49+dirty 2.92 MiB 3.61 MiB 705.07 KiB

CHANGELOG.md Outdated Show resolved Hide resolved
@krystofwoldrich
Copy link
Member

@lucas-zimerman Have you tested this with the flavorAware flag enabled?

From the PR description, I'm not sure.

Copy link
Contributor

github-actions bot commented Jun 28, 2024

Android (new) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 346.33 ms 367.85 ms 21.53 ms
Size 7.15 MiB 8.22 MiB 1.07 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
80b2ce3+dirty 271.29 ms 316.47 ms 45.18 ms
86d6d2c+dirty 267.21 ms 325.24 ms 58.04 ms
5571a20+dirty 359.52 ms 389.80 ms 30.28 ms
d0bf494+dirty 253.73 ms 308.23 ms 54.49 ms
22e31b6+dirty 295.75 ms 346.73 ms 50.98 ms
12427f4+dirty 379.48 ms 400.92 ms 21.44 ms
5a22220+dirty 384.61 ms 419.06 ms 34.45 ms
abb7058+dirty 320.78 ms 324.08 ms 3.30 ms
70e6261+dirty 395.08 ms 408.12 ms 13.04 ms
148f924+dirty 347.36 ms 389.13 ms 41.77 ms

App size

Revision Plain With Sentry Diff
80b2ce3+dirty 7.15 MiB 8.04 MiB 911.02 KiB
86d6d2c+dirty 7.15 MiB 8.09 MiB 962.69 KiB
5571a20+dirty 7.15 MiB 8.20 MiB 1.05 MiB
d0bf494+dirty 7.15 MiB 8.04 MiB 910.85 KiB
22e31b6+dirty 7.15 MiB 8.10 MiB 981.29 KiB
12427f4+dirty 7.15 MiB 8.12 MiB 997.78 KiB
5a22220+dirty 7.15 MiB 8.21 MiB 1.06 MiB
abb7058+dirty 7.15 MiB 8.10 MiB 980.40 KiB
70e6261+dirty 7.15 MiB 8.21 MiB 1.07 MiB
148f924+dirty 7.15 MiB 8.21 MiB 1.07 MiB

Previous results on branch: feat/android-env-token

Startup times

Revision Plain With Sentry Diff
b664d49+dirty 370.92 ms 422.47 ms 51.55 ms

App size

Revision Plain With Sentry Diff
b664d49+dirty 7.15 MiB 8.22 MiB 1.07 MiB

@lucas-zimerman
Copy link
Collaborator Author

@lucas-zimerman Have you tested this with the flavorAware flag enabled?

From the PR description, I'm not sure.

I have tested with the default value so FlavorAware was off.

I have tried with flavor aware = true but it seems like the same isn't working for me (build error) but the reasons seems unrelated to this PR.

@lucas-zimerman
Copy link
Collaborator Author

@krystofwoldrich after finding the correct flavoraware filename, I was able to test that there are no additional changes for it to read from the environment file:
image

Copy link
Member

@krystofwoldrich krystofwoldrich left a comment

Choose a reason for hiding this comment

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

Thank you! 🚀

@krystofwoldrich krystofwoldrich merged commit b096e3b into main Jul 4, 2024
60 of 61 checks passed
@krystofwoldrich krystofwoldrich deleted the feat/android-env-token branch July 4, 2024 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Read sentry token from environment variable (SENTRY_AUTH_TOKEN)
2 participants