some api changes

Author: CamDavidsonPilon

CHANGELOG.md

@@ -1,3 +1,14 @@
+### Upcoming
+
+#### Breaking changes
+
+ - Renamed `/api/is_local_access_point_active` to `/api/local_access_point` (now returns `{active: <bool>}`).
+ - Consolidated experiment profile routes under `/api/experiment_profiles` and `/api/experiments/<experiment>/experiment_profiles/*`. Removed `/api/contrib/experiment_profiles` and `/api/experiment_profiles/running/experiments/<experiment>`. `PATCH` now targets `/api/experiment_profiles/<filename>`.
+
+#### Enhancements
+
+ - Added `/api/units/<pioreactor_unit>/jobs/stop/experiments/<experiment>` to mirror worker stop-all behavior.
+
 ### 26.2.3
 
 #### Enhancements

core/pioreactor/web/api.py

@@ -35,6 +35,7 @@
 from pioreactor.pubsub import post_into
 from pioreactor.structs import CalibrationBase
 from pioreactor.structs import Dataset
+from pioreactor.utils.networking import is_using_local_access_point
 from pioreactor.utils.networking import resolve_to_address
 from pioreactor.utils.timing import current_utc_datetime
 from pioreactor.utils.timing import current_utc_timestamp
@@ -197,8 +198,12 @@ def get_models() -> ResponseReturnValue:
     "/workers/<pioreactor_unit>/jobs/stop/experiments/<experiment>",
     methods=["POST", "PATCH"],
 )
-def stop_all_jobs_on_worker_for_experiment(pioreactor_unit: str, experiment: str) -> ResponseReturnValue:
-    """Kills all jobs for worker assigned to experiment"""
+@api_bp.route(
+    "/units/<pioreactor_unit>/jobs/stop/experiments/<experiment>",
+    methods=["POST", "PATCH"],
+)
+def stop_all_jobs_on_unit_for_experiment(pioreactor_unit: str, experiment: str) -> ResponseReturnValue:
+    """Kills all jobs for worker or unit assigned to experiment"""
     if pioreactor_unit == UNIVERSAL_IDENTIFIER:
         broadcast_post_across_cluster("/unit_api/jobs/stop", json={"experiment": experiment})
     else:
@@ -2716,17 +2721,18 @@ def get_historical_config_for(filename: str) -> ResponseReturnValue:
     return attach_cache_control(jsonify(configs_for_filename), max_age=15)
 
 
-@api_bp.route("/is_local_access_point_active", methods=["GET"])
-def is_local_access_point_active() -> ResponseReturnValue:
+@api_bp.route("/local_access_point", methods=["GET"])
+def get_local_access_point() -> ResponseReturnValue:
     return attach_cache_control(
-        jsonify({"result": os.path.isfile("/boot/firmware/local_access_point")}), max_age=10_000
+        jsonify({"active": is_using_local_access_point()}),
+        max_age=10_000,
     )
 
 
 ### experiment profiles
 
 
-@api_bp.route("/experiment_profiles/running/experiments/<experiment>", methods=["GET"])
+@api_bp.route("/experiments/<experiment>/experiment_profiles/running", methods=["GET"])
 def get_running_profiles(experiment: str) -> ResponseReturnValue:
     jobs = query_temp_local_metadata_db(
         """
@@ -2771,7 +2777,7 @@ def get_recent_experiment_profile_runs(experiment: str) -> ResponseReturnValue:
     return attach_cache_control(jsonify(recent_runs), max_age=5)
 
 
-@api_bp.route("/contrib/experiment_profiles", methods=["POST"])
+@api_bp.route("/experiment_profiles", methods=["POST"])
 def create_experiment_profile() -> ResponseReturnValue:
     body = request.get_json()
     experiment_profile_body = body["body"]
@@ -2815,11 +2821,11 @@ def create_experiment_profile() -> ResponseReturnValue:
     return {"status": "success"}, 200
 
 
-@api_bp.route("/contrib/experiment_profiles", methods=["PATCH"])
-def update_experiment_profile() -> ResponseReturnValue:
+@api_bp.route("/experiment_profiles/<filename>", methods=["PATCH"])
+def update_experiment_profile(filename: str) -> ResponseReturnValue:
     body = request.get_json()
     experiment_profile_body = body["body"]
-    experiment_profile_filename = Path(body["filename"]).name
+    experiment_profile_filename = Path(filename).name
 
     # verify content
     try:
@@ -2853,7 +2859,7 @@ def update_experiment_profile() -> ResponseReturnValue:
     return {"status": "success"}, 200
 
 
-@api_bp.route("/contrib/experiment_profiles", methods=["GET"])
+@api_bp.route("/experiment_profiles", methods=["GET"])
 def get_experiment_profiles() -> ResponseReturnValue:
     try:
         profile_path = Path(os.environ["DOT_PIOREACTOR"]) / "experiment_profiles"
@@ -2890,7 +2896,7 @@ def get_experiment_profiles() -> ResponseReturnValue:
         abort_with(400, str(e))
 
 
-@api_bp.route("/contrib/experiment_profiles/<filename>", methods=["GET"])
+@api_bp.route("/experiment_profiles/<filename>", methods=["GET"])
 def get_experiment_profile(filename: str) -> ResponseReturnValue:
     file = Path(filename).name
     try:
@@ -2908,7 +2914,7 @@ def get_experiment_profile(filename: str) -> ResponseReturnValue:
         abort_with(404, str(e))
 
 
-@api_bp.route("/contrib/experiment_profiles/<filename>", methods=["DELETE"])
+@api_bp.route("/experiment_profiles/<filename>", methods=["DELETE"])
 def delete_experiment_profile(filename: str) -> ResponseReturnValue:
     file = Path(filename).name
     try:

core/pioreactor/web/mcp.py

@@ -382,7 +382,7 @@ def get_experiment_profiles() -> dict:
 
     List available experiment profiles (filename, fullpath, and parsed metadata).
     """
-    return get_from_leader("/api/contrib/experiment_profiles")
+    return get_from_leader("/api/experiment_profiles")
 
 
 @mcp.tool()

core/tests/web/test_app.py

@@ -346,16 +346,16 @@ def test_get_config_rejects_non_ini(client) -> None:
 
 def test_create_experiment_profile_invalid_filename_returns_400(client) -> None:
     response = client.post(
-        "/api/contrib/experiment_profiles",
+        "/api/experiment_profiles",
         json={"body": "experiment_profile_name: demo", "filename": "bad?name.yaml"},
     )
     assert response.status_code == 400
 
 
 def test_update_experiment_profile_invalid_filename_returns_400(client) -> None:
     response = client.patch(
-        "/api/contrib/experiment_profiles",
-        json={"body": "experiment_profile_name: demo", "filename": "bad?name.yaml"},
+        "/api/experiment_profiles/bad:name.yaml",
+        json={"body": "experiment_profile_name: demo"},
     )
     assert response.status_code == 400
 

core/tests/web/test_mcp.py

@@ -124,5 +124,5 @@ def test_endpoints_exist_in_api_and_unit_api(app) -> None:
         "/api/workers/<pioreactor_unit>/jobs/settings/job_name/<job_name>/experiments/<experiment>" in routes
     )
     assert "/api/experiments/<experiment>/recent_logs" in routes
-    assert "/api/contrib/experiment_profiles" in routes
+    assert "/api/experiment_profiles" in routes
     assert "/api/units/<pioreactor_unit>/configuration" in routes

frontend/src/CreateExperimentProfile.jsx

@@ -95,7 +95,7 @@ metadata:
     }
 
     setIsError(false);
-    fetch("/api/contrib/experiment_profiles", {
+    fetch("/api/experiment_profiles", {
       method: "POST",
       body: JSON.stringify({ body: code, filename: filename + '.yaml' }),
       headers: {

frontend/src/EditExperimentProfile.jsx

@@ -81,9 +81,9 @@ const EditExperimentProfilesContent = ({ initialCode, profileFilename }) => {
   const saveCurrentCode = () => {
 
     setIsError(false);
-    fetch("/api/contrib/experiment_profiles", {
+    fetch(`/api/experiment_profiles/${encodeURIComponent(profileFilename)}`, {
       method: "PATCH",
-      body: JSON.stringify({ body: code, filename: profileFilename }),
+      body: JSON.stringify({ body: code }),
       headers: {
         'Accept': 'application/json',
         'Content-Type': 'application/json'
@@ -199,7 +199,7 @@ function ProfilesContainer(){
   const [openCapabilities, setOpenCapabilities] = React.useState(false)
 
   React.useEffect(() => {
-    fetch(`/api/contrib/experiment_profiles/${profileFilename}`, {
+    fetch(`/api/experiment_profiles/${encodeURIComponent(profileFilename)}`, {
           method: "GET",
       }).then(res => {
         if (res.ok) {

frontend/src/Profiles.jsx

@@ -75,7 +75,7 @@ function RunExperimentProfilesContent({
       cancellationButtonProps: { color: "secondary" },
     })
       .then(() => {
-        fetch(`/api/contrib/experiment_profiles/${selectedExperimentProfile}`, {
+        fetch(`/api/experiment_profiles/${selectedExperimentProfile}`, {
           method: "DELETE",
         }).then(res => {
           if (res.ok) {
@@ -89,7 +89,7 @@ function RunExperimentProfilesContent({
   const getSourceAndView = () => {
     // fetch the raw file content only if we are about to toggle into “view source”
     if (!viewSource) {
-      fetch(`/api/contrib/experiment_profiles/${selectedExperimentProfile}`, {
+      fetch(`/api/experiment_profiles/${selectedExperimentProfile}`, {
         method: "GET",
       }).then(res => {
         if (res.ok) {
@@ -106,7 +106,7 @@ function RunExperimentProfilesContent({
     if (!selectedExperimentProfile) {
       return;
     }
-    fetch(`/api/contrib/experiment_profiles/${selectedExperimentProfile}`, { method: 'GET' })
+    fetch(`/api/experiment_profiles/${selectedExperimentProfile}`, { method: 'GET' })
       .then(res => {
         if (!res.ok) {
           throw new Error('Failed to fetch profile');
@@ -419,7 +419,7 @@ function Profiles(props) {
   }, [experimentMetadata.experiment]);
 
   React.useEffect(() => {
-    fetch("/api/contrib/experiment_profiles")
+    fetch("/api/experiment_profiles")
       .then(response => response.json())
       .then(profiles => {
         // shape: [ {file: "...", experimentProfile: {...}}, ... ]

frontend/src/components/SideNavAndHeader.jsx

@@ -186,12 +186,12 @@ export default function SideNavAndHeader() {
 
   React.useEffect(() => {
     async function getLAP() {
-       await fetch("/api/is_local_access_point_active")
+       await fetch("/api/local_access_point")
       .then((response) => {
-        return response.text();
+        return response.json();
       })
       .then((data) => {
-        setLAP(data === "true")
+        setLAP(Boolean(data?.active))
       });
     }
 

frontend/src/providers/RunningProfilesContext.js

@@ -29,7 +29,7 @@ export function RunningProfilesProvider({ children, experiment }) {
     setLoading(true);
     try {
       const response = await fetch(
-        `/api/experiment_profiles/running/experiments/${experiment}`
+        `/api/experiments/${encodeURIComponent(experiment)}/experiment_profiles/running`
       );
       if (!response.ok) {
         throw new Error(`Failed to fetch running profiles: ${response.statusText}`);