Skip to content

Commit

Permalink
feat(client): app id with path + realtime url (#51)
Browse files Browse the repository at this point in the history
* feat: app id + path format support

* chore: bump client to 0.8.4
  • Loading branch information
drochetti authored Feb 21, 2024
1 parent 66d817b commit e0b7627
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 28 deletions.
2 changes: 1 addition & 1 deletion apps/demo-nextjs-app-router/app/camera-turbo/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ export default function WebcamPage() {
const previewRef = useRef<HTMLCanvasElement | null>(null);

const { send } = fal.realtime.connect<LCMInput, LCMOutput>(
'fal-ai/sd-turbo-real-time-high-fps-msgpack',
'fal-ai/sd-turbo-real-time-high-fps-msgpack-a10g',
{
connectionKey: 'camera-turbo-demo',
// not throttling the client, handling throttling of the camera itself
Expand Down
39 changes: 18 additions & 21 deletions apps/demo-nextjs-app-router/app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -79,27 +79,24 @@ export default function Home() {
setLoading(true);
const start = Date.now();
try {
const result: Result = await fal.subscribe(
'54285744/illusion-diffusion',
{
input: {
prompt,
image_url: imageFile,
image_size: 'square_hd',
},
pollInterval: 5000, // Default is 1000 (every 1s)
logs: true,
onQueueUpdate(update) {
setElapsedTime(Date.now() - start);
if (
update.status === 'IN_PROGRESS' ||
update.status === 'COMPLETED'
) {
setLogs((update.logs || []).map((log) => log.message));
}
},
}
);
const result: Result = await fal.subscribe('fal-ai/illusion-diffusion', {
input: {
prompt,
image_url: imageFile,
image_size: 'square_hd',
},
pollInterval: 3000, // Default is 1000 (every 1s)
logs: true,
onQueueUpdate(update) {
setElapsedTime(Date.now() - start);
if (
update.status === 'IN_PROGRESS' ||
update.status === 'COMPLETED'
) {
setLogs((update.logs || []).map((log) => log.message));
}
},
});
setResult(result);
} catch (error: any) {
setError(error);
Expand Down
2 changes: 1 addition & 1 deletion libs/client/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@fal-ai/serverless-client",
"description": "The fal serverless JS/TS client",
"version": "0.8.3",
"version": "0.8.4",
"license": "MIT",
"repository": {
"type": "git",
Expand Down
10 changes: 7 additions & 3 deletions libs/client/src/function.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { ensureAppIdFormat, isUUIDv4, isValidUrl } from './utils';
type RunOptions<Input> = {
/**
* The path to the function, if any. Defaults to ``.
* @deprecated Pass the path as part of the app id itself, e.g. `fal-ai/sdxl/image-to-image`
*/
readonly path?: string;

Expand Down Expand Up @@ -268,11 +269,12 @@ export const queue: Queue = {
id: string,
options: SubmitOptions<Input>
): Promise<EnqueueResult> {
const [appOwner, appAlias] = ensureAppIdFormat(id).split('/');
const { webhookUrl, path = '', ...runOptions } = options;
const query = webhookUrl
? '?' + new URLSearchParams({ fal_webhook: webhookUrl }).toString()
: '';
return send(id, {
return send(`${appOwner}/${appAlias}`, {
...runOptions,
subdomain: 'queue',
method: 'post',
Expand All @@ -283,7 +285,8 @@ export const queue: Queue = {
id: string,
{ requestId, logs = false }: QueueStatusOptions
): Promise<QueueStatus> {
return send(id, {
const [appOwner, appAlias] = ensureAppIdFormat(id).split('/');
return send(`${appOwner}/${appAlias}`, {
subdomain: 'queue',
method: 'get',
path: `/requests/${requestId}/status`,
Expand All @@ -296,7 +299,8 @@ export const queue: Queue = {
id: string,
{ requestId }: BaseQueueOptions
): Promise<Output> {
return send(id, {
const [appOwner, appAlias] = ensureAppIdFormat(id).split('/');
return send(`${appOwner}/${appAlias}`, {
subdomain: 'queue',
method: 'get',
path: `/requests/${requestId}`,
Expand Down
16 changes: 15 additions & 1 deletion libs/client/src/realtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,17 @@ type RealtimeUrlParams = {
maxBuffering?: number;
};

// This is a list of apps deployed before formal realtime support. Their URLs follow
// a different pattern and will be kept here until we fully sunset them.
const LEGACY_APPS = [
'lcm-sd15-i2i',
'lcm',
'sdxl-turbo-realtime',
'sd-turbo-real-time-high-fps-msgpack-a10g',
'lcm-plexed-sd15-i2i',
'sd-turbo-real-time-high-fps-msgpack',
];

function buildRealtimeUrl(
app: string,
{ token, maxBuffering }: RealtimeUrlParams
Expand All @@ -263,7 +274,10 @@ function buildRealtimeUrl(
queryParams.set('max_buffering', maxBuffering.toFixed(0));
}
const appId = ensureAppIdFormat(app);
return `wss://fal.run/${appId}/ws?${queryParams.toString()}`;
const [, appAlias] = ensureAppIdFormat(app).split('/');
const suffix =
LEGACY_APPS.includes(appAlias) || !app.includes('/') ? 'ws' : 'realtime';
return `wss://fal.run/${appId}/${suffix}?${queryParams.toString()}`;
}

const TOKEN_EXPIRATION_SECONDS = 120;
Expand Down
5 changes: 5 additions & 0 deletions libs/client/src/utils.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ describe('The utils test suite', () => {
expect(ensureAppIdFormat(id)).toBe(id);
});

it('shoud match a current appOwner/appId/path format', () => {
const id = 'fal-ai/fast-sdxl/image-to-image';
expect(ensureAppIdFormat(id)).toBe(id);
});

it('should throw on an invalid app id format', () => {
const id = 'just-an-id';
expect(() => ensureAppIdFormat(id)).toThrowError();
Expand Down
2 changes: 1 addition & 1 deletion libs/client/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export function isUUIDv4(id: string): boolean {

export function ensureAppIdFormat(id: string): string {
const parts = id.split('/');
if (parts.length === 2) {
if (parts.length > 1) {
return id;
}
const [, appOwner, appId] = /^([0-9]+)-([a-zA-Z0-9-]+)$/.exec(id) || [];
Expand Down

0 comments on commit e0b7627

Please sign in to comment.