flightdeck

[jeremybanka]

User description

• 🚧 draft of self-updating server process
• ♻️ class impl
• ❓ debugging... bun spawn doesn't work... 😠
• ✅ working service manager
• ✅ self-updating server
• 🚚 metaserver -> flight-deck
• 📦 flightdeck
• 🏷️ options
• ✨ bin
• 🚧 working on path optionsd
• 🏷️ improve comline's router interface
• 🚧 prepare to reimplement comline
• ♻️ reimplement comline
• 🏷️ enhance cli typings
• 🧹 clean up
• 🧪 experiment
• ✅ demo
• ✏️ fix typo
• ♻️ rework the schema script
• 🦋

---

PR Type

Enhancement, Tests

---

Description

• Implemented a self-updating server process using the FlightDeck class, including methods for starting, stopping, and updating services.
• Enhanced CLI interface with route-specific options and added support for JSON schema generation.
• Added tests for FlightDeck class functionality and updated existing tests to reflect changes in CLI handling.
• Fixed type definitions and event handling in CustomSocket and ParentSocket.
• Added README documentation and package configuration for FlightDeck.
• Configured build and testing options for FlightDeck using tsup and Vitest.

---

Changes walkthrough 📝

	Relevant files
Enhancement	4 files flightdeck.ts Implement self-updating server process with `FlightDeck` class packages/flightdeck/src/flightdeck.ts Implemented a self-updating server process using FlightDeck class. Added methods for starting, stopping, and updating services. Integrated HTTP2 server for webhook handling. +235/-0  break-check.x.ts Refactor CLI options handling and schema generation            packages/break-check/src/break-check.x.ts Refactored CLI options handling with OptionsGroup. Improved schema generation for CLI options. +100/-68 cli.ts Enhance CLI interface with route-specific options                packages/comline/src/cli.ts Enhanced CLI interface with route-specific options. Added support for JSON schema generation for CLI options. +77/-29  bin.ts Implement CLI entry point for `FlightDeck`                              packages/flightdeck/src/bin.ts Implemented CLI entry point for FlightDeck. Added command-line options parsing and schema generation. +113/-0
Tests	4 files positional-args.test.ts Update tests for CLI positional arguments and options        packages/comline/__tests__/positional-args.test.ts Updated tests to reflect changes in CLI positional arguments handling. Added tests for route-specific options. +42/-30  options.test.ts Update tests for new CLI options handling                                packages/comline/__tests__/options.test.ts Updated tests to verify new CLI options handling. Added tests for complex options parsing. +44/-36  config-file.test.ts Update tests for config file options handling                        packages/comline/__tests__/config-file.test.ts Updated tests to verify config file options handling. Added tests for overriding options with CLI arguments. +32/-28  flightdeck.test.ts Add tests for `FlightDeck` class functionality                      packages/flightdeck/__tests__/flightdeck.test.ts Added tests for FlightDeck class functionality. Verified service start and update processes. +76/-0
Bug fix	2 files custom-socket.ts Fix type definitions in `CustomSocket`                                      packages/atom.io/realtime-server/src/ipc-sockets/custom-socket.ts - Fixed type definitions for event listeners in `CustomSocket`. +7/-7      parent-socket.ts Correct event type handling in `ParentSocket`                        packages/atom.io/realtime-server/src/ipc-sockets/parent-socket.ts - Corrected event type handling in `ParentSocket`. +4/-4
Documentation	1 files README.md Add README documentation for `FlightDeck`                                packages/flightdeck/README.md Added README documentation for FlightDeck. Described the cycle and functionality of FlightDeck. +14/-0
Configuration changes	4 files package.json Add package configuration for `FlightDeck`                              packages/flightdeck/package.json Added package configuration for FlightDeck. Defined scripts and dependencies for the package. +49/-0    tsup.config.ts Configure build options for `FlightDeck`                                  packages/flightdeck/tsup.config.ts - Configured build options for `FlightDeck` using `tsup`. +19/-0    vitest.config.ts Add Vitest configuration for `FlightDeck`                                packages/flightdeck/vitest.config.ts - Added Vitest configuration for testing `FlightDeck`. +7/-0      tsconfig.json Configure TypeScript options for `FlightDeck`                        packages/flightdeck/tsconfig.json - Configured TypeScript compiler options for `FlightDeck`. +7/-0
Additional files (token-limit)	2 files my-app ...                                                                                                            packages/flightdeck/__tests__/demo/backup/repo/my-app ... +3829/-1 my-app ...                                                                                                            packages/flightdeck/__tests__/demo/current/repo/my-app ... +3829/-1

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
atom-io-fyi	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 7, 2024 6:42am
wayfarer-quest	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 7, 2024 6:42am

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: 57b09127158ba60465a24513749c581988899169

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

| Name | Type | | ----------- | ----- | | flightdeck | Patch | | comline | Minor | | break-check | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions[bot]]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 5 🔵🔵🔵🔵🔵

🧪 PR contains tests

🔒 No security concerns identified

⚡ Key issues to review Code Duplication The flags for `tagPattern` and `verbose` options are both set to `v`. This could lead to conflicts when parsing command line arguments. Consider using unique flags for each option. Error Handling The method `startService` recursively calls itself without a clear base case for stopping besides the `safety` counter. This could potentially lead to a stack overflow if the base case is not reached quickly. Consider implementing a more robust mechanism to handle retries, possibly with backoff strategy. Resource Management The method `applyUpdate` removes the backup directory and immediately recreates it which might lead to data loss if the process is interrupted. Consider implementing a more atomic approach to handle directory updates.

[github-actions[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible bug	Ensure that superResolve and superReject are defined before they are used in the Future class constructor ___ **The Future class constructor uses superResolve and superReject which are assigned inside the super constructor callback. This pattern might lead to issues if the executor function passed to Future executes synchronously and tries to call this.resolve or this.reject before they are assigned. To fix this, ensure that superResolve and superReject are defined before any potential synchronous execution of executor.** [packages/flightdeck/__tests__/demo/backup/repo/my-app [12-20]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-43854c4b6d08b902229b03f5b3459479a1f193dfded7ed7d480bce39998c7aedR12-R20) ```diff +let superResolve, superReject; super((resolve, reject) => { superResolve = resolve; superReject = reject; }); this.resolve = superResolve; this.reject = superReject; ``` Suggestion importance[1-10]: 9 Why: The suggestion addresses a potential bug where `superResolve` and `superReject` might not be assigned before being used, which is crucial for the correct functioning of the `Future` class. The improved code ensures these variables are defined before any synchronous execution, preventing possible runtime errors.	9
	Add a check to ensure bRelations exists before modifying it in the deleteRelation method of Junction ___ **The Junction class method deleteRelation does not handle the case where bRelations might be undefined after deleting a from bRelations. This can lead to a runtime error when trying to delete a from an undefined set. To prevent this, check if bRelations exists before attempting to modify it.** [packages/flightdeck/__tests__/demo/backup/repo/my-app [195-200]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-43854c4b6d08b902229b03f5b3459479a1f193dfded7ed7d480bce39998c7aedR195-R200) ```diff if (bRelations) { bRelations.delete(a); if (bRelations.size === 0) { this.relations.delete(b); } +} else { + this.relations.delete(b); } ``` Suggestion importance[1-10]: 8 Why: The suggestion correctly identifies a potential runtime error in the `deleteRelation` method and provides a fix to ensure `bRelations` is checked before modification. This improves the robustness of the code by preventing errors when `bRelations` is undefined.	8
	Add a check for options.set before calling it in the createWritableSelector function ___ **The createWritableSelector function does not handle the case where options.set might not be provided, leading to a potential runtime error when setSelf is called. To prevent this, add a default no-op function for options.set if it is not provided.** [packages/flightdeck/__tests__/demo/backup/repo/my-app [930-940]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-43854c4b6d08b902229b03f5b3459479a1f193dfded7ed7d480bce39998c7aedR930-R940) ```diff const setSelf = (next) => { const innerTarget = newest(store4); const oldValue = getSelf(options.get, innerTarget); const newValue = become(next)(oldValue); store4.logger.info(`\uD83D\uDCDD`, `selector`, options.key, `set (`, oldValue, `->`, newValue, `)`); cacheValue(options.key, newValue, subject4, innerTarget); markDone(innerTarget, options.key); if (isRootStore(innerTarget)) { subject4.next({ newValue, oldValue }); } - options.set(setterToolkit, newValue); + if (options.set) { + options.set(setterToolkit, newValue); + } }; ``` Suggestion importance[1-10]: 8 Why: The suggestion provides a safeguard against potential runtime errors by checking if `options.set` is defined before calling it. This is a good practice to ensure the function does not fail unexpectedly, enhancing the robustness of the `createWritableSelector` function.	8
	Add a check to ensure newValue is not undefined after calling become in the setAtom function ___ **The setAtom function does not handle the case where newValue might be undefined after calling become(next)(newValue). This can lead to unexpected behavior if become returns undefined. To fix this, add a check to ensure newValue is not undefined before proceeding with further operations.** [packages/flightdeck/__tests__/demo/backup/repo/my-app [624]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-43854c4b6d08b902229b03f5b3459479a1f193dfded7ed7d480bce39998c7aedR624-R624) ```diff -newValue = become(next)(newValue); +const updatedValue = become(next)(newValue); +if (updatedValue !== undefined) { + newValue = updatedValue; +} ``` Suggestion importance[1-10]: 7 Why: The suggestion addresses a potential issue where `newValue` could be `undefined`, which might lead to unexpected behavior. Adding a check for `undefined` improves the reliability of the `setAtom` function, although the impact might be less critical compared to other suggestions.	7
Enhancement	Remove the redundant type definition that directly maps types without modification ___ **The type Flat is redundant as it directly maps types without modification. Consider removing it if it does not serve additional purposes beyond direct type mapping.** [packages/comline/src/tree.ts [33-35]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-7b69c51d4a258f92c427555d39cf16265f7cd3f5b4f49abfda7e1be25c91924aR33-R35) ```diff -export type Flat = { - [K in keyof R]: R[K] -} +// Removed redundant type definition ``` Suggestion importance[1-10]: 8 Why: Removing the redundant type definition simplifies the code and eliminates unnecessary complexity, which is a good practice for code clarity and maintainability.	8
Maintainability	Simplify the conditional type logic by extracting repeated checks into a utility type ___ **Consider simplifying the conditional type logic by extracting the repeated conditional checks into a separate utility type or function. This will make the code more readable and maintainable.** [packages/comline/src/tree.ts [13-23]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-7b69c51d4a258f92c427555d39cf16265f7cd3f5b4f49abfda7e1be25c91924aR13-R23) ```diff +type ConditionalString = K extends `$${string}` ? string & {} : K; + export type TreePath = { [K in keyof T[1]]: T[0] extends `required` ? T[1][K] extends Tree - ? [K extends `$${string}` ? string & {} : K, ...TreePath] - : [K extends `$${string}` ? string & {} : K] + ? [ConditionalString, ...TreePath] + : [ConditionalString] : | (T[1][K] extends Tree - ? [K extends `$${string}` ? string & {} : K, ...TreePath] - : [K extends `$${string}` ? string & {} : K]) + ? [ConditionalString, ...TreePath] + : [ConditionalString]) | [] }[keyof T[1]] ``` Suggestion importance[1-10]: 7 Why: The suggestion improves code readability and maintainability by reducing repetition in the conditional type logic, which is beneficial for future code modifications and understanding.	7
Performance	Optimize the recursive type Join by using template literal types more effectively ___ **The recursive type Join can be optimized by using template literal types more effectively, reducing the need for complex conditional types.** [packages/comline/src/tree.ts [41-50]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-7b69c51d4a258f92c427555d39cf16265f7cd3f5b4f49abfda7e1be25c91924aR41-R50) ```diff -export type Join< - Arr extends any[], - Separator extends string = ``, -> = Arr extends [] - ? `` - : Arr extends [infer First extends string] - ? First - : Arr extends [infer First extends string, ...infer Rest extends string[]] - ? `${First}${Separator}${Join}` - : string +export type Join = Arr extends [infer First extends string, ...infer Rest extends string[]] + ? `${First}${Separator}${Join}` + : Arr extends [infer Last extends string] ? Last : ``; ``` Suggestion importance[1-10]: 6 Why: The optimization suggestion is valid and can improve performance slightly by simplifying the recursive type logic, although the impact is minor.	6
Possible issue	Add error handling to the ToPath type for unexpected string formats ___ **For the ToPath type, consider adding error handling or a default case to manage unexpected string formats that do not match the expected template literal types.** [packages/comline/src/tree.ts [52-61]](https://github.com/jeremybanka/wayforge/pull/2531/files#diff-7b69c51d4a258f92c427555d39cf16265f7cd3f5b4f49abfda7e1be25c91924aR52-R61) ```diff export type ToPath< S extends string, D extends string, > = S extends `${infer T extends string}${D}${infer U extends string}` ? T extends `$${string}` ? [string & {}, ...ToPath] : [T, ...ToPath] : S extends `$${string}` ? [string & {}] - : [S] + : S extends string ? [S] : never; // Added handling for unexpected formats ``` Suggestion importance[1-10]: 5 Why: Adding error handling for unexpected formats is a good practice for robustness, but the suggestion's impact is limited as it addresses a potential edge case rather than a common issue.	5

[coveralls]

coverage: 92.494%. remained the same when pulling 57b09127158ba60465a24513749c581988899169 on flightdeck into 1b3e304025ef559c285823c8b7a6d1428140cb57 on main.