Simplifying DBOS TypeScript Syntax #656
Conversation
Co-authored-by: Harry Pierson <harrypierson@hotmail.com> Signed-off-by: chuck-dbos <134347445+chuck-dbos@users.noreply.github.com>
100%. The entrypoints way has huge advantages for people building new apps that want the features we started with... and there are some. There's a lot less code for something that does just scheduled workflows, say. But we will need the startup command for some of the new usecases. |
| async function main() { | ||
| await DBOS.launch({expressApp: app}); | ||
|
|
||
| const PORT = DBOS.runtimeConfig?.port ?? 9000; |
There was a problem hiding this comment.
Nit: The default port for Express.js is 3000. Why do we use 9000 here?
There was a problem hiding this comment.
What port does the DBOS Cloud forward?
There was a problem hiding this comment.
DBOS Cloud forwards to 3000 for node.js apps and 8000 for Python apps.
| // DBOS uses TypeScript decorators to automatically make your functions reliable, so they need to be static. | ||
| export class Hello { | ||
| // Serve this function from HTTP GET requests at the /greeting endpoint with 'user' as a path parameter | ||
| @DBOS.getApi("/greeting/:user") |
There was a problem hiding this comment.
If we want to eventually get rid of getApi and other HTTP verbs, we should use Koa directly here.
There was a problem hiding this comment.
Disagree strongly.
There was a problem hiding this comment.
We can discuss this some other time -- maintaining a thin wrapper around Koa is pretty annoying. Remember the times we wanted to support CORS and preflight requests :/
There was a problem hiding this comment.
Agree with one part of the Koa point (features have to be added in the framework), strong disagree on the CORS part, baking that into your code is bad and should be managed by the deployment, which we can do better if we help you in a "serverless" way.
src/context.ts
Outdated
| idAssignedForNextWorkflow?: string; | ||
| queueAssignedForWorkflows?: string; | ||
| parentWorkflowId?: string; | ||
| parentWorkflowFid?: number; |
There was a problem hiding this comment.
What is this? This field is not used anywhere. Same as parentWorkflowId
If we can already access parentCtx, then these fields are not necessary.
Yeah, this is permits an incremental upgrade without having file-specific TS compiler settings. Have they made a better decorator scheme for TS? A year ago, the successor was neither better nor final. |
Main Change - New API
In addition to supporting all prior API constructs, DBOS Transact Typescript has a new API that does not require passing contexts around between functions. (This was inspired by the relative simplicity of the Python API.) Instead, functionality is accessed by
DBOS.<thing>, such as@DBOS.workfloworDBOS.knexClientorDBOS.authenticatedUser. You can mix old and new code.Second Big Change - Library Usage
DBOS can now be used as a library, or within Express.js or other frameworks, rather than just as serverless Koa-based entrypoints. Examples and guidance are evolving.
Other Items
Recovery has been moved to after init.