docs: correct PlatformServiceMixin caching documentation and fix interface comments #166

Open
anomalist wants to merge 3 commits from platformservicemixin-interface-consolidation into master
Owner
  • Fix misleading claims about WeakMap-based caching (all caching code is commented out)
  • Correct interface comment from "contacts cached, settings fresh" to "always fresh (no caching)"
  • Add comprehensive clarification section explaining caching confusion
  • Document that caching system was planned but never implemented
  • Update performance optimizations section to reflect actual no-caching reality

The documentation now accurately reflects that this is a no-caching system
that provides convenience methods for database operations, not a
performance-optimized caching system as previously claimed.

- Fix misleading claims about WeakMap-based caching (all caching code is commented out) - Correct interface comment from "contacts cached, settings fresh" to "always fresh (no caching)" - Add comprehensive clarification section explaining caching confusion - Document that caching system was planned but never implemented - Update performance optimizations section to reflect actual no-caching reality The documentation now accurately reflects that this is a no-caching system that provides convenience methods for database operations, not a performance-optimized caching system as previously claimed.
anomalist added 1 commit 2025-08-13 05:07:53 +00:00
- Fix misleading claims about WeakMap-based caching (all caching code is commented out)
- Correct interface comment from "contacts cached, settings fresh" to "always fresh (no caching)"
- Add comprehensive clarification section explaining caching confusion
- Document that caching system was planned but never implemented
- Update performance optimizations section to reflect actual no-caching reality

The documentation now accurately reflects that this is a no-caching system
that provides convenience methods for database operations, not a
performance-optimized caching system as previously claimed.
anomalist added 1 commit 2025-08-19 10:46:20 +00:00
anomalist added 1 commit 2025-08-19 11:25:30 +00:00
- Remove deprecated $updateSettings method entirely
- Migrate 21 components to use proper settings methods
- Consolidate IPlatformServiceMixin and ComponentCustomProperties interfaces
- Establish single source of truth for platform service methods
- Update all components to use $saveMySettings, $saveUserSettings, $saveSettings
- Remove interface duplication and deprecated method warnings
- Ensure clean, maintainable codebase with proper separation of concerns

Breaking Change: $updateSettings method removed - use $saveSettings variants instead
This pull request has changes conflicting with the target branch.
  • src/components/UserNameDialog.vue
  • src/utils/PlatformServiceMixin.ts
  • src/views/ContactQRScanShowView.vue
  • src/views/HelpNotificationsView.vue
  • src/views/HelpView.vue
  • src/views/NewActivityView.vue
  • src/views/NewEditAccountView.vue
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin platformservicemixin-interface-consolidation:platformservicemixin-interface-consolidation
git checkout platformservicemixin-interface-consolidation
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: trent_larson/crowd-funder-for-time-pwa#166