-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
shared kernel for opfs related to projects
- Loading branch information
Showing
6 changed files
with
171 additions
and
54 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export { retrieveProject } from "@/services/opfs-projects-shared-internals"; |
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,127 @@ | ||
| /** | ||
| * A shared kernel serving as dependency for two or more OPFS services | ||
| * from difference project features. | ||
| */ | ||
|
|
||
| import { | ||
| makeOpfsFileAdapter, | ||
| makeOpfsMainDirAdapter, | ||
| } from "./origin-private-file-system"; | ||
| import { Project } from "@/entities/management"; | ||
|
|
||
| /** | ||
| * Retrieve a project from the private file system based on its UUID. | ||
| */ | ||
| export async function retrieveProject(uuid: Project["uuid"]): Promise<Project> { | ||
| const filename = await retrieveProjectFilenameByUuid(uuid); | ||
|
|
||
| const file = await makeOpfsFileAdapter<Project>({ | ||
| filename, | ||
| subdir: PROJECTS_OPFS_SUBDIRECTORY, | ||
| }); | ||
|
|
||
| const content = await file.retrieve(); | ||
| if (!content) { | ||
| throw new Error(`Project file content not found: ${uuid}`); | ||
| } | ||
|
|
||
| return content; | ||
| } | ||
|
|
||
| /** | ||
| * Persist a file in the projects private directory, | ||
| * its filename will be created/found based on the combination | ||
| * of its UUID and name. | ||
| */ | ||
| export async function persistProject(project: Project): Promise<void> { | ||
| const file = await makeOpfsFileAdapter<Project>({ | ||
| filename: getProjectFilename(project), | ||
| subdir: PROJECTS_OPFS_SUBDIRECTORY, | ||
| }); | ||
|
|
||
| await file.persist(project); | ||
| } | ||
|
|
||
| /** | ||
| * Remove a file from the projects private directory, thus | ||
| * destroying permanently the project, based only | ||
| * on its UUID. | ||
| */ | ||
| export async function removeProject(uuid: string): Promise<{ uuid: string }> { | ||
| const filename = await retrieveProjectFilenameByUuid(uuid); | ||
|
|
||
| const file = await makeOpfsFileAdapter<never>({ | ||
| filename, | ||
| subdir: PROJECTS_OPFS_SUBDIRECTORY, | ||
| }); | ||
|
|
||
| await file.remove(); | ||
|
|
||
| return { uuid }; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve all raw filenames from the projects private directory. | ||
| */ | ||
| export async function retrieveProjectsFilenames(): Promise<string[]> { | ||
| const opfsDir = await makeOpfsMainDirAdapter({ | ||
| subdir: PROJECTS_OPFS_SUBDIRECTORY, | ||
| }); | ||
| const filenames = await opfsDir.retrieveFilenames(); | ||
| return filenames; | ||
| } | ||
|
|
||
| /** | ||
| * Return what should be the current filename of a project. | ||
| * | ||
| * No side effects here, there's no query on file system. | ||
| */ | ||
| export function getProjectFilename( | ||
| item: Pick<Project, "uuid" | "name"> | ||
| ): string { | ||
| return `${item.uuid}_${hygienizeProjectName(item.name)}.json`; | ||
| } | ||
|
|
||
| /** | ||
| * Build a project listing item based only on the filename. | ||
| * Each project filename is actually the whole listing item. | ||
| * | ||
| * No side effects here, there's no query on file system. | ||
| */ | ||
| export function getListingItemFromFilename( | ||
| filename: string | ||
| ): Pick<Project, "uuid" | "name"> { | ||
| const rFilename = | ||
| /(?<uuid>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})_(?<name>[A-Za-z ]+)\.json/; | ||
| const match = filename.match(rFilename); | ||
| if (!match || !match.groups) { | ||
| throw new Error(`Invalid project filename (corrupted data?): ${filename}`); | ||
| } | ||
|
|
||
| return { | ||
| uuid: match.groups.uuid, | ||
| name: match.groups.name, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * The private subdirectory where all projects are stored. | ||
| */ | ||
| export const PROJECTS_OPFS_SUBDIRECTORY = "projects"; | ||
|
|
||
| function hygienizeProjectName(name: string): string { | ||
| return name.trim().replace(".json", ""); | ||
| } | ||
|
|
||
| async function retrieveProjectFilenameByUuid(uuid: string): Promise<string> { | ||
| const allFilenames = await retrieveProjectsFilenames(); | ||
| const filename = allFilenames.find( | ||
| (filename) => getListingItemFromFilename(filename).uuid === uuid | ||
| ); | ||
|
|
||
| if (!filename) { | ||
| throw new Error(`Project filename not found: ${uuid}`); | ||
| } | ||
|
|
||
| return filename; | ||
| } |