50 medium widget by aking618 · Pull Request #334 · mikaelacaron/Basic-Car-Maintenance

aking618 · 2024-10-08T22:27:55Z

What it Does

Closes FEATURE - Medium Widgets, View Maintenance Events #50
This PR adds a medium widget for viewing a vehicle's latest maintenance events logged.
- Due to widget sizing, only up to two events are visible. (The most current events are used)

How I Tested

Run the application
Add a vehicle / maintenance
Return to the home screen
Add a widget
Configure the widget. (Ensure that all vehicle names are present)

Notes

I added an app group to share user defaults with the widget. I currently store the user id there to use it for fetching vehicles.
- I originally attempted to use FirebaseAuth, but I couldn't get anything to work.

Screenshots

Widget Gallery	View

I would love to hear some feedback and ideas on the data sharing.

mikaelacaron

hey! I haven't looked at the whole thing, but just a few questions

mikaelacaron · 2024-10-14T10:33:59Z

Basic-Car-Maintenance/Shared/BasicCarMaintenanceApp.swift

        FirebaseApp.configure()

-        let useEmulator = UserDefaults.standard.bool(forKey: "useEmulator")
+        let useEmulator = UserDefaults.shared.bool(forKey: "useEmulator")


what does this do? changing the UserDefaults to use the shared app group?

I did this so the widget would respect the same "useEmulator" value as the main app.

Basic-Car-Maintenance/Shared/Settings/ViewModels/AuthenticationViewModel.swift

mikaelacaron · 2024-10-14T10:37:25Z

Basic-Car-Maintenance.xcodeproj/project.pbxproj

+		ED42FB492CB3621B00C5CC56 /* PBXFileSystemSynchronizedBuildFileExceptionSet */ = {
+			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
+			membershipExceptions = (
+				"Shared/GoogleService-Info.plist",
+				Shared/Models/MaintenanceEvent.swift,
+				Shared/Models/Vehicle.swift,
+				"Shared/UserDefaults/UserDefaults+Shared.swift",
+				Shared/Utilities/Constants.swift,
+			);
+			target = FFDADF7C2ACD35A100DDEF79 /* Basic-Car-Maintenance-WidgetExtension */;
+		};


is this adding Firebase to the widgets?

this doesn't feel like the right way to do this....? but I'm not sure....also asking a friend who knows Firebase pretty well what they think

Sounds good! Thanks for looking into this

mikaelacaron

Thanks for working on this!

I reviewed a few files of the PR, because this is a bigger PR. I wanted to clarify a few things, before I review the whole thing.

mikaelacaron · 2024-10-15T08:29:48Z

Basic-Car-Maintenance-Widget/Basic-Car-Maintenance-WidgetExtension.entitlements

+	</array>
+	<key>keychain-access-groups</key>
+	<array>
+		<string>$(AppIdentifierPrefix)com.mikaelacaron.Shared</string>


what does this entitlement do? also should this be .Shared? as opposed to matching the bundle ID with the app name

and should there be a . between $(AppIdentifierPrefix) and com.mikaelacaron.Shared

The . is included in $(AppIdentifierPrefix).

I can change the Shared portion. It was a standard that I saw other devs using online.

mikaelacaron · 2024-10-15T08:31:04Z

Basic-Car-Maintenance-Widget/Info.plist

 <plist version="1.0">
 <dict>
+	<key>KeychainAccessGroup</key>
+	<string>$(AppIdentifierPrefix)com.mikaelacaron.Shared</string>


Same question herea bout the format (as the widget extension question

The . is included in $(AppIdentifierPrefix).

mikaelacaron · 2024-10-15T08:32:04Z

Basic-Car-Maintenance.xcodeproj/project.pbxproj

 	objects = {

 /* Begin PBXBuildFile section */
+		ED1FE7692CB4BEDC006F861F /* FirebaseFirestoreSwift in Frameworks */ = {isa = PBXBuildFile; productRef = ED1FE7682CB4BEDC006F861F /* FirebaseFirestoreSwift */; };


do we still need to import all the Firebase stuff into the widget? Or do we not need to now, and only use keychain?

Yes, since the widget uses the models/enums to fetch data from Firestore. The keychain was needed to share the authentication between applications. Firebase Cross-Application Authentication

FirebaseCore is used to configure the firebase app.

FirebaseAuth is used to access the current user from Auth.auth().

FirebaseFirestoreSwift is needed since we are including Vehicle.swift in the widget and that file uses a Firebase property wrapper.

mikaelacaron · 2024-10-15T08:32:25Z

Basic-Car-Maintenance/Basic_Car_Maintenance.entitlements

+		<string>$(AppIdentifierPrefix)com.mikaelacaron.Shared</string>
+	</array>


same question here too

Yep. The . is included with the app identifier prefix.

mikaelacaron · 2024-10-15T08:33:24Z

Basic-Car-Maintenance/Shared/Utilities/Bundle+extension.swift

+    var keychainAccessGroup: String? {
+        return infoDictionary?["KeychainAccessGroup"] as? String
+    }


should this have a default value if nothing is found?

I think it should. I wasn't sure if we should hardcode the team name into the application.

The default value would probably need to be team-id.bundleId

aking618 added 17 commits October 6, 2024 18:58

Create basic medium view

ab5ae85

Fetch data into widget

e9e00fa

Load vehicles as configuarable options

812dea3

Resolve swiftlint warnings

1e0a141

Finish views for widget | Clean up Widget classes/structs

53fcf4e

Move network calls into static functions

e546242

Update gallery placeholder

a9b96e1

Create app group

c488c50

Share user id with widget

7154d5e

Add empty state for widget

d4da607

Sort events by date

fe7a950

Entitlement clean up

518ce0c

Merge remote-tracking branch 'origin/dev' into 50-medium-widget

dc273fb

Merge remote-tracking branch 'origin/dev' into 50-medium-widget

4a09d94

Removing hanging entitlement file

b2f3448

Add doc comments to user default extension

d3e4605

Update entitlements reference for widget

272d553

mikaelacaron reviewed Oct 14, 2024

View reviewed changes

aking618 added 4 commits October 14, 2024 08:36

Merge remote-tracking branch 'origin/dev' into 50-medium-widget

5743a8b

Widget respects Firebase Auth current user | Removed shared UserDefaults

117ce4f

Remove extra space

0d05d65

Reconnect firestore to widget

e601402

aking618 marked this pull request as ready for review October 14, 2024 14:54

mikaelacaron reviewed Oct 15, 2024

View reviewed changes

mikaelacaron added the hacktoberfest-accepted Accepted PR for Hacktoberfest label Oct 28, 2024

TMaszko mentioned this pull request Oct 9, 2025

Feat: add small total maintenance events count widget #394

Merged

		<string>$(AppIdentifierPrefix)com.mikaelacaron.Shared</string>
		</array>

Uh oh!

Comments

Conversation

aking618 commented Oct 8, 2024

What it Does

How I Tested

Notes

Screenshots

Uh oh!

mikaelacaron left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikaelacaron left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aking618 Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

aking618 Oct 15, 2024 •

edited

Loading