Support plain OpenModelica Co-Sim FMUs (relax BOPTEST-only assumptions)

[nllong]

Summary

Custom FMUs exported straight from OpenModelica (FMI 2.0 Co-Simulation, plain physical I/O, no resources/kpis.json) failed to upload/run in Alfalfa because the modelica job path assumed two BOPTEST-only conventions. This PR relaxes those assumptions so such FMUs load and run as-is — while remaining fully compatible with BOPTEST-style wrapped FMUs.

Root cause

1. Data_Manager raised on a missing resources/kpis.json (a BOPTEST artifact).
2. TestCase assumed every variable has a unit/description and finite min/max bounds, then clamped inputs against those bounds — plain control I/O is often unitless/unbounded, so metadata lookups and the min/max clamp failed.

Changes

• alfalfa_worker/lib/data/data_manager.py — missing resources/kpis.json now degrades to {} (with a clearer warning) and sets a kpi_json_missing flag instead of erroring.
• alfalfa_worker/lib/testcase.py — wrap unit/description/min/max metadata lookups in try/except (→ None); _check_value_min_max skips the clamp when a bound is None.
• Web notice pipeline — when an uploaded FMU has no kpis.json, surface a non-fatal, web-visible notice explaining why and how to fix it (instead of a raw traceback / silent behavior):
  • models.py (Run.notices), job.py (Job.add_run_notice), jobs/modelica/step_run.py (emit notice), server/api.js (expose notices), new components/Sites/NoticeDialog.js + Sites.js info icon.
• tests/worker/test_testcase_metadata.py — regression test for the None-bounds range-check behavior.
• docs/Modelica FMU Requirements.md / docs/Alfalfa-FMU-Compatibility.md — FMU compatibility / wrapping guidance.

Testing

Rebased onto develop and re-verified end-to-end (Docker Compose: worker + web + mongo/redis/minio):

• tests/worker/test_testcase_metadata.py: 3 passed — the None-bounds range-check regression test.
• tests/jobs/test_workflow.py -k model_path1 (wrapped.fmu, -m docker): 2 passed.
• tests/integration/test_modelica.py (-m integration): 1 passed — full HTTP path (AlfalfaClient → web → worker → mongo/redis/minio) submitting the known-good wrapped.fmu, asserting all BOPTEST _u/_y inputs & outputs, advancing ×5, stopping. Confirms these changes do not regress the BOPTEST path.

Notes

• Rebased onto develop; the PACER rename is no longer part of this PR (base package names are back to alfalfa_worker/alfalfa_web, and docs/branding reference Alfalfa).
• These are deliberate relaxations of BOPTEST assumptions; behavior for BOPTEST-compliant FMUs is unchanged.

Co-authored-by: Copilot App 223556219+Copilot@users.noreply.github.com
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

[Copilot]

Pull request overview

This PR relaxes BOPTEST-specific assumptions in the Modelica/FMUs execution path so “plain” OpenModelica-exported FMI 2.0 Co-Simulation FMUs (without resources/kpis.json and with partial/absent variable metadata) can upload, start, and run in Alfalfa, while preserving BOPTEST compatibility. It also adds run notices and point min/max metadata to the API/UI so missing KPIs and writable ranges are visible and enforceable.

Changes:

• Worker: tolerate missing resources/kpis.json, tolerate missing unit/description/min/max metadata, and skip min/max clamping when bounds are undefined.
• Data model + API/UI: persist run notices and external_clock, expose point min/max, validate writes against ranges, and show notices + external-clock stepping in the UI.
• Tests/docs: add regression/unit/integration coverage for the new behaviors and document FMU compatibility requirements.

Reviewed changes

Copilot reviewed 21 out of 25 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/worker/test_testcase_metadata.py	Unit tests ensuring _check_value_min_max skips clamping when bounds are None.
tests/integration/test_component_fmus.py	Integration coverage for running “plain” component FMUs and verifying I/O + optional ranges.
docs/Modelica FMU Requirements.md	New doc describing FMU expectations and the relaxed behavior for missing KPIs/metadata.
docs/Alfalfa-FMU-Compatibility.md	Detailed compatibility guide/checklist and guidance for workbench-generated FMUs.
alfalfa_worker/lib/testcase.py	Make variable metadata lookups tolerant to missing unit/description/min/max; skip clamp when bounds missing.
alfalfa_worker/lib/models.py	Add Point.minimum/maximum, Run.external_clock, and Run.notices fields.
alfalfa_worker/lib/job.py	Add Job.add_run_notice() helper to persist non-fatal run notices (deduped).
alfalfa_worker/lib/data/data_manager.py	Treat missing resources/kpis.json as non-fatal, set kpi_json_missing flag.
alfalfa_worker/jobs/modelica/step_run.py	Emit run notice when KPIs are missing; attach point units/min/max from FMU metadata; fix output point value assignment.
alfalfa_web/server/api.js	Expose run notices + externalClock, expose point min/max, and validate writes against range.
alfalfa_web/server/api-v2.js	Reuse shared validatePointWrite for single-point writes.
alfalfa_web/package.json	Add jszip dependency (used for client-side folder zipping).
alfalfa_web/package-lock.json	Lockfile updates for jszip (and related dependency tree).
alfalfa_web/components/Upload/Upload.scss	Styling for the new upload UI layout/status row.
alfalfa_web/components/Upload/Upload.js	Upload UX improvements: status states, completion dialog, error snackbar, disable inputs while busy.
alfalfa_web/components/Upload/FileInput.js	Add “Select Folder” and zip folder contents client-side into a .zip upload via JSZip.
alfalfa_web/components/Sites/StartDialog.js	Improve defaults for start/end times (rounded start; default 8-hour duration).
alfalfa_web/components/Sites/Sites.js	Add sorting, select-all, upload timestamp display, and notice indicator + dialog trigger.
alfalfa_web/components/Sites/PointDialog.js	Add writable point control UI, min/max display, and external-clock stepping controls.
alfalfa_web/components/Sites/NoticeDialog.js	New dialog to display run notices in the UI.
alfalfa_web/api.yml	Document externalClock on run metadata (but currently missing notices).
AGENTS.md	Adds/records repository agent instructions (CI/testing expectations).

Files not reviewed (1)

• alfalfa_web/package-lock.json: Generated file

Comments suppressed due to low confidence (1)

alfalfa_worker/jobs/modelica/step_run.py:71

• name_to_id currently calls name.replace(" ", "_") but ignores the returned string, so spaces are not actually sanitized. This can leak spaces into ref_id/API point IDs and break lookups if an FMU variable name contains spaces.

        inputs_metadata = getattr(self.tc, 'inputs_metadata', {})

        def name_to_id(name: str) -> str:
            name.replace(" ", "_")
            return name

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.