@adminforth/upload 2.4.1 → 2.6.0

package/build.log

@@ -11,5 +11,5 @@ custom/preview.vue
 custom/tsconfig.json
 custom/uploader.vue
 
-sent 48,314 bytes  received 134 bytes  96,896.00 bytes/sec
-total size is 47,825  speedup is 0.99
+sent 49,208 bytes  received 134 bytes  98,684.00 bytes/sec
+total size is 48,726  speedup is 0.99

package/custom/imageGenerator.vue

@@ -248,7 +248,6 @@ onMounted(async () => {
 
     if (resp?.files?.length) {
       attachmentFiles.value = resp.files;
-      console.log('attachmentFiles', attachmentFiles.value);
     }
   } catch (err) {
     console.error('Failed to fetch attachment files', err);
@@ -337,7 +336,7 @@ async function generateImages() {
   let error = null;
   try {
     resp = await callAdminForthApi({
-      path: `/plugin/${props.meta.pluginInstanceId}/generate_images`,
+      path: `/plugin/${props.meta.pluginInstanceId}/create-image-generation-job`,
       method: 'POST',
       body: {
         prompt: prompt.value,
@@ -346,16 +345,13 @@ async function generateImages() {
     });
   } catch (e) {
     console.error(e);
-  } finally {
-    clearInterval(ticker);
-    loadingTimer.value = null;
-    loading.value = false;
   }
+
   if (resp?.error) {
     error = resp.error;
   }
   if (!resp) {
-    error = $t('Error generating images, something went wrong');
+    error = $t('Error creating image generation job');
   }
 
   if (error) {
@@ -371,11 +367,53 @@ async function generateImages() {
     return;
   }
 
+  const jobId = resp.jobId;
+  let jobStatus = null;
+  let jobResponse = null;
+  do {
+    jobResponse = await callAdminForthApi({
+      path: `/plugin/${props.meta.pluginInstanceId}/get-image-generation-job-status`,
+      method: 'POST',
+      body: { jobId },
+    });
+    if (jobResponse?.error) {
+      error = jobResponse.error;
+      break;
+    };
+    jobStatus = jobResponse?.job?.status;
+    if (jobStatus === 'failed') {
+      error = jobResponse?.job?.error || $t('Image generation job failed');
+    }
+    if (jobStatus === 'timeout') {
+      error = jobResponse?.job?.error || $t('Image generation job timeout');
+    }
+    await new Promise((resolve) => setTimeout(resolve, 2000));
+  } while (jobStatus === 'in_progress')
+
+  if (error) {
+      adminforth.alert({
+        message: error,
+        variant: 'danger',
+        timeout: 'unlimited',
+      });
+      clearInterval(ticker);
+      loadingTimer.value = null;
+      loading.value = false;
+    return;
+  }
+
+  const respImages = jobResponse?.job?.images || [];
+
   images.value = [
     ...images.value,
-    ...resp.images,
+    ...respImages,
   ];
 
+  clearInterval(ticker);
+  loadingTimer.value = null;
+  loading.value = false;
+  
+
   // images.value = [
   //   'https://via.placeholder.com/600x400?text=Image+1',
   //   'https://via.placeholder.com/600x400?text=Image+2',
@@ -386,7 +424,6 @@ async function generateImages() {
   caurosel.value = new Carousel(
     document.getElementById('gallery'), 
     images.value.map((img, index) => {
-      console.log('mapping image', img, index);
       return {
         image: img,
         el: document.getElementById('gallery').querySelector(`[data-carousel-item]:nth-child(${index + 1})`),

package/dist/custom/imageGenerator.vue

@@ -248,7 +248,6 @@ onMounted(async () => {
 
     if (resp?.files?.length) {
       attachmentFiles.value = resp.files;
-      console.log('attachmentFiles', attachmentFiles.value);
     }
   } catch (err) {
     console.error('Failed to fetch attachment files', err);
@@ -337,7 +336,7 @@ async function generateImages() {
   let error = null;
   try {
     resp = await callAdminForthApi({
-      path: `/plugin/${props.meta.pluginInstanceId}/generate_images`,
+      path: `/plugin/${props.meta.pluginInstanceId}/create-image-generation-job`,
       method: 'POST',
       body: {
         prompt: prompt.value,
@@ -346,16 +345,13 @@ async function generateImages() {
     });
   } catch (e) {
     console.error(e);
-  } finally {
-    clearInterval(ticker);
-    loadingTimer.value = null;
-    loading.value = false;
   }
+
   if (resp?.error) {
     error = resp.error;
   }
   if (!resp) {
-    error = $t('Error generating images, something went wrong');
+    error = $t('Error creating image generation job');
   }
 
   if (error) {
@@ -371,11 +367,53 @@ async function generateImages() {
     return;
   }
 
+  const jobId = resp.jobId;
+  let jobStatus = null;
+  let jobResponse = null;
+  do {
+    jobResponse = await callAdminForthApi({
+      path: `/plugin/${props.meta.pluginInstanceId}/get-image-generation-job-status`,
+      method: 'POST',
+      body: { jobId },
+    });
+    if (jobResponse?.error) {
+      error = jobResponse.error;
+      break;
+    };
+    jobStatus = jobResponse?.job?.status;
+    if (jobStatus === 'failed') {
+      error = jobResponse?.job?.error || $t('Image generation job failed');
+    }
+    if (jobStatus === 'timeout') {
+      error = jobResponse?.job?.error || $t('Image generation job timeout');
+    }
+    await new Promise((resolve) => setTimeout(resolve, 2000));
+  } while (jobStatus === 'in_progress')
+
+  if (error) {
+      adminforth.alert({
+        message: error,
+        variant: 'danger',
+        timeout: 'unlimited',
+      });
+      clearInterval(ticker);
+      loadingTimer.value = null;
+      loading.value = false;
+    return;
+  }
+
+  const respImages = jobResponse?.job?.images || [];
+
   images.value = [
     ...images.value,
-    ...resp.images,
+    ...respImages,
   ];
 
+  clearInterval(ticker);
+  loadingTimer.value = null;
+  loading.value = false;
+  
+
   // images.value = [
   //   'https://via.placeholder.com/600x400?text=Image+1',
   //   'https://via.placeholder.com/600x400?text=Image+2',
@@ -386,7 +424,6 @@ async function generateImages() {
   caurosel.value = new Carousel(
     document.getElementById('gallery'), 
     images.value.map((img, index) => {
-      console.log('mapping image', img, index);
       return {
         image: img,
         el: document.getElementById('gallery').querySelector(`[data-carousel-item]:nth-child(${index + 1})`),

package/dist/index.js

@@ -10,9 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { AdminForthPlugin, Filters, suggestIfTypo } from "adminforth";
 import { Readable } from "stream";
 import { RateLimiter } from "adminforth";
+import { randomUUID } from "crypto";
 import { interpretResource } from 'adminforth';
 import { ActionCheckSource } from 'adminforth';
 const ADMINFORTH_NOT_YET_USED_TAG = 'adminforth-candidate-for-cleanup';
+const jobs = new Map();
 export default class UploadPlugin extends AdminForthPlugin {
     constructor(options) {
         var _a, _b, _c;
@@ -21,10 +23,80 @@ export default class UploadPlugin extends AdminForthPlugin {
         // for calcualting average time
         this.totalCalls = 0;
         this.totalDuration = 0;
+        this.getFileDownloadUrl = (path_1, ...args_1) => __awaiter(this, [path_1, ...args_1], void 0, function* (path, expiresInSeconds = 1800) {
+            if (!path) {
+                return '';
+            }
+            return this.options.storageAdapter.getDownloadUrl(path, expiresInSeconds);
+        });
         if ((_b = (_a = this.options.generation) === null || _a === void 0 ? void 0 : _a.rateLimit) === null || _b === void 0 ? void 0 : _b.limit) {
             this.rateLimiter = new RateLimiter((_c = this.options.generation.rateLimit) === null || _c === void 0 ? void 0 : _c.limit);
         }
     }
+    generateImages(jobId, prompt, recordId, adminUser, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            if ((_a = this.options.generation.rateLimit) === null || _a === void 0 ? void 0 : _a.limit) {
+                // rate limit
+                // const { error } = RateLimiter.checkRateLimit(
+                //   this.pluginInstanceId, 
+                //   this.options.generation.rateLimit?.limit,
+                //   this.adminforth.auth.getClientIp(headers),
+                // );
+                if (!(yield this.rateLimiter.consume(`${this.pluginInstanceId}-${this.adminforth.auth.getClientIp(headers)}`))) {
+                    jobs.set(jobId, { status: "failed", error: this.options.generation.rateLimit.errorMessage });
+                    return { error: this.options.generation.rateLimit.errorMessage };
+                }
+            }
+            let attachmentFiles = [];
+            if (this.options.generation.attachFiles) {
+                // TODO - does it require additional allowed action to check this record id has access to get the image?
+                // or should we mention in docs that user should do validation in method itself
+                const record = yield this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ((_b = this.resourceConfig.columns.find(c => c.primaryKey)) === null || _b === void 0 ? void 0 : _b.name, recordId)]);
+                if (!record) {
+                    return { error: `Record with id ${recordId} not found` };
+                }
+                attachmentFiles = yield this.options.generation.attachFiles({ record, adminUser });
+                // if files is not array, make it array
+                if (!Array.isArray(attachmentFiles)) {
+                    attachmentFiles = [attachmentFiles];
+                }
+            }
+            let error = undefined;
+            const STUB_MODE = false;
+            const images = yield Promise.all((new Array(this.options.generation.countToGenerate)).fill(0).map(() => __awaiter(this, void 0, void 0, function* () {
+                if (STUB_MODE) {
+                    yield new Promise((resolve) => setTimeout(resolve, 2000));
+                    return `https://picsum.photos/200/300?random=${Math.floor(Math.random() * 1000)}`;
+                }
+                const start = +new Date();
+                let resp;
+                try {
+                    resp = yield this.options.generation.adapter.generate({
+                        prompt,
+                        inputFiles: attachmentFiles,
+                        n: 1,
+                        size: this.options.generation.outputSize,
+                    });
+                }
+                catch (e) {
+                    error = `No response from image generation provider: ${e.message}. Please check your prompt or try again later.`;
+                    return;
+                }
+                if (resp.error) {
+                    console.error('Error generating image', resp.error);
+                    error = resp.error;
+                    return;
+                }
+                this.totalCalls++;
+                this.totalDuration += (+new Date() - start) / 1000;
+                return resp.imageURLs[0];
+            })));
+            jobs.set(jobId, { status: "completed", images, error });
+            return { ok: true };
+        });
+    }
+    ;
     instanceUniqueRepresentation(pluginOptions) {
         return `${pluginOptions.pathColumnName}`;
     }
@@ -282,66 +354,30 @@ export default class UploadPlugin extends AdminForthPlugin {
         // }'
         server.endpoint({
             method: 'POST',
-            path: `/plugin/${this.pluginInstanceId}/generate_images`,
+            path: `/plugin/${this.pluginInstanceId}/create-image-generation-job`,
             handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, headers }) {
-                var _b;
                 const { prompt, recordId } = body;
-                if (this.rateLimiter) {
-                    // rate limit
-                    // const { error } = RateLimiter.checkRateLimit(
-                    //   this.pluginInstanceId, 
-                    //   this.options.generation.rateLimit?.limit,
-                    //   this.adminforth.auth.getClientIp(headers),
-                    // );
-                    if (!(yield this.rateLimiter.consume(`${this.pluginInstanceId}-${this.adminforth.auth.getClientIp(headers)}`))) {
-                        return { error: this.options.generation.rateLimit.errorMessage };
-                    }
+                const jobId = randomUUID();
+                jobs.set(jobId, { status: "in_progress" });
+                this.generateImages(jobId, prompt, recordId, adminUser, headers);
+                setTimeout(() => jobs.delete(jobId), 1800000);
+                setTimeout(() => { jobs.set(jobId, { status: "timeout" }); }, 300000);
+                return { ok: true, jobId };
+            })
+        });
+        server.endpoint({
+            method: 'POST',
+            path: `/plugin/${this.pluginInstanceId}/get-image-generation-job-status`,
+            handler: (_a) => __awaiter(this, [_a], void 0, function* ({ body, adminUser, headers }) {
+                const jobId = body.jobId;
+                if (!jobId) {
+                    return { error: "Can't find job id" };
                 }
-                let attachmentFiles = [];
-                if (this.options.generation.attachFiles) {
-                    // TODO - does it require additional allowed action to check this record id has access to get the image?
-                    // or should we mention in docs that user should do validation in method itself
-                    const record = yield this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ((_b = this.resourceConfig.columns.find((column) => column.primaryKey)) === null || _b === void 0 ? void 0 : _b.name, recordId)]);
-                    if (!record) {
-                        return { error: `Record with id ${recordId} not found` };
-                    }
-                    attachmentFiles = yield this.options.generation.attachFiles({ record, adminUser });
-                    // if files is not array, make it array
-                    if (!Array.isArray(attachmentFiles)) {
-                        attachmentFiles = [attachmentFiles];
-                    }
+                const job = jobs.get(jobId);
+                if (!job) {
+                    return { error: "Job not found" };
                 }
-                let error = undefined;
-                const STUB_MODE = false;
-                const images = yield Promise.all((new Array(this.options.generation.countToGenerate)).fill(0).map(() => __awaiter(this, void 0, void 0, function* () {
-                    if (STUB_MODE) {
-                        yield new Promise((resolve) => setTimeout(resolve, 2000));
-                        return `https://picsum.photos/200/300?random=${Math.floor(Math.random() * 1000)}`;
-                    }
-                    const start = +new Date();
-                    let resp;
-                    try {
-                        resp = yield this.options.generation.adapter.generate({
-                            prompt,
-                            inputFiles: attachmentFiles,
-                            n: 1,
-                            size: this.options.generation.outputSize,
-                        });
-                    }
-                    catch (e) {
-                        error = `No response from image generation provider: ${e.message}. Please check your prompt or try again later.`;
-                        return;
-                    }
-                    if (resp.error) {
-                        console.error('Error generating image', resp.error);
-                        error = resp.error;
-                        return;
-                    }
-                    this.totalCalls++;
-                    this.totalDuration += (+new Date() - start) / 1000;
-                    return resp.imageURLs[0];
-                })));
-                return { error, images };
+                return { ok: true, job };
             })
         });
         server.endpoint({

package/index.ts

@@ -3,11 +3,12 @@ import { PluginOptions } from './types.js';
 import { AdminForthPlugin, AdminForthResourceColumn, AdminForthResource, Filters, IAdminForth, IHttpServer, suggestIfTypo } from "adminforth";
 import { Readable } from "stream";
 import { RateLimiter } from "adminforth";
+import { randomUUID } from "crypto";
 import { interpretResource } from 'adminforth';
 import { ActionCheckSource } from 'adminforth'; 
 
 const ADMINFORTH_NOT_YET_USED_TAG = 'adminforth-candidate-for-cleanup';
-
+const jobs = new Map();
 export default class UploadPlugin extends AdminForthPlugin {
   options: PluginOptions;
 
@@ -20,6 +21,8 @@ export default class UploadPlugin extends AdminForthPlugin {
 
   rateLimiter: RateLimiter;
 
+  getFileDownloadUrl: ((path: string) => Promise<string>); 
+
   constructor(options: PluginOptions) {
     super(options, import.meta.url);
     this.options = options;
@@ -27,11 +30,94 @@ export default class UploadPlugin extends AdminForthPlugin {
     // for calcualting average time
     this.totalCalls = 0;
     this.totalDuration = 0;
+    this.getFileDownloadUrl = async (path: string, expiresInSeconds: number = 1800) : Promise<string> => {
+      if (!path) {
+        return '';
+      }
+      return this.options.storageAdapter.getDownloadUrl(path, expiresInSeconds);
+    }
     if (this.options.generation?.rateLimit?.limit) {
-    this.rateLimiter = new RateLimiter(this.options.generation.rateLimit?.limit)
+      this.rateLimiter = new RateLimiter(this.options.generation.rateLimit?.limit)
     }
   }
 
+  private async generateImages(jobId: string, prompt: string, recordId: any, adminUser: any, headers: any) {
+    if (this.options.generation.rateLimit?.limit) {
+      // rate limit
+      // const { error } = RateLimiter.checkRateLimit(
+      //   this.pluginInstanceId, 
+      //   this.options.generation.rateLimit?.limit,
+      //   this.adminforth.auth.getClientIp(headers),
+      // );
+      if (!await this.rateLimiter.consume(`${this.pluginInstanceId}-${this.adminforth.auth.getClientIp(headers)}`)) {
+        jobs.set(jobId, { status: "failed", error: this.options.generation.rateLimit.errorMessage });
+        return { error: this.options.generation.rateLimit.errorMessage };
+      }
+    }
+    let attachmentFiles = [];
+    if (this.options.generation.attachFiles) {
+      // TODO - does it require additional allowed action to check this record id has access to get the image?
+      // or should we mention in docs that user should do validation in method itself
+      const record = await this.adminforth.resource(this.resourceConfig.resourceId).get(
+        [Filters.EQ(this.resourceConfig.columns.find(c => c.primaryKey)?.name, recordId)]
+      );
+
+
+      if (!record) {
+        return { error: `Record with id ${recordId} not found` };
+      }
+      
+      attachmentFiles = await this.options.generation.attachFiles({ record, adminUser });
+      // if files is not array, make it array
+      if (!Array.isArray(attachmentFiles)) {
+        attachmentFiles = [attachmentFiles];
+      }
+
+    }
+    
+    let error: string | undefined = undefined;
+
+    const STUB_MODE = false;
+
+    const images = await Promise.all(
+      (new Array(this.options.generation.countToGenerate)).fill(0).map(async () => {
+        if (STUB_MODE) {
+          await new Promise((resolve) => setTimeout(resolve, 2000));
+          return `https://picsum.photos/200/300?random=${Math.floor(Math.random() * 1000)}`;
+        }
+        const start = +new Date();
+        let resp;
+        try {
+          resp = await this.options.generation.adapter.generate(
+            {
+              prompt,
+              inputFiles: attachmentFiles,
+              n: 1,
+              size: this.options.generation.outputSize,
+            }
+          )
+        } catch (e: any) {
+          error = `No response from image generation provider: ${e.message}. Please check your prompt or try again later.`;
+          return;
+        }
+
+        if (resp.error) {
+          console.error('Error generating image', resp.error);
+          error = resp.error;
+          return;
+        }
+
+        this.totalCalls++;
+        this.totalDuration += (+new Date() - start) / 1000;
+        
+        return resp.imageURLs[0]
+
+      })
+    );
+    jobs.set(jobId, { status: "completed", images, error });
+    return { ok: true };
+  };
+
   instanceUniqueRepresentation(pluginOptions: any) : string {
     return `${pluginOptions.pathColumnName}`;
   }
@@ -315,81 +401,34 @@ export default class UploadPlugin extends AdminForthPlugin {
 
     server.endpoint({
       method: 'POST',
-      path: `/plugin/${this.pluginInstanceId}/generate_images`,
+      path: `/plugin/${this.pluginInstanceId}/create-image-generation-job`,
       handler: async ({ body, adminUser, headers }) => {
         const { prompt, recordId } = body;
-        if (this.rateLimiter) {
-          // rate limit
-          // const { error } = RateLimiter.checkRateLimit(
-          //   this.pluginInstanceId, 
-          //   this.options.generation.rateLimit?.limit,
-          //   this.adminforth.auth.getClientIp(headers),
-          // );
-          if (!await this.rateLimiter.consume(`${this.pluginInstanceId}-${this.adminforth.auth.getClientIp(headers)}`)) {
-            return { error: this.options.generation.rateLimit.errorMessage };
-          }
-        }
-        let attachmentFiles = [];
-        if (this.options.generation.attachFiles) {
-          // TODO - does it require additional allowed action to check this record id has access to get the image?
-          // or should we mention in docs that user should do validation in method itself
-          const record = await this.adminforth.resource(this.resourceConfig.resourceId).get(
-            [Filters.EQ(this.resourceConfig.columns.find((column: any) => column.primaryKey)?.name, recordId)]
-          );
-
-          if (!record) {
-            return { error: `Record with id ${recordId} not found` };
-          }
-          
-          attachmentFiles = await this.options.generation.attachFiles({ record, adminUser });
-          // if files is not array, make it array
-          if (!Array.isArray(attachmentFiles)) {
-            attachmentFiles = [attachmentFiles];
-          }
-
-        }
-        
-        let error: string | undefined = undefined;
-
-        const STUB_MODE = false;
 
-        const images = await Promise.all(
-          (new Array(this.options.generation.countToGenerate)).fill(0).map(async () => {
-            if (STUB_MODE) {
-              await new Promise((resolve) => setTimeout(resolve, 2000));
-              return `https://picsum.photos/200/300?random=${Math.floor(Math.random() * 1000)}`;
-            }
-            const start = +new Date();
-            let resp;
-            try {
-              resp = await this.options.generation.adapter.generate(
-                {
-                  prompt,
-                  inputFiles: attachmentFiles,
-                  n: 1,
-                  size: this.options.generation.outputSize,
-                }
-              )
-            } catch (e: any) {
-              error = `No response from image generation provider: ${e.message}. Please check your prompt or try again later.`;
-              return;
-            }
-
-            if (resp.error) {
-              console.error('Error generating image', resp.error);
-              error = resp.error;
-              return;
-            }
+        const jobId = randomUUID();
+        jobs.set(jobId, { status: "in_progress" });
 
-            this.totalCalls++;
-            this.totalDuration += (+new Date() - start) / 1000;
-            
-            return resp.imageURLs[0]
+        this.generateImages(jobId, prompt, recordId, adminUser, headers);
+        setTimeout(() => jobs.delete(jobId), 1_800_000);
+        setTimeout(() => {jobs.set(jobId, { status: "timeout" });}, 300_000);
 
-          })
-        );
+        return { ok: true, jobId };
+      }
+    });
 
-        return { error, images };
+    server.endpoint({
+      method: 'POST',
+      path: `/plugin/${this.pluginInstanceId}/get-image-generation-job-status`,
+      handler: async ({ body, adminUser, headers }) => {
+        const jobId = body.jobId;
+        if (!jobId) {
+          return { error: "Can't find job id" };
+        }
+        const job = jobs.get(jobId);
+        if (!job) {
+          return { error: "Job not found" };
+        }
+        return { ok: true, job };
       }
     });
 
@@ -451,5 +490,6 @@ export default class UploadPlugin extends AdminForthPlugin {
     });
 
   }
+  
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/upload",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "Plugin for uploading files for adminforth",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",