damongolding / immich-kiosk

Immich Kiosk is a lightweight slideshow for running on kiosk devices and browsers that uses Immich as a data source.
GNU Affero General Public License v3.0
535 stars 19 forks source link

Allow a weather location to be set as the default #193

Closed damongolding closed 6 days ago

damongolding commented 6 days ago

Summary by CodeRabbit

Release Notes

These changes improve user experience by ensuring accurate weather information and enhancing the overall functionality of the application.

coderabbitai[bot] commented 6 days ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduced in this pull request primarily enhance the management of weather locations within the application. A new boolean field, Default, has been added to the WeatherLocation struct, allowing identification of a default weather location. The Config struct now tracks whether any weather location is set as default through the HasWeatherDefault field. Additionally, modifications have been made to various route handlers and templates to incorporate this default weather logic, improving error handling and rendering conditions based on the presence of a default setting.

Changes

File Change Summary
config/config.go Added Default bool \mapstructure:"default"`toWeatherLocation; addedHasWeatherDefault bool `json:"-" default:"false"`toConfig; modifiedcheckWeatherLocations` method.
routes/routes_home.go Added import for weather package; updated Home function to add default weather location to query parameters under specific conditions.
routes/routes_weather.go Enhanced error handling in Weather function for missing weather location parameter; logs error if no default location is set.
views/views_home.templ Modified rendering logic for weather component to check viewData.HasWeatherDefault; minor formatting adjustments in HTML/CSS generation.
views/views_home_templ.go Updated Home function's conditional logic for rendering weather component to include viewData.HasWeatherDefault.
weather/weather.go Added global variable defaultLocation; updated AddWeatherLocation to set defaultLocation; introduced CurrentWeather and updateWeather functions with enhanced error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeFunction
    participant WeatherService
    participant Config

    User->>HomeFunction: Request Home
    HomeFunction->>Config: Check for default weather location
    alt No weather query
        Config-->>HomeFunction: Return HasWeatherDefault
        HomeFunction-->>User: Render Home with default weather
    else Weather query present
        HomeFunction-->>WeatherService: Fetch weather data
        WeatherService-->>HomeFunction: Return weather data
        HomeFunction-->>User: Render Home with weather data
    end

🐇 "In the garden of code, we hop and we play,
With weather locations, brightening the day.
Default settings now guide our way,
As we fetch the sunshine, come what may!
So let’s cheer for the changes, both big and small,
In this world of weather, we welcome them all!" 🌼

Possibly related PRs

[!WARNING]

Rate limit exceeded

@damongolding has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 55 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.
📥 Commits Reviewing files that changed from the base of the PR and between 7c78ff2d1aebd6f3e683594d01af44bb8e5a0beb and bd85c0d7daded681eb641de56b22a275c19e13b5.

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. ### CodeRabbit Configuration 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/schema.v2.json` ### 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.