zenflow / composite-service Goto Github PK

Add boolean colorOutput config defaulting to false.

Choose:

• https://www.npmjs.com/package/colorette
• https://www.npmjs.com/package/chalk
• https://www.npmjs.com/package/supports-color + https://github.com/chalk/ansi-styles

This also includes replacing tsdx which is blocking upgrading TypeScript, ESLint, etc.:

• bundling: microbundle or tsup
• linting: eslint & eslint-config-zenflow
• testing: unit testing needs to test TS source which also relies on Babel + babel-plugin-macros + ts-interface-builder/macro

For example, returning a Symbol would work to signal that the composite service should crash.
If there's an error in the onCrash, it should be logged and the service should be restarted.

Each line of output for each composed service has a prefix with some styles applied: bright background colors & default text color.
This looks fine when the terminal background is black/dark background, but sometimes terminal background is white/light and the contrast is not nice.

As titled

Config validation errors:

1. should show the invalid value
2. should show link to documentation for the relevant interface field
3. should include full description of type instead of "1 more" (issue for https://github.com/gristlabs/ts-interface-checker)
4. should not show stack trace (?)

Also, maybe validation errors for config.services.foo should appear like nested validation errors in config. Or maybe validation errors for config.serviceDefaults should not appear like nested validation errors in config.

Also, not an enhancement to functionality, but for maintainability gristlabs/ts-interface-builder#24 needs to be documented & an official release made.

The following interface would be useful for safely determining port numbers for your services.

type PortNumber = number | string

// Throw an error if the given `port` number is already in use
declare function assertPortFree(port: PortNumber): void

// Returns an array of port numbers that are not in use. 
declare function findPorts(numberOfPorts: number, options: { exclude: PortNumber | PortNumber[] }): number[]

// Example of using findPorts
const [apiPort, webPort] = findPorts(2, { exclude: PORT });

The function signatures above assume that we're only ever working with ports on localhost.
Should we support working with ports on other hosts?
Docker Machine runs on a different host than localhost on Windows, for example.

Describe similarities & differences between this library and others:

1. https://github.com/docker/compose
2. https://github.com/Unitech/pm2
3. https://github.com/godaddy/node-cluster-service
4. https://github.com/kimmobrunfeldt/concurrently

I'm thinking a composite service composing:

1. some node web app like a file manager or TODO tracker from awesome-selfhosted
2. an express.js backend that makes some calls to it
3. a static frontend with Parcel

Project should be able to run in either production or development mode.

Feature this in the docs introduction.

Also make sure docs refer to "ordered startup" instead of "graceful startup"

https://docs.docker.com/config/containers/multi-service_container/

Then remove item in TODO.md

And maybe share this project on reddit or wherever

1. nicer theme & styles/colors
   • https://v2.docusaurus.io/docs/theme-classic/#theme
   • https://v2.docusaurus.io/docs/styling-layout
2. github stars somwhere on website to encourage starring
3. include README badges & links, & possibly whole README (organizational change)
4. frontpage demo animation (show contents of a composite service script & results of running it)
5. site search https://docsearch.algolia.com/
6. sitemap - docusaurus-plugin-sitemap package?
7. social media meta tags - https://metatags.io
8. make landing page pleasant and or informative. For inspiration:
   • https://faastjs.org/
   • https://repeater.js.org/
   • https://gqless.dev/
   • https://uniforms.tools/

This should integrate with the proxy routes in a flexible way. For example, we should be able to mount static files at /admin and mount a proxy at / (default catch-all route) and vice-versa

https://expressjs.com/en/resources/middleware/serve-static.html

https://github.com/lukeed/polka#readme

Polka is faster and smaller than Express.

It seems that @semantic-release/release-notes-generator now outputs these headings as h1 (one #) instead of h2 (two #s).. Not sure why, since conventional-changelog-writer documentation shows use of h2 (##) here.

Interactive mode could be used to receive commands from keyboard input, such as:

1. Select service to direct keyboard input into
2. Restart a certain service on-the-fly
3. Stop a certain service's dependents, restart the certain service, start the certain service's dependents again

If there will be some kind of interactive UI in the terminal, it would also be nice to have a "dashboard line" displayed below the log tail and above the command prompt, which indicates the status of each service (e.g. starting, stopping, crashed)

This ink package looks pretty neato! Uses React, and this build system already compiles jsx.

• general editing
• less verbose Features section
• simplify/reduce Basic Usage section
• explain ServiceConfig.ready function before Crash Handling (which should be changed to Custom Crash Handling)
• Shutting down: detail "optional behaviors"
• Shutting Down: "hint" -> Caveats (need for windowsCtrlCShutdown /w e.g. nodemon)

and enhancements to README for https://github.com/zenflow/composite-service-http-gateway

https://github.com/maxogden/binary-split