@axium/storage 0.2.4 → 0.3.0

package/dist/common.d.ts

@@ -48,7 +48,8 @@ export type StorageItemUpdate = z.infer<typeof StorageItemUpdate>;
 export interface StorageItemMetadata<T extends Record<string, unknown> = Record<string, unknown>> {
     createdAt: Date;
     dataURL: string;
-    hash: string;
+    /** The hash of the file, or null if it is a directory */
+    hash: string | null;
     id: string;
     immutable: boolean;
     modifiedAt: Date;

package/dist/server.d.ts

@@ -6,7 +6,7 @@ declare module '@axium/server/database' {
     interface Schema {
         storage: {
             createdAt: Generated<Date>;
-            hash: Uint8Array;
+            hash: Uint8Array | null;
             id: Generated<string>;
             immutable: Generated<boolean>;
             modifiedAt: Generated<Date>;
@@ -24,6 +24,11 @@ declare module '@axium/server/database' {
         storage: ColumnTypes<Schema['storage']>;
     }
 }
+/**
+ * @internal A storage item selected from the database.
+ */
+interface SelectedItem extends Selectable<Schema['storage']> {
+}
 declare module '@axium/server/config' {
     interface Config {
         storage: {
@@ -52,15 +57,16 @@ declare module '@axium/server/config' {
 export interface StorageItem extends StorageItemMetadata {
     data: Uint8Array<ArrayBufferLike>;
 }
-export declare function parseItem<T extends Record<string, unknown> = Record<string, unknown>>(item: Selectable<Schema['storage']>): StorageItemMetadata<T>;
+export declare function parseItem<T extends SelectedItem>(item: T): Omit<T, keyof Schema['storage']> & StorageItemMetadata;
 /**
  * Returns the current usage of the storage for a user in bytes.
  */
 export declare function currentUsage(userId: string): Promise<StorageUsage>;
-export declare function get<T extends Record<string, unknown> = Record<string, unknown>>(itemId: string): Promise<StorageItemMetadata<T>>;
+export declare function get(itemId: string): Promise<StorageItemMetadata>;
 export type ExternalLimitHandler = (userId?: string) => StorageLimits | Promise<StorageLimits>;
 /**
  * Define the handler to get limits for a user externally.
  */
 export declare function useLimits(handler: ExternalLimitHandler): void;
 export declare function getLimits(userId?: string): Promise<StorageLimits>;
+export {};

package/dist/server.js

@@ -8,7 +8,6 @@ import { addRoute } from '@axium/server/routes';
 import { error } from '@sveltejs/kit';
 import { createHash } from 'node:crypto';
 import { linkSync, readFileSync, unlinkSync, writeFileSync } from 'node:fs';
-import { writeFile } from 'node:fs/promises';
 import { join } from 'node:path/posix';
 import * as z from 'zod';
 import { StorageItemUpdate } from './common.js';
@@ -50,9 +49,8 @@ addConfigDefaults({
 export function parseItem(item) {
     return {
         ...item,
-        metadata: item.metadata,
         dataURL: `/raw/storage/${item.id}`,
-        hash: item.hash.toHex(),
+        hash: item.hash?.toHex(),
     };
 }
 /**
@@ -140,6 +138,8 @@ addRoute({
             .returningAll()
             .executeTakeFirstOrThrow()
             .catch(withError('Could not delete item'));
+        if (item.type == 'inode/directory')
+            return item;
         const { count } = await database
             .selectFrom('storage')
             .where('hash', '=', Uint8Array.fromHex(item.hash))
@@ -191,6 +191,8 @@ addRoute({
                 .parseAsync(maybeParentId)
                 .catch(() => error(400, 'Invalid parent ID'))
             : null;
+        if (parentId)
+            await checkAuthForItem(event, 'storage', parentId, Permission.Edit);
         const size = Number(event.request.headers.get('content-length'));
         if (Number.isNaN(size))
             error(411, 'Missing or invalid content length header');
@@ -205,33 +207,48 @@ addRoute({
         if (content.byteLength > size)
             error(400, 'Content length does not match size header');
         const type = event.request.headers.get('content-type') || 'application/octet-stream';
+        const isDirectory = type == 'inode/directory';
+        if (isDirectory && size > 0)
+            error(400, 'Directories can not have content');
         const useCAS = config.storage.cas.enabled &&
+            !isDirectory &&
             (defaultCASMime.some(pattern => pattern.test(type)) || config.storage.cas.include.some(mime => type.match(mime)));
-        const hash = createHash('BLAKE2b512').update(content).digest();
-        // @todo: make this atomic
-        const result = await database
-            .insertInto('storage')
-            .values({ userId: userId, hash, name, size, type, immutable: useCAS, parentId })
-            .returningAll()
-            .executeTakeFirstOrThrow()
-            .catch(withError('Could not create item'));
-        const path = join(config.storage.data, result.id);
-        const _noDupe = () => {
-            writeFileSync(path, content);
-            return parseItem(result);
-        };
-        if (!useCAS)
-            return _noDupe();
-        const existing = await database
-            .selectFrom('storage')
-            .where('hash', '=', hash)
-            .where('id', '!=', result.id)
-            .selectAll()
-            .executeTakeFirst();
-        if (!existing)
-            return _noDupe();
-        linkSync(join(config.storage.data, existing.id), path);
-        return parseItem(result);
+        const hash = isDirectory ? null : createHash('BLAKE2b512').update(content).digest();
+        const tx = await database.startTransaction().execute();
+        try {
+            const item = parseItem(await tx
+                .insertInto('storage')
+                .values({ userId, hash, name, size, type, immutable: useCAS, parentId })
+                .returningAll()
+                .executeTakeFirstOrThrow());
+            const path = join(config.storage.data, item.id);
+            if (!useCAS) {
+                if (!isDirectory)
+                    writeFileSync(path, content);
+                return item;
+            }
+            const existing = await tx
+                .selectFrom('storage')
+                .select('id')
+                .where('hash', '=', hash)
+                .where('id', '!=', item.id)
+                .limit(1)
+                .executeTakeFirst();
+            if (!existing) {
+                if (!isDirectory)
+                    writeFileSync(path, content);
+                return item;
+            }
+            linkSync(join(config.storage.data, existing.id), path);
+            return item;
+        }
+        catch (error) {
+            await tx.rollback().execute();
+            throw withError('Could not create item', 500)(error);
+        }
+        finally {
+            await tx.commit().execute();
+        }
     },
 });
 addRoute({
@@ -258,7 +275,9 @@ addRoute({
         const itemId = event.params.id;
         const { item } = await checkAuthForItem(event, 'storage', itemId, Permission.Edit);
         if (item.immutable)
-            error(403, 'Item is immutable');
+            error(405, 'Item is immutable');
+        if (item.type == 'inode/directory')
+            error(409, 'Directories do not have content');
         if (item.trashedAt)
             error(410, 'Trashed items can not be changed');
         const type = event.request.headers.get('content-type') || 'application/octet-stream';
@@ -278,16 +297,22 @@ addRoute({
         if (content.byteLength > size)
             error(400, 'Content length does not match size header');
         const hash = createHash('BLAKE2b512').update(content).digest();
-        // @todo: make this atomic
-        const result = await database
-            .updateTable('storage')
-            .where('id', '=', itemId)
-            .set({ size, modifiedAt: new Date(), hash })
-            .returningAll()
-            .executeTakeFirstOrThrow()
-            .catch(withError('Could not update item'));
-        await writeFile(join(config.storage.data, result.id), content).catch(withError('Could not write'));
-        return parseItem(result);
+        const tx = await database.startTransaction().execute();
+        try {
+            const result = await tx
+                .updateTable('storage')
+                .where('id', '=', itemId)
+                .set({ size, modifiedAt: new Date(), hash })
+                .returningAll()
+                .executeTakeFirstOrThrow();
+            writeFileSync(join(config.storage.data, result.id), content);
+            await tx.commit().execute();
+            return parseItem(result);
+        }
+        catch (error) {
+            await tx.rollback().execute();
+            throw withError('Could not update item', 500)(error);
+        }
     },
 });
 addRoute({

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@axium/storage",
-	"version": "0.2.4",
+	"version": "0.3.0",
 	"author": "James Prevett <axium@jamespre.dev> (https://jamespre.dev)",
 	"description": "User file storage for Axium",
 	"funding": {