Add group to export

[david-roper]

Works on issue #1005

Summary by CodeRabbit

• New Features
  • Exported instrument records now include a group identification field.
• Improvements
  • Consistent use of a default group name across the application for group-related operations.

[coderabbitai]

"""

Walkthrough

A new constant, DEFAULT_GROUP_NAME, is introduced and exported from the core schema package. This constant replaces hardcoded group name fallbacks in both backend and frontend logic. The instrument records export structure is updated to include a required groupId field, ensuring group identification is consistently handled.

Changes

File(s)	Change Summary
packages/schemas/src/core/core.ts	Added and exported the constant DEFAULT_GROUP_NAME = 'root'.
apps/api/src/instrument-records/instrument-records.service.ts apps/web/src/features/session/components/StartSessionForm/StartSessionForm.tsx	Replaced hardcoded group name fallback with imported DEFAULT_GROUP_NAME constant.
packages/schemas/src/instrument-records/instrument-records.ts	Added required groupId: string property to the InstrumentRecordsExport type.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebApp
    participant API
    participant Schemas

    User->>WebApp: Start session
    WebApp->>Schemas: Import DEFAULT_GROUP_NAME
    WebApp->>API: Send session start with group name (uses DEFAULT_GROUP_NAME if needed)
    API->>Schemas: Import DEFAULT_GROUP_NAME and InstrumentRecordsExport
    API->>API: Export records with groupId (from subject's groupIds or DEFAULT_GROUP_NAME)
    API->>User: Return export data with groupId

Loading

Poem

In the warren of code, a new name took root,
DEFAULT_GROUP_NAME—now isn’t that cute?
No more hardcoded strings hiding in fright,
Each record and session now labeled just right.
With groupId in tow, exports hop along,
Our data’s more tidy, our logic more strong!
🐇✨
"""

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between d40ac21 and b0bf8ca.

📒 Files selected for processing (1)

• packages/schemas/src/core/core.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/schemas/src/core/core.ts

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (1)

apps/api/src/instrument-records/instrument-records.service.ts (1)

7-8: Barrel export again
Same note as earlier—ensure the constant is re-exported from the core package root.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between b94c666 and 35bf325.

📒 Files selected for processing (4)

• apps/api/src/instrument-records/instrument-records.service.ts (2 hunks)
• apps/web/src/features/session/components/StartSessionForm/StartSessionForm.tsx (2 hunks)
• packages/schemas/src/core/core.ts (1 hunks)
• packages/schemas/src/instrument-records/instrument-records.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

apps/web/src/features/session/components/StartSessionForm/StartSessionForm.tsx (1)

packages/schemas/src/core/core.ts (1)

• DEFAULT_GROUP_NAME (9-9)

apps/api/src/instrument-records/instrument-records.service.ts (1)

packages/schemas/src/core/core.ts (1)

• DEFAULT_GROUP_NAME (9-9)

🔇 Additional comments (3)

packages/schemas/src/core/core.ts (1)

9-10: Confirm barrel export & add as const
Great to see a single-source default. Please double-check that packages/schemas/src/core/index.ts (or whatever the barrel file is for @opendatacapture/schemas/core) re-exports DEFAULT_GROUP_NAME; otherwise the two new imports in the API & Web will fail.
You can also lock the literal type with a const-assertion for extra safety:

-export const DEFAULT_GROUP_NAME = 'root';
+/** Fallback group name when the subject is not linked to any group */
+export const DEFAULT_GROUP_NAME = 'root' as const;

apps/web/src/features/session/components/StartSessionForm/StartSessionForm.tsx (2)

6-7: Import path relies on barrel export
This path compiles only if the barrel in @opendatacapture/schemas/core re-exports the constant (see previous comment). If the CI complains about a missing export, expose it from the barrel rather than switching to a deep import.

---

256-258: Consistent fallback applied – LGTM
Replacing the magic string with DEFAULT_GROUP_NAME keeps the frontend aligned with the schema. Nice cleanup.