Fix path encoding for ComponentDefinitionPath (#29794)

GitOrigin-RevId: 511ad4af1b0db0a3ed34f9d32d7c8afafee567ad

Author: Sujay Jayakar

npm-packages/convex/src/cli/lib/components.ts

@@ -39,7 +39,6 @@ import {
 } from "./deployApi/definitionConfig.js";
 import { typeCheckFunctionsInMode, TypeCheckMode } from "./typecheck.js";
 import { withTmpDir } from "../../bundler/fs.js";
-import { ROOT_DEFINITION_FILENAME } from "./components/constants.js";
 import { handleDebugBundlePath } from "./debugBundlePath.js";
 import chalk from "chalk";
 import { StartPushRequest, StartPushResponse } from "./deployApi/startPush.js";
@@ -52,16 +51,36 @@ import {
   DeveloperIndexConfig,
 } from "./deployApi/finishPush.js";
 import { Reporter, Span } from "./tracing.js";
+import {
+  DEFINITION_FILENAME_JS,
+  DEFINITION_FILENAME_TS,
+} from "./components/constants.js";
+
+async function findComponentRootPath(ctx: Context, functionsDir: string) {
+  // Default to `.ts` but fallback to `.js` if not present.
+  let componentRootPath = path.resolve(
+    path.join(functionsDir, DEFINITION_FILENAME_TS),
+  );
+  if (!ctx.fs.exists(componentRootPath)) {
+    componentRootPath = path.resolve(
+      path.join(functionsDir, DEFINITION_FILENAME_JS),
+    );
+  }
+  return componentRootPath;
+}
 
 export async function runCodegen(ctx: Context, options: CodegenOptions) {
   // This also ensures the current directory is the project root.
   await ensureHasConvexDependency(ctx, "codegen");
 
   const { configPath, projectConfig } = await readProjectConfig(ctx);
   const functionsDirectoryPath = functionsDir(configPath, projectConfig);
-  const componentRootPath = path.resolve(
-    path.join(functionsDirectoryPath, ROOT_DEFINITION_FILENAME),
+
+  const componentRootPath = await findComponentRootPath(
+    ctx,
+    functionsDirectoryPath,
   );
+
   if (ctx.fs.exists(componentRootPath)) {
     const deploymentSelection = deploymentSelectionFromOptions(options);
     const credentials = await fetchDeploymentCredentialsProvisionProd(
@@ -106,9 +125,7 @@ export async function runCodegen(ctx: Context, options: CodegenOptions) {
 export async function runPush(ctx: Context, options: PushOptions) {
   const { configPath, projectConfig } = await readProjectConfig(ctx);
   const convexDir = functionsDir(configPath, projectConfig);
-  const componentRootPath = path.resolve(
-    path.join(convexDir, ROOT_DEFINITION_FILENAME),
-  );
+  const componentRootPath = await findComponentRootPath(ctx, convexDir);
   if (ctx.fs.exists(componentRootPath)) {
     await runComponentsPush(ctx, options, configPath, projectConfig);
   } else {

npm-packages/convex/src/cli/lib/components/constants.ts

@@ -1,3 +1,2 @@
-export const ROOT_DEFINITION_FILENAME = "convex.config.ts";
-export const DEFINITION_FILENAME = "convex.config.ts";
-export const COMPILED_DEFINITION_FILENAME = "convex.config.js";
+export const DEFINITION_FILENAME_TS = "convex.config.ts";
+export const DEFINITION_FILENAME_JS = "convex.config.js";

npm-packages/convex/src/cli/lib/components/definition/bundle.ts

@@ -435,10 +435,6 @@ export async function bundleDefinitions(
         rootComponentDirectory,
         directory,
       ),
-      origDefinitionPath: toComponentDefinitionPath(
-        rootComponentDirectory,
-        directory,
-      ),
       definition: {
         path: path.relative(directory.path, outputJs.path),
         source: outputJs.text,

npm-packages/convex/src/cli/lib/components/definition/directoryStructure.ts

@@ -1,9 +1,8 @@
 import path from "path";
 import { Context } from "../../../../bundler/context.js";
 import {
-  COMPILED_DEFINITION_FILENAME,
-  DEFINITION_FILENAME,
-  ROOT_DEFINITION_FILENAME,
+  DEFINITION_FILENAME_JS,
+  DEFINITION_FILENAME_TS,
 } from "../constants.js";
 import { getFunctionsDirectoryPath } from "../../config.js";
 
@@ -19,8 +18,19 @@ import { getFunctionsDirectoryPath } from "../../config.js";
  * (e.g. 'convex-waitlist' instead of '../node_modules/convex-waitlist/convex.config.ts')
  */
 export type ComponentDirectory = {
+  /**
+   * Is this component directory for the root component?
+   */
   isRoot: boolean;
+
+  /**
+   * Absolute local filesystem path to the component definition's directory.
+   */
   path: string;
+
+  /**
+   * Absolute local filesystem path to the `convex.config.{ts,js}` file within the component definition.
+   */
   definitionPath: string;
 };
 
@@ -57,13 +67,11 @@ export function isComponentDirectory(
     return { kind: "err", why: `Not a directory` };
   }
 
-  // Check that we have a definition file.
-  let filename = isRoot
-    ? ROOT_DEFINITION_FILENAME
-    : COMPILED_DEFINITION_FILENAME;
+  // Check that we have a definition file, defaulting to `.ts` but falling back to `.js`.
+  let filename = DEFINITION_FILENAME_TS;
   let definitionPath = path.resolve(path.join(directory, filename));
   if (!ctx.fs.exists(definitionPath)) {
-    filename = isRoot ? ROOT_DEFINITION_FILENAME : DEFINITION_FILENAME;
+    filename = DEFINITION_FILENAME_JS;
     definitionPath = path.resolve(path.join(directory, filename));
   }
   if (!ctx.fs.exists(definitionPath)) {
@@ -128,15 +136,27 @@ export function toComponentDefinitionPath(
   rootComponent: ComponentDirectory,
   component: ComponentDirectory,
 ): ComponentDefinitionPath {
-  return path.relative(
+  // First, compute a file system relative path.
+  const relativePath: string = path.relative(
     rootComponent.path,
     component.path,
-  ) as ComponentDefinitionPath;
+  );
+
+  // Then, convert it to a ComponentDefinitionPath, which always uses POSIX conventions.
+  const definitionPath = relativePath.split(path.sep).join(path.posix.sep);
+
+  return definitionPath as ComponentDefinitionPath;
 }
 
 export function toAbsolutePath(
   rootComponent: ComponentDirectory,
   componentDefinitionPath: ComponentDefinitionPath,
 ) {
-  return path.normalize(path.join(rootComponent.path, componentDefinitionPath));
+  // Repeat the process from `toComponentDefinitionPath` in reverse: First
+  // convert to a relative local filesystem path, and then join it to
+  // the root component's absolute path.
+  const relativePath = componentDefinitionPath
+    .split(path.posix.sep)
+    .join(path.sep);
+  return path.normalize(path.join(rootComponent.path, relativePath));
 }

npm-packages/convex/src/cli/lib/config.ts

@@ -632,21 +632,19 @@ interface BundledModuleInfo {
 export type ComponentDefinitionSpec = {
   /** This path is relative to the app (root component) directory. */
   definitionPath: ComponentDefinitionPath;
-  /** This path is relative to the app (root component) directory. */
-  origDefinitionPath: ComponentDefinitionPath;
+
   /** Dependencies are paths to the directory of the dependency component definition from the app (root component) directory */
   dependencies: ComponentDefinitionPath[];
 
   // All other paths are relative to the directory of the definitionPath above.
-
   definition: Bundle;
   schema: Bundle;
   functions: Bundle[];
 };
 
 export type AppDefinitionSpec = Omit<
   ComponentDefinitionSpec,
-  "definitionPath" | "origDefinitionPath"
+  "definitionPath"
 > & {
   // Only app (root) component specs contain an auth bundle.
   auth: Bundle | null;