Begin alignment with new API #471

TShapinsky · 2023-12-04T23:00:39Z

API:

New API endpoint structure
Internal API functions now use Run and Point objects as parameters instead of the reference Id
All mentions of site in the api have changed to run
Aliases can replace runIds in the url (you no longer have to get the alias, you can just use it instead of the runId)
Added error handler. Now API errors are passed through the API instead of being silenced.
Run and Point objects are fetched by preprocessors to make handling consistent.
Writing point values now validates points before committing writes.
Response format is now consistent
sendRunMessage api function will now reject a promise if it times out

Worker:

New OS measure to extract building name. Now works for E+ models as well.

Model:

Added metadata endpoint for single models
Added download endpoint for single models

Run:

Now includes a name which defaults to the uploaded model.
Deprecated site object

TODO

Add API tests outside the functionality of the alfalfa-client. There are a lot of endpoints that it doesn't use.
Integrate new api documentation with old api documentation

…t those from happening

TShapinsky · 2023-12-12T19:22:18Z

alfalfa_web/components/Sites/ErrorDialog.js

            <IconButton onClick={onClose}>
              <Close />
            </IconButton>
          </Grid>
        </DialogTitle>
        <DialogContent>
-          <pre style={{ whiteSpace: "pre-wrap" }}>{site.errorLog}</pre>
+          <pre style={{ whiteSpace: "pre-wrap" }}>{run.errorLog}</pre>
        </DialogContent>


Changing from site to run

TShapinsky · 2023-12-12T19:22:33Z

alfalfa_web/components/Sites/PointDialog.js

@@ -90,7 +100,7 @@ export const PointDialog = ({ onClose, site }) => {
      <Dialog fullWidth={true} maxWidth="lg" open={true} onClose={onClose}>
        <DialogTitle>
          <Grid container justifyContent="space-between" alignItems="center">
-            <span>{`${site.name} Points`}</span>
+            <span>{`${run.name} Points`}</span>
            <IconButton onClick={onClose}>
              <Close />
            </IconButton>


changing from site to run

TShapinsky · 2023-12-12T19:22:59Z

alfalfa_web/components/Sites/Sites.js

+    start: ["READY"],
+    stop: ["PREPROCESSING", "STARTING", "STARTED", "RUNNING", "STOPPING"],
+    remove: ["READY", "COMPLETE", "ERROR"],
+    download: ["READY", "COMPLETE", "ERROR"]


I got rid of the code which was lowercasing all of the statuses when they went through the api

TShapinsky · 2023-12-12T19:23:18Z

alfalfa_web/components/Sites/Sites.js

-              sx={{ m: 1 }}>
-              Download Site
+            <Button variant="contained" disabled={isDownloadButtonDisabled()} onClick={handleDownloadRun} sx={{ m: 1 }}>
+              Download Run
            </Button>


Rest of file is migrating from sites to runs

TShapinsky · 2023-12-12T19:24:19Z

alfalfa_web/server/api-v2.js

+  res.status(500);
+  res.json({ error: JSON.parse(JSON.stringify(err, Object.getOwnPropertyNames(err))) });
+};
+


This allows all api endpoints to call next(err) when they get an error and it will be properly and consistently handled

TShapinsky · 2023-12-12T19:25:52Z

alfalfa_web/server/api-v2.js

+});
+
+router.param("runId", (req, res, next, id) => {
+  const error = validate(


Whenever runId is a param in the URL this function will parse the id and add the run object to the request object. This allows all downstream function to not have to worry about validating and processing the id. This also allows me to check if an alias exists in cases where the id doesn't correspond to a run.

TShapinsky · 2023-12-12T19:26:12Z

alfalfa_web/server/api-v2.js

+  }
+});
+
+router.param("pointId", (req, res, next, id) => {


This is the same but just with pointId instead of runId

TShapinsky · 2023-12-12T19:26:28Z

alfalfa_web/server/api-v2.js

+    .catch(next);
+});
+
+router.param("modelId", (req, res, next, id) => {


same again but for modelId

TShapinsky · 2023-12-12T19:27:09Z

alfalfa_web/server/api-v2.js

-        return res.json({ data });
-      } else {
-        return res.status(404).json({
-          error: `Site ID '${siteId}' does not exist`


This 404 has been removed as now that is handled by the pre-processor. You'll see this a lot in this file

TShapinsky · 2023-12-12T19:27:48Z

alfalfa_web/server/api-v2.js

    })
-    .catch(() => res.sendStatus(500));
+    .catch(next);


This catch will funnel all errors to the single error handler. You'll see this a lot in this file

TShapinsky · 2023-12-12T19:28:49Z

alfalfa_web/server/api-v2.js

-          error: `Site ID '${siteId}' does not exist`
-        });
-      }
+    .formatRun(req.run)


Requests to the internal api are now done with the run object instead of the id. This helps make everything more consistent and also allows us to change the id in the future without having to rewrite everything.

TShapinsky · 2023-12-12T19:29:27Z

alfalfa_web/server/api-v2.js

+  api
+    .getPointsByRun(req.run)
+    .then((points) => {
+      return points.map(api.formatPoint);


All db objects now have an accompanying format function which is used to present them to the user.

alfalfa_web/server/api-v2.js

TShapinsky · 2023-12-12T19:33:47Z

alfalfa_web/server/api-v2.js

+          });
+        })
+        .catch((err) => {
+          errors.push(JSON.parse(JSON.stringify(err, Object.getOwnPropertyNames(err))));


validate point writes and collate errors if there are ones.

TShapinsky · 2023-12-12T19:38:39Z

alfalfa_web/server/api-v2.js


+router.all("/aliases/:alias", (req, res, next) => {


This does a similar thing as the other pre-processors. The reason this is an all instead of param is because that would fail on the PUT endpoint. Because when you PUT an alias it doesn't have to exist yet. So if you ever tried to create an alias you'd get a 404 because it didn't exist yet.

TShapinsky · 2023-12-12T19:40:44Z

alfalfa_web/server/api.js

@@ -38,64 +37,53 @@ class AlfalfaAPI {
    });
  }


Main thing in this file is making the api more consistent and also having functions operate on the db objects instead of their ids.

TShapinsky · 2023-12-12T19:41:09Z

alfalfa_web/server/api.js

+    return this.runs.findOne({ _id: runObjectId });
+  };
+
+  formatRun = async (run) => {


This was previously in two places, now it's a function.

alfalfa_web/server/api.js

TShapinsky · 2023-12-12T19:43:36Z

alfalfa_web/server/api.js

-        modified
-      }));
-    } catch (e) {
-      console.error(e);


This kind of error handling was removed in favor of top level error handling to make the api more communicative about what went wrong.

TShapinsky · 2023-12-12T19:44:40Z

alfalfa_web/server/api.js

-      console.error(e);
-      return Promise.reject();
-    }
+  setAlias = async (alias, run) => {


Aliases now use the ObjectID of a run instead of it's ref_id this is intended to make the look ups more performant as ref_id may not be indexed.

TShapinsky · 2023-12-12T19:45:53Z

alfalfa_worker/jobs/openstudio/create_run.py

@@ -46,6 +46,13 @@ def exec(self):
        # run workflow
        check_output(['openstudio', '--gem_path', '/var/lib/gems/2.7.0', 'run', '-m', '-w', str(submitted_osw_path)])

+        self.logger.info('Loading Building Metadata')


Runs now contain the name of the run. This is extracted by a measure which creates a report including this and possibly other data in the future.

anyaelena · 2023-12-14T16:59:31Z

Closes #472

anyaelena

Thank you for turning this around so quickly!

TShapinsky added 4 commits December 4, 2023 15:59

begin alignment with new API

0d47b9a

update dependecies

3292de0

SiteID to RunID

975b785

migrate names from Sites to Runs to remove need for Sites

a5391c0

TShapinsky force-pushed the boptest_aligment branch from 547988b to a5391c0 Compare December 5, 2023 21:22

TShapinsky added 3 commits December 11, 2023 16:58

site->run refactor + api restructuring

8e41cc7

get rid of test that has been skipped for a long time

4b63b09

now that unreplied messages cause rejected promises we need to preven…

d993358

…t those from happening

TShapinsky commented Dec 12, 2023

View reviewed changes

alfalfa_web/server/api-v2.js Outdated Show resolved Hide resolved

TShapinsky commented Dec 12, 2023

View reviewed changes

alfalfa_web/server/api.js Outdated Show resolved Hide resolved

TShapinsky commented Dec 12, 2023

View reviewed changes

address my own review comments

8443025

anyaelena self-requested a review December 15, 2023 13:25

anyaelena previously approved these changes Dec 15, 2023

View reviewed changes

Align response format

02d33e8

TShapinsky dismissed anyaelena’s stale review via 02d33e8 December 15, 2023 16:45

TShapinsky added 2 commits December 15, 2023 09:55

update lock file

6d9ba42

fix tests

4bc7570

anyaelena self-requested a review December 15, 2023 21:36

anyaelena approved these changes Dec 15, 2023

View reviewed changes

anyaelena merged commit 8796ba7 into develop Dec 15, 2023
6 checks passed

anyaelena deleted the boptest_aligment branch December 15, 2023 21:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Begin alignment with new API #471

Begin alignment with new API #471

TShapinsky commented Dec 4, 2023 •

edited

Loading

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

TShapinsky Dec 12, 2023

anyaelena commented Dec 14, 2023

anyaelena left a comment

Begin alignment with new API #471

Begin alignment with new API #471

Conversation

TShapinsky commented Dec 4, 2023 • edited Loading

API:

Worker:

Model:

Run:

TODO

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anyaelena commented Dec 14, 2023

anyaelena left a comment

Choose a reason for hiding this comment

TShapinsky commented Dec 4, 2023 •

edited

Loading