Skip to content

🎥 Make videos programmatically with React

Refresh Studio terminal shortcuts when app preferences change

Jonny Burgerecd511a42d31
diff --git a/packages/studio-server/src/helpers/recently-used-apps.ts b/packages/studio-server/src/helpers/recently-used-apps.ts
index cfd71168b8..efa725b8d0 100644
--- a/packages/studio-server/src/helpers/recently-used-apps.ts
+++ b/packages/studio-server/src/helpers/recently-used-apps.ts
@@ -3,6 +3,24 @@ import path from 'node:path';
import {defaultCodingAgentIds, defaultEditorIds} from '@remotion/renderer';
const histories = new Map<string, Promise<readonly string[]>>();
+const historyListeners = new Set<{
+ remotionRoot: string;
+ onChange: () => void;
+}>();
+
+export const subscribeToRecentlyUsedApps = ({
+ remotionRoot,
+ onChange,
+}: {
+ remotionRoot: string;
+ onChange: () => void;
+}): (() => void) => {
+ const listener = {remotionRoot, onChange};
+ historyListeners.add(listener);
+ return () => {
+ historyListeners.delete(listener);
+ };
+};
export const getRecentlyUsedApps = ({
remotionRoot,
@@ -53,6 +71,12 @@ export const getRecentlyUsedApps = ({
} catch {
// Keep the history in memory when the project cache is not writable.
}
+
+ historyListeners.forEach((listener) => {
+ if (listener.remotionRoot === remotionRoot) {
+ listener.onChange();
+ }
+ });
}
return updatedIds;
diff --git a/packages/studio-server/src/preview-server/live-events.ts b/packages/studio-server/src/preview-server/live-events.ts
index 174ef41b5f..fe0cd83ec3 100644
--- a/packages/studio-server/src/preview-server/live-events.ts
+++ b/packages/studio-server/src/preview-server/live-events.ts
@@ -28,6 +28,16 @@ const serializeMessage = (message: EventSourceEvent) => {
};
let printPortMessageTimeout: Timer | null = null;
+const configChangeListeners = new Set<() => void>();
+
+export const subscribeToConfigChanges = (
+ onChange: () => void,
+): (() => void) => {
+ configChangeListeners.add(onChange);
+ return () => {
+ configChangeListeners.delete(onChange);
+ };
+};
export const clearPrintPortMessageTimeout = () => {
if (printPortMessageTimeout) {
@@ -99,6 +109,10 @@ export const makeLiveEventsRouter = (
};
const sendEventToClient = (event: EventSourceEvent) => {
+ if (event.type === 'config-file-changed') {
+ configChangeListeners.forEach((listener) => listener());
+ }
+
clients.forEach((client) => {
client.response.write(serializeMessage(event));
});
diff --git a/packages/studio-server/src/studio-shortcuts.ts b/packages/studio-server/src/studio-shortcuts.ts
index da55e0093f..96b2eb8cf7 100644
--- a/packages/studio-server/src/studio-shortcuts.ts
+++ b/packages/studio-server/src/studio-shortcuts.ts
@@ -14,9 +14,15 @@ import {focusBrowserTabByOrigin} from './better-opn';
import {getAppDiscovery, getEditorInfo} from './helpers/app-discovery';
import type {InstalledCodingAgent} from './helpers/coding-agent-registry';
import {openInCodingAgent, openInEditor} from './helpers/open-in-app';
-import {getRecentlyUsedApps} from './helpers/recently-used-apps';
+import {
+ getRecentlyUsedApps,
+ subscribeToRecentlyUsedApps,
+} from './helpers/recently-used-apps';
import {maybeOpenBrowser} from './maybe-open-browser';
-import {clearPrintPortMessageTimeout} from './preview-server/live-events';
+import {
+ clearPrintPortMessageTimeout,
+ subscribeToConfigChanges,
+} from './preview-server/live-events';
type Key = {
name?: string;
@@ -57,12 +63,17 @@ export const registerStudioShortcuts = ({
null;
let codingAgent: InstalledCodingAgent | null = null;
const openingApps = new Set<string>();
+ let refreshRevision = 0;
+ let lastPrintedAssignment: string | null = null;
- const discoverShortcuts = async () => {
+ const refreshShortcuts = async () => {
+ const revision = ++refreshRevision;
+ const configuredEditor = getDefaultEditor();
+ const configuredCodingAgent = getDefaultCodingAgent();
const [discovery, editorInfo, recentEditors, recentCodingAgents] =
await Promise.all([
getAppDiscovery(),
- getEditorInfo(getDefaultEditor()),
+ getEditorInfo(configuredEditor),
getRecentlyUsedApps({
remotionRoot,
type: 'editor',
@@ -74,6 +85,10 @@ export const registerStudioShortcuts = ({
recentlyUsedIds: null,
}),
]);
+ if (cleanedUp || revision !== refreshRevision) {
+ return;
+ }
+
editor = getPreferredApp({
installedApps: editorInfo.installedEditors,
configuredId: editorInfo.defaultEditor,
@@ -83,11 +98,12 @@ export const registerStudioShortcuts = ({
});
codingAgent = getPreferredApp({
installedApps: discovery.installedCodingAgents,
- configuredId: getDefaultCodingAgent(),
+ configuredId: configuredCodingAgent,
runningIds: discovery.runningCodingAgents,
recentlyUsedIds: recentCodingAgents,
fallbackIds: discovery.installedCodingAgents.map(({id}) => id),
});
+ printShortcuts();
};
const printShortcuts = () => {
@@ -104,12 +120,44 @@ export const registerStudioShortcuts = ({
]
: []),
];
+ const assignment = JSON.stringify([
+ editor?.id ?? null,
+ codingAgent?.id ?? null,
+ shortcuts,
+ editor?.id === 'custom' ? getDefaultEditor() : null,
+ ]);
+ if (assignment === lastPrintedAssignment) {
+ return;
+ }
+
+ lastPrintedAssignment = assignment;
RenderInternals.Log.info(
{indent: false, logLevel},
RenderInternals.chalk.gray(shortcuts.join(' ')),
);
};
+ const onPreferencesChange = () => {
+ if (cleanedUp) {
+ return;
+ }
+
+ refreshShortcuts().catch((err) => {
+ RenderInternals.Log.verbose(
+ {indent: false, logLevel},
+ 'Could not refresh Studio shortcuts:',
+ err,
+ );
+ printShortcuts();
+ });
+ };
+
+ const unsubscribeHistory = subscribeToRecentlyUsedApps({
+ remotionRoot,
+ onChange: onPreferencesChange,
+ });
+ const unsubscribeConfig = subscribeToConfigChanges(onPreferencesChange);
+
const openApp = async (key: 'a' | 'e') => {
if (openingApps.has(key) || cleanedUp) {
return;
@@ -164,6 +212,8 @@ export const registerStudioShortcuts = ({
}
cleanedUp = true;
+ unsubscribeHistory();
+ unsubscribeConfig();
process.stdin.removeListener('keypress', onKeypress);
process.removeListener('SIGINT', cleanup);
process.removeListener('exit', cleanup);
@@ -247,15 +297,7 @@ export const registerStudioShortcuts = ({
process.once('SIGINT', cleanup);
process.once('exit', cleanup);
// Discovery may finish after other startup logs; never await it here.
- discoverShortcuts()
- .catch((err) => {
- RenderInternals.Log.verbose(
- {indent: false, logLevel},
- 'Could not discover Studio shortcuts:',
- err,
- );
- })
- .then(printShortcuts);
+ onPreferencesChange();
return {registered: true, cleanup};
};