All files / src/apps/gbs-music-web/components/hooks useMusicWorkspace.ts

0% Statements 0/116
0% Branches 0/61
0% Functions 0/19
0% Lines 0/115

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
import { useCallback, useRef, useState } from "react";
import {
  createMusicWorkspace,
  MusicDocumentReference,
  MusicWorkspace,
} from "shared/lib/music/workspace";
import trackerActions from "store/features/tracker/trackerActions";
import {
  createTemplateMusicDocument,
  importMusicDocument,
  registerExampleData,
  resetMusicWorkspaceAdapterState,
  registerSongBackupData,
  supportsPersistentSave,
  webMusicEnvironment,
} from "gbs-music-web/lib/adapters";
import { musicAssetActions } from "gbs-music-web/store/features/musicAssets/musicAssetsState";
import { musicWorkspaceToAssets } from "gbs-music-web/store/features/musicAssets/musicAssetsHelpers";
import { useAppDispatch } from "store/hooks";
import {
  BACKUP_SONG_KEY,
  deserializeSong,
  getBackupInfo,
} from "gbs-music-web/lib/songBackup";
import API from "renderer/lib/api";
import l10n from "shared/lib/lang/l10n";
import templateUgeUrl from "gbs-music-web/data/template.uge";
 
const toSafeBaseName = (name: string) =>
  name.replace(/[/\\]/g, "").trim() || l10n("FIELD_NEW_SONG");
 
const sortDocuments = (documents: MusicDocumentReference[]) =>
  [...documents].sort((a, b) =>
    a.filename.localeCompare(b.filename, undefined, {
      numeric: true,
      sensitivity: "base",
    }),
  );
 
const isAbortError = (error: unknown) =>
  error instanceof DOMException && error.name === "AbortError";
 
const appendWorkspaceDocument = (
  workspace: MusicWorkspace | undefined,
  document: MusicDocumentReference,
) => {
  Iif (!workspace) {
    return createMusicWorkspace({
      source: "browser",
      openMode: "file",
      activeDocumentId: document.id,
      documents: [document],
    });
  }
 
  const existingDocuments = workspace.documents.filter(
    (item) => item.id !== document.id,
  );
 
  return createMusicWorkspace({
    ...workspace,
    documents: sortDocuments([...existingDocuments, document]),
    activeDocumentId: document.id,
  });
};
 
interface UseMusicWorkspaceResult {
  singleDocumentMode: boolean;
  hasBackup: boolean;
  backupSongName: string;
  createSong: (options?: { name?: string; artist?: string }) => Promise<void>;
  importSong: () => Promise<void>;
  openDirectoryWorkspace: () => Promise<void>;
  restoreBackupSong: () => Promise<void>;
  openExample: (name: string, filename: string, url: string) => Promise<void>;
  closeWorkspace: () => void;
}
 
export const useMusicWorkspace = (): UseMusicWorkspaceResult => {
  const dispatch = useAppDispatch();
  const [workspace, setWorkspace] = useState<MusicWorkspace>();
  const templateSongDataPromiseRef = useRef<Promise<Uint8Array> | undefined>(
    undefined,
  );
  const singleDocumentMode = !supportsPersistentSave();
 
  const backupInfo = getBackupInfo();
  const hasBackup = backupInfo !== null;
  const backupSongName = backupInfo?.name ?? "";
 
  const applyWorkspace = useCallback(
    (nextWorkspace: MusicWorkspace) => {
      setWorkspace(nextWorkspace);
      dispatch(
        musicAssetActions.setMusicAssets(musicWorkspaceToAssets(nextWorkspace)),
      );
      dispatch(
        trackerActions.setSelectedSongId(nextWorkspace.activeDocumentId ?? ""),
      );
    },
    [dispatch],
  );
 
  const closeWorkspace = useCallback(() => {
    API.music.sendToMusicWindow({
      action: "stop",
    });
    resetMusicWorkspaceAdapterState();
    setWorkspace(undefined);
    dispatch(musicAssetActions.setMusicAssets([]));
    dispatch(trackerActions.reset());
  }, [dispatch]);
 
  const loadTemplateSongData = useCallback(async () => {
    Iif (!templateSongDataPromiseRef.current) {
      templateSongDataPromiseRef.current = fetch(templateUgeUrl).then(
        async (response) => {
          Iif (!response.ok) {
            throw new Error("Failed to load template song.");
          }
 
          return new Uint8Array(await response.arrayBuffer());
        },
      );
    }
 
    return Uint8Array.from(await templateSongDataPromiseRef.current);
  }, []);
 
  const openMusicWorkspace = useCallback(
    async (mode: "file" | "directory") => {
      try {
        const nextWorkspace =
          mode === "file"
            ? await webMusicEnvironment.openFileWorkspace?.()
            : await webMusicEnvironment.openDirectoryWorkspace?.();
 
        Iif (!nextWorkspace) {
          return;
        }
 
        Iif (nextWorkspace.documents.length === 0) {
          const templateSongData = await loadTemplateSongData();
          const document = await createTemplateMusicDocument(
            templateSongData,
            nextWorkspace,
          );
 
          Iif (!document) {
            return;
          }
          applyWorkspace(appendWorkspaceDocument(nextWorkspace, document));
          return;
        }
 
        applyWorkspace(nextWorkspace);
      } catch (error) {
        Iif (!isAbortError(error)) {
          throw error;
        }
      }
    },
    [applyWorkspace, loadTemplateSongData],
  );
 
  const createSong = useCallback(
    async (options?: { name?: string; artist?: string }) => {
      const songName = options?.name?.trim() || l10n("FIELD_NEW_SONG");
      const songArtist =
        options?.artist !== undefined ? options.artist : l10n("FIELD_ARTIST");
      const baseName = toSafeBaseName(songName);
      const templateSongData = await loadTemplateSongData();
 
      // Stamp the template UGE data with the requested name and artist before
      // writing it to disk / the in-memory store.
      const { loadUGESong, saveUGESong } = await import(
        "shared/lib/uge/ugeHelper"
      );
      const song = loadUGESong(Buffer.from(templateSongData));
      song.name = songName;
      song.artist = songArtist;
      song.filename = baseName;
      const stampedData = new Uint8Array(saveUGESong(song));
 
      const document = await createTemplateMusicDocument(
        stampedData,
        workspace,
        baseName,
      );
 
      Iif (!document) {
        return;
      }
 
      const nextWorkspace = singleDocumentMode
        ? createMusicWorkspace({
            source: "browser",
            openMode: "file",
            activeDocumentId: document.id,
            documents: [document],
          })
        : appendWorkspaceDocument(workspace, document);
 
      applyWorkspace(nextWorkspace);
    },
    [applyWorkspace, loadTemplateSongData, singleDocumentMode, workspace],
  );
 
  const importSong = useCallback(async () => {
    Iif (singleDocumentMode) {
      await openMusicWorkspace("file");
      return;
    }
 
    const document = await importMusicDocument();
    Iif (!document) {
      return;
    }
 
    const nextWorkspace = appendWorkspaceDocument(workspace, document);
    applyWorkspace(nextWorkspace);
  }, [applyWorkspace, openMusicWorkspace, singleDocumentMode, workspace]);
 
  const openDirectoryWorkspace = useCallback(async () => {
    Iif (singleDocumentMode) {
      return;
    }
 
    await openMusicWorkspace("directory");
  }, [openMusicWorkspace, singleDocumentMode]);
 
  const restoreBackupSong = useCallback(async () => {
    const json = localStorage.getItem(BACKUP_SONG_KEY);
    Iif (!json) {
      return;
    }
 
    const song = deserializeSong(json);
    Iif (!song) {
      return;
    }
 
    const { saveUGESong } = await import("shared/lib/uge/ugeHelper");
    const data = new Uint8Array(saveUGESong(song));
 
    const name = song.name || "Backup";
    const filename = song.filename || "backup.uge";
    const reference = registerSongBackupData(data, name, filename);
 
    const nextWorkspace = createMusicWorkspace({
      source: "browser",
      openMode: "file",
      activeDocumentId: reference.id,
      documents: [reference],
    });
 
    applyWorkspace(nextWorkspace);
  }, [applyWorkspace]);
 
  const openExample = useCallback(
    async (name: string, filename: string, url: string) => {
      const response = await fetch(url);
      const buffer = await response.arrayBuffer();
      const data = new Uint8Array(buffer);
      const reference = registerExampleData(data, name, filename);
      const nextWorkspace = createMusicWorkspace({
        source: "browser",
        openMode: "file",
        activeDocumentId: reference.id,
        documents: [reference],
      });
      applyWorkspace(nextWorkspace);
    },
    [applyWorkspace],
  );
 
  return {
    singleDocumentMode,
    hasBackup,
    backupSongName,
    createSong,
    importSong,
    openDirectoryWorkspace,
    restoreBackupSong,
    openExample,
    closeWorkspace,
  };
};