Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: extra settings to enable mail notifications and matrix aggregation #1434

Merged
merged 3 commits into from
Jan 27, 2025

Conversation

ab-smith
Copy link
Contributor

@ab-smith ab-smith commented Jan 27, 2025

Summary by CodeRabbit

  • New Features

    • Added interface settings for aggregating scenarios on risk matrices
    • Introduced email notification settings
    • Expanded global settings configuration options
  • Localization

    • Added new translation entries for interface and notification settings in English and French
  • User Interface

    • Updated General Settings form to include new configuration checkboxes for notifications and interface preferences

Copy link

coderabbitai bot commented Jan 27, 2025

Walkthrough

This pull request introduces new configuration settings for notifications and interface preferences across the application. The changes span multiple files in the backend and frontend, adding two new keys to the general settings: interface_agg_scenario_matrix and notifications_enable_mailing. The modifications enable users to toggle email notifications and control scenario matrix aggregation, with corresponding updates to serializers, views, translation files, and frontend components to support these new settings.

Changes

File Change Summary
backend/global_settings/serializers.py Added two new keys to GENERAL_SETTINGS_KEYS: interface_agg_scenario_matrix and notifications_enable_mailing
backend/global_settings/views.py Added notifications_settings and interface_settings methods, updated default_settings with new keys
frontend/messages/en.json Added new translation entries for interface and notification settings
frontend/messages/fr.json Added French translations for new settings
frontend/src/lib/components/Forms/ModelForm/GeneralSettingForm.svelte Added checkboxes for notifications and interface settings
frontend/src/lib/utils/schemas.ts Added optional boolean properties for new settings
frontend/src/routes/(app)/(internal)/risk-assessments/[id=uuid]/+layout.server.ts Added fetch for interface settings, introduced useBubbles property
frontend/src/routes/(app)/(internal)/risk-assessments/[id=uuid]/+page.svelte Updated useBubbles initialization to use dynamic data

Sequence Diagram

sequenceDiagram
    participant User
    participant Frontend
    participant Backend
    participant GlobalSettings

    User->>Frontend: Access Settings Page
    Frontend->>Backend: Fetch General Settings
    Backend->>GlobalSettings: Retrieve Settings
    GlobalSettings-->>Backend: Return Settings
    Backend-->>Frontend: Provide Settings
    Frontend->>User: Display Settings with Checkboxes
    User->>Frontend: Toggle Notification/Interface Settings
    Frontend->>Backend: Update Settings
    Backend->>GlobalSettings: Save New Settings
    GlobalSettings-->>Backend: Confirm Update
    Backend-->>Frontend: Confirm Changes
    Frontend->>User: Show Updated Settings
Loading

Possibly related PRs

Suggested reviewers

  • eric-intuitem

Poem

🐰 A Rabbit's Ode to Settings New

Checkboxes dance, configurations bloom,
Notifications sing, interfaces zoom!
With matrix and mail, our settings take flight,
Empowering users with digital might.
Hop, hop, hooray for flexibility true! 🎉

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ab-smith ab-smith marked this pull request as ready for review January 27, 2025 17:09
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
frontend/src/routes/(app)/(internal)/risk-assessments/[id=uuid]/+layout.server.ts (1)

23-25: Add error handling for the interface settings fetch.

While the fetch follows the existing pattern, consider adding error handling to gracefully handle API failures.

-	const interface_settings = await fetch(`${BASE_API_URL}/settings/general/object`).then((res) =>
-		res.json()
-	);
+	let interface_settings = { interface_agg_scenario_matrix: false };
+	try {
+		const response = await fetch(`${BASE_API_URL}/settings/general/object`);
+		if (response.ok) {
+			interface_settings = await response.json();
+		} else {
+			console.error('Failed to fetch interface settings:', response.statusText);
+		}
+	} catch (error) {
+		console.error('Error fetching interface settings:', error);
+	}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e2fd1f and ef2982a.

📒 Files selected for processing (8)
  • backend/global_settings/serializers.py (1 hunks)
  • backend/global_settings/views.py (2 hunks)
  • frontend/messages/en.json (1 hunks)
  • frontend/messages/fr.json (1 hunks)
  • frontend/src/lib/components/Forms/ModelForm/GeneralSettingForm.svelte (3 hunks)
  • frontend/src/lib/utils/schemas.ts (1 hunks)
  • frontend/src/routes/(app)/(internal)/risk-assessments/[id=uuid]/+layout.server.ts (2 hunks)
  • frontend/src/routes/(app)/(internal)/risk-assessments/[id=uuid]/+page.svelte (1 hunks)
👮 Files not reviewed due to content moderation or server errors (4)
  • frontend/src/routes/(app)/(internal)/risk-assessments/[id=uuid]/+page.svelte
  • frontend/src/lib/utils/schemas.ts
  • frontend/messages/en.json
  • frontend/messages/fr.json
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: functional-tests (3.12, chromium)
  • GitHub Check: test (3.12)
  • GitHub Check: enterprise-functional-tests (3.12, chromium)
🔇 Additional comments (6)
backend/global_settings/serializers.py (1)

11-12: LGTM! The new settings keys are well-structured.

The new keys follow the existing naming convention and their names clearly indicate their purpose.

backend/global_settings/views.py (2)

68-69: LGTM! Conservative defaults are security-conscious.

The new settings default to False, which is a secure default as it requires explicit opt-in for both mail notifications and matrix aggregation.


107-124: LGTM! Well-structured action methods.

The new action methods follow the existing pattern and are properly decorated with @action. They return specific subsets of settings which helps minimize data exposure.

frontend/src/lib/components/Forms/ModelForm/GeneralSettingForm.svelte (2)

17-29: LGTM! Well-structured notifications section.

The notifications section is logically organized with appropriate icon and checkbox binding.


30-43: LGTM! Well-structured interface settings section.

The interface settings section follows the same pattern and maintains consistency in the UI.

frontend/src/routes/(app)/(internal)/risk-assessments/[id=uuid]/+layout.server.ts (1)

153-154: LGTM! Clear mapping of interface settings.

The mapping from interface_agg_scenario_matrix to useBubbles is clear and maintains the semantic meaning.

Copy link
Collaborator

@eric-intuitem eric-intuitem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ab-smith ab-smith merged commit 5af0a26 into main Jan 27, 2025
21 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 27, 2025
@ab-smith ab-smith deleted the extra_settings branch January 27, 2025 18:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants