Merge pull request #5378 from remotion-dev/copilot/fix-55bffa9b-25ec-4d77-b541-9b44d7f6005c

Author: JonnyBurger

bun.lock

@@ -0,0 +1,59 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "remotion-monorepo",
+      "dependencies": {
+        "turbo": "2.4.4",
+        "typescript": "5.8.2",
+      },
+      "devDependencies": {
+        "@types/bun": "1.2.8",
+        "@types/deno": "2.0.0",
+        "@types/react": "19.0.0",
+        "@types/react-dom": "19.0.0",
+        "prettier": "3.3.3",
+        "prettier-plugin-organize-imports": "3.2.4",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.2.7" } }, "sha512-t8L1RvJVUghW5V+M/fL3Thbxcs0HwNsXsnTEBEfEVqGteiJToOlZ/fyOEaR1kZsNqnu+3XA4RI/qmnX4w6+S+w=="],
+
+    "@types/deno": ["@types/[email protected]", "", {}, "sha512-O9/jRVlq93kqfkl4sYR5N7+Pz4ukzXVIbMnE/VgvpauNHsvjQ9iBVnJ3X0gAvMa2khcoFD8DSO7mQVCuiuDMPg=="],
+
+    "@types/node": ["@types/[email protected]", "", { "dependencies": { "undici-types": "~7.8.0" } }, "sha512-MX4Zioh39chHlDJbKmEgydJDS3tspMP/lnQC67G3SWsTnb9NeYVWOjkxpOSy4oMfPs4StcWHwBrvUb4ybfnuaw=="],
+
+    "@types/react": ["@types/[email protected]", "", { "dependencies": { "csstype": "^3.0.2" } }, "sha512-MY3oPudxvMYyesqs/kW1Bh8y9VqSmf+tzqw3ae8a9DZW68pUe3zAdHeI1jc6iAysuRdACnVknHP8AhwD4/dxtg=="],
+
+    "@types/react-dom": ["@types/[email protected]", "", { "dependencies": { "@types/react": "*" } }, "sha512-1KfiQKsH1o00p9m5ag12axHQSb3FOU9H20UTrujVSkNhuCrRHiQWFqgEnTNK5ZNfnzZv8UWrnXVqCmCF9fgY3w=="],
+
+    "@types/ws": ["@types/[email protected]", "", { "dependencies": { "@types/node": "*" } }, "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg=="],
+
+    "bun-types": ["[email protected]", "", { "dependencies": { "@types/node": "*", "@types/ws": "*" } }, "sha512-P4hHhk7kjF99acXqKvltyuMQ2kf/rzIw3ylEDpCxDS9Xa0X0Yp/gJu/vDCucmWpiur5qJ0lwB2bWzOXa2GlHqA=="],
+
+    "csstype": ["[email protected]", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="],
+
+    "prettier": ["[email protected]", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew=="],
+
+    "prettier-plugin-organize-imports": ["[email protected]", "", { "peerDependencies": { "@volar/vue-language-plugin-pug": "^1.0.4", "@volar/vue-typescript": "^1.0.4", "prettier": ">=2.0", "typescript": ">=2.9" }, "optionalPeers": ["@volar/vue-language-plugin-pug", "@volar/vue-typescript"] }, "sha512-6m8WBhIp0dfwu0SkgfOxJqh+HpdyfqSSLfKKRZSFbDuEQXDDndb8fTpRWkUrX/uBenkex3MgnVk0J3b3Y5byog=="],
+
+    "turbo": ["[email protected]", "", { "optionalDependencies": { "turbo-darwin-64": "2.4.4", "turbo-darwin-arm64": "2.4.4", "turbo-linux-64": "2.4.4", "turbo-linux-arm64": "2.4.4", "turbo-windows-64": "2.4.4", "turbo-windows-arm64": "2.4.4" }, "bin": { "turbo": "bin/turbo" } }, "sha512-N9FDOVaY3yz0YCOhYIgOGYad7+m2ptvinXygw27WPLQvcZDl3+0Sa77KGVlLSiuPDChOUEnTKE9VJwLSi9BPGQ=="],
+
+    "turbo-darwin-64": ["[email protected]", "", { "os": "darwin", "cpu": "x64" }, "sha512-5kPvRkLAfmWI0MH96D+/THnDMGXlFNmjeqNRj5grLKiry+M9pKj3pRuScddAXPdlxjO5Ptz06UNaOQrrYGTx1g=="],
+
+    "turbo-darwin-arm64": ["[email protected]", "", { "os": "darwin", "cpu": "arm64" }, "sha512-/gtHPqbGQXDFhrmy+Q/MFW2HUTUlThJ97WLLSe4bxkDrKHecDYhAjbZ4rN3MM93RV9STQb3Tqy4pZBtsd4DfCw=="],
+
+    "turbo-linux-64": ["[email protected]", "", { "os": "linux", "cpu": "x64" }, "sha512-SR0gri4k0bda56hw5u9VgDXLKb1Q+jrw4lM7WAhnNdXvVoep4d6LmnzgMHQQR12Wxl3KyWPbkz9d1whL6NTm2Q=="],
+
+    "turbo-linux-arm64": ["[email protected]", "", { "os": "linux", "cpu": "arm64" }, "sha512-COXXwzRd3vslQIfJhXUklgEqlwq35uFUZ7hnN+AUyXx7hUOLIiD5NblL+ETrHnhY4TzWszrbwUMfe2BYWtaPQg=="],
+
+    "turbo-windows-64": ["[email protected]", "", { "os": "win32", "cpu": "x64" }, "sha512-PV9rYNouGz4Ff3fd6sIfQy5L7HT9a4fcZoEv8PKRavU9O75G7PoDtm8scpHU10QnK0QQNLbE9qNxOAeRvF0fJg=="],
+
+    "turbo-windows-arm64": ["[email protected]", "", { "os": "win32", "cpu": "arm64" }, "sha512-403sqp9t5sx6YGEC32IfZTVWkRAixOQomGYB8kEc6ZD+//LirSxzeCHCnM8EmSXw7l57U1G+Fb0kxgTcKPU/Lg=="],
+
+    "typescript": ["[email protected]", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ=="],
+
+    "undici-types": ["[email protected]", "", {}, "sha512-9UJ2xGDvQ43tYyVMpuHlsgApydB8ZKfVYTsLDhXkFL/6gfkp+U8xTGdh8pMJv1SpZna0zxG1DwsKZsreLbXBxw=="],
+  }
+}

packages/docs/docs/lambda/proxy.mdx

@@ -0,0 +1,169 @@
+---
+image: /generated/articles-docs-lambda-proxy.png
+id: proxy
+title: Using a proxy with Remotion Lambda
+sidebar_label: Using a proxy
+crumb: 'Lambda'
+---
+
+_Available from v4.0.315_
+
+Remotion Lambda supports using HTTP/HTTPS proxies for all AWS API calls by accepting a `requestHandler` option that allows you to pass a custom AWS SDK request handler.
+
+This is useful when your environment requires all external HTTP requests to go through a proxy server.
+
+## Setting up a proxy
+
+### 1. Install a proxy agent
+
+First, install an HTTP/HTTPS proxy agent package like `https-proxy-agent`:
+
+```bash
+npm install https-proxy-agent
+```
+
+### 2. Create a request handler with proxy
+
+Create a request handler that uses your proxy:
+
+```tsx twoslash
+import {HttpsProxyAgent} from 'https-proxy-agent';
+
+// Configure your proxy URL
+const proxyUrl = 'http://your-proxy-server:8080';
+
+// Create a proxy agent
+const proxyAgent = new HttpsProxyAgent(proxyUrl);
+
+// Create a request handler that uses the proxy
+export const proxyRequestHandler = {
+  httpsAgent: proxyAgent,
+};
+```
+
+### 3. Use the request handler with Remotion Lambda functions
+
+Pass the `requestHandler` option to any Remotion Lambda function:
+
+```tsx twoslash
+// @filename: proxy-setup.ts
+import {HttpsProxyAgent} from 'https-proxy-agent';
+
+const proxyUrl = 'http://your-proxy-server:8080';
+const proxyAgent = new HttpsProxyAgent(proxyUrl);
+
+export const proxyRequestHandler = {
+  httpsAgent: proxyAgent,
+};
+
+// @filename: example.ts
+// ---cut---
+import {getFunctions} from '@remotion/lambda/client';
+import {proxyRequestHandler} from './proxy-setup';
+
+const functions = await getFunctions({
+  region: 'us-east-1',
+  compatibleOnly: true,
+  requestHandler: proxyRequestHandler,
+});
+
+console.log('Functions:', functions);
+```
+
+## Supported functions
+
+All public AWS-related APIs in the Lambda client accept the `requestHandler` option.
+
+## Example with authentication
+
+If your proxy requires authentication, you can include credentials in the proxy URL:
+
+```tsx twoslash
+import {HttpsProxyAgent} from 'https-proxy-agent';
+
+// Proxy with authentication
+const proxyUrl = 'http://username:password@your-proxy-server:8080';
+const proxyAgent = new HttpsProxyAgent(proxyUrl);
+
+export const authenticatedProxyRequestHandler = {
+  httpsAgent: proxyAgent,
+};
+```
+
+## TypeScript support
+
+Remotion Lambda exports a `RequestHandler` type that you can use for type safety:
+
+```tsx twoslash
+import type {RequestHandler} from '@remotion/lambda/client';
+import {HttpsProxyAgent} from 'https-proxy-agent';
+
+const proxyAgent = new HttpsProxyAgent('http://proxy:8080');
+
+const myRequestHandler: RequestHandler = {
+  httpsAgent: proxyAgent,
+};
+```
+
+## Environment-specific configuration
+
+You can conditionally use a proxy based on your environment:
+
+```tsx twoslash
+import {HttpsProxyAgent} from 'https-proxy-agent';
+import type {RequestHandler} from '@remotion/lambda/client';
+
+const createRequestHandler = (): RequestHandler | undefined => {
+  const proxyUrl = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
+
+  if (proxyUrl) {
+    return {
+      httpsAgent: new HttpsProxyAgent(proxyUrl),
+    };
+  }
+
+  // Return undefined to use default behavior
+  return undefined;
+};
+
+export const requestHandler = createRequestHandler();
+```
+
+Then use it in your Lambda calls:
+
+```tsx twoslash
+// @filename: conditional-proxy.ts
+import {HttpsProxyAgent} from 'https-proxy-agent';
+import type {RequestHandler} from '@remotion/lambda/client';
+
+const createRequestHandler = (): RequestHandler | undefined => {
+  const proxyUrl = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
+
+  if (proxyUrl) {
+    return {
+      httpsAgent: new HttpsProxyAgent(proxyUrl),
+    };
+  }
+
+  return undefined;
+};
+
+export const requestHandler = createRequestHandler();
+
+// @filename: usage.ts
+// ---cut---
+import {getFunctions} from '@remotion/lambda/client';
+import {requestHandler} from './conditional-proxy';
+
+const functions = await getFunctions({
+  region: 'us-east-1',
+  compatibleOnly: true,
+  requestHandler, // This will be undefined if no proxy is configured
+});
+```
+
+## See also
+
+- [https-proxy-agent documentation](https://www.npmjs.com/package/https-proxy-agent)
+- [getFunctions()](/docs/lambda/getfunctions)
+- [getAwsClient()](/docs/lambda/getawsclient)

packages/docs/package.json

@@ -96,6 +96,7 @@
 		"three": "0.158.0",
 		"uuid": "^8.3.2",
 		"zod": "3.22.3",
+		"https-proxy-agent": "^7.0.2",
 		"@remotion/eslint-config-internal": "workspace:*",
 		"eslint": "9.19.0"
 	},

packages/docs/sidebars.js

@@ -995,6 +995,7 @@ module.exports = {
 				'lambda/bucket-naming',
 				'lambda/optimizing-cost',
 				'lambda/optimizing-speed',
+				'lambda/proxy',
 				'lambda/limits',
 				'lambda/changelog',
 				'lambda/upgrading',

packages/docs/src/data/articles.ts

@@ -2258,6 +2258,15 @@ export const articles = [
 		noAi: false,
 		slug: 'lambda/presignurl',
 	},
+	{
+		id: 'proxy',
+		title: 'Using a proxy with Remotion Lambda',
+		relativePath: 'docs/lambda/proxy.mdx',
+		compId: 'articles-docs-lambda-proxy',
+		crumb: 'Lambda',
+		noAi: false,
+		slug: 'lambda/proxy',
+	},
 	{
 		id: 'lambda/python',
 		title: 'Triggering renders from Python',

packages/docs/static/generated/articles-docs-lambda-proxy.png

@@ -82,6 +82,7 @@ test(
 				},
 				apiKey: null,
 				storageClass: null,
+				requestHandler: null,
 			});
 
 		expect(removeUndefined(parsed)).toEqual(removeUndefined(nativeVersion));

packages/it-tests/src/monorepo/go-package.test.ts

@@ -127,6 +127,7 @@ class Semantic
 				},
 				apiKey: null,
 				storageClass: null,
+				requestHandler: null,
 			});
 		const jsonOutput = toParse.substring(0, toParse.lastIndexOf('}') + 1);
 		const parsedJson = JSON.parse(jsonOutput);

packages/it-tests/src/monorepo/php-package.test.ts

@@ -49,6 +49,7 @@ test('Python package should create the same renderMedia payload as normal Lambda
 	const toParse = output[PYTHON_OUTPUT_MARKER];
 	const nativeVersion =
 		await LambdaClientInternals.makeLambdaRenderMediaPayload({
+			requestHandler: null,
 			region: 'us-east-1',
 			composition: 'react-svg',
 			functionName: 'remotion-render',
@@ -193,6 +194,7 @@ test('Python package should create the same renderStill payload as normal Lambda
 			forcePathStyle: false,
 			apiKey: null,
 			storageClass: null,
+			requestHandler: null,
 		});
 	const jsonOutput = toParse.substring(0, toParse.lastIndexOf('}') + 1);
 	const {streamed: _, ...parsedJson} = JSON.parse(jsonOutput);

packages/it-tests/src/monorepo/python-package.test.ts

@@ -134,6 +134,7 @@ test('Render Media payload', async () => {
 			},
 			apiKey: null,
 			storageClass: null,
+			requestHandler: null,
 		});
 
 	expect(JSON.parse(output)).toEqual(nativeVersion);
@@ -178,6 +179,7 @@ test('Render Still payload', async () => {
 			apiKey: null,
 			offthreadVideoThreads: null,
 			storageClass: null,
+			requestHandler: null,
 		});
 
 	expect(JSON.parse(output)).toEqual({...nativeVersion, streamed: false});

packages/it-tests/src/monorepo/ruby-package.test.ts

@@ -5,56 +5,71 @@ import type {ServiceQuotasClient} from '@aws-sdk/client-service-quotas';
 import type {STSClient} from '@aws-sdk/client-sts';
 import {getServiceClient} from './get-service-client';
 import type {AwsRegion} from './regions';
+import type {RequestHandler} from './types';
 
 export const getCloudWatchLogsClient = (
 	region: AwsRegion,
+	requestHandler: RequestHandler | null,
 ): CloudWatchLogsClient => {
 	return getServiceClient({
 		region,
 		service: 'cloudwatch',
 		customCredentials: null,
 		forcePathStyle: false,
+		requestHandler,
 	});
 };
 
 export const getLambdaClient = (
 	region: AwsRegion,
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	_timeoutInTest?: number,
+	_timeoutInTest: number | undefined,
+	requestHandler: RequestHandler | null,
 ): LambdaClient => {
 	return getServiceClient({
 		region,
 		service: 'lambda',
 		customCredentials: null,
 		forcePathStyle: false,
+		requestHandler,
 	});
 };
 
-export const getIamClient = (region: AwsRegion): IAMClient => {
+export const getIamClient = (
+	region: AwsRegion,
+	requestHandler: RequestHandler | null,
+): IAMClient => {
 	return getServiceClient({
 		region,
 		service: 'iam',
 		customCredentials: null,
 		forcePathStyle: false,
+		requestHandler,
 	});
 };
 
 export const getServiceQuotasClient = (
 	region: AwsRegion,
+	requestHandler: RequestHandler | null,
 ): ServiceQuotasClient => {
 	return getServiceClient({
 		region,
 		service: 'servicequotas',
 		customCredentials: null,
 		forcePathStyle: false,
+		requestHandler,
 	});
 };
 
-export const getStsClient = (region: AwsRegion): STSClient => {
+export const getStsClient = (
+	region: AwsRegion,
+	requestHandler: RequestHandler | null,
+): STSClient => {
 	return getServiceClient({
 		region,
 		service: 'sts',
 		customCredentials: null,
 		forcePathStyle: false,
+		requestHandler,
 	});
 };