refactor(auth): introduce _ensureUserDataExists to handle default doc… #20
Conversation
…uments creation - Introduce new private method _ensureUserDataExists to centralize the logic for creating default UserAppSettings and UserContentPreferences - Replace inline creation logic with calls to _ensureUserDataExists for both registered and anonymous users - Add error handling to check for existing documents before creation, preventing duplicates
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @fulleni, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refactors the authentication service to centralize and robustify the creation of essential user-specific data documents, such as app settings and content preferences. By introducing a dedicated helper method, it eliminates code duplication and ensures data integrity across various user lifecycle events, including registration, anonymous user creation, and account linking.
Highlights
- Centralized User Data Provisioning: Introduced a new private method,
_ensureUserDataExists, withinAuthServiceto encapsulate the logic for creating defaultUserAppSettingsandUserContentPreferences. - Code Duplication Reduction: Replaced repetitive inline creation logic for these default documents in both registered user creation and anonymous user creation flows with calls to the new
_ensureUserDataExistsmethod. - Enhanced Data Integrity: Integrated
_ensureUserDataExistsinto thelinkAnonymousUserToEmailprocess, ensuring that all necessary user data documents are present even after an anonymous account is converted to a permanent one. - Idempotent Document Creation: The
_ensureUserDataExistsmethod now includes error handling (checking forNotFoundException) to prevent duplicate document creation, ensuring that default documents are only created if they don't already exist.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The code changes introduce a new private method _ensureUserDataExists to centralize the logic for creating default UserAppSettings and UserContentPreferences. This method is called in several places to ensure that user data exists after creation or linking. The refactoring improves code maintainability by reducing duplication.
| Future<void> _ensureUserDataExists(User user) async { | ||
| // Check for UserAppSettings | ||
| try { | ||
| await _userAppSettingsRepository.read(id: user.id, userId: user.id); | ||
| } on NotFoundException { | ||
| _log.info( | ||
| 'UserAppSettings not found for user ${user.id}. Creating with defaults.', | ||
| ); | ||
| final defaultAppSettings = UserAppSettings( | ||
| id: user.id, | ||
| displaySettings: const DisplaySettings( | ||
| baseTheme: AppBaseTheme.system, | ||
| accentTheme: AppAccentTheme.defaultBlue, | ||
| fontFamily: 'SystemDefault', | ||
| textScaleFactor: AppTextScaleFactor.medium, | ||
| fontWeight: AppFontWeight.regular, | ||
| ), | ||
| language: 'en', | ||
| feedPreferences: const FeedDisplayPreferences( | ||
| headlineDensity: HeadlineDensity.standard, | ||
| headlineImageStyle: HeadlineImageStyle.largeThumbnail, | ||
| showSourceInHeadlineFeed: true, | ||
| showPublishDateInHeadlineFeed: true, | ||
| ), | ||
| ); | ||
| await _userAppSettingsRepository.create( | ||
| item: defaultAppSettings, | ||
| userId: user.id, | ||
| ); | ||
| } | ||
|
|
||
| // Check for UserContentPreferences | ||
| try { | ||
| await _userContentPreferencesRepository.read(id: user.id, userId: user.id); | ||
| } on NotFoundException { | ||
| _log.info( | ||
| 'UserContentPreferences not found for user ${user.id}. Creating with defaults.', | ||
| ); | ||
| final defaultUserPreferences = UserContentPreferences( | ||
| id: user.id, | ||
| followedCountries: const [], | ||
| followedSources: const [], | ||
| followedTopics: const [], | ||
| savedHeadlines: const [], | ||
| ); | ||
| await _userContentPreferencesRepository.create( | ||
| item: defaultUserPreferences, | ||
| userId: user.id, | ||
| ); | ||
| } | ||
| } |
There was a problem hiding this comment.
The checks for UserAppSettings and UserContentPreferences are independent and involve I/O operations. Consider running them in parallel using Future.wait to potentially reduce the total execution time.
Future<void> _ensureUserDataExists(User user) async {
await Future.wait([
() async {
try {
await _userAppSettingsRepository.read(id: user.id, userId: user.id);
} on NotFoundException {
_log.info(
'UserAppSettings not found for user ${user.id}. Creating with defaults.',
);
final defaultAppSettings = UserAppSettings(
id: user.id,
displaySettings: const DisplaySettings(
baseTheme: AppBaseTheme.system,
accentTheme: AppAccentTheme.defaultBlue,
fontFamily: 'SystemDefault',
textScaleFactor: AppTextScaleFactor.medium,
fontWeight: AppFontWeight.regular,
),
language: 'en',
feedPreferences: const FeedDisplayPreferences(
headlineDensity: HeadlineDensity.standard,
headlineImageStyle: HeadlineImageStyle.largeThumbnail,
showSourceInHeadlineFeed: true,
showPublishDateInHeadlineFeed: true,
),
);
await _userAppSettingsRepository.create(
item: defaultAppSettings,
userId: user.id,
);
}
}(),
() async {
try {
await _userContentPreferencesRepository.read(id: user.id, userId: user.id);
} on NotFoundException {
_log.info(
'UserContentPreferences not found for user ${user.id}. Creating with defaults.',
);
final defaultUserPreferences = UserContentPreferences(
id: user.id,
followedCountries: const [],
followedSources: const [],
followedTopics: const [],
savedHeadlines: const [],
);
await _userContentPreferencesRepository.create(
item: defaultUserPreferences,
userId: user.id,
);
}
}(),
]);
}
…uments creation
Status
READY/IN DEVELOPMENT/HOLD
Description
Type of Change