🎥 Make videos programmatically with React
Elements: Install into the sole unfocused Studio tab
Igor Samokhovetsedca03a43eee
diff --git a/packages/docs/docs/studio-protocol/index.mdx b/packages/docs/docs/studio-protocol/index.mdxindex 39575b0adb..94fa9f5505 100644--- a/packages/docs/docs/studio-protocol/index.mdx+++ b/packages/docs/docs/studio-protocol/index.mdx@@ -22,7 +22,7 @@ Websites can provide [Elements](/elements) to a Studio either using drag-and-dro| Method | Benefits | Tradeoffs || -------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- || [Drag-and-drop](/docs/studio-protocol/set-studio-drag-data) | The user chooses the exact Studio tab, timeline position, and canvas position. | Studio labels the source as [unverified](/docs/studio-protocol/security#confirmation-boundary). |-| [Installation dialog](/docs/studio-protocol/install-in-studio) | The requesting website is shown. Remotion attempts to bring the Studio to the foreground. | Always the most recently focused Studio is taken. |+| [Installation dialog](/docs/studio-protocol/install-in-studio) | The requesting website is shown. Remotion attempts to bring the Studio to the foreground. | The most recently focused tab is selected, or the sole writable tab if none has been focused. |### Adding an Element Librarydiff --git a/packages/docs/docs/studio-protocol/install-in-studio.mdx b/packages/docs/docs/studio-protocol/install-in-studio.mdxindex 8ccf76b131..66dea378dd 100644--- a/packages/docs/docs/studio-protocol/install-in-studio.mdx+++ b/packages/docs/docs/studio-protocol/install-in-studio.mdx@@ -6,7 +6,7 @@ crumb: '@remotion/studio-protocol'# installInStudio()<AvailableFrom v="4.0.502" />-Sends an Element payload to the containing Remotion Studio, or discovers a recently focused Studio when called outside one.+Sends an Element payload to the containing Remotion Studio, or discovers a writable Studio when called outside one.## Example@@ -40,7 +40,7 @@ if (!result.success) {An installation request provides a one-click flow and shows the requesting website in Studio. On macOS, Studio attempts to bring the selected Studio tab to the foreground after delivering the request.-When [the library](/docs/studio-protocol/component-library-integration) is embedded in Studio, the containing Studio is selected. Otherwise, local Studio ports are probed and the most recently focused compatible Studio is used. Also offer drag-and-drop with [`setStudioDragData()`](/docs/studio-protocol/set-studio-drag-data) when possible so the user can choose a specific Studio tab, timeline position, and canvas position.+When [the library](/docs/studio-protocol/component-library-integration) is embedded in Studio, the containing Studio is selected. Otherwise, local Studio ports are probed and the most recently focused compatible Studio tab is used. If only one writable tab is available, it can receive the request without having been focused <AvailableFrom v="4.0.530" inline />. Also offer drag-and-drop with [`setStudioDragData()`](/docs/studio-protocol/set-studio-drag-data) when possible so the user can choose a specific Studio tab, timeline position, and canvas position.### Installing without a selected composition<AvailableFrom v="4.0.530" />@@ -110,7 +110,7 @@ A human-readable failure message. Use `code` for application logic.## Discovery-When called outside Studio, ports 3000 through 3009 are probed in parallel. The most recently focused compatible target is selected. Discovery returns a short-lived, single-use token for that Studio tab.+When called outside Studio, ports 3000 through 3009 are probed in parallel. The most recently focused compatible tab is selected, or the only available writable tab if none has focus history <AvailableFrom v="4.0.530" inline />. If multiple tabs are available and none has focus history, no tab is selected. A running Studio server without a connected, writable tab cannot receive a request. Discovery returns a short-lived, single-use token for the selected tab.## Supported originsdiff --git a/packages/studio-protocol/src/install-in-studio.ts b/packages/studio-protocol/src/install-in-studio.tsindex 5e42f5f48a..739b03b3dc 100644--- a/packages/studio-protocol/src/install-in-studio.ts+++ b/packages/studio-protocol/src/install-in-studio.ts@@ -249,14 +249,20 @@ export const installInStudioWithDependencies = async (}).sort((a, b) => {const focusDifference =- b.capability.target!.lastFocusedAt - a.capability.target!.lastFocusedAt;+ (b.capability.target!.lastFocusedAt ?? 0) -+ (a.capability.target!.lastFocusedAt ?? 0);return focusDifference === 0? b.discoveredAt - a.discoveredAt: focusDifference;});const selected = installable[0];const selectedTarget = selected?.capability.target;- if (!selected || selectedTarget === null || selectedTarget === undefined) {+ if (+ !selected ||+ selectedTarget === null ||+ selectedTarget === undefined ||+ (selectedTarget.lastFocusedAt === null && installable.length > 1)+ ) {return failure('no-installable-target','Focus a Remotion Studio that is not read-only, then try again.',diff --git a/packages/studio-protocol/src/studio-discovery.ts b/packages/studio-protocol/src/studio-discovery.tsindex 044d4a8479..9605c2106f 100644--- a/packages/studio-protocol/src/studio-discovery.ts+++ b/packages/studio-protocol/src/studio-discovery.ts@@ -6,7 +6,11 @@ export type StudioProtocolTarget = {readonly lastFocusedAt: number;};-export type StudioProtocolInstallTarget = StudioProtocolTarget & {+export type StudioProtocolInstallTarget = Omit<+ StudioProtocolTarget,+ 'lastFocusedAt'+> & {+ readonly lastFocusedAt: number | null;/*** @deprecated The installation destination is chosen in Studio. Use the opaque target id to request installation instead.*/@@ -67,7 +71,7 @@ const targetSchema = z.looseObject({const installTargetSchema = z.looseObject({id: z.string().check(z.minLength(1)),expiresAt: z.number(),- lastFocusedAt: z.number(),+ lastFocusedAt: z.nullable(z.number()),compositionId: z.nullable(z.string().check(z.minLength(1))),});const installCapabilitySchema = z.looseObject({diff --git a/packages/studio-protocol/src/test/install-in-studio.test.ts b/packages/studio-protocol/src/test/install-in-studio.test.tsindex d786e634ce..c6a7ce275b 100644--- a/packages/studio-protocol/src/test/install-in-studio.test.ts+++ b/packages/studio-protocol/src/test/install-in-studio.test.ts@@ -18,7 +18,7 @@ const descriptor = ({targetId,}: {readonly compositionId: string | null;- readonly lastFocusedAt: number;+ readonly lastFocusedAt: number | null;readonly projectName: string;readonly targetId: string;}) => ({@@ -70,7 +70,7 @@ test('delivers the payload when a newer Studio advertises an unknown capability'jsonResponse(descriptor({compositionId: 'Older',- lastFocusedAt: 300_000,+ lastFocusedAt: null,projectName: 'Older project',targetId: 'older-target',}),@@ -496,7 +496,7 @@ test('returns a structured error when the selected target expired', async () =>jsonResponse(descriptor({compositionId: 'Main',- lastFocusedAt: 950_000,+ lastFocusedAt: null,projectName: 'Project',targetId: 'expired-target',}),diff --git a/packages/studio-server/src/preview-server/element-install-state.ts b/packages/studio-server/src/preview-server/element-install-state.tsindex da7723db05..ab0cf94d36 100644--- a/packages/studio-server/src/preview-server/element-install-state.ts+++ b/packages/studio-server/src/preview-server/element-install-state.ts@@ -58,6 +58,8 @@ export const getElementInstallTargetByClientId = (clientId: string) => {export const getElementInstallTarget = (requestId: string | null) => {const now = Date.now();let bestTarget: ElementInstallTarget | null = null;+ let unfocusedTarget: ElementInstallTarget | null = null;+ let multipleUnfocusedTargets = false;for (const [clientId, currentTarget] of targetsByClientId) {if (now - currentTarget.updatedAt >= ELEMENT_INSTALL_TARGET_MAX_AGE) {@@ -67,18 +69,23 @@ export const getElementInstallTarget = (requestId: string | null) => {if ((requestId !== null && currentTarget.requestId !== requestId) ||- currentTarget.lastFocusedAt === null ||currentTarget.readOnly) {continue;}+ if (currentTarget.lastFocusedAt === null) {+ multipleUnfocusedTargets ||= unfocusedTarget !== null;+ unfocusedTarget = currentTarget;+ continue;+ }+if (bestTarget === null || compareTargets(currentTarget, bestTarget) > 0) {bestTarget = currentTarget;}}- return bestTarget;+ return bestTarget ?? (multipleUnfocusedTargets ? null : unfocusedTarget);};export const issueStudioProtocolTarget = ({diff --git a/packages/studio-server/src/preview-server/studio-protocol/handle-discovery.ts b/packages/studio-server/src/preview-server/studio-protocol/handle-discovery.tsindex 6963ebdbc0..0e59cd8f42 100644--- a/packages/studio-server/src/preview-server/studio-protocol/handle-discovery.ts+++ b/packages/studio-server/src/preview-server/studio-protocol/handle-discovery.ts@@ -36,7 +36,6 @@ const getLiveStudioTarget = (requestId: string) => {if (target === null ||now - target.updatedAt >= ELEMENT_INSTALL_TARGET_MAX_AGE ||- target.lastFocusedAt === null ||target.readOnly) {return null;@@ -109,7 +108,7 @@ export const handleStudioProtocolDiscovery = ({target: installTarget,});const issuedLicenseKeyTarget =- target === null+ target === null || target.lastFocusedAt === null? null: issueStudioProtocolTarget({now,@@ -118,7 +117,7 @@ export const handleStudioProtocolDiscovery = ({target,});const issuedElementLibraryTarget =- target === null+ target === null || target.lastFocusedAt === null? null: issueStudioProtocolTarget({now,diff --git a/packages/studio-server/src/test/studio-protocol-routes.test.ts b/packages/studio-server/src/test/studio-protocol-routes.test.tsindex 0fffb638a0..297fe56129 100644--- a/packages/studio-server/src/test/studio-protocol-routes.test.ts+++ b/packages/studio-server/src/test/studio-protocol-routes.test.ts@@ -103,7 +103,7 @@ const sendUnfinishedOversizedInstallRequest = (});};-test('discovers a focused Studio without a composition and delivers one install request over HTTP', async () => {+test('discovers a sole unfocused Studio without a composition and delivers one install request over HTTP', async () => {clearElementInstallStateForTests();const deliveredEvents: EventSourceEvent[] = [];const liveEventsServer: LiveEventsServer = {@@ -120,7 +120,7 @@ test('discovers a focused Studio without a composition and delivers one installclientId: 'focused-studio-tab',compositionFile: null,compositionId: null,- lastFocusedAt: Date.now() - 10 * 60 * 1000,+ lastFocusedAt: null,readOnly: false,studioUrl: 'http://localhost:3000',});@@ -204,12 +204,18 @@ test('discovers a focused Studio without a composition and delivers one installtarget: {id: string;compositionId: string | null;+ lastFocusedAt: number | null;};},];};const installTarget = descriptor.capabilities[0].target;expect(installTarget.compositionId).toBe(null);+ expect(installTarget.lastFocusedAt).toBe(null);+ expect(descriptor.capabilities.slice(1)).toMatchObject([+ {target: null},+ {target: null},+ ]);const installBody = {operation: 'install-element',