feat: deprecate owner column in favour of owner_id (#340)

Author: fenos

migrations/tenant/0017-add_owner_id_column_deprecate_owner.sql

@@ -0,0 +1,8 @@
+alter table storage.objects add column if not exists owner_id text default null;
+alter table storage.buckets add column if not exists owner_id text default null;
+
+comment on column storage.objects.owner is 'Field is deprecated, use owner_id instead';
+comment on column storage.buckets.owner is 'Field is deprecated, use owner_id instead';
+
+ALTER TABLE storage.buckets
+    DROP CONSTRAINT IF EXISTS buckets_owner_fkey;

src/monitoring/logger.ts

@@ -63,6 +63,8 @@ const whitelistHeaders = (headers: Record<string, unknown>) => {
     'host',
     'user-agent',
     'x-forwarded-proto',
+    'x-forwarded-host',
+    'x-forwarded-port',
     'referer',
     'content-length',
     'x-real-ip',

src/storage/database/knex.ts

@@ -13,6 +13,7 @@ import {
 import { DatabaseError } from 'pg'
 import { TenantConnection } from '../../database/connection'
 import { DbQueryPerformance } from '../../monitoring/metrics'
+import { isUuid } from '../limits'
 
 /**
  * Database
@@ -114,7 +115,8 @@ export class StorageKnexDB implements Database {
     const bucketData = {
       id: data.id,
       name: data.name,
-      owner: data.owner,
+      owner: isUuid(data.owner || '') ? data.owner : undefined,
+      owner_id: data.owner,
       public: data.public,
       allowed_mime_types: data.allowed_mime_types,
       file_size_limit: data.file_size_limit,
@@ -226,7 +228,8 @@ export class StorageKnexDB implements Database {
   async upsertObject(data: Pick<Obj, 'name' | 'owner' | 'bucket_id' | 'metadata' | 'version'>) {
     const objectData = {
       name: data.name,
-      owner: data.owner,
+      owner: isUuid(data.owner || '') ? data.owner : undefined,
+      owner_id: data.owner,
       bucket_id: data.bucket_id,
       metadata: data.metadata,
       version: data.version,
@@ -239,7 +242,8 @@ export class StorageKnexDB implements Database {
         .merge({
           metadata: data.metadata,
           version: data.version,
-          owner: data.owner,
+          owner: isUuid(data.owner || '') ? data.owner : undefined,
+          owner_id: data.owner,
         })
         .returning('*')
     })
@@ -253,15 +257,20 @@ export class StorageKnexDB implements Database {
     data: Pick<Obj, 'owner' | 'metadata' | 'version' | 'name'>
   ) {
     const [object] = await this.runQuery('UpdateObject', (knex) => {
-      return knex.from<Obj>('objects').where('bucket_id', bucketId).where('name', name).update(
-        {
-          name: data.name,
-          owner: data.owner,
-          metadata: data.metadata,
-          version: data.version,
-        },
-        '*'
-      )
+      return knex
+        .from<Obj>('objects')
+        .where('bucket_id', bucketId)
+        .where('name', name)
+        .update(
+          {
+            name: data.name,
+            owner: isUuid(data.owner || '') ? data.owner : undefined,
+            owner_id: data.owner,
+            metadata: data.metadata,
+            version: data.version,
+          },
+          '*'
+        )
     })
 
     if (!object) {
@@ -274,7 +283,8 @@ export class StorageKnexDB implements Database {
   async createObject(data: Pick<Obj, 'name' | 'owner' | 'bucket_id' | 'metadata' | 'version'>) {
     const object = {
       name: data.name,
-      owner: data.owner,
+      owner: isUuid(data.owner || '') ? data.owner : undefined,
+      owner_id: data.owner,
       bucket_id: data.bucket_id,
       metadata: data.metadata,
       version: data.version,
@@ -335,7 +345,8 @@ export class StorageKnexDB implements Database {
         .from<Obj>('objects')
         .update({
           last_accessed_at: new Date().toISOString(),
-          owner,
+          owner: isUuid(owner || '') ? owner : undefined,
+          owner_id: owner,
         })
         .returning('*')
         .where({ bucket_id: bucketId, name: objectName })

src/storage/limits.ts

@@ -109,3 +109,7 @@ export function parseFileSizeToBytes(valueWithUnit: string) {
       )
   }
 }
+
+export function isUuid(value: string) {
+  return /^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(value)
+}

src/storage/object.ts

@@ -269,6 +269,7 @@ export class ObjectStorage {
       await this.uploader.canUpload({
         bucketId: this.bucketId,
         objectName: destinationKey,
+        owner,
         isUpsert: false,
       })
 

src/storage/schemas/object.ts

@@ -8,6 +8,7 @@ export const objectSchema = {
     name: { type: 'string' },
     bucket_id: { type: 'string' },
     owner: { type: 'string' },
+    owner_id: { type: 'string' },
     version: { type: 'string' },
     id: { anyOf: [{ type: 'string' }, { type: 'null' }] },
     updated_at: { anyOf: [{ type: 'string' }, { type: 'null' }] },

src/test/tus.test.ts

@@ -129,6 +129,7 @@ describe('Tus multipart', () => {
       },
       name: objectName,
       owner: null,
+      owner_id: null,
       path_tokens: [objectName],
       updated_at: expect.any(Date),
       version: expect.any(String),