search

autolab / Autolab

Course management service that enables auto-graded programming assignments.
http://www.autolabproject.com/
Apache License 2.0
741 stars 209 forks source link

Use File.size? when checking for config files #2140

Closed damianhxy closed 3 months ago

damianhxy commented 3 months ago

Description

Use File.size? instead of File.exist? when checking the existence of config files, namely

Motivation and Context

For Docker compose installs, the Makefile automatically creates empty config files (using touch) when a user updates their installation. This is to avoid problems where the Docker volume mapping creates a directory instead of a file when the path does not exist.

However, the codebase currently uses File.exist? when checking for the existence of config files, which breaks since the empty config files do exist, causing the code to attempt to load configuration from blank files.

By replacing the size with File.size? instead, it returns nil when the file does not exist OR the file exists but is empty. This is the desired semantics.

How Has This Been Tested?

Create blank config files in the config subdirectory, e.g. touch smtp_config.yml github_config.yml oauth_config.yml lti_config.yml lti_platform_jwk.json lti_tool_jwk.json. Run Autolab.

Previously, there would be a variety of errors, starting with a failure to load github config.

After, Autolab should run fine, and e.g. the upload buttons for the LTI json files will not have the message saying that the files already exist.

Ensure that all relevant File existence checks in the codebase have been replaced with File.size?

Types of changes

Checklist:

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The recent updates across various controllers and configuration files in the application center around a shift from checking the existence of configuration files (such as `lti_config.yml`, `smtp_config.yml`, and various JSON Web Key files) to verifying their size using `File.size?`. This adjustment aims to enhance the file validation process, ensuring files not only exist but also contain content. Additionally, the `smtp_config_hash` now symbolizes keys, refining data handling within the SMTP configuration. ## Changes | File Path | Change Summary | |-----------|----------------| | `.../admins_controller.rb` | Modified `clear_cache` to check file size for `lti_config.yml` and `smtp_config.yml`; symbolized keys for `smtp_config_hash`. | | `.../lti_config_controller.rb`, `.../lti_launch_controller.rb`, `.../lti_nrps_controller.rb` | Replaced `File.exist?` with `File.size?` for file validation in LTI-related configurations and operations. | | `.../oauth_config_controller.rb` | Switched from file existence checks to file size checks before reading an OAuth configuration YAML file. | | `.../admins/_lti_integration.html.erb` | Updated logic to check for file size instead of existence for JSON file uploads (`lti_tool_jwk.json` and `lti_platform_jwk.json`). | | `config/environments/development.rb`, `config/environments/production.rb.template` | Changed file existence checks to file size checks for `github_config.yml` and `smtp_config.yml`, affecting configuration loading. |

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.