ti.sil/sourcebot
1
0
Fork 0
mirror of https://github.com/sourcebot-dev/sourcebot.git synced 2025-12-14 13:25:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add concept of environmentOverrides to config schema

Browse source
This commit is contained in:
bkellam 2025-11-02 12:01:37 -08:00
parent 5fde901356
commit 1d14ddc322
5 changed files with 476 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

282
packages/schemas/src/v3/index.schema.ts
View file

@ -134,6 +134,117 @@ const schema = {
} }
}, },
"additionalProperties": false "additionalProperties": false
},
"EnvironmentOverrides": {
"type": "object",
"description": "Environment variable overrides.",
"not": {
"$comment": "List of environment variables that are not allowed to be overridden.",
"anyOf": [
{
"required": [
"CONFIG_PATH"
]
}
]
},
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "token"
},
"value": {
"anyOf": [
{
"type": "object",
"properties": {
"env": {
"type": "string",
"description": "The name of the environment variable that contains the token."
}
},
"required": [
"env"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"googleCloudSecret": {
"type": "string",
"description": "The resource name of a Google Cloud secret. Must be in the format `projects/<project-id>/secrets/<secret-name>/versions/<version-id>`. See https://cloud.google.com/secret-manager/docs/creating-and-accessing-secrets"
}
},
"required": [
"googleCloudSecret"
],
"additionalProperties": false
}
]
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"value": {
"type": "number"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"value": {
"type": "boolean"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
}
]
}
}
} }
}, },
"properties": { "properties": {
@ -278,25 +389,29 @@ const schema = {
}, },
"additionalProperties": false "additionalProperties": false
}, },
"connections": { "environmentOverrides": {
"type": "object", "type": "object",
"description": "Defines a collection of connections from varying code hosts that Sourcebot should sync with. This is only available in single-tenancy mode.", "description": "Environment variable overrides.",
"not": {
"$comment": "List of environment variables that are not allowed to be overridden.",
"anyOf": [
{
"required": [
"CONFIG_PATH"
]
}
]
},
"patternProperties": { "patternProperties": {
"^[a-zA-Z0-9_-]+$": { "^[a-zA-Z0-9_-]+$": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ConnectionConfig",
"oneOf": [ "oneOf": [
{ {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object", "type": "object",
"title": "GithubConnectionConfig",
"properties": { "properties": {
"type": { "type": {
"const": "github", "const": "token"
"description": "GitHub Configuration"
}, },
"token": { "value": {
"description": "A Personal Access Token (PAT).",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -325,6 +440,113 @@ const schema = {
"additionalProperties": false "additionalProperties": false
} }
] ]
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"value": {
"type": "number"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"value": {
"type": "boolean"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
}
]
}
}
},
"connections": {
"type": "object",
"description": "Defines a collection of connections from varying code hosts that Sourcebot should sync with. This is only available in single-tenancy mode.",
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ConnectionConfig",
"oneOf": [
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "GithubConnectionConfig",
"properties": {
"type": {
"const": "github",
"description": "GitHub Configuration"
},
"token": {
"anyOf": [
{
"type": "object",
"properties": {
"env": {
"type": "string",
"description": "The name of the environment variable that contains the token."
}
},
"required": [
"env"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"googleCloudSecret": {
"type": "string",
"description": "The resource name of a Google Cloud secret. Must be in the format `projects/<project-id>/secrets/<secret-name>/versions/<version-id>`. See https://cloud.google.com/secret-manager/docs/creating-and-accessing-secrets"
}
},
"required": [
"googleCloudSecret"
],
"additionalProperties": false
}
],
"description": "A Personal Access Token (PAT)."
}, },
"url": { "url": {
"type": "string", "type": "string",
@ -504,7 +726,6 @@ const schema = {
"description": "GitLab Configuration" "description": "GitLab Configuration"
}, },
"token": { "token": {
"description": "An authentication token.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -532,7 +753,8 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "An authentication token."
}, },
"url": { "url": {
"type": "string", "type": "string",
@ -706,7 +928,6 @@ const schema = {
"description": "Gitea Configuration" "description": "Gitea Configuration"
}, },
"token": { "token": {
"description": "A Personal Access Token (PAT).",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -734,7 +955,8 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "A Personal Access Token (PAT)."
}, },
"url": { "url": {
"type": "string", "type": "string",
@ -973,7 +1195,6 @@ const schema = {
"description": "The username to use for authentication. Only needed if token is an app password." "description": "The username to use for authentication. Only needed if token is an app password."
}, },
"token": { "token": {
"description": "An authentication token.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -1001,7 +1222,8 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "An authentication token."
}, },
"url": { "url": {
"type": "string", "type": "string",
@ -1141,7 +1363,6 @@ const schema = {
"description": "Azure DevOps Configuration" "description": "Azure DevOps Configuration"
}, },
"token": { "token": {
"description": "A Personal Access Token (PAT).",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -1169,7 +1390,8 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "A Personal Access Token (PAT)."
}, },
"url": { "url": {
"type": "string", "type": "string",
@ -1425,7 +1647,6 @@ const schema = {
"description": "Optional display name." "description": "Optional display name."
}, },
"accessKeyId": { "accessKeyId": {
"description": "Optional access key ID to use with the model. Defaults to the `AWS_ACCESS_KEY_ID` environment variable.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -1453,10 +1674,10 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "Optional access key ID to use with the model. Defaults to the `AWS_ACCESS_KEY_ID` environment variable."
}, },
"accessKeySecret": { "accessKeySecret": {
"description": "Optional secret access key to use with the model. Defaults to the `AWS_SECRET_ACCESS_KEY` environment variable.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -1484,10 +1705,10 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "Optional secret access key to use with the model. Defaults to the `AWS_SECRET_ACCESS_KEY` environment variable."
}, },
"sessionToken": { "sessionToken": {
"description": "Optional session token to use with the model. Defaults to the `AWS_SESSION_TOKEN` environment variable.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -1515,7 +1736,8 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "Optional session token to use with the model. Defaults to the `AWS_SESSION_TOKEN` environment variable."
}, },
"region": { "region": {
"type": "string", "type": "string",
@ -2854,7 +3076,6 @@ const schema = {
"description": "Optional display name." "description": "Optional display name."
}, },
"accessKeyId": { "accessKeyId": {
"description": "Optional access key ID to use with the model. Defaults to the `AWS_ACCESS_KEY_ID` environment variable.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -2882,10 +3103,10 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "Optional access key ID to use with the model. Defaults to the `AWS_ACCESS_KEY_ID` environment variable."
}, },
"accessKeySecret": { "accessKeySecret": {
"description": "Optional secret access key to use with the model. Defaults to the `AWS_SECRET_ACCESS_KEY` environment variable.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -2913,10 +3134,10 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "Optional secret access key to use with the model. Defaults to the `AWS_SECRET_ACCESS_KEY` environment variable."
}, },
"sessionToken": { "sessionToken": {
"description": "Optional session token to use with the model. Defaults to the `AWS_SESSION_TOKEN` environment variable.",
"anyOf": [ "anyOf": [
{ {
"type": "object", "type": "object",
@ -2944,7 +3165,8 @@ const schema = {
], ],
"additionalProperties": false "additionalProperties": false
} }
] ],
"description": "Optional session token to use with the model. Defaults to the `AWS_SESSION_TOKEN` environment variable."
}, },
"region": { "region": {
"type": "string", "type": "string",

42
packages/schemas/src/v3/index.type.ts
View file

@ -44,6 +44,7 @@ export interface SourcebotConfig {
contexts?: { contexts?: {
[k: string]: SearchContext; [k: string]: SearchContext;
}; };
environmentOverrides?: EnvironmentOverrides;
/** /**
* Defines a collection of connections from varying code hosts that Sourcebot should sync with. This is only available in single-tenancy mode. * Defines a collection of connections from varying code hosts that Sourcebot should sync with. This is only available in single-tenancy mode.
*/ */
@ -159,6 +160,47 @@ export interface SearchContext {
*/ */
description?: string; description?: string;
} }
/**
* Environment variable overrides.
*
* This interface was referenced by `SourcebotConfig`'s JSON-Schema
* via the `definition` "EnvironmentOverrides".
*/
export interface EnvironmentOverrides {
/**
* This interface was referenced by `EnvironmentOverrides`'s JSON-Schema definition
* via the `patternProperty` "^[a-zA-Z0-9_-]+$".
*/
[k: string]:
| {
type: "token";
value:
| {
/**
* The name of the environment variable that contains the token.
*/
env: string;
}
| {
/**
* The resource name of a Google Cloud secret. Must be in the format `projects/<project-id>/secrets/<secret-name>/versions/<version-id>`. See https://cloud.google.com/secret-manager/docs/creating-and-accessing-secrets
*/
googleCloudSecret: string;
};
}
| {
type: "string";
value: string;
}
| {
type: "number";
value: number;
}
| {
type: "boolean";
value: boolean;
};
}
export interface GithubConnectionConfig { export interface GithubConnectionConfig {
/** /**
* GitHub Configuration * GitHub Configuration

96
packages/shared/src/env.ts
View file

@ -1,21 +1,107 @@
import { createEnv } from "@t3-oss/env-core"; import { createEnv } from "@t3-oss/env-core";
import { z } from "zod"; import { z } from "zod";
import { SOURCEBOT_CLOUD_ENVIRONMENT } from "./constants.js"; import { SOURCEBOT_CLOUD_ENVIRONMENT } from "./constants.js";
import { SourcebotConfig } from "@sourcebot/schemas/v3/index.type";
import { getTokenFromConfig } from "@sourcebot/crypto";
import { loadConfig } from "./utils.js";
// Booleans are specified as 'true' or 'false' strings.
const booleanSchema = z.enum(["true", "false"]);
// Numbers are treated as strings in .env files.
// coerce helps us convert them to numbers.
// @see: https://zod.dev/?id=coercion-for-primitives
const numberSchema = z.coerce.number();
const resolveEnvironmentVariableOverridesFromConfig = async (config: SourcebotConfig): Promise<Record<string, string>> => {
if (!config.environmentOverrides) {
return {};
}
const resolved: Record<string, string> = {};
console.debug('resolving environment variable overrides');
for (const [key, override] of Object.entries(config.environmentOverrides)) {
switch (override.type) {
case 'token':
resolved[key] = await getTokenFromConfig(override.value);
break;
case 'boolean':
resolved[key] = override.value ? 'true' : 'false';
break;
case 'number':
resolved[key] = override.value.toString();
break;
case 'string':
resolved[key] = override.value;
break;
}
}
return resolved;
}
// Merge process.env with environment variables resolved from config.json
const runtimeEnv = await (async () => {
const configPath = process.env.CONFIG_PATH;
if (!configPath) {
return process.env;
}
const config = await loadConfig(configPath);
const overrides = await resolveEnvironmentVariableOverridesFromConfig(config);
return {
...process.env,
...overrides,
}
})();
export const env = createEnv({ export const env = createEnv({
server: { server: {
SOURCEBOT_EE_LICENSE_KEY: z.string().optional(), SOURCEBOT_EE_LICENSE_KEY: z.string().optional(),
SOURCEBOT_PUBLIC_KEY_PATH: z.string(), SOURCEBOT_PUBLIC_KEY_PATH: z.string(),
SOURCEBOT_ENCRYPTION_KEY: z.string(),
SOURCEBOT_TELEMETRY_DISABLED: booleanSchema.default("false"),
SOURCEBOT_INSTALL_ID: z.string().default("unknown"),
DATA_CACHE_DIR: z.string(),
FALLBACK_GITHUB_CLOUD_TOKEN: z.string().optional(),
FALLBACK_GITLAB_CLOUD_TOKEN: z.string().optional(),
FALLBACK_GITEA_CLOUD_TOKEN: z.string().optional(),
REDIS_URL: z.string().url(),
REDIS_REMOVE_ON_COMPLETE: numberSchema.default(0),
REDIS_REMOVE_ON_FAIL: numberSchema.default(100),
LOGTAIL_TOKEN: z.string().optional(),
LOGTAIL_HOST: z.string().url().optional(),
SOURCEBOT_LOG_LEVEL: z.enum(["info", "debug", "warn", "error"]).default("info"),
DEBUG_ENABLE_GROUPMQ_LOGGING: booleanSchema.default('false'),
DATABASE_URL: z.string().url(),
CONFIG_PATH: z.string(),
CONNECTION_MANAGER_UPSERT_TIMEOUT_MS: numberSchema.default(300000),
REPO_SYNC_RETRY_BASE_SLEEP_SECONDS: numberSchema.default(60),
GITLAB_CLIENT_QUERY_TIMEOUT_SECONDS: numberSchema.default(60 * 10),
EXPERIMENT_EE_PERMISSION_SYNC_ENABLED: booleanSchema.default('false'),
AUTH_EE_GITHUB_BASE_URL: z.string().optional(),
AUTH_EE_GITLAB_BASE_URL: z.string().default("https://gitlab.com"),
}, },
client: { client: {
NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT: z.enum(SOURCEBOT_CLOUD_ENVIRONMENT).optional(), NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT: z.enum(SOURCEBOT_CLOUD_ENVIRONMENT).optional(),
NEXT_PUBLIC_SOURCEBOT_VERSION: z.string().default("unknown"),
NEXT_PUBLIC_POSTHOG_PAPIK: z.string().optional(),
NEXT_PUBLIC_SENTRY_BACKEND_DSN: z.string().optional(),
NEXT_PUBLIC_SENTRY_ENVIRONMENT: z.string().optional(),
}, },
clientPrefix: "NEXT_PUBLIC_", clientPrefix: "NEXT_PUBLIC_",
runtimeEnvStrict: { runtimeEnv,
SOURCEBOT_EE_LICENSE_KEY: process.env.SOURCEBOT_EE_LICENSE_KEY,
SOURCEBOT_PUBLIC_KEY_PATH: process.env.SOURCEBOT_PUBLIC_KEY_PATH,
NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT: process.env.NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT,
},
emptyStringAsUndefined: true, emptyStringAsUndefined: true,
skipValidation: process.env.SKIP_ENV_VALIDATION === "1", skipValidation: process.env.SKIP_ENV_VALIDATION === "1",
}); });

3
packages/shared/src/index.server.ts
View file

@ -25,3 +25,6 @@ export {
getConfigSettings, getConfigSettings,
} from "./utils.js"; } from "./utils.js";
export * from "./constants.js"; export * from "./constants.js";
export {
env
} from "./env.js";

87
schemas/v3/index.json
View file

@ -83,6 +83,90 @@
}, },
"SearchContext": { "SearchContext": {
"$ref": "./searchContext.json" "$ref": "./searchContext.json"
},
"EnvironmentOverrides": {
"type": "object",
"description": "Environment variable overrides.",
"not": {
"$comment": "List of environment variables that are not allowed to be overridden.",
"anyOf": [
{
"required": [
"CONFIG_PATH"
]
}
]
},
"patternProperties": {
"^[a-zA-Z0-9_-]+$": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "token"
},
"value": {
"$ref": "./shared.json#/definitions/Token"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"value": {
"type": "number"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"value": {
"type": "boolean"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
}
]
}
}
} }
}, },
"properties": { "properties": {
@ -102,6 +186,9 @@
}, },
"additionalProperties": false "additionalProperties": false
}, },
"environmentOverrides": {
"$ref": "#/definitions/EnvironmentOverrides"
},
"connections": { "connections": {
"type": "object", "type": "object",
"description": "Defines a collection of connections from varying code hosts that Sourcebot should sync with. This is only available in single-tenancy mode.", "description": "Defines a collection of connections from varying code hosts that Sourcebot should sync with. This is only available in single-tenancy mode.",