-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add user preference persistence framework (#1024)
Add user preference framework, accessible via the currentUser resource. Co-authored-by: Matthew White <[email protected]>
- Loading branch information
1 parent
99b11a8
commit e80cbb6
Showing
8 changed files
with
343 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| Copyright 2024 ODK Central Developers | ||
| See the NOTICE file at the top-level directory of this distribution and at | ||
| https://github.com/getodk/central-frontend/blob/master/NOTICE. | ||
| This file is part of ODK Central. It is subject to the license terms in | ||
| the LICENSE file found in the top-level directory of this distribution and at | ||
| https://www.apache.org/licenses/LICENSE-2.0. No part of ODK Central, | ||
| including this file, may be copied, modified, propagated, or distributed | ||
| except according to the terms contained in the LICENSE file. | ||
| */ | ||
|
|
||
| const VUE_PROPERTY_PREFIX = '__v_'; // Empirically established. I couldn't find documentation on it. | ||
|
|
||
|
|
||
| class PreferenceNotRegisteredError extends Error { | ||
| constructor(prop, whatclass) { | ||
| super(); | ||
| this.name = 'PreferencesNotRegisteredError'; | ||
| this.message = `Property "${prop}" has not been registered in ${whatclass.name}`; | ||
| } | ||
| } | ||
|
|
||
|
|
||
| export default class PreferenceNormalizer { | ||
| static _normalize(target, prop, val) { | ||
| const normalizer = this.normalizeFn(prop); | ||
| const theVal = (target === undefined ? val : target[prop]); | ||
| return normalizer(theVal); | ||
| } | ||
|
|
||
| static normalizeFn(prop) { | ||
| const normalizer = Object.prototype.hasOwnProperty.call(this, prop) ? this[prop] : undefined; | ||
| if (normalizer !== undefined) return normalizer; | ||
| throw new PreferenceNotRegisteredError(prop, this); | ||
| } | ||
|
|
||
| static normalize(prop, val) { | ||
| return this._normalize(undefined, prop, val); | ||
| } | ||
|
|
||
| static getProp(target, prop) { | ||
| if (typeof (prop) === 'string' && !prop.startsWith(VUE_PROPERTY_PREFIX)) { | ||
| return this._normalize(target, prop); | ||
| } | ||
| return target[prop]; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /* | ||
| Copyright 2024 ODK Central Developers | ||
| See the NOTICE file at the top-level directory of this distribution and at | ||
| https://github.com/getodk/central-frontend/blob/master/NOTICE. | ||
| This file is part of ODK Central. It is subject to the license terms in | ||
| the LICENSE file found in the top-level directory of this distribution and at | ||
| https://www.apache.org/licenses/LICENSE-2.0. No part of ODK Central, | ||
| including this file, may be copied, modified, propagated, or distributed | ||
| except according to the terms contained in the LICENSE file. | ||
| */ | ||
|
|
||
| import PreferenceNormalizer from './normalizer'; | ||
|
|
||
| // The SitePreferenceNormalizer and ProjectPreferenceNormalizer classes are used to: | ||
| // a) verify that the preference key has been declared here. | ||
| // Such might seem persnickety, but it allows us to have a central | ||
| // registry of which keys are in use. | ||
| // b) normalize the value as per the normalization function with the name | ||
| // of the preference. This also allows supplying a default. | ||
| // Preferences serverside may have been created by some frontend version that | ||
| // used different semantics (different values, perhaps differently typed). | ||
| // Writing a validator function here makes it so one does not have to be defensive | ||
| // for that eventuality in *every single usage site of the setting*. | ||
| // | ||
| // As such, any newly introduced preference will need a normalization function added | ||
| // to one of those classes, even if it's just a straight passthrough. | ||
| // Furthermore, the answer to "why can't I set an arbitrary value for a certain preference" | ||
| // can be found there. | ||
|
|
||
|
|
||
| export class SitePreferenceNormalizer extends PreferenceNormalizer { | ||
| static projectSortMode(val) { | ||
| return ['alphabetical', 'latest', 'newest'].includes(val) ? val : 'latest'; | ||
| } | ||
| } | ||
|
|
||
| export class ProjectPreferenceNormalizer extends PreferenceNormalizer { | ||
| static formTrashCollapsed(val) { | ||
| return val === true; | ||
| } | ||
| } |
Oops, something went wrong.