misskey/packages/client/src/pizzax.ts

import { onUnmounted, Ref, ref, watch } from 'vue';
import { $i } from './account';
import { api } from './os';
import { get, set } from './scripts/idb-proxy';
import { stream } from './stream';

type StateDef = Record<string, {
	where: 'account' | 'device' | 'deviceAccount';
	default: any;
}>;

type State<T extends StateDef> = { [K in keyof T]: T[K]['default']; };
type ReactiveState<T extends StateDef> = { [K in keyof T]: Ref<T[K]['default']>; };

type ArrayElement<A> = A extends readonly (infer T)[] ? T : never;

const connection = $i ? stream.useChannel('main') : null;

export class Storage<T extends StateDef> {
	public readonly ready: PromiseLike<void>;

	public readonly key: string;
	public readonly deviceStateKeyName: string;
	public readonly deviceAccountStateKeyName: string;
	public readonly registryCacheKeyName: string;

	public readonly def: T;

	// TODO: これが実装されたらreadonlyにしたい: https://github.com/microsoft/TypeScript/issues/37487
	public readonly state = {} as State<T>;
	public readonly reactiveState = {} as ReactiveState<T>;

	// indexedDB保存を重複させないために簡易的にキューイング
	private nextIdbJob: Promise<any> = Promise.resolve();
	private addIdbSetJob<T>(job: () => Promise<T>) {
		const promise = this.nextIdbJob.then(job, e => {
			console.error('Pizzax failed to save data to idb!', e);
			return job();
		});
		this.nextIdbJob = promise;
		return promise;
	}

	constructor(key: string, def: T) {
		this.key = key;
		this.deviceStateKeyName = `pizzax::${key}`;
		this.deviceAccountStateKeyName = $i ? `pizzax::${key}::${$i.id}` : '';
		this.registryCacheKeyName = $i ? `pizzax::${key}::cache::${$i.id}` : '';
		this.def = def;

		this.ready = this.init();
	}

	private init(): Promise<void> {
		return new Promise(async (resolve, reject) => {
			await this.migrate();

			const deviceState: State<T> = await get(this.deviceStateKeyName) || {};
			const deviceAccountState = $i ? await get(this.deviceAccountStateKeyName) || {} : {};
			const registryCache = $i ? await get(this.registryCacheKeyName) || {} : {};
	
			for (const [k, v] of Object.entries(this.def) as [keyof T, T[keyof T]][]) {
				if (v.where === 'device' && Object.prototype.hasOwnProperty.call(deviceState, k)) {
					this.state[k] = deviceState[k];
				} else if (v.where === 'account' && $i && Object.prototype.hasOwnProperty.call(registryCache, k)) {
					this.state[k] = registryCache[k];
				} else if (v.where === 'deviceAccount' && Object.prototype.hasOwnProperty.call(deviceAccountState, k)) {
					this.state[k] = deviceAccountState[k];
				} else {
					this.state[k] = v.default;
					if (_DEV_) console.log('Use default value', k, v.default);
				}
			}
			for (const [k, v] of Object.entries(this.state) as [keyof T, T[keyof T]][]) {
				this.reactiveState[k] = ref(v);
			}
	
			if ($i) {
				// なぜかsetTimeoutしないとapi関数内でエラーになる(おそらく循環参照してることに原因がありそう)
				setTimeout(() => {
					api('i/registry/get-all', { scope: ['client', this.key] })
					.then(kvs => {
						const cache = {};
						for (const [k, v] of Object.entries(this.def)) {
							if (v.where === 'account') {
								if (Object.prototype.hasOwnProperty.call(kvs, k)) {
									this.state[k as keyof T] = kvs[k];
									this.reactiveState[k as keyof T].value = kvs[k as string];
									cache[k] = kvs[k];
								} else {
									this.state[k as keyof T] = v.default;
									this.reactiveState[k].value = v.default;
								}
							}
						}

						return set(this.registryCacheKeyName, cache);
					})
					.then(() => resolve());
				}, 1);

				// streamingのuser storage updateイベントを監視して更新
				connection?.on('registryUpdated', async ({ scope, key, value }: { scope: string[], key: keyof T, value: T[typeof key]['default'] }) => {
					if (scope[1] !== this.key || this.state[key] === value) return;
	
					this.state[key] = value;
					this.reactiveState[key].value = value;
	
					const cache = await get(this.registryCacheKeyName);
					if (cache[key] !== value) {
						cache[key] = value;
						await set(this.registryCacheKeyName, cache);
					}
				});
			}
		});
	}

	public set<K extends keyof T>(key: K, value: T[K]['default']): Promise<void> {
		if (_DEV_) console.log('set', key, value);

		this.state[key] = value;
		this.reactiveState[key].value = value;

		return this.addIdbSetJob(async () => {
			switch (this.def[key].where) {
				case 'device': {
					const deviceState = await get(this.deviceStateKeyName) || {};
					deviceState[key] = value;
					await set(this.deviceStateKeyName, deviceState);
					break;
				}
				case 'deviceAccount': {
					if ($i == null) break;
					const deviceAccountState = await get(this.deviceAccountStateKeyName) || {};
					deviceAccountState[key] = value;
					await set(this.deviceAccountStateKeyName, deviceAccountState);
					break;
				}
				case 'account': {
					if ($i == null) break;
					const cache = await get(this.registryCacheKeyName) || {};
					cache[key] = value;
					await set(this.registryCacheKeyName, cache);
					await api('i/registry/set', {
						scope: ['client', this.key],
						key: key,
						value: value
					});
					break;
				}
			}
		});
	}

	public push<K extends keyof T>(key: K, value: ArrayElement<T[K]['default']>): void {
		const currentState = this.state[key];
		this.set(key, [...currentState, value]);
	}

	public reset(key: keyof T) {
		this.set(key, this.def[key].default);
	}

	/**
	 * 特定のキーの、簡易的なgetter/setterを作ります
	 * 主にvue場で設定コントロールのmodelとして使う用
	 */
	public makeGetterSetter<K extends keyof T>(key: K, getter?: (v: T[K]) => unknown, setter?: (v: unknown) => T[K]) {
		const valueRef = ref(this.state[key]);

		const stop = watch(this.reactiveState[key], val => {
			valueRef.value = val;
		});

		// NOTE: vueコンポーネント内で呼ばれない限りは、onUnmounted は無意味なのでメモリリークする
		onUnmounted(() => {
			stop();
		});

		// TODO: VueのcustomRef使うと良い感じになるかも
		return {
			get: () => {
				if (getter) {
					return getter(valueRef.value);
				} else {
					return valueRef.value;
				}
			},
			set: (value: unknown) => {
				const val = setter ? setter(value) : value;
				this.set(key, val);
				valueRef.value = val;
			}
		};
	}

	// localStorage => indexedDBのマイグレーション
	private async migrate() {
		const deviceState = localStorage.getItem(this.deviceStateKeyName);
		if (deviceState) { 
			await set(this.deviceStateKeyName, JSON.parse(deviceState));
			localStorage.removeItem(this.deviceStateKeyName);
		}

		const deviceAccountState = $i && localStorage.getItem(this.deviceAccountStateKeyName);
		if ($i && deviceAccountState) {
			await set(this.deviceAccountStateKeyName, JSON.parse(deviceAccountState));
			localStorage.removeItem(this.deviceAccountStateKeyName);
		}

		const registryCache = $i && localStorage.getItem(this.registryCacheKeyName);
		if ($i && registryCache) {
			await set(this.registryCacheKeyName, JSON.parse(registryCache));
			localStorage.removeItem(this.registryCacheKeyName);
		}
	}
}