generated from Seekra/repository-template
feat(settings): make setting value function synchronous
Added a store to cache the settings configuration. The getSetting function from useSettings is now synchronous and uses this cache. The settings cache is set when loading the settings initially (asnychronously).
This commit is contained in:
@@ -14,17 +14,58 @@ See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import { useSettingsConfigCacheStore } from '../../stores/settingsConfigCacheStore';
|
||||
import { useSettingsStore } from '../../stores/settingsStore';
|
||||
import { useSettings } from '../useSettings';
|
||||
import { createTestingPinia } from '@pinia/testing';
|
||||
import { setActivePinia } from 'pinia';
|
||||
import { beforeEach, describe, expect, test, vi } from 'vitest';
|
||||
|
||||
const settingDefaultValue = vi.hoisted(() => 42);
|
||||
const settingPath = vi.hoisted(() => ['test', 'number']);
|
||||
const settingDefaultValue = 42;
|
||||
const settingPath = ['test', 'number'];
|
||||
|
||||
vi.mock('../../utils/settingsParser', () => ({
|
||||
loadSettingsConfig: vi.fn().mockResolvedValue({
|
||||
describe('useSettings', () => {
|
||||
describe('getSetting', () => {
|
||||
test('returns stored value', () => {
|
||||
const { getSetting } = useSettings();
|
||||
const settings = useSettingsStore();
|
||||
|
||||
const key = 'setting';
|
||||
const value = 42;
|
||||
|
||||
settings.set(key, value);
|
||||
|
||||
expect(getSetting(key)).toBe(value);
|
||||
});
|
||||
|
||||
test('returns default value', () => {
|
||||
const { getSetting } = useSettings();
|
||||
expect(getSetting(settingPath)).toBe(settingDefaultValue);
|
||||
});
|
||||
|
||||
test('returns stored value instead of default value', () => {
|
||||
const { getSetting } = useSettings();
|
||||
const settings = useSettingsStore();
|
||||
|
||||
const value = 43;
|
||||
|
||||
expect(getSetting(settingPath)).toBe(settingDefaultValue);
|
||||
|
||||
settings.set(settingPath, value);
|
||||
expect(getSetting(settingPath)).toBe(value);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
setActivePinia(
|
||||
createTestingPinia({
|
||||
createSpy: vi.fn,
|
||||
stubActions: false
|
||||
})
|
||||
);
|
||||
const settingsConfigCache = useSettingsConfigCacheStore();
|
||||
settingsConfigCache.set({
|
||||
contents: [
|
||||
{
|
||||
name: 'test',
|
||||
@@ -39,47 +80,5 @@ vi.mock('../../utils/settingsParser', () => ({
|
||||
]
|
||||
}
|
||||
]
|
||||
})
|
||||
}));
|
||||
|
||||
describe('useSettings', () => {
|
||||
describe('getSetting', () => {
|
||||
test('returns stored value', async () => {
|
||||
const { getSetting } = useSettings();
|
||||
const settings = useSettingsStore();
|
||||
|
||||
const key = 'setting';
|
||||
const value = 42;
|
||||
|
||||
settings.set(key, value);
|
||||
|
||||
expect(await getSetting(key)).toBe(value);
|
||||
});
|
||||
|
||||
test('returns default value', async () => {
|
||||
const { getSetting } = useSettings();
|
||||
expect(await getSetting(settingPath)).toBe(settingDefaultValue);
|
||||
});
|
||||
|
||||
test('returns stored value instead of default value', async () => {
|
||||
const { getSetting } = useSettings();
|
||||
const settings = useSettingsStore();
|
||||
|
||||
const value = 43;
|
||||
|
||||
expect(await getSetting(settingPath)).toBe(settingDefaultValue);
|
||||
|
||||
settings.set(settingPath, value);
|
||||
expect(await getSetting(settingPath)).toBe(value);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
setActivePinia(
|
||||
createTestingPinia({
|
||||
createSpy: vi.fn,
|
||||
stubActions: false
|
||||
})
|
||||
);
|
||||
});
|
||||
|
||||
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import { useSettingsConfigCacheStore } from '../stores/settingsConfigCacheStore';
|
||||
import { useSettingsStore } from '../stores/settingsStore';
|
||||
import { getSettingRecursively } from '../utils/getSetting';
|
||||
import { loadSettingsConfig } from '../utils/settingsParser';
|
||||
@@ -27,10 +28,10 @@ export const useSettings = function useSettings () {
|
||||
* @param {string[]} key - The settings key.
|
||||
* @return The value of the setting.
|
||||
*/
|
||||
const getSetting = async function getSetting (key) {
|
||||
const getSetting = function getSetting (key) {
|
||||
const settingsStore = useSettingsStore();
|
||||
|
||||
const settings = await loadSettingsConfig();
|
||||
const settings = useSettingsConfigCacheStore().get();
|
||||
return (
|
||||
settingsStore.get(key) ??
|
||||
getSettingRecursively(
|
||||
|
||||
Reference in New Issue
Block a user