@ computesdk/ cloudflare (英语)

Cloudflare ComputeSDK的提供商——在Cloudflare的边缘网络上以安全,孤立的容器执行代码.

安装

npm install @computesdk/cloudflare

设置

调出桥工 worker/它需要一个关于工人付费计划的Cloudflare账户和Docker在当地运行; wrangler deploy 建立容器图像并把它们推向Cloudflare的注册.

git clone https://github.com/computesdk/computesdk.git
cd computesdk/packages/cloudflare/worker
npm ci
npx wrangler login
openssl rand -hex 32   # use the output as the API key
npx wrangler secret put SANDBOX_API_KEY
npx wrangler deploy

然后配置您的应用程序 :

CLOUDFLARE_SANDBOX_URL=https://computesdk-sandbox.<your-subdomain>.workers.dev
CLOUDFLARE_SANDBOX_API_KEY=<same value as SANDBOX_API_KEY>

您也可以运行 :

npx @computesdk/cloudflare

打印这些设置指令.

调来一名工人 云花板沙盒演示 继续为命令和文件工作。 适配器检查 GET /v1/info 并仅在工人列出时使用桥的本地文件传输,预览 URL和快照.

预览 URL

和桥工人, sandbox.getUrl({ port }) 返回时 <sandboxUrl>/v1/sandbox/<id>/ports/<port>/,将 HTTP 和 WebSocket 请求转发到该端口。 服务器必须收听 0.0.0.0预览 URL 不需要 API 键: 任何拥有 URL 的人都可以到达端口.

抓图

和桥工人, compute.snapshot.create(sandboxId) 保存沙盒的文件系统并 compute.instances.create({ snapshotId }) 从它开始一个新的沙盒。 快照只保存文件,而不是内存或运行过程. Cloudflare 将快照数据保存在创建或最后一次恢复后30天; snapshot.delete 从桥上取出手柄.

快速启动

import { cloudflare } from '@computesdk/cloudflare';

const compute = cloudflare({
  sandboxUrl: process.env.CLOUDFLARE_SANDBOX_URL,
  sandboxApiKey: process.env.CLOUDFLARE_SANDBOX_API_KEY,
});

const sandbox = await compute.instances.create();

const result = await sandbox.runCommand(
  "node -e 'console.log(\"Hello from Cloudflare!\")'"
);

console.log(result.stdout);
await sandbox.destroy();

使用量

运行命令

在沙盒内使用普通 shell 命令 :

await sandbox.runCommand('echo "Hello from Cloudflare"');
await sandbox.runCommand("node -e 'console.log(\"Hello Node.js\")'");

列表文件

const result = await sandbox.runCommand('ls -la /tmp/app');
console.log(result.stdout);

文件系统

// Create directories
await sandbox.filesystem.mkdir('/tmp/app/data');

// Write and read files
await sandbox.filesystem.writeFile('/tmp/app/config.json', JSON.stringify({ key: 'value' }));
const content = await sandbox.filesystem.readFile('/tmp/app/config.json');

// List directory contents
const files = await sandbox.filesystem.readdir('/tmp/app');

// Check existence
const exists = await sandbox.filesystem.exists('/tmp/app/config.json');

// Remove files
await sandbox.filesystem.remove('/tmp/app/temp.txt');

环境变量

初始化时将环境变量传递到沙盒命令 :

const compute = cloudflare({
  sandboxUrl: process.env.CLOUDFLARE_SANDBOX_URL,
  sandboxApiKey: process.env.CLOUDFLARE_SANDBOX_API_KEY,
  envVars: {
    API_KEY: 'your-api-key',
    DATABASE_URL: 'postgresql://localhost:5432/mydb',
  },
});

或创建时的每盒:

const sandbox = await compute.instances.create({
  envs: { NODE_ENV: 'production' },
});

沙盒大小和图像

创建时选择新沙盒的大小和图像 :

const sandbox = await compute.instances.create({
  vcpu: 2,
  memoryMib: 6144,
  diskMb: 12000,
  image: 'builder',
});

设定 vcpu, (中文(简体) ), memoryMib,以及 diskMb 一起来 没有它们,沙盒会使用工人的默认实例类型. 无 image它使用工人的默认图像.

配置

interface CloudflareConfig {
  /** URL of the deployed bridge Worker (or sandbox demo Worker) */
  sandboxUrl?: string;
  /** API key that matches the Worker's SANDBOX_API_KEY secret */
  sandboxApiKey?: string;
  /** Deprecated compatibility alias for sandboxApiKey */
  sandboxSecret?: string;
  /** Durable Object binding to the Worker's Sandbox class (direct mode only) */
  sandboxBinding?: any;
  /** Execution timeout in milliseconds (default 30,000; maximum 900,000) */
  timeout?: number;
  /** Environment variables to pass to sandbox commands */
  envVars?: Record<string, string>;
}

直接模式

如果你的代码已经运行在云旗工人,直接绑在 Sandbox 工人输出的持久对象 :

{
  "durable_objects": {
    "bindings": [
      {
        "name": "SANDBOX",
        "class_name": "Sandbox",
        "script_name": "sandbox"
      }
    ]
  }
}

然后,把装订 给提供者:

import { cloudflare } from '@computesdk/cloudflare';

const compute = cloudflare({
  sandboxBinding: env.SANDBOX,
});

处理错误

const result = await sandbox.runCommand('command-that-does-not-exist');
if (result.exitCode !== 0) {
  console.error(result.stderr);
}

限制

• 根据您的 Cloudflare 计划适用资源限制
• 一些系统调用在集装箱环境中可能受到限制
• 预览 URL 和快照需要桥接工作人, 而不能直接使用
• 不支持列出所有沙盒- 使用 getById 重新连接到特定的沙盒ID.

许可证

麻省理工学院