Fix #7347 - Catch errors loading tflite models in Identity SDK by kentwilliams-stripe · Pull Request #9812 · stripe/stripe-android

kentwilliams-stripe · 2024-12-20T06:31:31Z

Summary

Identity SDK

Validates that cached models are valid, exits flow with IdentityVerificationSheet.VerificationFlowResult.Failed if not
Handle error If an invalid model is still somehow still loaded, preventing an app crash

Motivation

#7347

Testing

Added tests
Modified tests
Manually verified

Changelog

[Fixed] Fix app crash when TFLite model fails to load

github-actions · 2024-12-20T06:37:40Z

Diffuse output:

OLD: identity-example-release-base.apk (signature: V1, V2)
NEW: identity-example-release-pr.apk (signature: V1, V2)

          │            compressed            │           uncompressed           
          ├───────────┬───────────┬──────────┼───────────┬───────────┬──────────
 APK      │ old       │ new       │ diff     │ old       │ new       │ diff     
──────────┼───────────┼───────────┼──────────┼───────────┼───────────┼──────────
      dex │     2 MiB │     2 MiB │ +1.5 KiB │   4.1 MiB │   4.1 MiB │ +1.5 KiB 
     arsc │     1 MiB │     1 MiB │      0 B │     1 MiB │     1 MiB │      0 B 
 manifest │   2.3 KiB │   2.3 KiB │      0 B │     8 KiB │     8 KiB │      0 B 
      res │ 301.8 KiB │ 301.8 KiB │      0 B │ 455.5 KiB │ 455.5 KiB │      0 B 
   native │   6.2 MiB │   6.2 MiB │      0 B │  15.8 MiB │  15.8 MiB │      0 B 
    asset │   7.1 KiB │   7.1 KiB │    -18 B │   6.9 KiB │   6.9 KiB │    -18 B 
    other │  90.2 KiB │  90.3 KiB │    +12 B │ 170.3 KiB │ 170.3 KiB │      0 B 
──────────┼───────────┼───────────┼──────────┼───────────┼───────────┼──────────
    total │   9.6 MiB │   9.6 MiB │ +1.5 KiB │  21.5 MiB │  21.5 MiB │ +1.5 KiB 

 DEX     │ old   │ new   │ diff            
─────────┼───────┼───────┼─────────────────
   files │     1 │     1 │   0             
 strings │ 19966 │ 19970 │  +4 (+9 -5)     
   types │  6188 │  6191 │  +3 (+6 -3)     
 classes │  4979 │  4982 │  +3 (+3 -0)     
 methods │ 29759 │ 29769 │ +10 (+194 -184) 
  fields │ 17526 │ 17540 │ +14 (+284 -270) 

 ARSC    │ old  │ new  │ diff 
─────────┼──────┼──────┼──────
 configs │  164 │  164 │  0   
 entries │ 3622 │ 3622 │  0

APK

     compressed      │    uncompressed     │                                           
──────────┬──────────┼──────────┬──────────┤                                           
 size     │ diff     │ size     │ diff     │ path                                      
──────────┼──────────┼──────────┼──────────┼───────────────────────────────────────────
    2 MiB │ +1.5 KiB │  4.1 MiB │ +1.5 KiB │ ∆ classes.dex                             
  6.3 KiB │    -20 B │  6.1 KiB │    -20 B │ ∆ assets/dexopt/baseline.prof             
 28.5 KiB │     +7 B │ 62.9 KiB │      0 B │ ∆ META-INF/CERT.SF                        
 25.3 KiB │     +6 B │ 62.8 KiB │      0 B │ ∆ META-INF/MANIFEST.MF                    
    859 B │     +2 B │    727 B │     +2 B │ ∆ assets/dexopt/baseline.profm            
  1.2 KiB │     -2 B │  1.2 KiB │      0 B │ ∆ META-INF/CERT.RSA                       
    272 B │     +1 B │    120 B │      0 B │ ∆ META-INF/version-control-info.textproto 
──────────┼──────────┼──────────┼──────────┼───────────────────────────────────────────
    2 MiB │ +1.5 KiB │  4.2 MiB │ +1.5 KiB │ (total)

DEX

STRINGS:

   old   │ new   │ diff       
  ───────┼───────┼────────────
   19966 │ 19970 │ +4 (+9 -5) 
  
  + Invalid TFLite model, likely a corrupted download
  + LB3/m;
  + LH3/n;
  + LK3/g1;
  + VLLLB
  + [LH3/n;
  + [LK3/Y0;
  + [LK3/y0;
  + ~~R8{"backend":"dex","compilation-mode":"release","has-checksums":false,"min-api":21,"pg-map-id":"fe84a2d","r8-mode":"full","version":"8.7.14"}
  
  - VLLB
  - [LH3/i;
  - [LK3/X0;
  - [LK3/x0;
  - ~~R8{"backend":"dex","compilation-mode":"release","has-checksums":false,"min-api":21,"pg-map-id":"cb0eba6","r8-mode":"full","version":"8.7.14"}
  

TYPES:

   old  │ new  │ diff       
  ──────┼──────┼────────────
   6188 │ 6191 │ +3 (+6 -3) 
  
  + LB3/m;
  + LH3/n;
  + LK3/g1;
  + [LH3/n;
  + [LK3/Y0;
  + [LK3/y0;
  
  - [LH3/i;
  - [LK3/X0;
  - [LK3/x0;
  

METHODS:

   old   │ new   │ diff            
  ───────┼───────┼─────────────────
   29759 │ 29769 │ +10 (+194 -184) 
  
  + A3.g <init>(Context, l, g, x)
  + B3.g <init>(t0, IllegalStateException, d)
  + B3.g h(Object, Object) → Object
  + B3.g l(d, Object) → d
  + B3.h <init>(i, d)
  + B3.h o(Object) → Object
  + B3.i <init>(e, s)
  + B3.i <init>(o, g)
  + B3.i a(int, d) → Object
  + B3.i j(Object, d) → Object
  + B3.j <init>(Object, int, Object)
  + B3.j b(g, d) → Object
  + B3.k <init>(l, j, y, b, a, t0, Rect, d)
  + B3.k h(Object, Object) → Object
  + B3.k l(d, Object) → d
  + B3.k o(Object) → Object
  + B3.l <init>()
  + B3.l <init>(O, Context, int)
  + B3.l a() → j
  + B3.l b(a)
  + B3.l c()
  + B3.m <init>(Context, V)
  + B3.m a(d) → l
  + B4.M <init>(i, d)
  + B4.s <init>(i, d)
  + C4.a <init>(i)
  + D.e C0(l0) → y0
  + D.e O(Set, E) → j
  + E3.b <init>(l, l, IdentityActivity)
  + E3.b <init>(l, l, IdentityActivity, byte)
  + H3.a <init>(b, c)
  + H3.a o(Object) → Object
  + H3.b <init>(g, a)
  + H3.b a(String, c) → Object
  + H3.b b(File) → boolean
  + H3.c <init>(g, c)
  + H3.d <init>(g, c)
  + H3.e <init>(g, c)
  + H3.f <init>(g, c)
  + H3.f o(Object) → Object
  + H3.g <init>(k, a, Context)
  + H3.g a(String, c) → Object
  + H3.g b(g, a, c) → Object
  + H3.g c(i, O, c, c) → Object
  + H3.g d(String, String, f, c, E) → Object
  + H3.g e(String, String, J) → Object
  + H3.g f(d, c) → Object
  + H3.g g(String, String, boolean, O) → Object
  + H3.g h(String, String, File, j, c, i) → Object
  + H3.g i(String, String, boolean, W) → Object
  + H3.h <init>(String)
  + H3.i <init>(i, f, String)
  + H3.i a() → Map
  + H3.i b() → x
  + H3.i c() → Map
  + H3.i e() → String
  + H3.i f(OutputStream)
  + H3.i g() → String
  + H3.i h() → String
  + H3.i i(PrintWriter, String)
  + H3.j <init>(m, Object, String, Throwable)
  + H3.k <init>(j, j, j, j, j, j)
  + H3.k a(k, j, j, j, j, j, j, int) → k
  + H3.l <init>()
  + H3.l <init>(j, j)
  + H3.l a(l, j, j, int) → l
  + H3.l b() → IllegalStateException
  + H3.l c() → boolean
  + H3.l d() → boolean
  + H3.l describeContents() → int
  + H3.l equals(Object) → boolean
  + H3.l hashCode() → int
  + H3.l toString() → String
  + H3.l writeToParcel(Parcel, int)
  + H3.m valueOf(String) → m
  + H3.m values() → m[]
  + H3.n <clinit>()
  + H3.n <init>(h, List, m)
  + H3.n describeContents() → int
  + H3.n equals(Object) → boolean
  + H3.n hashCode() → int
  + H3.n toString() → String
  + H3.n writeToParcel(Parcel, int)
  + I3.e b(n, n, n, n, n, n, boolean, float, float, int) → f
  + K3.A0 <init>(c, j, d)
  + K3.A0 h(Object, Object) → Object
  + K3.A0 l(d, Object) → d
  + K3.A0 o(Object) → Object
  + K3.B0 <init>()
  + K3.B0 a(e) → C
  + K3.C0 <init>(c, V, V, d)
  + K3.C0 h(Object, Object) → Object
  + K3.C0 l(d, Object) → d
  + K3.C0 o(Object) → Object
  + K3.D0 <init>(d0, int)
  + K3.E0 <init>(X, C, Context, int)
  + K3.E0 a() → Object
  + K3.F0 <init>(X, C, d)
  + K3.F0 h(Object, Object) → Object
  + K3.F0 l(d, Object) → d
  + K3.G0 <init>(c, X, C, d)
  + K3.G0 i(Object) → Object
  + K3.H0 <init>(C, O, X, Context, c, d)
  + K3.I0 <init>(k0, n, X, C, Context, d0, c, d)
  + K3.J0 <init>(c, L0, d)
  + K3.J0 h(Object, Object) → Object
  + K3.J0 l(d, Object) → d
  + K3.J0 o(Object) → Object
  + K3.K0 <clinit>()
  + K3.K0 g() → String
  + K3.K0 h(String) → J0
  + K3.L0 <init>(X, String, j, int, int)
  + K3.M0 <init>(X, j, String, d)
  + K3.M0 l(d, Object) → d
  + K3.M0 o(Object) → Object
  + K3.N0 <init>(float, m, int)
  + K3.N0 h(Object, Object) → Object
  + K3.O0 <init>(c, boolean)
  + K3.O0 <init>(boolean, Enum, int)
  + K3.O0 i(Object) → Object
  + K3.P0 <init>(m, String, boolean, boolean, C, c
...✂

identity/src/main/java/com/stripe/android/identity/camera/IdentityScanFlow.kt

jaynewstrom-stripe · 2024-12-20T21:48:04Z

identity/src/test/java/com/stripe/android/identity/viewmodel/IdentityScanViewModelTest.kt

        mockFpsTracker,
        mockIdentityAnalyticsRequestFactory,
        mock(),
+        mock(),


Would be nice to see tests for this, rather than just mocks.

Happy to chat about this if you think it's worthwhile! The line you commented on is a finishWithResult function, were you suggesting that I write tests for errorHandler?

kentwilliams-stripe added 5 commits December 19, 2024 14:48

TEMP: go to error page working, sketch code though

1be6fc0

close with failure instead of going to error page

1fff556

Validate model immediately on download or read from cache

1ce8c00

improvements

9bb1367

Remove unused properties

63ae6cb

kentwilliams-stripe changed the title ~~Fix #7347 - Catch errors loading tflite models~~ Fix #7347 - Catch errors loading tflite models in Identity SDK Dec 20, 2024

kentwilliams-stripe added 8 commits December 20, 2024 09:55

Formatting

f86b969

Remove debug line

f44916f

Extra newline

b630b2c

Fix lint/detekt problems

78fc98e

Fix indentation

89b6cab

Fix tests

ca8f45c

Make error handler optional

242d234

Type safety

8f0c344

kentwilliams-stripe marked this pull request as ready for review December 20, 2024 21:23

kentwilliams-stripe requested review from a team as code owners December 20, 2024 21:23

kentwilliams-stripe requested review from awush-stripe and samer-stripe December 20, 2024 21:23

jaynewstrom-stripe reviewed Dec 20, 2024

View reviewed changes

identity/src/main/java/com/stripe/android/identity/camera/IdentityScanFlow.kt Outdated Show resolved Hide resolved

Make errorHandler non-optional, implement all uses

b68840b

jaynewstrom-stripe approved these changes Dec 20, 2024

View reviewed changes

kentwilliams-stripe merged commit dd48576 into master Dec 20, 2024

kentwilliams-stripe deleted the catch-errors-loading-tflite-models branch December 20, 2024 22:36

kentwilliams-stripe mentioned this pull request Dec 20, 2024

Update CHANGELOG.md for #9812 #9817

Merged

3 tasks

kentwilliams-stripe added a commit that referenced this pull request Dec 21, 2024

Update CHANGELOG.md for #9812 (#9817)

0b7c686

bcapps mentioned this pull request Dec 2, 2025

Identity TFLite Model Creation Crash Fix #12083

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #7347 - Catch errors loading tflite models in Identity SDK#9812

Fix #7347 - Catch errors loading tflite models in Identity SDK#9812
kentwilliams-stripe merged 14 commits intomasterfrom
catch-errors-loading-tflite-models

kentwilliams-stripe commented Dec 20, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Dec 20, 2024 •

edited

Loading

Uh oh!

Uh oh!

jaynewstrom-stripe Dec 20, 2024

Uh oh!

kentwilliams-stripe Dec 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

kentwilliams-stripe commented Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation

Testing

Changelog

Uh oh!

github-actions bot commented Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jaynewstrom-stripe Dec 20, 2024

Choose a reason for hiding this comment

Uh oh!

kentwilliams-stripe Dec 20, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kentwilliams-stripe commented Dec 20, 2024 •

edited

Loading

github-actions bot commented Dec 20, 2024 •

edited

Loading