Uh oh!
There was an error while loading. Please reload this page.
[world-local] Finish renaming embedded world to local world - #441
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
🦋 Changeset detectedLatest commit: 9ba3c29 The changes in this PR will be included in the next version bump. This PR includes changesets to release 14 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
🔧 Build Fix:
The peer dependency specifier for @workflow/world-postgres is set to "*", which does not match prerelease versions when pnpm's frozen-lockfile validation is enabled. The specifier should be ">=4.1.0-beta.15" to match the current version in the workspace.
View Details
📝 Patch Details
diff --git a/packages/web/package.json b/packages/web/package.json
index eec8149..3b49cc0 100644
--- a/packages/web/package.json+++ b/packages/web/package.json@@ -29,7 +29,7 @@
"next": "15.5.4"
},
"peerDependencies": {
- "@workflow/world-postgres": "*"+ "@workflow/world-postgres": ">=4.1.0-beta.15"
},
"peerDependenciesMeta": {
"@workflow/world-postgres": {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 0d1684f..ae9dccb 100644
--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -776,7 +776,7 @@ importers:
packages/web:
dependencies:
'@workflow/world-postgres':
- specifier: '*'+ specifier: '>=4.1.0-beta.15'
version: 4.1.0-beta.15(@opentelemetry/api@1.9.0)(better-sqlite3@11.10.0)(pg@8.16.3)
next:
specifier: 15.5.4
Analysis
pnpm frozen-lockfile incompatible with prerelease peer dependency version
What fails:pnpm install --frozen-lockfile fails during the Vercel build because the peer dependency constraint in @workflow/web does not satisfy the prerelease version of @workflow/world-postgres.
How to reproduce:
pnpm install --frozen-lockfileResult:
[ERROR] ERR_PNPM_OUTDATED_LOCKFILE Cannot install with "frozen-lockfile" because pnpm-lock.yaml is not up to date with <ROOT>/packages/web/package.json
[ERROR] Failure reason:
[ERROR] The importer resolution is broken at dependency "@workflow/world-postgres": version "4.1.0-beta.15" doesn't satisfy range "*"
[ERROR] Error: Command "pnpm install" exited with 1
Root cause: The packages/web/package.json declares @workflow/world-postgres as an optional peer dependency with specifier "*", but pnpm's frozen-lockfile mode does not consider prerelease versions (like 4.1.0-beta.15) to match the "*" range. The pnpm-lock.yaml had become out of sync with the package.json.
Fix: Update the peer dependency specifier to explicitly include the prerelease version constraint ">=4.1.0-beta.15" so that pnpm can validate the lockfile correctly with frozen-lockfile enabled.
There was a problem hiding this comment.
Additional Suggestion:
The KNOWN_WORLDS array still has id: 'embedded' and displayName: 'Embedded', but the codebase now expects the backend to be 'local'. This will cause UI feature detection and conditional logic to fail.
View Details
📝 Patch Details
diff --git a/packages/web/src/lib/config-world.ts b/packages/web/src/lib/config-world.ts
index f2989b2..635b413 100644
--- a/packages/web/src/lib/config-world.ts+++ b/packages/web/src/lib/config-world.ts@@ -37,7 +37,7 @@ export interface WorldAvailability {
/**
* Check which world packages are installed.
*
- * Built-in worlds (embedded, vercel) are always available.+ * Built-in worlds (local, vercel) are always available.
* Third-party worlds are checked by attempting to resolve their package.
*/
export async function checkWorldsAvailability(): Promise<WorldAvailability[]> {
diff --git a/packages/web/src/lib/known-worlds.ts b/packages/web/src/lib/known-worlds.ts
index d26a61e..70af02f 100644
--- a/packages/web/src/lib/known-worlds.ts+++ b/packages/web/src/lib/known-worlds.ts@@ -22,13 +22,13 @@ export interface KnownWorld {
/**
* List of known worlds that can be configured in the UI.
*
- * Built-in worlds (embedded, vercel) are always available as they're bundled+ * Built-in worlds (local, vercel) are always available as they're bundled
* with @workflow/core. Third-party worlds need to be installed separately.
*/
export const KNOWN_WORLDS: KnownWorld[] = [
{
- id: 'embedded',- displayName: 'Embedded',+ id: 'local',+ displayName: 'Local',
packageName: null,
description: 'Local file-based storage, ideal for development',
isBuiltIn: true,
Analysis
KNOWN_WORLDS array has incorrect id 'embedded' instead of 'local'
What fails: The settings sidebar backend selector shows "Embedded" as the first option, but when selected, it sets backend: 'embedded'. All conditional logic throughout the codebase checks for backend === 'local', causing the local backend UI features (Port, Data Directory fields) to fail to render.
How to reproduce:
- Open the settings sidebar in the workflow web UI
- Click on the Backend dropdown
- Select "Embedded" (first option)
- Observe: Port and Data Directory input fields do NOT appear
- The
isLocalcheck in settings-sidebar.tsx (line 38) returns false, so the local-specific fields remain hidden
Result: When the first world is selected from the dropdown, backend becomes 'embedded' (from KNOWN_WORLDS[0].id), but all checks throughout the code look for backend === 'local':
- settings-sidebar.tsx line 38:
const isLocal = backend === 'local';→ returns false - connection-status.tsx line 28:
if (backend === 'local')→ skipped - config-world.ts line 76:
if (backend === 'local')→ validation skipped
Expected: The first world should have id: 'local' and displayName: 'Local' to match the backend === 'local' checks used throughout the codebase and the default value of backend: 'local' in config.ts.
Root cause: The KNOWN_WORLDS array was added after the embedding-to-local rename refactoring (commit 78e3917) was completed. The file was created in commit 109fe59 with the old 'embedded' identifier instead of the 'local' identifier used everywhere else.
There was a problem hiding this comment.
Additional Suggestion:
The documentation contains 19 outdated references to the old createEmbeddedWorld function name and WORKFLOW_EMBEDDED_* environment variables that should be createLocalWorld and WORKFLOW_LOCAL_* respectively.
View Details
📝 Patch Details
diff --git a/docs/content/docs/deploying/world/local-world.mdx b/docs/content/docs/deploying/world/local-world.mdx
index 717736e..ddd7a57 100644
--- a/docs/content/docs/deploying/world/local-world.mdx+++ b/docs/content/docs/deploying/world/local-world.mdx@@ -62,15 +62,15 @@ By default, workflow data is stored in `.workflow-data/` in your project root. T
**Environment variable:**
```bash
-export WORKFLOW_EMBEDDED_DATA_DIR=./custom-workflow-data+export WORKFLOW_LOCAL_DATA_DIR=./custom-workflow-data
```
**Programmatically:**
```typescript
-import { createEmbeddedWorld } from '@workflow/world-local';+import { createLocalWorld } from '@workflow/world-local';-const world = createEmbeddedWorld({ dataDir: './custom-workflow-data' });+const world = createLocalWorld({ dataDir: './custom-workflow-data' });
```
### Port
@@ -80,10 +80,10 @@ By default, the local world **automatically detects** which port your applicatio
**Auto-detection example** (recommended):
```typescript
-import { createEmbeddedWorld } from '@workflow/world-local';+import { createLocalWorld } from '@workflow/world-local';
// Port is automatically detected - no configuration needed!
-const world = createEmbeddedWorld();+const world = createLocalWorld();
```
If auto-detection fails, the world will fall back to the `PORT` environment variable, then to port `3000`.
@@ -93,9 +93,9 @@ If auto-detection fails, the world will fall back to the `PORT` environment vari
You can override the auto-detected port by specifying it explicitly:
```typescript
-import { createEmbeddedWorld } from '@workflow/world-local';+import { createLocalWorld } from '@workflow/world-local';-const world = createEmbeddedWorld({ port: 3000 });+const world = createLocalWorld({ port: 3000 });
```
### Base URL
@@ -111,21 +111,21 @@ For advanced use cases like HTTPS or custom hostnames, you can override the enti
**Environment variable:**
```bash
-export WORKFLOW_EMBEDDED_BASE_URL=https://local.example.com:3000+export WORKFLOW_LOCAL_BASE_URL=https://local.example.com:3000
```
**Programmatically:**
```typescript
-import { createEmbeddedWorld } from '@workflow/world-local';+import { createLocalWorld } from '@workflow/world-local';
// HTTPS
-const world = createEmbeddedWorld({+const world = createLocalWorld({
baseUrl: 'https://localhost:3000'
});
// Custom hostname
-const world = createEmbeddedWorld({+const world = createLocalWorld({
baseUrl: 'https://local.example.com:3000'
});
```
@@ -203,12 +203,12 @@ For production deployments, use the [Vercel World](/docs/deploying/world/vercel-
## API Reference
-### `createEmbeddedWorld`+### `createLocalWorld`
Creates a local world instance:
```typescript
-function createEmbeddedWorld(+function createLocalWorld(
args?: Partial<{
dataDir: string;
port: number;
@@ -220,9 +220,9 @@ function createEmbeddedWorld(
**Parameters:**
- `args` - Optional configuration object:
- - `dataDir` - Directory for storing workflow data (default: `.workflow-data/` or `WORKFLOW_EMBEDDED_DATA_DIR` env var)+ - `dataDir` - Directory for storing workflow data (default: `.workflow-data/` or `WORKFLOW_LOCAL_DATA_DIR` env var)
- `port` - Port override for queue transport (default: auto-detected → `PORT` env var → `3000`)
- - `baseUrl` - Full base URL override for queue transport (default: `http://localhost:{port}` or `WORKFLOW_EMBEDDED_BASE_URL` env var)+ - `baseUrl` - Full base URL override for queue transport (default: `http://localhost:{port}` or `WORKFLOW_LOCAL_BASE_URL` env var)
**Returns:**
@@ -231,24 +231,24 @@ function createEmbeddedWorld(
**Examples:**
```typescript
-import { createEmbeddedWorld } from '@workflow/world-local';+import { createLocalWorld } from '@workflow/world-local';
// Use all defaults (recommended - auto-detects port)
-const world = createEmbeddedWorld();+const world = createLocalWorld();
// Custom data directory
-const world = createEmbeddedWorld({ dataDir: './my-data' });+const world = createLocalWorld({ dataDir: './my-data' });
// Override port
-const world = createEmbeddedWorld({ port: 3000 });+const world = createLocalWorld({ port: 3000 });
// HTTPS with custom hostname
-const world = createEmbeddedWorld({+const world = createLocalWorld({
baseUrl: 'https://local.example.com:3000'
});
// Multiple options
-const world = createEmbeddedWorld({+const world = createLocalWorld({
dataDir: './my-data',
baseUrl: 'https://localhost:3000'
});
Analysis
Documentation contains outdated references to renamed createEmbeddedWorld function and environment variables
What fails: Developers following code examples in docs/content/docs/deploying/world/local-world.mdx will get import errors because the documented createEmbeddedWorld function no longer exists - it was renamed to createLocalWorld in the source code. Similarly, environment variable references to WORKFLOW_EMBEDDED_DATA_DIR and WORKFLOW_EMBEDDED_BASE_URL are outdated - they should be WORKFLOW_LOCAL_DATA_DIR and WORKFLOW_LOCAL_BASE_URL.
How to reproduce:
- Read the documentation at
docs/content/docs/deploying/world/local-world.mdx - Copy any of the code examples that uses
createEmbeddedWorld - Try to use it in a project:
import { createEmbeddedWorld } from '@workflow/world-local' - Get error: Module
@workflow/world-localhas no exported member namedcreateEmbeddedWorld
Evidence of the issue:
- Source code in
packages/world-local/src/index.tsexports onlycreateLocalWorld(), notcreateEmbeddedWorld() - Config in
packages/world-local/src/config.tsusesWORKFLOW_LOCAL_DATA_DIRandWORKFLOW_LOCAL_BASE_URLenvironment variables - Core orchestrator in
packages/core/src/runtime/world.tsimportscreateLocalWorld(confirming the API has been renamed) - Documentation contained 19 references to the old function name and environment variable names across multiple code examples and API reference sections
Resolution: Replaced all occurrences of:
createEmbeddedWorld→createLocalWorldWORKFLOW_EMBEDDED_DATA_DIR→WORKFLOW_LOCAL_DATA_DIRWORKFLOW_EMBEDDED_BASE_URL→WORKFLOW_LOCAL_BASE_URL
This ensures developers can now copy working code examples from the documentation.
…Name: 'Embedded'`\, but the codebase now expects the backend to be `'local'`\. This will cause UI feature detection and conditional logic to fail\.
…eateEmbeddedWorld` function name and `WORKFLOW_EMBEDDED_*` environment variables that should be `createLocalWorld` and `WORKFLOW_LOCAL_*` respectively\.
No description provided.