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

Add fields request to reduced schedule #1386

Merged
merged 1 commit into from
Jan 29, 2025

Conversation

paulfalgout
Copy link
Member

@paulfalgout paulfalgout commented Jan 29, 2025

When we added fields to the schedule, it looks like we missed doing it on the reduced schedule.. not the end of the world, but it used to fail silently.. now it doesn’t

Shortcut Story ID: [sc-58838]

Summary by CodeRabbit

  • New Features

    • Enhanced data retrieval for patient schedule actions by specifying which flow fields to include in the request.
  • Tests

    • Updated integration test to verify new URL query parameters for flow fields.

When we added fields to the schedule, it looks like we missed doing it on the reduced schedule.. not the end of the world, but it used to fail silently.. now it doesn’t
Copy link

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request modifies the beforeStart method in the reduced schedule application to include a new fields parameter when fetching actions. This change adds specific field selection for flows, requesting only the name and state attributes. The corresponding integration test has been updated to verify the new URL query parameters, ensuring that the fields[flows] parameter is correctly included in the request.

Changes

File Change Summary
src/js/apps/patients/schedule/reduced-schedule/reduced_schedule_app.js Modified beforeStart() method to include fields parameter with flows: ['name', 'state'] in the actions collection fetch request
test/integration/patients/worklist/reduced-schedule.js Updated test assertions to check for new fields[flows]=name,state URL query parameter

Sequence Diagram

sequenceDiagram
    participant App as Reduced Schedule App
    participant Radio as Radio Service
    participant Entities as Entities Collection

    App->>Radio: Request fetch:actions:collection
    Radio->>Entities: Fetch with filter and fields
    Entities-->>Radio: Return filtered and field-limited collection
    Radio-->>App: Provide actions collection
Loading

Possibly related PRs

Suggested reviewers

  • shadowhand

Poem

🐰 Rabbit's Code Rhyme 🐰

In schedules reduced, a change so neat,
Fields of flows, now crisp and fleet
Name and state, precisely picked
Our data dance, perfectly tricked!
Code hops forward with graceful might

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
🪧 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.

@@ -98,7 +98,8 @@ export default App.extend({
},
beforeStart() {
const filter = this.getState().getEntityFilter();
return Radio.request('entities', 'fetch:actions:collection', { data: { filter } });
const fields = { flows: ['name', 'state'] };
Copy link
Member Author

Choose a reason for hiding this comment

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

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)
src/js/apps/patients/schedule/reduced-schedule/reduced_schedule_app.js (1)

101-102: LGTM! Consider extracting fields as a constant.

The addition of the fields parameter correctly addresses the oversight by explicitly requesting the required flow fields. This change improves the API request efficiency by only fetching the necessary data.

Consider extracting the fields configuration as a constant at the module level for better maintainability:

 import Radio from 'backbone.radio';
+const FLOW_FIELDS = { flows: ['name', 'state'] };
 
 // ... rest of the imports
 
   beforeStart() {
     const filter = this.getState().getEntityFilter();
-    const fields = { flows: ['name', 'state'] };
-    return Radio.request('entities', 'fetch:actions:collection', { data: { filter, fields } });
+    return Radio.request('entities', 'fetch:actions:collection', { data: { filter, fields: FLOW_FIELDS } });
   },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a8b6d45 and 78acaab.

📒 Files selected for processing (2)
  • src/js/apps/patients/schedule/reduced-schedule/reduced_schedule_app.js (1 hunks)
  • test/integration/patients/worklist/reduced-schedule.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: test-build
🔇 Additional comments (1)
test/integration/patients/worklist/reduced-schedule.js (1)

104-105: LGTM! Test coverage properly validates the fields parameter.

The test has been appropriately updated to verify that the correct fields are being requested for flows. This ensures the API request includes only the necessary data fields.

Copy link

cypress bot commented Jan 29, 2025

RoundingWell Care Ops Frontend    Run #7202

Run Properties:  status check passed Passed #7202  •  git commit 78acaab15e: Add fields request to reduced schedule
Project RoundingWell Care Ops Frontend
Branch Review bug/reduced-filter-fields
Run status status check passed Passed #7202
Run duration 02m 57s
Commit git commit 78acaab15e: Add fields request to reduced schedule
Committer Paul Falgout
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 1
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 313
View all changes introduced in this branch ↗︎

@coveralls
Copy link

Pull Request Test Coverage Report for Build 163a685f-a212-4292-9f8b-2aa9a27609b3

Details

  • 2 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 26e0f078-849d-4415-b91f-1fde05769b2c: 0.0%
Covered Lines: 6083
Relevant Lines: 6083

💛 - Coveralls

@paulfalgout paulfalgout merged commit 2065c02 into develop Jan 29, 2025
6 checks passed
@paulfalgout paulfalgout deleted the bug/reduced-filter-fields branch January 29, 2025 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants