refactor: solid presets (@miodec) #7825
There are no files selected for viewing
This file contains hidden or 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,208 @@ | ||
| import { Preset } from "@monkeytype/schemas/presets"; | ||
| import { queryCollectionOptions } from "@tanstack/query-db-collection"; | ||
| import { | ||
| createCollection, | ||
| createOptimisticAction, | ||
| useLiveQuery, | ||
| } from "@tanstack/solid-db"; | ||
| import Ape from "../ape"; | ||
| import { queryClient } from "../queries"; | ||
| import { baseKey } from "../queries/utils/keys"; | ||
| import { ConfigGroupName } from "@monkeytype/schemas/configs"; | ||
|
|
||
| export type PresetItem = Preset & { display: string }; | ||
|
|
||
| const queryKeys = { | ||
| root: () => [...baseKey("presets", { isUserSpecific: true })], | ||
| }; | ||
|
|
||
| function toPresetItem(preset: Preset): PresetItem { | ||
| return { | ||
| ...preset, | ||
| display: preset.name.replaceAll("_", " "), | ||
| }; | ||
| } | ||
|
|
||
| // oxlint-disable-next-line typescript/explicit-function-return-type | ||
| export function usePresetsLiveQuery() { | ||
|
Member
There was a problem hiding this comment. should we rename to ConfigPresets for more clarity? We have FilterPresets as well |
||
| return useLiveQuery((q) => { | ||
| return q | ||
| .from({ preset: presetsCollection }) | ||
| .orderBy(({ preset }) => preset.name, "asc"); | ||
| }); | ||
| } | ||
|
|
||
| const presetsCollection = createCollection( | ||
| queryCollectionOptions({ | ||
| staleTime: Infinity, | ||
| startSync: true, | ||
| queryKey: queryKeys.root(), | ||
|
|
||
| queryClient, | ||
| getKey: (it) => it._id, | ||
| queryFn: async () => { | ||
| return [] as PresetItem[]; | ||
| }, | ||
| }), | ||
| ); | ||
|
|
||
| type ActionType = { | ||
| addPreset: { | ||
| name: string; | ||
| config: Preset["config"]; | ||
| settingGroups: ConfigGroupName[] | undefined; | ||
| }; | ||
| editPreset: { | ||
| presetId: string; | ||
| name: string; | ||
| config?: Preset["config"]; | ||
| settingGroups?: ConfigGroupName[] | null; | ||
| }; | ||
| deletePreset: { | ||
| presetId: string; | ||
| }; | ||
| }; | ||
|
|
||
| const actions = { | ||
| addPreset: createOptimisticAction<ActionType["addPreset"]>({ | ||
| onMutate: ({ name, config, settingGroups }) => { | ||
| presetsCollection.insert({ | ||
| _id: "temp-" + Date.now(), | ||
|
|
||
| name, | ||
| display: name.replaceAll("_", " "), | ||
| config, | ||
| settingGroups, | ||
| }); | ||
| }, | ||
| mutationFn: async ({ name, config, settingGroups }) => { | ||
| const response = await Ape.presets.add({ | ||
| body: { | ||
| name, | ||
| config, | ||
| ...(settingGroups !== undefined && { settingGroups }), | ||
| }, | ||
| }); | ||
| if (response.status !== 200) { | ||
| throw new Error(`Failed to add preset: ${response.body.message}`); | ||
| } | ||
| presetsCollection.utils.writeInsert( | ||
| toPresetItem({ | ||
| _id: response.body.data.presetId, | ||
| name: name, | ||
| settingGroups: settingGroups, | ||
| config: config, | ||
| }), | ||
| ); | ||
| }, | ||
| }), | ||
| editPreset: createOptimisticAction<ActionType["editPreset"]>({ | ||
| onMutate: ({ presetId, name, config, settingGroups }) => { | ||
| presetsCollection.update(presetId, (preset) => { | ||
| preset.name = name; | ||
| preset.display = name.replaceAll("_", " "); | ||
|
|
||
| if (config !== undefined) { | ||
| preset.config = config; | ||
| } | ||
| if (settingGroups !== undefined) { | ||
| preset.settingGroups = settingGroups; | ||
| } | ||
| }); | ||
| }, | ||
| mutationFn: async ({ presetId, name, config, settingGroups }) => { | ||
| const existing = presetsCollection.get(presetId); | ||
|
|
||
| if (existing === undefined) { | ||
| throw new Error("Preset not found"); | ||
| } | ||
|
|
||
| const response = await Ape.presets.save({ | ||
| body: { | ||
| _id: presetId, | ||
| name: name, | ||
| ...(config !== undefined && { | ||
| config: config, | ||
| settingGroups: settingGroups, | ||
| }), | ||
| }, | ||
| }); | ||
| if (response.status !== 200) { | ||
| throw new Error(`Failed to edit preset: ${response.body.message}`); | ||
| } | ||
|
|
||
| // if this is missing getPreset is out of sync | ||
| presetsCollection.utils.writeUpdate({ | ||
| _id: presetId, | ||
| name, | ||
| display: name.replaceAll("_", " "), | ||
| ...(config !== undefined && { config }), | ||
| ...(settingGroups !== undefined && { settingGroups }), | ||
| }); | ||
| }, | ||
| }), | ||
| deletePreset: createOptimisticAction<ActionType["deletePreset"]>({ | ||
| onMutate: ({ presetId }) => { | ||
| presetsCollection.delete(presetId); | ||
| }, | ||
| mutationFn: async ({ presetId }) => { | ||
| const response = await Ape.presets.delete({ | ||
| params: { presetId }, | ||
| }); | ||
| if (response.status !== 200) { | ||
| throw new Error(`Failed to delete preset: ${response.body.message}`); | ||
| } | ||
| presetsCollection.utils.writeDelete(presetId); | ||
| }, | ||
| }), | ||
| }; | ||
|
|
||
| // --- Public API --- | ||
|
|
||
| function getPresets(): PresetItem[] { | ||
| return [...presetsCollection.values()].sort((a, b) => | ||
| a.name.localeCompare(b.name), | ||
| ); | ||
| } | ||
|
|
||
| function getPreset(id: string): PresetItem | undefined { | ||
| return presetsCollection.get(id); | ||
| } | ||
|
|
||
| export function fillPresetsCollection(presets: Preset[]): void { | ||
| const presetItems = presets.map(toPresetItem); | ||
|
|
||
| presetsCollection.utils.writeBatch(() => { | ||
|
Comment on lines
+172
to
+174
Member
There was a problem hiding this comment. logout clears the presetsCollection |
||
| presetItems.forEach((item) => { | ||
| presetsCollection.utils.writeInsert(item); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| export async function addPreset( | ||
| params: ActionType["addPreset"], | ||
| ): Promise<void> { | ||
| const transaction = actions.addPreset(params); | ||
| await transaction.isPersisted.promise; | ||
| } | ||
|
|
||
| export async function editPreset( | ||
| params: ActionType["editPreset"], | ||
| ): Promise<void> { | ||
| const transaction = actions.editPreset(params); | ||
| await transaction.isPersisted.promise; | ||
| } | ||
|
|
||
| export async function deletePreset( | ||
| params: ActionType["deletePreset"], | ||
| ): Promise<void> { | ||
| const transaction = actions.deletePreset(params); | ||
| await transaction.isPersisted.promise; | ||
| } | ||
|
|
||
| /** | ||
| * Used for non reactive access. Do not use in Solid components. | ||
| */ | ||
| export const __nonReactive = { | ||
| getPresets, | ||
| getPreset, | ||
| }; | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we do the same as with tags? update the name to be without underscores, only convert when talking to the api?