[RFC] 046 - ENV config 重构

[arvinxx]

背景

在之前的 env config 直接采用了非常简单的实现：

export const getProviderConfig = () => {
  if (typeof process === 'undefined') {
    throw new Error('[Server Config] you are importing a server-only module outside of server');
  }

  return {
    API_KEY_SELECT_MODE: process.env.API_KEY_SELECT_MODE,

    OPENAI_API_KEY: process.env.OPENAI_API_KEY,
    OPENAI_PROXY_URL: process.env.OPENAI_PROXY_URL,
    OPENAI_MODEL_LIST: process.env.OPENAI_MODEL_LIST,
    OPENAI_FUNCTION_REGIONS: regions,
  };
};

但在后面发现这个 config 有点简陋，不支持类型校验、而且本以为 typeof process === 'undefined' 能拦截在 client 使用 server env，但是似乎在某些情况下也不会触发。

同时在添加 auth 时发现，某些领域的 env 是需要同时配置 client env 和 server env，拆成 server config 和 client config 并不合适。

因此需要对这部分的实现做一轮优化

设计思路

采用 t3-oss/t3-env 包，它内置了类型校验、 env 使用环境检查等能力，开发体验很好。

目前已经在 file 、auth 和 analytics 三个 config 场景使用，file示例如下：

// src/config/file.ts
import { createEnv } from '@t3-oss/env-nextjs';
import { z } from 'zod';

const DEFAULT_S3_FILE_PATH = 'files';

export const getFileConfig = () => {
  return createEnv({
    client: {
      NEXT_PUBLIC_S3_DOMAIN: z.string().optional(),
      NEXT_PUBLIC_S3_FILE_PATH: z.string().optional(),
    },
    server: {
      // S3
      S3_ACCESS_KEY_ID: z.string().optional(),
      S3_BUCKET: z.string().optional(),
      S3_ENDPOINT: z.string().optional(),

      S3_REGION: z.string().optional(),
      S3_SECRET_ACCESS_KEY: z.string().optional(),
    },

    runtimeEnv: {
      NEXT_PUBLIC_S3_DOMAIN: process.env.NEXT_PUBLIC_S3_DOMAIN,
      NEXT_PUBLIC_S3_FILE_PATH: process.env.NEXT_PUBLIC_S3_FILE_PATH || DEFAULT_S3_FILE_PATH,

      S3_ACCESS_KEY_ID: process.env.S3_ACCESS_KEY_ID,
      S3_BUCKET: process.env.S3_BUCKET,
      S3_ENDPOINT: process.env.S3_ENDPOINT,
      S3_REGION: process.env.S3_REGION,
      S3_SECRET_ACCESS_KEY: process.env.S3_SECRET_ACCESS_KEY,
    },
  });
};

export const fileEnv = getFileConfig();

计划跟随后续迭代，将之前所有的 server 和 client 的 env 都迁移到 @t3-oss/env 的实现里来。

进展

• Model Provider：♻️ refactor: refactor the llm env #2592
• Langfuse: ♻️ refactor: refactor the langfuse ENV #2602
• App: ♻️ refactor: refactor the app ENV #2604
• serverDB: ♻️ refactor: refactor to serverDB ENV #2612