search

appsmithorg / appsmith

Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
https://www.appsmith.com
Apache License 2.0
34.66k stars 3.75k forks source link

chore: Port `ctl` code to Typescript #37606

Closed sharat87 closed 21 hours ago

sharat87 commented 1 day ago

This PR converts the Javscript code of the ctl module, into Typescript, and in the process already fixing two small bugs that went undetected because... of lack of good type checking.

The linting exceptions are still there and will be removed in the next PR. Didn't want to change anymore than necessary or Git will detect these changes as "new files" instead of as "renames".

Automation

/test sanity

:mag: Cypress test results

[!TIP] 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11949059369 Commit: e156dacbc5cb513030052535c3d1f25ce1c7f222 Cypress dashboard. Tags: @tag.Sanity Spec:

Thu, 21 Nov 2024 08:45:48 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 day ago

Walkthrough

The changes in this pull request primarily involve transitioning from CommonJS to ES module syntax across various files in the app/client/packages/rts directory. Key modifications include updating import statements, changing function declarations to use the export keyword, and enhancing type safety in TypeScript files. Additionally, the entry point for the bundler has been updated to use a TypeScript file. New type definitions have been added for better type safety, and several constants have been introduced in a new constants.ts file.

Changes

File Path Change Summary
app/client/packages/rts/build.js Updated entry point from src/ctl/index.js to src/ctl/index.ts.
app/client/packages/rts/package.json Added @types/nodemailer and @types/readline-sync to devDependencies.
app/client/packages/rts/src/ctl/backup.test.ts Converted require statements to import, added Jest mocks, and updated variable declarations.
app/client/packages/rts/src/ctl/backup.ts Transitioned to ES module syntax, exported several functions, and removed the module exports section.
app/client/packages/rts/src/ctl/check_replica_set.ts Updated to ES module syntax, added type definitions, and exported the exec function.
app/client/packages/rts/src/ctl/constants.js Deleted file containing constants related to backup operations.
app/client/packages/rts/src/ctl/constants.ts Introduced new constants for backup and restore operations.
app/client/packages/rts/src/ctl/export_db.ts Transitioned to ES module syntax and exported exportDatabase and run functions.
app/client/packages/rts/src/ctl/import_db.ts Updated to ES module syntax, added type annotations, and exported the run function.
app/client/packages/rts/src/ctl/index.ts Converted to ES module syntax, streamlined command handling, and updated import statements.
app/client/packages/rts/src/ctl/logger.ts Transitioned to ES module syntax and exported backup_error and backup_info functions.
app/client/packages/rts/src/ctl/mailer.ts Updated to ES module syntax and exported sendBackupErrorToAdmins function.
app/client/packages/rts/src/ctl/mongo_shell_utils.ts Transitioned to ES module syntax and exported exec function.
app/client/packages/rts/src/ctl/restore.ts Updated to ES module syntax and exported run function.
app/client/packages/rts/src/ctl/utils.test.ts Converted require statements to import, no changes to test cases.
app/client/packages/rts/src/ctl/utils.ts Transitioned to ES module syntax, updated function exports, and added return types.
app/client/packages/rts/src/ctl/version.ts Updated to ES module syntax and exported exec function.

Possibly related PRs

Suggested labels

Task, Frontend

Suggested reviewers

"In code we trust, with types so bright,
From JS to TS, we take flight.
Imports now clear, exports in sight,
Our backups and restores, all done right!
With constants anew, our paths align,
In the world of code, we surely shine!" 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
sharat87 commented 21 hours ago

Deferring CodeRabbit suggestions to the next PR so I don't change the files too much. I want Git to treat the changes as file renames instead of deletions+additions.