Skip to content

SDK drift: Python ServerManager primary alive-check method is is_server_alive(); TypeScript primary is isServerRunning() with isServerAlive() as a deprecated alias #1142

Description

@realfishsam

Summary

The two SDKs use different names as the primary server-alive check method. This is not a simple camelCase↔snake_case rename — the base word differs (alive vs running).

Python (sdks/python/pmxt/server_manager.py, line 333):

def is_server_alive(self) -> bool:
    """Check if the server is currently running and healthy."""

is_server_alive is the only public alive-check method. There is no is_server_running alias.

TypeScript (sdks/typescript/pmxt/server-manager.ts, lines 105–130):

/** Check if the server is running. */
async isServerRunning(): Promise<boolean> { ... }

/** Backwards-compatible alias for `isServerRunning()`. */
async isServerAlive(): Promise<boolean> {
    return this.isServerRunning();
}

isServerRunning is the primary method; isServerAlive is a backwards-compat alias.

Impact

  • Code ported from Python that calls server_manager.is_server_alive() has no exact camelCase twin in TypeScript (isServerAlive exists as an alias, but isServerRunning is the canonical name).
  • SDK documentation that references one name will be wrong for the other SDK.

Expected behaviour

Both SDKs should use the same base word. Either:

  • Python adds is_server_running() as the primary and aliases is_server_alive(), or
  • TypeScript promotes isServerAlive() and aliases isServerRunning().

The pmxt.server.health() wrapper already provides a language-neutral name; the underlying ServerManager method should be consistent.

Files

SDK File Lines
Python sdks/python/pmxt/server_manager.py 333
TypeScript sdks/typescript/pmxt/server-manager.ts 105–130

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions