jerry.tian/fal-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #19 from fal-ai/matteo/logs-query-param-status

Browse Source 
chore: send logs query param to status request as true by default
This commit is contained in:
Matteo Ferrando 2023-10-26 13:58:15 -04:00 committed by GitHub
commit 897fb49914
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
apps/demo-nextjs-app/pages/index.tsx
View File

@ -71,13 +71,14 @@ export function Index() {
setLoading(true); setLoading(true);
const start = Date.now(); const start = Date.now();
try { try {
const result: Result = await fal.queue.subscribe('110602490-lora', { const result: Result = await fal.subscribe('110602490-lora', {
input: { input: {
prompt, prompt,
model_name: 'stabilityai/stable-diffusion-xl-base-1.0', model_name: 'stabilityai/stable-diffusion-xl-base-1.0',
image_size: 'square_hd', image_size: 'square_hd',
}, },
pollInterval: 5000, // Default is 1000 (every 1s) pollInterval: 5000, // Default is 1000 (every 1s)
logs: true,
onQueueUpdate(update) { onQueueUpdate(update) {
setElapsedTime(Date.now() - start); setElapsedTime(Date.now() - start);
if ( if (

15
libs/client/src/function.ts
View File

@ -131,7 +131,7 @@ export async function subscribe<Input, Output>(
const pollInterval = options.pollInterval ?? 1000; const pollInterval = options.pollInterval ?? 1000;
const poll = async () => { const poll = async () => {
try { try {
const requestStatus = await queue.status(id, requestId); const requestStatus = await queue.status(id, requestId, options.logs ?? false);
if (options.onQueueUpdate) { if (options.onQueueUpdate) {
options.onQueueUpdate(requestStatus); options.onQueueUpdate(requestStatus);
} }
@ -176,6 +176,11 @@ type QueueSubscribeOptions = {
* @param status - The current status of the queue. * @param status - The current status of the queue.
*/ */
onQueueUpdate?: (status: QueueStatus) => void; onQueueUpdate?: (status: QueueStatus) => void;
/**
* If `true`, the response will include the logs for the request.
*/
logs?: boolean;
}; };
/** /**
@ -197,9 +202,10 @@ interface Queue {
* *
* @param id - The ID or URL of the function web endpoint. * @param id - The ID or URL of the function web endpoint.
* @param requestId - The unique identifier for the enqueued request. * @param requestId - The unique identifier for the enqueued request.
* @param logs - If `true`, the response will include the logs for the request.
* @returns A promise that resolves to the status of the request. * @returns A promise that resolves to the status of the request.
*/ */
status(id: string, requestId: string): Promise<QueueStatus>; status(id: string, requestId: string, logs: boolean): Promise<QueueStatus>;
/** /**
* Retrieves the result of a specific request from the queue. * Retrieves the result of a specific request from the queue.
@ -231,10 +237,13 @@ export const queue: Queue = {
): Promise<EnqueueResult> { ): Promise<EnqueueResult> {
return run(id, { ...options, method: 'post', path: '/fal/queue/submit/' }); return run(id, { ...options, method: 'post', path: '/fal/queue/submit/' });
}, },
async status(id: string, requestId: string): Promise<QueueStatus> { async status(id: string, requestId: string, logs = false): Promise<QueueStatus> {
return run(id, { return run(id, {
method: 'get', method: 'get',
path: `/fal/queue/requests/${requestId}/status`, path: `/fal/queue/requests/${requestId}/status`,
input: {
logs: logs ? '1' : '0',
},
}); });
}, },
async result<Output>(id: string, requestId: string): Promise<Output> { async result<Output>(id: string, requestId: string): Promise<Output> {

7
libs/client/src/types.ts
View File

@ -6,11 +6,6 @@ export type EnqueueResult = {
request_id: string; request_id: string;
}; };
// export type QueueStatus = {
// status: "IN_PROGRESS" | "COMPLETED";
// queue: number;
// };
export type RequestLog = { export type RequestLog = {
message: string; message: string;
level: 'STDERR' | 'STDOUT' | 'ERROR' | 'INFO' | 'WARN' | 'DEBUG'; level: 'STDERR' | 'STDOUT' | 'ERROR' | 'INFO' | 'WARN' | 'DEBUG';
@ -22,7 +17,7 @@ export type QueueStatus =
| { | {
status: 'IN_PROGRESS' | 'COMPLETED'; status: 'IN_PROGRESS' | 'COMPLETED';
response_url: string; response_url: string;
logs: RequestLog[]; logs: null | RequestLog[];
} }
| { | {
status: 'IN_QUEUE'; status: 'IN_QUEUE';