Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Separate skill detection from updates

Jonny Burgerfa458610649c
diff --git a/packages/studio-server/src/detect-outdated-remotion-skills.ts b/packages/studio-server/src/detect-outdated-remotion-skills.ts
index 94ba330ed7..d4fdb05f4b 100644
--- a/packages/studio-server/src/detect-outdated-remotion-skills.ts
+++ b/packages/studio-server/src/detect-outdated-remotion-skills.ts
@@ -99,6 +99,19 @@ const getStatusForSkillsDirectory = ({
return {type: 'up-to-date', scope, skillsDirectory};
};
+export const getRemotionSkillsDirectories = ({
+ cwd,
+ homeDirectory,
+}: {
+ cwd: string;
+ homeDirectory: string;
+}) => {
+ return {
+ project: path.join(cwd, '.agents', 'skills'),
+ global: path.join(homeDirectory, '.agents', 'skills'),
+ };
+};
+
export const detectOutdatedRemotionSkills = ({
currentVersion = VERSION,
cwd = process.cwd(),
@@ -111,19 +124,18 @@ export const detectOutdatedRemotionSkills = ({
project: RemotionSkillsStatus;
global: RemotionSkillsStatus;
} => {
- const projectSkillsDirectory = path.join(cwd, '.agents', 'skills');
- const globalSkillsDirectory = path.join(homeDirectory, '.agents', 'skills');
+ const skillsDirectories = getRemotionSkillsDirectories({cwd, homeDirectory});
return {
project: getStatusForSkillsDirectory({
currentVersion,
scope: 'project',
- skillsDirectory: projectSkillsDirectory,
+ skillsDirectory: skillsDirectories.project,
}),
global: getStatusForSkillsDirectory({
currentVersion,
scope: 'global',
- skillsDirectory: globalSkillsDirectory,
+ skillsDirectory: skillsDirectories.global,
}),
};
};
diff --git a/packages/studio-server/src/preview-server/api-routes.ts b/packages/studio-server/src/preview-server/api-routes.ts
index 33fbc280fc..baf4a4f7ab 100644
--- a/packages/studio-server/src/preview-server/api-routes.ts
+++ b/packages/studio-server/src/preview-server/api-routes.ts
@@ -39,6 +39,7 @@ import {prepareElementInstallHandler} from './routes/prepare-element-install';
import {projectInfoHandler} from './routes/project-info';
import {redoHandler} from './routes/redo';
import {registerClientRenderHandler} from './routes/register-client-render';
+import {remotionSkillsInfoHandler} from './routes/remotion-skills-info';
import {handleRemoveRender} from './routes/remove-render';
import {renameStaticFileHandler} from './routes/rename-static-file';
import {reorderEffectHandler} from './routes/reorder-effect';
@@ -114,6 +115,7 @@ export const allApiRoutes: {
'/api/duplicate-jsx-node': duplicateJsxNodeHandler,
'/api/split-jsx-sequence': splitJsxSequenceHandler,
'/api/update-available': handleUpdate,
+ '/api/remotion-skills-info': remotionSkillsInfoHandler,
'/api/project-info': projectInfoHandler,
'/api/delete-static-file': deleteStaticFileHandler,
'/api/rename-static-file': renameStaticFileHandler,
diff --git a/packages/studio-server/src/preview-server/routes/remotion-skills-info.ts b/packages/studio-server/src/preview-server/routes/remotion-skills-info.ts
new file mode 100644
index 0000000000..6acc7be658
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/remotion-skills-info.ts
@@ -0,0 +1,39 @@
+import {existsSync} from 'node:fs';
+import {homedir} from 'node:os';
+import path from 'node:path';
+import type {
+ GetRemotionSkillsInfoRequest,
+ GetRemotionSkillsInfoResponse,
+} from '@remotion/studio-shared';
+import {getRemotionSkillsDirectories} from '../../detect-outdated-remotion-skills';
+import type {RemotionSkillName} from '../../remotion-skill-names';
+import type {ApiHandler} from '../api-types';
+
+export const getRemotionSkillsInfo = ({
+ remotionRoot,
+ homeDirectory = homedir(),
+}: {
+ remotionRoot: string;
+ homeDirectory?: string;
+}): GetRemotionSkillsInfoResponse => {
+ const skillsDirectories = getRemotionSkillsDirectories({
+ cwd: remotionRoot,
+ homeDirectory,
+ });
+ const isSkillAvailable = (skillName: RemotionSkillName) =>
+ Object.values(skillsDirectories).some((skillsDirectory) =>
+ existsSync(path.join(skillsDirectory, skillName, 'SKILL.md')),
+ );
+
+ return {
+ remotionUpgradeSkillAvailable: isSkillAvailable('remotion-upgrade'),
+ remotionInteractivitySkillAvailable: isSkillAvailable(
+ 'remotion-interactivity',
+ ),
+ };
+};
+
+export const remotionSkillsInfoHandler: ApiHandler<
+ GetRemotionSkillsInfoRequest,
+ GetRemotionSkillsInfoResponse
+> = ({remotionRoot}) => Promise.resolve(getRemotionSkillsInfo({remotionRoot}));
diff --git a/packages/studio-server/src/preview-server/update-available.ts b/packages/studio-server/src/preview-server/update-available.ts
index 7afbb010c2..2def8c5a7d 100644
--- a/packages/studio-server/src/preview-server/update-available.ts
+++ b/packages/studio-server/src/preview-server/update-available.ts
@@ -1,43 +1,24 @@
-import {existsSync} from 'node:fs';
-import {homedir} from 'node:os';
-import path from 'node:path';
import type {LogLevel} from '@remotion/renderer';
import type {UpdateAvailableResponse} from '@remotion/studio-shared';
import semver from 'semver';
import {detectOutdatedRemotionSkills} from '../detect-outdated-remotion-skills';
import {getLatestRemotionVersion} from '../get-latest-remotion-version';
-import type {RemotionSkillName} from '../remotion-skill-names';
import {getPackageManager} from './get-package-manager';
const getSkillsUpdateInfo = ({
remotionRoot,
currentVersion,
- homeDirectory = homedir(),
}: {
remotionRoot: string;
currentVersion: string;
- homeDirectory?: string;
}) => {
- const skills = detectOutdatedRemotionSkills({
+ const projectSkills = detectOutdatedRemotionSkills({
cwd: remotionRoot,
currentVersion,
- homeDirectory,
- });
- const skillsDirectories = [
- skills.project.skillsDirectory,
- skills.global.skillsDirectory,
- ];
- const isSkillAvailable = (skillName: RemotionSkillName) =>
- skillsDirectories.some((skillsDirectory) =>
- existsSync(path.join(skillsDirectory, skillName, 'SKILL.md')),
- );
+ }).project;
return {
- skillsUpdateAvailable: skills.project.type === 'outdated',
- remotionUpgradeSkillAvailable: isSkillAvailable('remotion-upgrade'),
- remotionInteractivitySkillAvailable: isSkillAvailable(
- 'remotion-interactivity',
- ),
+ skillsUpdateAvailable: projectSkills.type === 'outdated',
};
};
@@ -46,19 +27,16 @@ export const isUpdateAvailable = async ({
currentVersion,
logLevel,
getLatestVersion,
- homeDirectory = homedir(),
}: {
remotionRoot: string;
currentVersion: string;
logLevel: LogLevel;
getLatestVersion: (() => Promise<string>) | null;
- homeDirectory?: string;
}): Promise<UpdateAvailableResponse> => {
const latest = await (getLatestVersion ?? getLatestRemotionVersion)();
const skillsUpdateInfo = getSkillsUpdateInfo({
remotionRoot,
currentVersion,
- homeDirectory,
});
const pkgManager = getPackageManager({
diff --git a/packages/studio-server/src/test/remotion-skills-info.test.ts b/packages/studio-server/src/test/remotion-skills-info.test.ts
new file mode 100644
index 0000000000..a5510d73c2
--- /dev/null
+++ b/packages/studio-server/src/test/remotion-skills-info.test.ts
@@ -0,0 +1,78 @@
+import {expect, test} from 'bun:test';
+import {mkdirSync, mkdtempSync, rmSync, writeFileSync} from 'node:fs';
+import {tmpdir} from 'node:os';
+import path from 'node:path';
+import {
+ getRemotionSkillsInfo,
+ remotionSkillsInfoHandler,
+} from '../preview-server/routes/remotion-skills-info';
+
+const writeSkill = (skillsDirectory: string, skillName: string) => {
+ const skillDirectory = path.join(skillsDirectory, skillName);
+ mkdirSync(skillDirectory, {recursive: true});
+ writeFileSync(path.join(skillDirectory, 'SKILL.md'), '---\n---\n');
+};
+
+test('the skills info endpoint reports project skills', async () => {
+ const remotionRoot = mkdtempSync(
+ path.join(tmpdir(), 'remotion-skills-info-route-'),
+ );
+
+ try {
+ writeSkill(
+ path.join(remotionRoot, '.agents', 'skills'),
+ 'remotion-interactivity',
+ );
+ const response = await remotionSkillsInfoHandler({
+ binariesDirectory: null,
+ configFile: null,
+ entryPoint: '',
+ getDefaultCodingAgent: () => null,
+ getDefaultEditor: () => null,
+ input: {},
+ logLevel: 'error',
+ methods: {
+ addJob: () => undefined,
+ cancelJob: () => undefined,
+ removeJob: () => undefined,
+ },
+ publicDir: '',
+ remotionRoot,
+ request: {} as never,
+ response: {} as never,
+ });
+
+ expect(response).toEqual({
+ remotionUpgradeSkillAvailable: false,
+ remotionInteractivitySkillAvailable: true,
+ });
+ } finally {
+ rmSync(remotionRoot, {recursive: true, force: true});
+ }
+});
+
+test('global skills are also available to the endpoint response', () => {
+ const temporaryDirectory = mkdtempSync(
+ path.join(tmpdir(), 'remotion-global-skills-info-'),
+ );
+ const remotionRoot = path.join(temporaryDirectory, 'project');
+ const homeDirectory = path.join(temporaryDirectory, 'home');
+
+ try {
+ writeSkill(
+ path.join(homeDirectory, '.agents', 'skills'),
+ 'remotion-upgrade',
+ );
+ writeSkill(
+ path.join(homeDirectory, '.agents', 'skills'),
+ 'remotion-interactivity',
+ );
+
+ expect(getRemotionSkillsInfo({remotionRoot, homeDirectory})).toEqual({
+ remotionUpgradeSkillAvailable: true,
+ remotionInteractivitySkillAvailable: true,
+ });
+ } finally {
+ rmSync(temporaryDirectory, {recursive: true, force: true});
+ }
+});
diff --git a/packages/studio-server/src/test/update-available.test.ts b/packages/studio-server/src/test/update-available.test.ts
index 6202900709..f06a0786da 100644
--- a/packages/studio-server/src/test/update-available.test.ts
+++ b/packages/studio-server/src/test/update-available.test.ts
@@ -34,85 +34,9 @@ test('reports outdated project skills when Remotion itself is up to date', async
latestVersion: '4.0.502',
updateAvailable: false,
skillsUpdateAvailable: true,
- remotionUpgradeSkillAvailable: false,
- remotionInteractivitySkillAvailable: false,
timedOut: false,
});
-
- const upgradeSkillDirectory = path.join(
- remotionRoot,
- '.agents',
- 'skills',
- 'remotion-upgrade',
- );
- mkdirSync(upgradeSkillDirectory, {recursive: true});
- writeFileSync(
- path.join(upgradeSkillDirectory, 'SKILL.md'),
- '---\nname: remotion-upgrade\nversion: 4.0.501\n---\n',
- );
- const interactivitySkillDirectory = path.join(
- remotionRoot,
- '.agents',
- 'skills',
- 'remotion-interactivity',
- );
- mkdirSync(interactivitySkillDirectory, {recursive: true});
- writeFileSync(
- path.join(interactivitySkillDirectory, 'SKILL.md'),
- '---\nname: remotion-interactivity\nversion: 4.0.501\n---\n',
- );
-
- const resultWithUpgradeSkill = await isUpdateAvailable({
- remotionRoot,
- currentVersion: '4.0.502',
- logLevel: 'error',
- getLatestVersion: () => Promise.resolve('4.0.502'),
- });
-
- expect(resultWithUpgradeSkill).toMatchObject({
- skillsUpdateAvailable: true,
- remotionUpgradeSkillAvailable: true,
- remotionInteractivitySkillAvailable: true,
- });
} finally {
rmSync(remotionRoot, {recursive: true, force: true});
}
});
-
-test('reports skills installed in the global scope as available', async () => {
- const temporaryDirectory = mkdtempSync(
- path.join(tmpdir(), 'remotion-studio-global-skills-'),
- );
- const remotionRoot = path.join(temporaryDirectory, 'project');
- const homeDirectory = path.join(temporaryDirectory, 'home');
-
- try {
- mkdirSync(remotionRoot, {recursive: true});
- for (const skillName of ['remotion-upgrade', 'remotion-interactivity']) {
- const skillDirectory = path.join(
- homeDirectory,
- '.agents',
- 'skills',
- skillName,
- );
- mkdirSync(skillDirectory, {recursive: true});
- writeFileSync(path.join(skillDirectory, 'SKILL.md'), '---\n---\n');
- }
-
- const result = await isUpdateAvailable({
- remotionRoot,
- currentVersion: '4.0.502',
- logLevel: 'error',
- getLatestVersion: () => Promise.resolve('4.0.502'),
- homeDirectory,
- });
-
- expect(result).toMatchObject({
- skillsUpdateAvailable: false,
- remotionUpgradeSkillAvailable: true,
- remotionInteractivitySkillAvailable: true,
- });
- } finally {
- rmSync(temporaryDirectory, {recursive: true, force: true});
- }
-});
diff --git a/packages/studio-shared/src/api-requests.ts b/packages/studio-shared/src/api-requests.ts
index d5d0cea327..b32a7e58e5 100644
--- a/packages/studio-shared/src/api-requests.ts
+++ b/packages/studio-shared/src/api-requests.ts
@@ -1031,12 +1031,16 @@ export type UpdateAvailableResponse = {
latestVersion: string;
updateAvailable: boolean;
skillsUpdateAvailable: boolean;
- remotionUpgradeSkillAvailable: boolean;
- remotionInteractivitySkillAvailable: boolean;
timedOut: boolean;
packageManager: PackageManager | 'unknown';
};
+export type GetRemotionSkillsInfoRequest = {};
+export type GetRemotionSkillsInfoResponse = {
+ remotionUpgradeSkillAvailable: boolean;
+ remotionInteractivitySkillAvailable: boolean;
+};
+
export type ProjectInfoRequest = {};
export type ProjectInfoResponse = {
projectInfo: ProjectInfo;
@@ -1291,6 +1295,10 @@ export type ApiRoutes = {
UpdateAvailableRequest,
UpdateAvailableResponse
>;
+ '/api/remotion-skills-info': ReqAndRes<
+ GetRemotionSkillsInfoRequest,
+ GetRemotionSkillsInfoResponse
+ >;
'/api/apply-codemod': ReqAndRes<ApplyCodemodRequest, ApplyCodemodResponse>;
'/api/project-info': ReqAndRes<ProjectInfoRequest, ProjectInfoResponse>;
'/api/delete-static-file': ReqAndRes<
diff --git a/packages/studio-shared/src/index.ts b/packages/studio-shared/src/index.ts
index 106af51b76..893d572859 100644
--- a/packages/studio-shared/src/index.ts
+++ b/packages/studio-shared/src/index.ts
@@ -61,6 +61,8 @@ export {
GetDefaultCodingAgentInfoResponse,
GetDefaultEditorInfoRequest,
GetDefaultEditorInfoResponse,
+ GetRemotionSkillsInfoRequest,
+ GetRemotionSkillsInfoResponse,
GoogleFontSourceEdit,
InsertElementFileConflict,
InsertElementRequest,
diff --git a/packages/studio/src/components/SettingsContext.tsx b/packages/studio/src/components/SettingsContext.tsx
index c5c044b9d0..3d859d90e2 100644
--- a/packages/studio/src/components/SettingsContext.tsx
+++ b/packages/studio/src/components/SettingsContext.tsx
@@ -1,6 +1,7 @@
import type {
GetDefaultCodingAgentInfoResponse,
GetDefaultEditorInfoResponse,
+ GetRemotionSkillsInfoResponse,
RenderDefaults,
StudioRuntimeConfig,
} from '@remotion/studio-shared';
@@ -21,6 +22,7 @@ type SettingsContextValue = {
readonly editorInfo: GetDefaultEditorInfoResponse | null;
readonly error: string | null;
readonly publicLicenseKey: string | null;
+ readonly remotionSkillsInfo: GetRemotionSkillsInfoResponse | null;
readonly renderDefaults: RenderDefaults | null;
readonly studioRuntimeConfig: StudioRuntimeConfig | null;
readonly revision: number;
@@ -42,6 +44,7 @@ export const SettingsProvider: React.FC<{
editorInfo: null,
error: null,
publicLicenseKey: window.remotion_studioConfig?.publicLicenseKey ?? null,
+ remotionSkillsInfo: null,
renderDefaults: window.remotion_renderDefaults ?? null,
studioRuntimeConfig: window.remotion_studioConfig ?? null,
revision: 0,
@@ -64,8 +67,9 @@ export const SettingsProvider: React.FC<{
Promise.all([
callApi('/api/default-editor-info', {}, controller.signal),
callApi('/api/default-coding-agent-info', {}, controller.signal),
+ callApi('/api/remotion-skills-info', {}, controller.signal),
])
- .then(([editorInfo, codingAgentInfo]) => {
+ .then(([editorInfo, codingAgentInfo, remotionSkillsInfo]) => {
const runtimeConfig = window.remotion_studioConfig;
setSettings((currentSettings) => ({
...currentSettings,
@@ -81,6 +85,7 @@ export const SettingsProvider: React.FC<{
? runtimeConfig.defaultEditor
: editorInfo.defaultEditor,
},
+ remotionSkillsInfo,
error: null,
revision: currentSettings.revision + 1,
}));
diff --git a/packages/studio/src/components/Timeline/TimelineSchemaField.tsx b/packages/studio/src/components/Timeline/TimelineSchemaField.tsx
index 3a91b0c9fd..c55106fbb5 100644
--- a/packages/studio/src/components/Timeline/TimelineSchemaField.tsx
+++ b/packages/studio/src/components/Timeline/TimelineSchemaField.tsx
@@ -12,7 +12,7 @@ import type {
TimelineFieldOnSave,
} from '../../helpers/timeline-layout';
import {SetSelectedModalContext} from '../../state/modals';
-import {updateAvailable} from '../RenderQueue/actions';
+import {useSettings} from '../SettingsContext';
import {formatTimelineFieldValueForDisplay} from './timeline-field-display-utils';
import {TimelineArrayField} from './TimelineArrayField';
import {
@@ -125,27 +125,16 @@ export const TimelineNonEditableStatus: React.FC<{
readonly validatedLocation: CodePosition;
}> = ({propStatus, field, runtimeValue, validatedLocation}) => {
const {setSelectedModal} = useContext(SetSelectedModalContext);
+ const {remotionSkillsInfo} = useSettings();
const onFix = useCallback(() => {
- const controller = new AbortController();
- updateAvailable(controller.signal)
- .then((info) => {
- setSelectedModal({
- type: 'fix-computed-value',
- prop: field.key,
- context: `${validatedLocation.source}:${validatedLocation.line}:${validatedLocation.column}`,
- remotionInteractivitySkillAvailable:
- info.remotionInteractivitySkillAvailable,
- });
- })
- .catch(() => {
- setSelectedModal({
- type: 'fix-computed-value',
- prop: field.key,
- context: `${validatedLocation.source}:${validatedLocation.line}:${validatedLocation.column}`,
- remotionInteractivitySkillAvailable: false,
- });
- });
- }, [field.key, setSelectedModal, validatedLocation]);
+ setSelectedModal({
+ type: 'fix-computed-value',
+ prop: field.key,
+ context: `${validatedLocation.source}:${validatedLocation.line}:${validatedLocation.column}`,
+ remotionInteractivitySkillAvailable:
+ remotionSkillsInfo?.remotionInteractivitySkillAvailable ?? false,
+ });
+ }, [field.key, remotionSkillsInfo, setSelectedModal, validatedLocation]);
if (propStatus.status === 'computed') {
return (
diff --git a/packages/studio/src/components/UpdateCheck.tsx b/packages/studio/src/components/UpdateCheck.tsx
index 83f6d32a63..3b59c0224a 100644
--- a/packages/studio/src/components/UpdateCheck.tsx
+++ b/packages/studio/src/components/UpdateCheck.tsx
@@ -1,4 +1,7 @@
-import type {PackageManager} from '@remotion/studio-shared';
+import type {
+ GetRemotionSkillsInfoResponse,
+ UpdateAvailableResponse,
+} from '@remotion/studio-shared';
import React, {
useCallback,
useContext,
@@ -18,17 +21,10 @@ import {useZIndex} from '../state/z-index';
import type {RenderInlineAction} from './InlineAction';
import {InlineAction} from './InlineAction';
import {updateAvailable} from './RenderQueue/actions';
+import {useSettings} from './SettingsContext';
-export type UpdateInfo = {
- currentVersion: string;
- latestVersion: string;
- updateAvailable: boolean;
- skillsUpdateAvailable: boolean;
- remotionUpgradeSkillAvailable: boolean;
- remotionInteractivitySkillAvailable: boolean;
- timedOut: boolean;
- packageManager: PackageManager | 'unknown';
-};
+export type UpdateInfo = UpdateAvailableResponse &
+ Pick<GetRemotionSkillsInfoResponse, 'remotionUpgradeSkillAvailable'>;
const buttonStyle: React.CSSProperties = {
appearance: 'none',
@@ -57,8 +53,9 @@ export type Bug = {
};
export const UpdateCheck = () => {
- const [info, setInfo] = useState<UpdateInfo | null>(null);
+ const [info, setInfo] = useState<UpdateAvailableResponse | null>(null);
const {setSelectedModal} = useContext(SetSelectedModalContext);
+ const {remotionSkillsInfo} = useSettings();
const {tabIndex} = useZIndex();
const [knownBugs, setKnownBugs] = useState<Bug[] | null>(null);
const [hovered, setHovered] = useState(false);
@@ -121,10 +118,14 @@ export const UpdateCheck = () => {
const openModal = useCallback(() => {
setSelectedModal({
type: 'update',
- info: info as UpdateInfo,
+ info: {
+ ...(info as UpdateAvailableResponse),
+ remotionUpgradeSkillAvailable:
+ remotionSkillsInfo?.remotionUpgradeSkillAvailable ?? false,
+ },
knownBugs: knownBugs as Bug[],
});
- }, [info, knownBugs, setSelectedModal]);
+ }, [info, knownBugs, remotionSkillsInfo, setSelectedModal]);
const dynButtonStyle: React.CSSProperties = useMemo(() => {
return {