Skip to content

🎥 Make videos programmatically with React

3.1 KB
Raw Blame
import path from 'node:path';
import type {LogLevel} from '@remotion/renderer';
import type {UpdateAvailableResponse} from '@remotion/studio-shared';
import semver from 'semver';
import {
	detectOutdatedRemotionSkills,
	readRemotionSkill,
} from '../detect-outdated-remotion-skills';
import {getLatestRemotionVersion} from '../get-latest-remotion-version';
import {getPackageManager} from './get-package-manager';

const getSkillsUpdateInfo = ({
	remotionRoot,
	currentVersion,
}: {
	remotionRoot: string;
	currentVersion: string;
}): Pick<
	UpdateAvailableResponse,
	'skillsUpdateAvailable' | 'skillsUpdateDetails'
> => {
	const projectSkills = detectOutdatedRemotionSkills({
		cwd: remotionRoot,
		currentVersion,
	}).project;

	return {
		skillsUpdateAvailable: projectSkills.type === 'outdated',
		skillsUpdateDetails:
			projectSkills.type === 'outdated'
				? {
						outdatedSkills: projectSkills.outdatedSkillNames.map((name) => {
							const {version} = readRemotionSkill(
								path.join(projectSkills.skillsDirectory, name, 'SKILL.md'),
							);
							return {
								name,
								installedVersion: version,
								reason:
									version === null
										? 'missing-version'
										: semver.valid(version) === null
											? 'invalid-version'
											: 'older-version',
							};
						}),
					}
				: null,
	};
};

export const isUpdateAvailable = async ({
	remotionRoot,
	currentVersion,
	logLevel,
	getLatestVersion,
}: {
	remotionRoot: string;
	currentVersion: string;
	logLevel: LogLevel;
	getLatestVersion: (() => Promise<string>) | null;
}): Promise<UpdateAvailableResponse> => {
	const latest = await (getLatestVersion ?? getLatestRemotionVersion)();
	const skillsUpdateInfo = getSkillsUpdateInfo({
		remotionRoot,
		currentVersion,
	});

	const pkgManager = getPackageManager({
		remotionRoot,
		packageManager: undefined,
		dirUp: 0,
		logLevel,
	});

	return {
		updateAvailable: semver.lt(currentVersion, latest),
		...skillsUpdateInfo,
		currentVersion,
		latestVersion: latest,
		timedOut: false,
		packageManager: pkgManager === 'unknown' ? 'unknown' : pkgManager.manager,
	};
};

export const getRemotionVersion = () => {
	// careful when refactoring this file, path must be adjusted
	const packageJson = require('../../package.json');

	const {version} = packageJson;

	return version;
};

export const isUpdateAvailableWithTimeout = (
	remotionRoot: string,
	logLevel: LogLevel,
) => {
	const version = getRemotionVersion();
	const skillsUpdateInfo = getSkillsUpdateInfo({
		remotionRoot,
		currentVersion: version,
	});
	const threeSecTimeout = new Promise<UpdateAvailableResponse>((resolve) => {
		const pkgManager = getPackageManager({
			remotionRoot,
			packageManager: undefined,
			dirUp: 0,
			logLevel,
		});
		setTimeout(() => {
			resolve({
				currentVersion: version,
				latestVersion: version,
				updateAvailable: false,
				...skillsUpdateInfo,
				timedOut: true,
				packageManager:
					pkgManager === 'unknown' ? 'unknown' : pkgManager.manager,
			});
		}, 3000);
	});
	return Promise.race([
		threeSecTimeout,
		isUpdateAvailable({
			remotionRoot,
			currentVersion: version,
			logLevel,
			getLatestVersion: null,
		}),
	]);
};