feat(api,app): sync terminal session routing and mobile-ready web terminal flow

Author: skulidropek

packages/api/src/api/contracts.ts

@@ -362,6 +362,7 @@ export type TerminalSession = {
   readonly sshCommand: string
   readonly status: TerminalSessionStatus
   readonly createdAt: string
+  readonly attachedClients?: number | undefined
   readonly startedAt?: string | undefined
   readonly closedAt?: string | undefined
   readonly exitCode?: number | undefined

packages/api/src/api/schema.ts

@@ -269,6 +269,7 @@ export const TerminalSessionSchema = Schema.Struct({
   sshCommand: Schema.String,
   status: TerminalSessionStatusSchema,
   createdAt: Schema.String,
+  attachedClients: Schema.optional(Schema.Number),
   startedAt: OptionalString,
   closedAt: OptionalString,
   exitCode: Schema.optional(Schema.Number),

packages/api/src/http.ts

@@ -74,6 +74,7 @@ import {
   downAllProjects,
   downProject,
   getProject,
+  getProjectItemByKey,
   listProjects,
   readProjectLogs,
   readProjectPs,
@@ -106,7 +107,13 @@ import {
 } from "./services/project-port-forwards.js"
 import { proxyProjectPortForward } from "./services/project-port-proxy.js"
 import { parseProjectPortProxyPath } from "./services/project-port-proxy-core.js"
-import { createTerminalSession, deleteTerminalSession } from "./services/terminal-sessions.js"
+import {
+  createTerminalSession,
+  deleteTerminalSession,
+  getProjectTerminalSession,
+  listProjectTerminalSessions,
+  lookupTerminalSessionById
+} from "./services/terminal-sessions.js"
 import {
   commitStateFromRequest,
   initStateFromRequest,
@@ -121,6 +128,10 @@ const ProjectParamsSchema = Schema.Struct({
   projectId: Schema.String
 })
 
+const ProjectKeyParamsSchema = Schema.Struct({
+  projectKey: Schema.String
+})
+
 const ProjectPortForwardParamsSchema = Schema.Struct({
   projectId: Schema.String,
   targetPort: Schema.String
@@ -141,6 +152,11 @@ const TerminalSessionParamsSchema = Schema.Struct({
   sessionId: Schema.String
 })
 
+const TerminalSessionByProjectKeyParamsSchema = Schema.Struct({
+  projectKey: Schema.String,
+  sessionId: Schema.String
+})
+
 const ContainerTaskParamsSchema = Schema.Struct({
   projectId: Schema.String,
   pid: Schema.String
@@ -311,10 +327,12 @@ const errorResponse = (error: ApiError | unknown) => {
 }
 
 const projectParams = HttpRouter.schemaParams(ProjectParamsSchema)
+const projectKeyParams = HttpRouter.schemaParams(ProjectKeyParamsSchema)
 const projectPortForwardParams = HttpRouter.schemaParams(ProjectPortForwardParamsSchema)
 const projectDatabaseProfileParams = HttpRouter.schemaParams(ProjectDatabaseProfileParamsSchema)
 const agentParams = HttpRouter.schemaParams(AgentParamsSchema)
 const terminalSessionParams = HttpRouter.schemaParams(TerminalSessionParamsSchema)
+const terminalSessionByProjectKeyParams = HttpRouter.schemaParams(TerminalSessionByProjectKeyParamsSchema)
 const containerTaskParams = HttpRouter.schemaParams(ContainerTaskParamsSchema)
 const authTerminalSessionParams = HttpRouter.schemaParams(AuthTerminalSessionParamsSchema)
 
@@ -521,6 +539,14 @@ export const makeRouter = () => {
       "/auth/terminal-sessions/:sessionId/ws",
       terminalWebSocketUpgradeResponse.pipe(Effect.catchAll(errorResponse))
     ),
+    HttpRouter.get(
+      "/terminal-sessions/:sessionId",
+      Effect.gen(function*(_) {
+        const params = yield* _(authTerminalSessionParams)
+        const session = yield* _(lookupTerminalSessionById(params.sessionId))
+        return yield* _(jsonResponse(session, 200))
+      }).pipe(Effect.catchAll(errorResponse))
+    ),
     HttpRouter.del(
       "/auth/terminal-sessions/:sessionId",
       Effect.gen(function*(_) {
@@ -954,6 +980,58 @@ export const makeRouter = () => {
         Effect.catchAll(errorResponse)
       )
     ),
+    HttpRouter.post(
+      "/projects/by-key/:projectKey/terminal-sessions",
+      projectKeyParams.pipe(
+        Effect.flatMap(({ projectKey }) =>
+          getProjectItemByKey(projectKey).pipe(
+            Effect.flatMap((project) => createTerminalSession(project.projectDir))
+          )
+        ),
+        Effect.flatMap(({ project, session }) => jsonResponse({ ok: true, project, session }, 201)),
+        Effect.catchAll(errorResponse)
+      )
+    ),
+    HttpRouter.get(
+      "/projects/by-key/:projectKey/terminal-sessions",
+      projectKeyParams.pipe(
+        Effect.flatMap(({ projectKey }) =>
+          getProjectItemByKey(projectKey).pipe(
+            Effect.map((project) => ({ sessions: listProjectTerminalSessions(project.projectDir) }))
+          )
+        ),
+        Effect.flatMap((body) => jsonResponse(body, 200)),
+        Effect.catchAll(errorResponse)
+      )
+    ),
+    HttpRouter.get(
+      "/projects/by-key/:projectKey/terminal-sessions/:sessionId",
+      terminalSessionByProjectKeyParams.pipe(
+        Effect.flatMap(({ projectKey, sessionId }) =>
+          getProjectItemByKey(projectKey).pipe(
+            Effect.flatMap((project) => getProjectTerminalSession(project.projectDir, sessionId))
+          )
+        ),
+        Effect.flatMap((session) => jsonResponse({ session }, 200)),
+        Effect.catchAll(errorResponse)
+      )
+    ),
+    HttpRouter.get(
+      "/projects/by-key/:projectKey/terminal-sessions/:sessionId/ws",
+      terminalWebSocketUpgradeResponse.pipe(Effect.catchAll(errorResponse))
+    ),
+    HttpRouter.del(
+      "/projects/by-key/:projectKey/terminal-sessions/:sessionId",
+      terminalSessionByProjectKeyParams.pipe(
+        Effect.flatMap(({ projectKey, sessionId }) =>
+          getProjectItemByKey(projectKey).pipe(
+            Effect.flatMap((project) => deleteTerminalSession(project.projectDir, sessionId))
+          )
+        ),
+        Effect.flatMap(() => jsonResponse({ ok: true }, 200)),
+        Effect.catchAll(errorResponse)
+      )
+    ),
     HttpRouter.post(
       "/projects/:projectId/terminal-sessions",
       projectParams.pipe(
@@ -962,6 +1040,22 @@ export const makeRouter = () => {
         Effect.catchAll(errorResponse)
       )
     ),
+    HttpRouter.get(
+      "/projects/:projectId/terminal-sessions",
+      projectParams.pipe(
+        Effect.flatMap(({ projectId }) => Effect.succeed({ sessions: listProjectTerminalSessions(projectId) })),
+        Effect.flatMap((body) => jsonResponse(body, 200)),
+        Effect.catchAll(errorResponse)
+      )
+    ),
+    HttpRouter.get(
+      "/projects/:projectId/terminal-sessions/:sessionId",
+      terminalSessionParams.pipe(
+        Effect.flatMap(({ projectId, sessionId }) => getProjectTerminalSession(projectId, sessionId)),
+        Effect.flatMap((session) => jsonResponse({ session }, 200)),
+        Effect.catchAll(errorResponse)
+      )
+    ),
     HttpRouter.get(
       "/projects/:projectId/terminal-sessions/:sessionId/ws",
       terminalWebSocketUpgradeResponse.pipe(Effect.catchAll(errorResponse))

packages/api/src/services/projects.ts

@@ -262,6 +262,24 @@ const findProjectById = (projectId: string) =>
 
 export const getProjectItemById = (projectId: string) => findProjectById(projectId)
 
+const findProjectByKey = (projectKey: string) =>
+  Effect.gen(function*(_) {
+    const projects = yield* _(listProjectItems)
+    const matches = projects.filter((item) => projectShortKey(item.projectDir) === projectKey)
+    if (matches.length === 0) {
+      return yield* _(Effect.fail(new ApiNotFoundError({ message: `Project key not found: ${projectKey}` })))
+    }
+    if (matches.length > 1) {
+      return yield* _(Effect.fail(new ApiConflictError({ message: `Project key is ambiguous: ${projectKey}` })))
+    }
+    const project = matches[0]
+    return project === undefined
+      ? yield* _(Effect.fail(new ApiNotFoundError({ message: `Project key not found: ${projectKey}` })))
+      : project
+  })
+
+export const getProjectItemByKey = (projectKey: string) => findProjectByKey(projectKey)
+
 const resolveCreatedProject = (
   containerName: string,
   repoUrl: string,
@@ -772,3 +790,4 @@ export const readProjectLogs = (
   }).pipe(Effect.mapError(toProjectApiError))
 
 export const resolveProjectById = findProjectById
+export const resolveProjectByKey = findProjectByKey