Metadata: Environment and Device Information #315

tobitech · 2025-04-09T12:12:27Z

User description

Story: https://app.shortcut.com/smileid/story/15152/

Summary

Collect metadata for timezone
Collect metadata for user's localed
Collect metadata for screen resolution
Collect metadata for available physical memory
Collect metadata for device orientation
Collect metadata for system architecture.

Known Issues

N/A.

Test Instructions

Run a job and inspect the metadata to confirm that the data points listed in the description above are collected and that they are in the right format based on the story.

Screenshot

N/A

PR Type

Enhancement

Description

Added device environment metadata collection
Fixed allowNewEnroll parameter type
Implemented extensions for device information

Changes walkthrough 📝

Relevant files

Bug fix

3 files

OrchestratedBiometricKycViewModel.swift `Fix allowNewEnroll parameter type`	+1/-1
OrchestratedDocumentVerificationViewModel.swift `Fix allowNewEnroll parameter type`	+1/-1
LocalStorage.swift `Fix allowNewEnroll parameter type`	+1/-1

Enhancement

5 files

MetadataKey.swift `Add new metadata keys`	+6/-0
MetadataManager.swift `Implement collection of environment metadata`	+10/-0
ProcessInfoExtension.swift `Add extension for memory and architecture info`	+27/-0
UIDeviceExtension.swift `Add device orientation detection`	+28/-0
UIScreenExtension.swift `Add screen resolution formatting`	+11/-0

Need help?
Type /help how to ... in the comments thread for any questions about PR-Agent usage.
Check out the documentation for more information.

prfectionist · 2025-04-09T12:13:02Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Potential UI Thread Issue The code accesses UI elements (UIApplication.shared.windows) to determine orientation when device orientation is unknown. This could cause issues if called from a background thread. let interfaceOrientation = UIApplication.shared.windows.first?.windowScene?.interfaceOrientation switch interfaceOrientation { case .portrait, .portraitUpsideDown: return "Portrait" case .landscapeLeft, .landscapeRight: return "Landscape" case .unknown, .none: return "Unknown" @unknown default: return "Unknown" } Memory Representation The available memory is returned as a string without formatting. Consider adding proper formatting (e.g., thousands separators) for better readability. var availableMemoryInMB: String { // Get physical memory in bytes let physicalMemory = self.physicalMemory // Convert to MB (1 MB = 1,048,576 bytes) let memoryInMB = physicalMemory / 1_048_576 return "\(memoryInMB)" }

github-actions · 2025-04-09T12:13:20Z

	Warnings
⚠️	The source files were changed, but the tests remain unmodified. Consider updating or adding to the tests to match the source changes.
⚠️	Sources/SmileID/Classes/SelfieCapture/SelfieViewModel.swift#L229 - TODOs should be resolved (Use mouth deformation as an al...). (`todo`)

Generated by 🚫 Danger Swift against a638c10

prfectionist · 2025-04-09T12:13:25Z

Sources/SmileID/Classes/Metadata/UIDeviceExtension.swift

+    var orientationString: String {
+        switch UIDevice.current.orientation {
+        case .portrait, .portraitUpsideDown:
+            return "Portrait"
+        case .landscapeLeft, .landscapeRight:
+            return "Landscape"
+        case .faceUp:
+            return "FaceUp"
+        case .faceDown:
+            return "FaceDown"
+        case .unknown:
+            // Default to UI orientation if device orientation is unknown
+            let interfaceOrientation = UIApplication.shared.windows.first?.windowScene?.interfaceOrientation
+            switch interfaceOrientation {
+            case .portrait, .portraitUpsideDown:
+                return "Portrait"
+            case .landscapeLeft, .landscapeRight:
+                return "Landscape"
+            case .unknown, .none:
+                return "Unknown"
+            @unknown default:
+                return "Unknown"
+            }
+        @unknown default:
+            return "Unknown"
+        }
+    }


Suggestion: The code is using the deprecated UIApplication.shared.windows property which was deprecated in iOS 15. Use UIApplication.shared.connectedScenes instead to get the interface orientation. [possible issue, importance: 8]

Suggested change

var orientationString: String {

switch UIDevice.current.orientation {

case .portrait, .portraitUpsideDown:

return "Portrait"

case .landscapeLeft, .landscapeRight:

return "Landscape"

case .faceUp:

return "FaceUp"

case .faceDown:

return "FaceDown"

case .unknown:

// Default to UI orientation if device orientation is unknown

let interfaceOrientation = UIApplication.shared.windows.first?.windowScene?.interfaceOrientation

switch interfaceOrientation {

case .portrait, .portraitUpsideDown:

return "Portrait"

case .landscapeLeft, .landscapeRight:

return "Landscape"

case .unknown, .none:

return "Unknown"

@unknown default:

return "Unknown"

}

@unknown default:

return "Unknown"

}

}

var orientationString: String {

switch UIDevice.current.orientation {

case .portrait, .portraitUpsideDown:

return "Portrait"

case .landscapeLeft, .landscapeRight:

return "Landscape"

case .faceUp:

return "FaceUp"

case .faceDown:

return "FaceDown"

case .unknown:

// Default to UI orientation if device orientation is unknown

if let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene {

switch windowScene.interfaceOrientation {

case .portrait, .portraitUpsideDown:

return "Portrait"

case .landscapeLeft, .landscapeRight:

return "Landscape"

case .unknown:

return "Unknown"

@unknown default:

return "Unknown"

}

}

return "Unknown"

@unknown default:

return "Unknown"

}

}

robin-smileid · 2025-04-09T15:06:35Z

Sources/SmileID/Classes/Metadata/UIDeviceExtension.swift

@@ -21,6 +21,34 @@ extension UIDevice {
            ?? identifier
    }

+    var orientationString: String {


This value is also something that fluctuates over time (ie. depending on when it is recorded). I do wonder if we want to collect this in an array? The question then is how often and when do we want to sample this value? cc @Yeboahmedia

robin-smileid

Code changes look fine to me. Tested the flow and the values are added correctly. Left a comment in case we want to collect device orientation as an array.

JNdhlovu

@tobitech @robin-smileid I think like the orientation the available memory is also something that changes overtime, is that something we want to set on init when we init the metadata or this is something that should be set maybe when we begin a flow or something?

robin-smileid · 2025-04-10T10:48:46Z

@tobitech @robin-smileid I think like the orientation the available memory is also something that changes overtime, is that something we want to set on init when we init the metadata or this is something that should be set maybe when we begin a flow or something?

@JNdhlovu We actually record the total memory (RAM) of the device. This shouldn't change over time. We can also think about recording memory changes (available memory) and then that would need to recorded differently.

…t selfie.

robin-smileid · 2025-04-14T10:07:18Z

Sources/SmileID/Classes/Metadata/ProcessInfoExtension.swift

+            return "ARM64"
+        #elseif arch(x86_64)
+            return "x86_64"
+        #elseif arch(i386)
+            return "i386"
+        #else
+            return "Unknown"


Should we keep this all lower cased?

Suggested change

return "ARM64"

#elseif arch(x86_64)

return "x86_64"

#elseif arch(i386)

return "i386"

#else

return "Unknown"

return "arm64"

#elseif arch(x86_64)

return "x86_64"

#elseif arch(i386)

return "i386"

#else

return "unknown"

robin-smileid · 2025-04-14T10:09:46Z

Sources/SmileID/Classes/Metadata/UIDeviceOrientationExtension.swift

+            return "FaceUp"
+        case .faceDown:
+            return "FaceDown"
+        case .unknown:


And maybe also here lower-case unknown. Just to keep consistency in case we can't extract it.

robin-smileid

Code changes look fine to me so far. Can we please also add the device orientation recording when we do a document capture? Left some comments in terms of default value unknown in case we can't extract a value.

tobitech added 8 commits April 8, 2025 10:43

collect metadata info for timezone identifier.

63ee572

collect metadata info for user's locale.

4611dcd

collect metadata info for screen resolution.

4707685

collect metadata info for available memory

9459e77

collect metadata for device orientation.

57b5283

collect metadata for system architecture.

ddac5e3

code formatting.

89f88e0

fix boolean issue from merging main.

54a45e4

tobitech self-assigned this Apr 9, 2025

tobitech requested a review from a team as a code owner April 9, 2025 12:12

prfectionist bot added the Review effort 2/5 label Apr 9, 2025

prfectionist bot reviewed Apr 9, 2025

View reviewed changes

tobitech changed the title ~~Metadata Environment and Device Information~~ Metadata: Environment and Device Information Apr 9, 2025

Merge branch 'fraud-signals-metadata' into metadata-environment-info

6d7746c

robin-smileid reviewed Apr 9, 2025

View reviewed changes

JNdhlovu requested changes Apr 10, 2025

View reviewed changes

tobitech added 3 commits April 10, 2025 20:07

Merge branch 'fraud-signals-metadata' into metadata-environment-info

378e1d1

collect orientation before and after selfie capture for enhanced smar…

d283f91

…t selfie.

improve how orientation is captured. remove unnecessary metadata key.

23cd8f8

tobitech requested review from JNdhlovu and robin-smileid April 11, 2025 14:23

robin-smileid reviewed Apr 14, 2025

View reviewed changes

format value.

a638c10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Metadata: Environment and Device Information #315

Metadata: Environment and Device Information #315

tobitech commented Apr 9, 2025 •

edited by prfectionist bot

Loading

prfectionist bot commented Apr 9, 2025

github-actions bot commented Apr 9, 2025 •

edited

Loading

prfectionist bot Apr 9, 2025

robin-smileid Apr 9, 2025

robin-smileid left a comment

JNdhlovu left a comment

robin-smileid commented Apr 10, 2025

robin-smileid Apr 14, 2025

robin-smileid Apr 14, 2025

robin-smileid left a comment

Metadata: Environment and Device Information #315

Are you sure you want to change the base?

Metadata: Environment and Device Information #315

Conversation

tobitech commented Apr 9, 2025 • edited by prfectionist bot Loading

User description

Summary

Known Issues

Test Instructions

Screenshot

PR Type

Description

Changes walkthrough 📝

prfectionist bot commented Apr 9, 2025

PR Reviewer Guide 🔍

github-actions bot commented Apr 9, 2025 • edited Loading

prfectionist bot Apr 9, 2025

Choose a reason for hiding this comment

robin-smileid Apr 9, 2025

Choose a reason for hiding this comment

robin-smileid left a comment

Choose a reason for hiding this comment

JNdhlovu left a comment

Choose a reason for hiding this comment

robin-smileid commented Apr 10, 2025

robin-smileid Apr 14, 2025

Choose a reason for hiding this comment

robin-smileid Apr 14, 2025

Choose a reason for hiding this comment

robin-smileid left a comment

Choose a reason for hiding this comment

tobitech commented Apr 9, 2025 •

edited by prfectionist bot

Loading

github-actions bot commented Apr 9, 2025 •

edited

Loading