feat(sdk): support custom port for router resource

.changeset/unlucky-mails-shave.md

@@ -0,0 +1,8 @@
+---
+"@plutolang/pluto-infra": patch
+"@plutolang/pluto": patch
+---
+
+feat(sdk): add support for configuring host and port for router resource
+
+This change introduces the ability to specify custom host and port settings for router resources, enhancing flexibility during local development.

packages/base-py/CHANGELOG.md

@@ -1,5 +1,9 @@
 # pluto-base
 
+## 0.0.8
+
+chore: add some debug logs
+
 ## 0.0.7
 
 feat: update resource ID generation to handle Unicode characters

packages/base-py/pluto_base/resource.py

@@ -1,3 +1,4 @@
+import os
 from abc import ABC
 from typing import Callable, List, Type
 
@@ -107,13 +108,19 @@ def __getattribute__(self, name: str):
         # Check if the attribute is an infrastructure API, if it is, return an empty lambda.
         infra_apis = self.__get_infra_apis()
         if name in infra_apis:
+            if os.getenv("DEBUG", False):
+                print(f"Skipping infrastructure API: {name}")
             return _empty_lambda
 
         # Try to get the attribute from the client, if it doesn't exist, return the attribute of
         # self. This is to make sure that the client is the first priority.
         try:
+            if os.getenv("DEBUG", False):
+                print(f"Getting attribute from _client: {name}")
             return getattr(self._client, name)
         except:
             # If the _client doesn't exist, or the attribute doesn't exist in the client, return the
             # attribute of self.
+            if os.getenv("DEBUG", False):
+                print(f"Getting attribute from self: {name}")
             return super().__getattribute__(name)

packages/base-py/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pluto-base"
-version = "0.0.7"
+version = "0.0.8"
 description = "The Base Library for Pluto Programming Language."
 authors = ["Jade Zheng <[email protected]>"]
 license = "Apache-2.0"

packages/pluto-infra/src/simulator/router.ts

@@ -17,38 +17,81 @@ import { SimFunction } from "./function";
 
 const VALID_HTTP_METHODS = ["get", "post", "put", "delete"];
 
+/**
+ * Adapts the options to the correct names for TypeScript.
+ * The option names for TypeScript and Python are different, so this function converts Python-style
+ * option names to TypeScript-style option names.
+ *
+ * @param opts - The options object that may contain Python-style option names.
+ * @returns The adapted options object with TypeScript-style option names.
+ */
+function adaptOptions(opts?: any): RouterOptions | undefined {
+  if (opts === undefined) {
+    return;
+  }
+
+  if (opts.sim_host) {
+    opts.simHost = opts.sim_host;
+  }
+  if (opts.sim_port) {
+    opts.simPort = opts.sim_port;
+  }
+  return opts;
+}
+
 export class SimRouter implements IResourceInfra, IRouterInfra, IRouterClient {
   public readonly id: string;
 
-  private readonly expressApp: express.Application;
-  private httpServer: http.Server;
+  private expressApp?: express.Express;
+  private httpServer?: http.Server;
+  private host: string;
   private port: number;
 
-  public outputs: string;
+  public outputs?: string;
 
   constructor(name: string, opts?: RouterOptions) {
+    opts = adaptOptions(opts);
+
     this.id = genResourceId(Router.fqn, name);
 
+    this.host = opts?.simHost ?? "localhost";
+    this.port = parseInt(opts?.simPort ?? "0");
+  }
+
+  public async init() {
     this.expressApp = express();
     this.expressApp.use(cors());
     this.expressApp.use(bodyParser.urlencoded({ extended: false }));
     this.expressApp.use(bodyParser.json());
 
-    this.httpServer = this.expressApp.listen(0);
-    const address = this.httpServer.address();
-    if (address && typeof address !== "string") {
-      this.port = address.port;
-    } else {
-      throw new Error(`Failed to obtain the port for the router: ${name}`);
+    const httpServer = this.expressApp.listen(this.port, this.host);
+    this.httpServer = httpServer;
+
+    async function waitForServerReady() {
+      return await new Promise<number>((resolve, reject) => {
+        httpServer.on("listening", () => {
+          const address = httpServer.address();
+          if (address && typeof address !== "string") {
+            resolve(address.port);
+          } else {
+            reject(new Error(`Failed to obtain the port for the router`));
+          }
+        });
+
+        httpServer.on("error", (err) => {
+          console.error(err);
+          reject(err);
+        });
+      });
     }
-    this.outputs = this.url();
+    const realPort = await waitForServerReady();
+    this.port = realPort;
 
-    name;
-    opts;
+    this.outputs = this.url();
   }
 
   public url(): string {
-    return `http://localhost:${this.port}`;
+    return `http://${this.host}:${this.port}`;
   }
 
   public async setup() {}
@@ -85,7 +128,7 @@ export class SimRouter implements IResourceInfra, IRouterInfra, IRouterClient {
 
     const func = new SimFunction(closure);
 
-    this.expressApp[method](
+    this.expressApp![method](
       path,
       async (req: express.Request, res: express.Response, next: express.NextFunction) => {
         const reqPluto: HttpRequest = {

packages/pluto-infra/src/simulator/website.ts

@@ -1,4 +1,5 @@
 import fs from "fs";
+import http from "http";
 import path from "path";
 import cors from "cors";
 import express from "express";
@@ -37,6 +38,7 @@ export class SimWebsite implements IResourceInfra, IWebsiteInfra, IWebsiteClient
 
   private host: string;
   private port: number;
+  private httpServer?: http.Server;
 
   public outputs?: string;
 
@@ -57,6 +59,7 @@ export class SimWebsite implements IResourceInfra, IWebsiteInfra, IWebsiteClient
     expressApp.use(express.static(this.websiteDir));
 
     const httpServer = expressApp.listen(this.port, this.host);
+    this.httpServer = httpServer;
 
     async function waitForServerReady() {
       return await new Promise<number>((resolve, reject) => {
@@ -112,6 +115,10 @@ export class SimWebsite implements IResourceInfra, IWebsiteInfra, IWebsiteClient
     if (this.originalPlutoJs) {
       fs.writeFileSync(plutoJsPath, this.originalPlutoJs);
     }
+
+    if (this.httpServer) {
+      this.httpServer.close();
+    }
   }
 }
 

packages/pluto-py/CHANGELOG.md

@@ -1,5 +1,11 @@
 # pluto-client
 
+## 0.0.20
+
+feat(sdk): add support for configuring host and port for website and router resource
+
+This change introduces the ability to specify custom host and port settings for website and router resources, enhancing flexibility during local development.
+
 ## 0.0.19
 
 feat: remove runtime dependency for AWS account ID retrieval

packages/pluto-py/pluto_client/router.py

@@ -26,7 +26,21 @@ class HttpResponse:
 
 @dataclass
 class RouterOptions:
-    pass
+    cors: Optional[bool] = None
+    """
+    Currently, only support Vercel. If an invalid value is provided, or if no value is provided at
+    all, it will default to your specified platform.
+    """
+    sim_host: Optional[str] = None
+    """
+    Host address for simulating the website when running the project with `pluto run`. If not
+    provided, it will be `localhost`.
+    """
+    sim_port: Optional[str] = None
+    """
+    Port number for simulating the website when running the project with `pluto run`. If not
+    provided, it will be randomly assigned.
+    """
 
 
 class IRouterClientApi(resource.IResourceClientApi):

packages/pluto-py/pluto_client/website.py

@@ -9,7 +9,7 @@
     IResourceInfraApi,
 )
 
-from .universal_class import UniversalClass
+from .utils import create_simulator_client
 
 
 @dataclass
@@ -67,7 +67,8 @@ def __init__(
             from .clients import shared
 
             self._client = shared.WebsiteClient(path, name, opts)
-        if platform_type in [PlatformType.Simulator]:
-            self._client = UniversalClass() # type: ignore
+        if platform_type == PlatformType.Simulator:
+            resource_id = utils.gen_resource_id(Website.fqn, name or "default")
+            self._client = create_simulator_client(resource_id)  # type: ignore
         else:
             raise ValueError(f"not support this runtime '{platform_type}'")

packages/pluto-py/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pluto-client"
-version = "0.0.19"
+version = "0.0.20"
 description = "The Client Library for Pluto Programming Language."
 authors = ["Jade Zheng <[email protected]>"]
 license = "Apache-2.0"

packages/pluto/src/router.ts

@@ -38,6 +38,18 @@ export interface RouterOptions {
    * and include the appropriate CORS headers in responses. @default true
    */
   cors?: boolean;
+
+  /**
+   * Host address for simulating the website when running the project with `pluto run`. If not
+   * provided, it will be `localhost`.
+   */
+  simHost?: string;
+
+  /**
+   * Port number for simulating the website when running the project with `pluto run`. If not
+   * provided, it will be a random port.
+   */
+  simPort?: string;
 }
 
 /**