Skip to content

🎥 Make videos programmatically with React

Remove legacy Studio discovery probe

Igor Samokhovets17f06f4e3e1b
diff --git a/packages/docs/docs/studio-protocol/install-in-studio.mdx b/packages/docs/docs/studio-protocol/install-in-studio.mdx
index 9e254f53af..07724879c3 100644
--- a/packages/docs/docs/studio-protocol/install-in-studio.mdx
+++ b/packages/docs/docs/studio-protocol/install-in-studio.mdx
@@ -90,8 +90,6 @@ A human-readable failure message. Use `code` for application logic.
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 bound to that Studio tab and contextual composition.
-Studios older than 4.0.502 are detected and return `studio-upgrade-required`. The Element is not sent through the legacy endpoint.
-
## Supported origins
The function supports any HTTPS website. HTTP is supported only on `localhost` and `127.0.0.1` for local development.
diff --git a/packages/studio-protocol/src/add-element-library-to-studio.ts b/packages/studio-protocol/src/add-element-library-to-studio.ts
index 7f8b3a4184..8c2718def8 100644
--- a/packages/studio-protocol/src/add-element-library-to-studio.ts
+++ b/packages/studio-protocol/src/add-element-library-to-studio.ts
@@ -6,7 +6,6 @@ import {
fetchWithTimeout,
focusedStudioMaxAge,
getAddElementLibraryCapability,
- hasLegacyStudio,
isAbortError,
studioProtocolProbePorts,
} from './studio-discovery';
@@ -154,13 +153,6 @@ export const addElementLibraryToStudioWithDependencies = async (
);
}
- if (await hasLegacyStudio(dependencies)) {
- return failure(
- 'studio-upgrade-required',
- 'This Remotion Studio cannot add an Element catalog through Studio Protocol. Upgrade Remotion to 4.0.518 or newer.',
- );
- }
-
if (discovery.foundInvalidResponse) {
return failure(
'invalid-response',
diff --git a/packages/studio-protocol/src/install-in-studio.ts b/packages/studio-protocol/src/install-in-studio.ts
index 0ff04f6ab0..1f0edb86ad 100644
--- a/packages/studio-protocol/src/install-in-studio.ts
+++ b/packages/studio-protocol/src/install-in-studio.ts
@@ -9,7 +9,6 @@ import {
fetchWithTimeout,
focusedStudioMaxAge,
getInstallCapability,
- hasLegacyStudio,
isAbortError,
studioProtocolProbePorts,
} from './studio-discovery';
@@ -178,13 +177,6 @@ export const installInStudioWithDependencies = async (
);
}
- if (await hasLegacyStudio(dependencies)) {
- return failure(
- 'studio-upgrade-required',
- 'This Remotion Studio does not support the Remotion Studio Protocol. Upgrade Remotion to 4.0.502 or newer.',
- );
- }
-
if (discovery.foundInvalidResponse) {
return failure(
'invalid-response',
diff --git a/packages/studio-protocol/src/set-license-key-in-studio.ts b/packages/studio-protocol/src/set-license-key-in-studio.ts
index 54afb06053..221430aef8 100644
--- a/packages/studio-protocol/src/set-license-key-in-studio.ts
+++ b/packages/studio-protocol/src/set-license-key-in-studio.ts
@@ -6,7 +6,6 @@ import {
fetchWithTimeout,
focusedStudioMaxAge,
getSetLicenseKeyCapability,
- hasLegacyStudio,
isAbortError,
studioProtocolProbePorts,
} from './studio-discovery';
@@ -96,15 +95,6 @@ export const setLicenseKeyInStudioWithDependencies = async (
};
}
- if (await hasLegacyStudio(dependencies)) {
- return {
- success: false,
- code: 'studio-upgrade-required',
- message:
- 'This Remotion Studio cannot set a license key through Studio Protocol. Upgrade Remotion to 4.0.504 or newer.',
- };
- }
-
if (discovery.foundInvalidResponse) {
return {
success: false,
diff --git a/packages/studio-protocol/src/studio-discovery.ts b/packages/studio-protocol/src/studio-discovery.ts
index a0f2cb372d..24fe631c3b 100644
--- a/packages/studio-protocol/src/studio-discovery.ts
+++ b/packages/studio-protocol/src/studio-discovery.ts
@@ -114,10 +114,6 @@ const protocolVersionEnvelopeSchema = z.looseObject({
protocol: z.literal('remotion-studio-protocol'),
protocolVersion: z.unknown(),
});
-const legacyStudioSchema = z.looseObject({
- type: z.literal('remotion-studio'),
-});
-
export const fetchWithTimeout = async ({
fetchFn,
options,
@@ -267,29 +263,5 @@ export const discoverStudios = async (
};
};
-export const hasLegacyStudio = async (
- dependencies: StudioProtocolDiscoveryDependencies,
-): Promise<boolean> => {
- const results = await Promise.all(
- dependencies.ports.map(async (port) => {
- try {
- const response = await fetchWithTimeout({
- fetchFn: dependencies.fetchFn,
- options: {cache: 'no-store'},
- url: `http://localhost:${port}/api/element-install-target`,
- });
- if (!response.ok) {
- return false;
- }
-
- return z.safeParse(legacyStudioSchema, await response.json()).success;
- } catch {
- return false;
- }
- }),
- );
- return results.some(Boolean);
-};
-
export const isAbortError = (error: unknown): boolean =>
error instanceof Error && error.name === 'AbortError';
diff --git a/packages/studio-protocol/src/test/add-element-library-to-studio.test.ts b/packages/studio-protocol/src/test/add-element-library-to-studio.test.ts
index 7eaad20e2c..849e0573d8 100644
--- a/packages/studio-protocol/src/test/add-element-library-to-studio.test.ts
+++ b/packages/studio-protocol/src/test/add-element-library-to-studio.test.ts
@@ -125,6 +125,30 @@ test('requests confirmation in the most recently focused compatible Studio', asy
});
});
+test('returns an actionable result when no Studio is running', async () => {
+ const requests: string[] = [];
+ const result = await addElementLibraryToStudioWithDependencies(
+ {url: 'https://catalog.example.com', displayName: null},
+ {
+ ...dependencies,
+ fetchFn: (input) => {
+ requests.push(String(input));
+ return Promise.resolve(new Response(null, {status: 404}));
+ },
+ },
+ );
+
+ expect(result).toEqual({
+ success: false,
+ code: 'no-compatible-studio',
+ message: 'Start Remotion Studio, focus it, and try again.',
+ });
+ expect(requests).toEqual([
+ 'http://localhost:3000/api/studio-protocol',
+ 'http://localhost:3001/api/studio-protocol',
+ ]);
+});
+
test('validates the request before probing localhost', async () => {
for (const request of [
{url: '/relative', displayName: null},
diff --git a/packages/studio-protocol/src/test/install-in-studio.test.ts b/packages/studio-protocol/src/test/install-in-studio.test.ts
index c8b53a5902..5642c77bdf 100644
--- a/packages/studio-protocol/src/test/install-in-studio.test.ts
+++ b/packages/studio-protocol/src/test/install-in-studio.test.ts
@@ -174,9 +174,13 @@ test('distinguishes a compatible Studio without an installable target', async ()
});
test('returns an actionable result when no Studio is running', async () => {
+ const requests: string[] = [];
const result = await installInStudioWithDependencies(elementPayload, {
...dependencies,
- fetchFn: () => Promise.resolve(new Response(null, {status: 404})),
+ fetchFn: (input) => {
+ requests.push(String(input));
+ return Promise.resolve(new Response(null, {status: 404}));
+ },
});
expect(result).toEqual({
@@ -184,6 +188,10 @@ test('returns an actionable result when no Studio is running', async () => {
code: 'no-compatible-studio',
message: 'Start Remotion Studio and open a composition, then try again.',
});
+ expect(requests).toEqual([
+ 'http://localhost:3000/api/studio-protocol',
+ 'http://localhost:3001/api/studio-protocol',
+ ]);
});
test('reports malformed discovery JSON as an invalid response', async () => {
@@ -212,36 +220,6 @@ test('reports malformed discovery JSON as an invalid response', async () => {
});
});
-test('reports a legacy Studio as requiring an upgrade without sending a payload', async () => {
- const requests: string[] = [];
- const fetchFn = (input: string | URL | Request) => {
- const url = String(input);
- requests.push(url);
- if (url === 'http://localhost:3000/api/element-install-target') {
- return Promise.resolve(
- jsonResponse({type: 'remotion-studio', canInstall: true}),
- );
- }
-
- return Promise.resolve(new Response(null, {status: 404}));
- };
-
- expect(
- await installInStudioWithDependencies(elementPayload, {
- ...dependencies,
- fetchFn,
- }),
- ).toEqual({
- success: false,
- code: 'studio-upgrade-required',
- message:
- 'This Remotion Studio does not support the Remotion Studio Protocol. Upgrade Remotion to 4.0.502 or newer.',
- });
- expect(
- requests.some((url) => url.endsWith('/api/request-element-install')),
- ).toBe(false);
-});
-
test('returns a structured error when the selected target expired', async () => {
const fetchFn = (input: string | URL | Request) => {
const url = String(input);
diff --git a/packages/studio-protocol/src/test/set-license-key-in-studio.test.ts b/packages/studio-protocol/src/test/set-license-key-in-studio.test.ts
index 075b502688..8c2e926bc1 100644
--- a/packages/studio-protocol/src/test/set-license-key-in-studio.test.ts
+++ b/packages/studio-protocol/src/test/set-license-key-in-studio.test.ts
@@ -121,6 +121,27 @@ test('requests confirmation in the most recently focused Studio project', async
});
});
+test('returns an actionable result when no Studio is running', async () => {
+ const requests: string[] = [];
+ const result = await setLicenseKeyInStudioWithDependencies(licenseKey, {
+ ...dependencies,
+ fetchFn: (input) => {
+ requests.push(String(input));
+ return Promise.resolve(new Response(null, {status: 404}));
+ },
+ });
+
+ expect(result).toEqual({
+ success: false,
+ code: 'no-compatible-studio',
+ message: 'Start Remotion Studio, focus it, and try again.',
+ });
+ expect(requests).toEqual([
+ 'http://localhost:3000/api/studio-protocol',
+ 'http://localhost:3001/api/studio-protocol',
+ ]);
+});
+
test('rejects malformed keys before discovery', async () => {
let requests = 0;
const fetchFn = () => {