mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-30 21:01:54 +08:00
## Problem
A user hit `Failed to register development environment session (500)`
when running the RDE (`hexclave dev` / `stack dev`). Removing
`defineStackConfig` from their `stack.config.ts` made it go away.
**Root cause:** the local dashboard evaluates the project's config file
in a plain Node context via `jiti`
([config-file.ts](apps/dashboard/src/lib/remote-development-environment/config-file.ts)).
When the config imports a *value* (e.g. `defineStackConfig`) from a
framework package like `@stackframe/stack` / `@hexclave/next`, jiti
executes the entire SDK — React, `server-only`, Next internals — which
throws in that context. The exception propagated as a bare 500. Dropping
`defineStackConfig` removed the value import, so jiti no longer loaded
the framework.
## Changes
**1. Graceful error (Fix 3)**
`readConfigFile` now wraps the `jiti.import` in try/catch and rethrows a
message pointing at the lightweight import path, instead of a raw 500.
**2. Lightweight `/config` subpath (Fix 1)**
Added a side-effect-free `./config` entrypoint to the framework packages
— `@hexclave/{js,next,react,tanstack-start}/config` — that re-exports
`defineHexclaveConfig` / `defineStackConfig` + the `HexclaveConfig` type
from `@hexclave/shared/config`, with **no framework runtime**. Source of
truth:
[`packages/template/src/config.ts`](packages/template/src/config.ts) +
the export in
[`package-template.json`](packages/template/package-template.json),
propagated to the generated packages via `generate-sdks`.
> Why per-package and not `@hexclave/shared/config`: `@hexclave/shared`
is only a *transitive* dependency from a user's perspective, so
importing from it fails under pnpm strict mode. Users depend on the
framework package directly, so `@hexclave/next/config` always resolves.
This was confirmed empirically — the previous tests that imported
`@hexclave/shared/config` were red.
**3. Docs / prompts / renderer aligned to the new path**
-
[`ai-setup-prompt.ts`](packages/shared/src/ai/unified-prompts/skill-site-prompt-parts/ai-setup-prompt.ts)
+ regenerated `docs-mintlify` (setup.mdx, llms-full.txt, snippets).
- Hand-written
[`hexclave-config.mdx`](docs-mintlify/guides/going-further/hexclave-config.mdx)
and
[`local-vs-cloud-dashboard.mdx`](docs-mintlify/guides/going-further/local-vs-cloud-dashboard.mdx).
(`docs/**` left untouched — legacy.)
- `renderConfigFileContent` (the config file the dashboard/CLI
auto-writes) now emits `import type { HexclaveConfig } from
"<pkg>/config"`. Legacy `@stackframe/*` packages predate the subpath, so
they keep their root import (guarded).
## Behavioral note
Existing config files that import from a package root get their import
line upgraded to `/config` on their next dashboard/CLI sync — a
one-time, harmless rewrite that migrates them onto the safe path. The
github-config-push idempotence test was updated to use the current
`/config` format so it still genuinely verifies "no spurious commit."
## Testing
- 43 unit tests pass across `config-file`, `github-config-push`,
`config-rendering`, `config-authoring`, `local-emulator`. The two
previously-red RDE `define*` tests now pass through jiti via
`@hexclave/next/config` (the real code path), and were made
resolution-stable by rooting their temp dir at the test file instead of
`process.cwd()`.
- Typecheck green on all source-changed packages (shared, cli, js, next,
react, tanstack-start). Lint clean.
- ⚠️ The two e2e suites (`cli.test.ts`, `config-local-emulator.test.ts`)
need backend+DB infra; their snapshot updates are mechanical and
**confirmable only in CI**.
<!-- This is an auto-generated description by cubic. -->
---
## Summary by cubic
Prevents 500s when loading `hexclave.config.ts` by adding a lightweight
`<pkg>/config` entrypoint and showing a clear, actionable error without
leaking framework stacks. Import detection, rendering, CLI, tests, and
docs now default to `/config` (including `@hexclave/tanstack-start`) so
configs load in plain Node contexts.
- **New Features**
- Added `/config` subpaths in `@hexclave/js`, `@hexclave/next`,
`@hexclave/react`, `@hexclave/tanstack-start` (and template)
re-exporting `defineHexclaveConfig`, `defineStackConfig`, and
`HexclaveConfig` with no framework runtime.
- Renderer, CLI, and docs import `HexclaveConfig` from `<pkg>/config`;
legacy `@stackframe/*` keep root imports. Existing config files
auto-upgrade on next dashboard/CLI sync.
- **Bug Fixes**
- Wrapped `jiti` config load with try/catch; capture raw error for
diagnostics and show a concise message pointing to `<pkg>/config` (no
nested framework stack traces).
- Import detection accepts optional `/config` suffix; renderer always
appends `/config` for Hexclave packages and recognizes
`@hexclave/tanstack-start`.
- Tests stabilized by scoping temp dirs to the test file; CLI error
example now references `HexclaveConfig` from `<pkg>/config` for Hexclave
packages.
<sup>Written for commit dfe7d5fee4.
Summary will update on new commits.</sup>
<a
href="https://cubic.dev/pr/hexclave/hexclave/pull/1557?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="Review in cubic"
src="https://cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>
<!-- End of auto-generated description by cubic. -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added lightweight "/config" subpath exports across SDK packages to
enable side-effect-free config authoring in plain Node contexts.
* **Documentation**
* Updated guides and snippets to recommend importing config types and
helpers from the "/config" entrypoint and added example usage.
* **Bug Fixes**
* Improved error messaging when dynamic config imports fail, with
guidance to use the "/config" entrypoint.
* **Tests**
* Adjusted tests and snapshots to expect normalized "/config" import
paths.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
147 lines
6.4 KiB
TypeScript
147 lines
6.4 KiB
TypeScript
import fs from "fs/promises";
|
|
import os from "os";
|
|
import path from "path";
|
|
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
import {
|
|
LOCAL_EMULATOR_HOST_MOUNT_ROOT_ENV,
|
|
isLocalEmulatorOnboardingEnabledInConfig,
|
|
readConfigFromFile,
|
|
writeConfigToFile,
|
|
writeShowOnboardingConfigToFile,
|
|
} from "./local-emulator";
|
|
|
|
describe("local emulator config", () => {
|
|
afterEach(() => {
|
|
vi.unstubAllEnvs();
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("reads config from STACK_LOCAL_EMULATOR_CONFIG_CONTENT env var when set", async () => {
|
|
const content = `export const config = { auth: { allowLocalhost: true } };\n`;
|
|
vi.stubEnv("STACK_LOCAL_EMULATOR_CONFIG_CONTENT", Buffer.from(content).toString("base64"));
|
|
|
|
await expect(readConfigFromFile("/irrelevant/path/stack.config.ts")).resolves.toMatchInlineSnapshot(`
|
|
{
|
|
"auth": {
|
|
"allowLocalhost": true,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("returns empty object when env var is not set and file does not exist", async () => {
|
|
await expect(readConfigFromFile("/nonexistent/stack.config.ts")).resolves.toEqual({});
|
|
});
|
|
|
|
it("returns empty object when env var content is empty", async () => {
|
|
const content = ``;
|
|
vi.stubEnv("STACK_LOCAL_EMULATOR_CONFIG_CONTENT", Buffer.from(content).toString("base64"));
|
|
|
|
await expect(readConfigFromFile("/irrelevant/path/stack.config.ts")).resolves.toEqual({});
|
|
});
|
|
|
|
it("treats show-onboarding config as an empty config override", async () => {
|
|
const content = `export const config = "show-onboarding";\n`;
|
|
vi.stubEnv("STACK_LOCAL_EMULATOR_CONFIG_CONTENT", Buffer.from(content).toString("base64"));
|
|
|
|
await expect(readConfigFromFile("/irrelevant/path/stack.config.ts")).resolves.toEqual({});
|
|
await expect(isLocalEmulatorOnboardingEnabledInConfig("/irrelevant/path/stack.config.ts")).resolves.toBe(true);
|
|
});
|
|
|
|
it("throws when the config module does not export config", async () => {
|
|
const content = `export default { auth: { allowLocalhost: true } };\n`;
|
|
vi.stubEnv("STACK_LOCAL_EMULATOR_CONFIG_CONTENT", Buffer.from(content).toString("base64"));
|
|
|
|
await expect(readConfigFromFile("/irrelevant/path/stack.config.ts")).rejects.toThrow(
|
|
"Error evaluating config in /irrelevant/path/stack.config.ts: Invalid config in /irrelevant/path/stack.config.ts. The file must export a plain `config` object or \"show-onboarding\"."
|
|
);
|
|
});
|
|
|
|
it("includes the config file path when static config parsing fails", async () => {
|
|
const content = `export const config = makeConfig();\n`;
|
|
vi.stubEnv("STACK_LOCAL_EMULATOR_CONFIG_CONTENT", Buffer.from(content).toString("base64"));
|
|
|
|
await expect(readConfigFromFile("/irrelevant/path/stack.config.ts")).rejects.toThrow(
|
|
"Error evaluating config in /irrelevant/path/stack.config.ts: Unsupported config expression: CallExpression"
|
|
);
|
|
});
|
|
|
|
it("reads config files from the host mount when configured", async () => {
|
|
const hostMountRoot = await fs.mkdtemp(path.join(os.tmpdir(), "stack-host-mount-"));
|
|
const absoluteFilePath = "/Users/foo/project/stack.config.ts";
|
|
const mountedFilePath = path.join(hostMountRoot, absoluteFilePath);
|
|
await fs.mkdir(path.dirname(mountedFilePath), { recursive: true });
|
|
await fs.writeFile(mountedFilePath, `export const config = { auth: { allowLocalhost: true } };\n`, "utf-8");
|
|
|
|
vi.stubEnv(LOCAL_EMULATOR_HOST_MOUNT_ROOT_ENV, hostMountRoot);
|
|
|
|
await expect(readConfigFromFile(absoluteFilePath)).resolves.toMatchInlineSnapshot(`
|
|
{
|
|
"auth": {
|
|
"allowLocalhost": true,
|
|
},
|
|
}
|
|
`);
|
|
});
|
|
|
|
it("writes new config files to the host mount when the mounted parent directory exists", async () => {
|
|
const hostMountRoot = await fs.mkdtemp(path.join(os.tmpdir(), "stack-host-mount-"));
|
|
const absoluteFilePath = "/Users/foo/project/stack.config.ts";
|
|
const mountedParentPath = path.join(hostMountRoot, "/Users/foo/project");
|
|
const mountedFilePath = path.join(hostMountRoot, absoluteFilePath);
|
|
await fs.mkdir(mountedParentPath, { recursive: true });
|
|
|
|
vi.stubEnv(LOCAL_EMULATOR_HOST_MOUNT_ROOT_ENV, hostMountRoot);
|
|
|
|
await writeConfigToFile(absoluteFilePath, { auth: { allowLocalhost: true } });
|
|
|
|
await expect(fs.readFile(mountedFilePath, "utf-8")).resolves.toBe(
|
|
`import type { HexclaveConfig } from "@hexclave/js/config";\n\nexport const config: HexclaveConfig = {\n "auth": {\n "allowLocalhost": true\n }\n};\n`
|
|
);
|
|
});
|
|
|
|
it("writes show-onboarding config files to the host mount", async () => {
|
|
const hostMountRoot = await fs.mkdtemp(path.join(os.tmpdir(), "stack-host-mount-"));
|
|
const absoluteFilePath = "/Users/foo/project/stack.config.ts";
|
|
const mountedParentPath = path.join(hostMountRoot, "/Users/foo/project");
|
|
const mountedFilePath = path.join(hostMountRoot, absoluteFilePath);
|
|
await fs.mkdir(mountedParentPath, { recursive: true });
|
|
|
|
vi.stubEnv(LOCAL_EMULATOR_HOST_MOUNT_ROOT_ENV, hostMountRoot);
|
|
|
|
await writeShowOnboardingConfigToFile(absoluteFilePath);
|
|
|
|
await expect(fs.readFile(mountedFilePath, "utf-8")).resolves.toBe(
|
|
`import type { StackConfig } from "@hexclave/js";\n\nexport const config: StackConfig = "show-onboarding";\n`
|
|
);
|
|
});
|
|
|
|
it("supports non-ts config filenames by evaluating them as TypeScript", async () => {
|
|
const hostMountRoot = await fs.mkdtemp(path.join(os.tmpdir(), "stack-host-mount-"));
|
|
const absoluteFilePath = "/Users/foo/project/test-config.untracked";
|
|
const mountedParentPath = path.join(hostMountRoot, "/Users/foo/project");
|
|
const mountedFilePath = path.join(hostMountRoot, absoluteFilePath);
|
|
await fs.mkdir(mountedParentPath, { recursive: true });
|
|
|
|
vi.stubEnv(LOCAL_EMULATOR_HOST_MOUNT_ROOT_ENV, hostMountRoot);
|
|
|
|
await writeConfigToFile(absoluteFilePath, { auth: { allowLocalhost: true } });
|
|
|
|
await expect(readConfigFromFile(absoluteFilePath)).resolves.toEqual({
|
|
auth: {
|
|
allowLocalhost: true,
|
|
},
|
|
});
|
|
await expect(fs.readFile(mountedFilePath, "utf-8")).resolves.toContain(`import type { HexclaveConfig }`);
|
|
});
|
|
|
|
it("fails loudly when the QEMU host mount root is configured but unavailable", async () => {
|
|
const hostMountRoot = await fs.mkdtemp(path.join(os.tmpdir(), "stack-host-mount-"));
|
|
vi.stubEnv(LOCAL_EMULATOR_HOST_MOUNT_ROOT_ENV, hostMountRoot);
|
|
|
|
await expect(writeConfigToFile("/Users/foo/project/stack.config.ts", { auth: { allowLocalhost: true } })).rejects.toThrow(
|
|
`Local emulator host mount root ${hostMountRoot} is configured`
|
|
);
|
|
});
|
|
});
|