Refactor

Part of #381

Author: kyoshino

src/lib/components/assets/browser/select-assets-dialog.svelte

@@ -29,6 +29,7 @@
   import { normalize } from '$lib/services/search';
   import { isSmallScreen } from '$lib/services/user/env';
   import { prefs } from '$lib/services/user/prefs';
+  import { getGitHash } from '$lib/services/utils/file';
   import { SUPPORTED_IMAGE_TYPES } from '$lib/services/utils/media/image';
 
   /**
@@ -181,7 +182,7 @@
       blobURL: blobURL ?? URL.createObjectURL(file),
       name,
       path: `${targetFolderPath}/${name}`,
-      sha: await getHash(file),
+      sha: await getGitHash(file),
       size,
       kind: getAssetKind(name),
       folder,

src/lib/components/contents/details/widgets/file/file-editor.svelte

@@ -26,7 +26,7 @@
   import { getDefaultMediaLibraryOptions, transformFile } from '$lib/services/assets/media-library';
   import { entryDraft } from '$lib/services/contents/draft';
   import { hasMouse } from '$lib/services/user/env';
-  import { createPath, formatSize } from '$lib/services/utils/file';
+  import { createPath, formatSize, getGitHash } from '$lib/services/utils/file';
   import { SUPPORTED_IMAGE_TYPES } from '$lib/services/utils/media/image';
 
   /**
@@ -182,9 +182,9 @@
           file = await transformFile(file, transformations);
         }
 
-        const hash = await getHash(file);
+        const sha = await getGitHash(file);
         const { folder } = selectedResource;
-        const existingAsset = $allAssets.find((a) => a.sha === hash && equal(a.folder, folder));
+        const existingAsset = $allAssets.find((a) => a.sha === sha && equal(a.folder, folder));
 
         if (existingAsset) {
           // If the selected file has already been uploaded, use the existing asset instead of

src/lib/services/assets/data/create.js

@@ -1,4 +1,3 @@
-import { getHash } from '@sveltia/utils/crypto';
 import { get } from 'svelte/store';
 import {
   allAssets,
@@ -12,7 +11,7 @@ import { getDefaultMediaLibraryOptions } from '$lib/services/assets/media-librar
 import { backend } from '$lib/services/backends';
 import { siteConfig } from '$lib/services/config';
 import { UPDATE_TOAST_DEFAULT_STATE } from '$lib/services/contents/collection/data';
-import { formatFileName } from '$lib/services/utils/file';
+import { formatFileName, getGitHash } from '$lib/services/utils/file';
 
 /**
  * @import { Asset, CommitAction, CommitChangesOptions, UploadingAssets } from '$lib/types/private';
@@ -110,7 +109,7 @@ export const saveAssets = async (uploadingAssets, options) => {
           blobURL: URL.createObjectURL(file),
           name,
           path,
-          sha: await getHash(file),
+          sha: await getGitHash(file),
           size: file.size,
           kind: getAssetKind(name),
           text: undefined,

src/lib/services/assets/data/move.js

@@ -37,29 +37,29 @@ import { getAssociatedCollections } from '$lib/services/contents/entry';
  * Update the asset and entry stores after moving or renaming assets.
  * @param {object} args Arguments.
  * @param {'move' | 'rename'} args.action The action performed, either 'move' or 'rename'.
- * @param {MovingAsset[]} args.movingAssets The list of assets being moved or renamed.
- * @param {Asset[]} args.savingAssets The updated asset objects to be saved in the store.
- * @param {Entry[]} args.savingEntries The updated entry objects to be saved in the store.
+ * @param {MovingAsset[]} args.movedAssets The assets that have been moved or renamed.
+ * @param {Asset[]} args.savedAssets The assets that have been saved.
+ * @param {Entry[]} args.savedEntries The entries that have been saved.
  */
-const updateStores = ({ action, movingAssets, savingAssets, savingEntries }) => {
-  const savingAssetsPaths = movingAssets.map((a) => a.asset.path); // old paths
-  const savingEntryIds = savingEntries.map((e) => e.id);
+const updateStores = ({ action, movedAssets, savedAssets, savedEntries }) => {
+  const savedAssetsPaths = movedAssets.map((a) => a.asset.path); // old paths
+  const savedEntryIds = savedEntries.map((e) => e.id);
 
   allAssets.update((assets) => [
-    ...assets.filter((a) => !savingAssetsPaths.includes(a.path)),
-    ...savingAssets,
+    ...assets.filter((a) => !savedAssetsPaths.includes(a.path)),
+    ...savedAssets,
   ]);
 
   allEntries.update((entries) => [
-    ...entries.filter((e) => !savingEntryIds.includes(e.id)),
-    ...savingEntries,
+    ...entries.filter((e) => !savedEntryIds.includes(e.id)),
+    ...savedEntries,
   ]);
 
   const _allAssets = get(allAssets);
   const focusedAssetPath = get(focusedAsset)?.path;
-  const _focusedAsset = movingAssets.find((a) => a.asset.path === focusedAssetPath);
+  const _focusedAsset = movedAssets.find((a) => a.asset.path === focusedAssetPath);
   const overlaidAssetPath = get(overlaidAsset)?.path;
-  const _overlaidAsset = movingAssets.find((a) => a.asset.path === overlaidAssetPath);
+  const _overlaidAsset = movedAssets.find((a) => a.asset.path === overlaidAssetPath);
 
   // Replace the existing asset
   if (_focusedAsset) {
@@ -75,7 +75,7 @@ const updateStores = ({ action, movingAssets, savingAssets, savingEntries }) =>
     ...UPDATE_TOAST_DEFAULT_STATE,
     moved: action === 'move',
     renamed: action === 'rename',
-    count: movingAssets.length,
+    count: movedAssets.length,
   });
 };
 
@@ -214,14 +214,15 @@ export const moveAssets = async (action, movingAssets) => {
 
   const results = await get(backend)?.commitChanges(changes, { commitType: 'uploadMedia' });
 
-  // Update blob URLs for the local backend
-  if (Array.isArray(results)) {
-    savingAssets.forEach((asset, index) => {
-      if (results[index] instanceof File) {
-        asset.blobURL = URL.createObjectURL(/** @type {File} */ (results[index]));
-      }
-    });
-  }
+  updateStores({
+    action,
+    movedAssets: [...movingAssets],
+    savedAssets: savingAssets.map((asset, index) => {
+      const result = results?.[index];
+      const blobURL = result instanceof File ? URL.createObjectURL(result) : undefined;
 
-  updateStores({ action, movingAssets, savingAssets, savingEntries });
+      return { ...asset, blobURL };
+    }),
+    savedEntries: [...savingEntries],
+  });
 };

src/lib/services/backends/shared/fs.js

@@ -3,7 +3,6 @@
 /* eslint-disable no-restricted-syntax */
 
 import { unique } from '@sveltia/utils/array';
-import { getHash } from '@sveltia/utils/crypto';
 import { getPathInfo, readAsText } from '@sveltia/utils/file';
 import { stripSlashes } from '@sveltia/utils/string';
 import { get } from 'svelte/store';
@@ -13,7 +12,7 @@ import { GIT_CONFIG_FILE_REGEX, gitConfigFiles } from '$lib/services/backends';
 import { createFileList } from '$lib/services/backends/shared/fetch';
 import { allEntries, allEntryFolders, dataLoaded, entryParseErrors } from '$lib/services/contents';
 import { prepareEntries } from '$lib/services/contents/file/process';
-import { createPathRegEx } from '$lib/services/utils/file';
+import { createPathRegEx, getGitHash } from '$lib/services/utils/file';
 
 /**
  * @import { BaseFileListItem, BaseFileListItemProps, FileChange } from '$lib/types/private';
@@ -146,23 +145,6 @@ const scanDir = async (dirHandle, context) => {
   }
 };
 
-/**
- * Asynchronously computes and returns the hash of a given file.
- * @param {File} file The file object to compute the hash for.
- * @returns {Promise<string>} The computed hash as a string, or an empty string if an error occurs.
- */
-const getFileHash = async (file) => {
-  try {
-    // Need `await` here to catch any exception
-    return await getHash(file);
-  } catch (/** @type {any} */ ex) {
-    // eslint-disable-next-line no-console
-    console.error(ex);
-  }
-
-  return '';
-};
-
 /**
  * Normalize a file list item to ensure it has the required properties. This function also computes
  * the SHA-1 hash of the file. The file path and name must be normalized, as certain non-ASCII
@@ -175,7 +157,7 @@ const normalizeFileListItem = async ({ file, path }) => ({
   path: path.normalize(),
   name: file.name.normalize(),
   size: file.size,
-  sha: await getFileHash(file),
+  sha: await getGitHash(file),
 });
 
 /**

src/lib/types/private.js

@@ -243,7 +243,7 @@
 /**
  * Base file info retrieved from a Git repository.
  * @typedef {object} RepositoryFileInfo
- * @property {string} sha SHA-1 hash for the file.
+ * @property {string} sha Git object ID (SHA-1 hash) for the file.
  * @property {number} size File size in bytes.
  * @property {string} [text] Raw text for a plaintext file, like HTML or Markdown.
  * @property {RepositoryFileMetadata} meta Metadata from the repository.
@@ -278,7 +278,7 @@
  * @property {File} [file] File object. Local backend only.
  * @property {string} path File path.
  * @property {string} name File name, without a path.
- * @property {string} sha SHA-1 hash for the file.
+ * @property {string} sha Git object ID (SHA-1 hash) for the file.
  * @property {number} size File size in bytes.
  * @property {string} [text] Raw text for a plaintext file, like HTML or Markdown.
  * @property {RepositoryFileMetadata} [meta] Metadata from the repository. Git backends only.
@@ -574,7 +574,9 @@
  * @property {string} [previousPath] Original path to a file being moved. Required when the commit
  * `action` is `move`.
  * @property {string} [slug] Entry slug or `undefined` for an asset.
- * @property {string | File} [data] File data.
+ * @property {string | File} [data] File data. `undefined` for a deleted file, or a file object for
+ * a new or updated file. It can also be a string for a text file like Markdown or HTML, which is
+ * automatically converted to a Blob.
  */
 
 /**
@@ -612,7 +614,7 @@
  * fetched or a local file being uploaded. Or `undefined` if the URL is not generated yet.
  * @property {string} name File name.
  * @property {string} path File path.
- * @property {string} sha SHA-1 hash for the file.
+ * @property {string} sha Git object ID (SHA-1 hash) for the file.
  * @property {number} size File size in bytes.
  * @property {AssetKind} kind Basic file type.
  * @property {string} [text] Raw text for a plaintext file, like HTML or Markdown.