feat(core): getUrl and getTemporaryUrl support

Author: bericp1

package.json

@@ -93,7 +93,7 @@
         ]
     },
     "dependencies": {
-        "@carimus/node-disks": "^1.8.0",
+        "@carimus/node-disks": "^1.9.1",
         "tmp": "^0.1.0"
     }
 }

src/lib/Uploads.test.ts

@@ -1,24 +1,38 @@
 import * as fs from 'fs';
 import { promisify } from 'util';
-import { DiskDriver, DiskManager, streamToBuffer } from '@carimus/node-disks';
+import {
+    DiskDriver,
+    DiskManager,
+    DiskManagerConfig,
+    streamToBuffer,
+} from '@carimus/node-disks';
 import { MemoryRepository, MemoryRepositoryRecord } from '../support';
 import { Uploads } from './Uploads';
 import { UploadMeta } from '../types';
 
 const readFileFromLocalFilesystem = promisify(fs.readFile);
 const deleteFromLocalFilesystem = promisify(fs.unlink);
 
-const disks = {
+const disks: DiskManagerConfig = {
     default: 'memory',
     memory: {
         driver: DiskDriver.Memory,
     },
     nonDefaultMemory: {
         driver: DiskDriver.Memory,
     },
+    memoryWithUrls: {
+        driver: DiskDriver.Memory,
+        config: {
+            url: 'http://localhost',
+            temporaryUrlFallback: true,
+        },
+    },
 };
 
-function setup(): {
+function setup(
+    defaultDisk = 'default',
+): {
     diskManager: DiskManager;
     repository: MemoryRepository;
     uploads: Uploads<MemoryRepositoryRecord>;
@@ -29,7 +43,7 @@ function setup(): {
         diskManager,
         repository,
         uploads: new Uploads<MemoryRepositoryRecord>({
-            defaultDisk: 'default',
+            defaultDisk,
             disks: diskManager,
             repository,
         }),
@@ -450,3 +464,31 @@ test('Uploads can read and createReadStream for uploads', async () => {
         uploadsReadStreamFileData.toString('base64'),
     );
 });
+
+test('Uploads can generate urls and temp urls for uploads on disks that supports URLs', async () => {
+    const { uploads } = setup('memoryWithUrls');
+
+    // Upload a file
+    const upload = await uploads.upload(
+        files.longName.data,
+        files.longName.uploadedAs,
+        files.longName.meta,
+    );
+
+    // Check the URLs generated
+    const url = await uploads.getUrl(upload);
+    const tempUrl = await uploads.getTemporaryUrl(upload);
+    expect(url).toBeTruthy();
+    expect(typeof url).toBe('string');
+    expect((url as string).indexOf('http://localhost')).toBe(0);
+    expect(tempUrl).toBeTruthy();
+    expect(typeof tempUrl).toBe('string');
+    expect((tempUrl as string).indexOf('http://localhost')).toBe(0);
+
+    // Transfer the upload to a disk that doesn't support URLs
+    await uploads.transfer(upload, 'default');
+
+    // Check to ensure the url and tempUrl are null for this upload now.
+    expect(await uploads.getUrl(upload)).toBeNull();
+    expect(await uploads.getTemporaryUrl(upload)).toBeNull();
+});

src/lib/Uploads.ts

@@ -336,6 +336,41 @@ export class Uploads<Upload> {
         return this.disks.getDisk(file.disk).createReadStream(file.path);
     }
 
+    /**
+     * Get a URL from the disk for an upload. Will be null if the disk that the upload is stored on does not support
+     * URLs or is not configured for them.
+     *
+     * @param upload
+     */
+    public async getUrl(upload: Upload): Promise<string | null> {
+        // Ask the repository for info on where and how the upload file is stored.
+        const file = await this.repository.getUploadedFileInfo(upload);
+        // Read the data into memory in a Buffer and resolve with it.
+        return this.disks.getDisk(file.disk).getUrl(file.path);
+    }
+
+    /**
+     * Get a temporary URL from the disk for an upload. Will be null if the disk that the upload is stored on does not
+     * support temporary URLs or is not configured for them.
+     *
+     * @param upload
+     * @param expires The number of seconds the URL should expire at. Default is configured at the disk level.
+     * @param fallback Whether or not to fallback to permanent URLs if the disk doesn't support temporary URLs. Defualt
+     *      is generally false but is configured at the disk level.
+     */
+    public async getTemporaryUrl(
+        upload: Upload,
+        expires?: number,
+        fallback?: boolean,
+    ): Promise<string | null> {
+        // Ask the repository for info on where and how the upload file is stored.
+        const file = await this.repository.getUploadedFileInfo(upload);
+        // Read the data into memory in a Buffer and resolve with it.
+        return this.disks
+            .getDisk(file.disk)
+            .getTemporaryUrl(file.path, expires, fallback);
+    }
+
     /**
      * Download the file to the local disk as a temporary file for operations that require local data manipuation
      * and which can't handle Buffers, i.e. operations expected to be performed on large files where it's easier to

yarn.lock

@@ -138,15 +138,16 @@
     lodash "^4.17.11"
     to-fast-properties "^2.0.0"
 
-"@carimus/node-disks@^1.8.0":
-  version "1.8.0"
-  resolved "https://registry.yarnpkg.com/@carimus/node-disks/-/node-disks-1.8.0.tgz#d5d12300dfaf244889570f5309e354b8df18ef3b"
-  integrity sha512-zdi7euqzn76Z2hyMBN5hUsr9beSDRB8fCktRz4xuUTXNAqmL15kCKruSV3WHB7tz4nUDn+Hr2yCYM3U+S3jgyw==
+"@carimus/node-disks@^1.9.1":
+  version "1.9.1"
+  resolved "https://registry.yarnpkg.com/@carimus/node-disks/-/node-disks-1.9.1.tgz#4a0f8bb54a07fcb59cb5dd2c43cb169e542e1c1b"
+  integrity sha512-yvsLRemMfB4wT+R0uMOvXgfZb3O7PGizVGBcSWMdkCM8PfdKgJW/ZvPSmxZwDDXrQK20HTScgUTsVcyTviDRfg==
   dependencies:
     aws-sdk "^2.431.0"
     fs-extra "^7.0.1"
     ramda "0.25.0"
     stream-to-array "^2.3.0"
+    url-join "^4.0.0"
     verror "^1.10.0"
 
 "@cnakazawa/watch@^1.0.3":