Report v2 #201

Exilliar · 2023-01-24T14:13:55Z

Fairly large pr making an update to the report object. Contains a couple of changes:

Update to include material carbon totals in the object so that child objects do not need to be pulled down into most pages (no pages require child objects atm, the assessment view page might at some point), reducing load times.
Added a "version" property to the object. This is the version of the object that is being used, not the version of the users report. This version number is used to let Act know how to load the report. It allows us to support both this new version of the report object and also the old version (and any new versions that we make).
Adds a new version of the model to the report, this version has the carbon values added to the model as new parameters. This allows us to more easily display a heat map on the report view page (which is also a new feature in this pr). Generating this model can take quite a while, so the time to save a report has increased. But I think that the trade-off is worth it.

More info on some of these changes here #180.

User's pre-update reports will not be directly updated as that would have a high chance of causing issues. Instead, any new reports that are created post-update will be made using this version of the report.

To test:

Create a new report and check that it loads properly (with the heat map and everything)
Edit a v1 report and see if that update works
There is meant to be full backwards compatibility with v1 reports, so check that the report view page still works on v1 reports

…rm into dev

…m into dev

…cleaner

…rm into report-v2

…rrect model being displayed on view assessment page

ro-sa · 2023-04-04T08:00:03Z

src/components/core/VersionUpdateDialog.vue

-      title: "Object parameter grouping",
-      subtitle: `You can now group your objects for material selection by any parameter on your model.`,
+      title: "Report Object v2",
+      subtitle: `The way that we store your carbon reports has now changed. The updates allow for faster loading, carbon heat maps, and makes it easier to access your data.`,


"make" instead of "makes"

ro-sa · 2023-04-04T08:41:17Z

src/components/viewAssessment/RendererControlsCard.vue

+    value: "parameters.Construction Carbon A5.value"
+  },
+  {
+    name: "Materials",


move this to the start of the array, to make the Materials the default category shown

ro-sa · 2023-04-04T09:19:55Z

src/models/newAssessment/speckleObject.interface.ts

@@ -21,7 +24,7 @@ export interface SpeckleObjectFormComplete {
  id: string;
  speckle_type: string;
  formData: ObjectFormDataComplete;
-  reportData?: ReportData;
+  reportData?: ReportDataChild;
 }

 export interface ObjectFormDataComplete {


can we make this more DRY, please?

SpeckeleObject, ObjectFromData, and ObjectFormDataComplete are the same. ObjectFromData and ObjectFormDataComplete are also not used anywhere

SpeckleObject is used in the ObjectsObj type, which is used on the Assessment.vue view.

ObjectFormData is used in the SpeckleObject interface.

ObjectFormDataComplete is used in SpeckleObjectFormComplete which is used in the Assessment.vue view and the carbonCalculator.ts file.

ObjectFormData is used in the SpeckleObject interface.

ObjectFormDataComplete is used in SpeckleObjectFormComplete.

If I remember right, a lot of these exist, and appear to be the same, because I wanted to have interfaces that both could/couldn't contain some fields, and interfaces that definitely would contain the same fields. I think that this was mainly done to make things easier in the Assessment.vue view.

A lot of this file/folder is heavily linked to the Assessment.vue view, which is incredibly messy and is difficult to figure out. It's the type of file where you can change on thing and that causes things elsewhere to break without you realising. Really that file needs a whole re-write, but that would be a massive job at this point. I might try to pull together some diagrams and stuff to help us better understand what's going on.

ro-sa · 2023-04-04T14:47:00Z

src/components/core/VersionUpdateDialog.vue

-      title: "Object parameter grouping",
-      subtitle: `You can now group your objects for material selection by any parameter on your model.`,
+      title: "Report Object v2",
+      subtitle: `The way that we store your carbon reports has now changed. The updates allow for faster loading, carbon heat maps, and gives you easier to access your data.`,


please rephrase and gives you easier to access your data. :D

* Report v2 (#201) * assessment page saves in new v2 object * mostly working I think * child objects properly appear on server * includes materials and transport colours in report parent object now * removed comment * moved around a load of functions to (hopefully) make things a little cleaner * clean up * model object id now saved to report object to be more certain that correct model being displayed on view assessment page * child objects actually contain total carbon * wrote main parameter update function, don't know if it works yet * almost working * attempted to make things work * adding param function works (kinda) * cleaned up addParams method a little bit, should more reliably work now * model with new params being correctly uploaded * carbon heatmap inside Act! * started adding some controls for the viewer on the report viewer page * continued work on the viewer controls on the report viewing page * can change model views on the view report page * report viewer can load both v1 and v2 reports * updated v1 report to v2 works * added key to report viewer page (it's rubbish, but gets the job done) * removed most of the console.log's * added message to the final loading spinner on the assessment page * object parameter grouping now properly works * updated version number * cleaned things up * updated speckle viewer * almost working * working (as far as I know) * clean up * clean up * text update * text update 2 * added links (#215)

Exilliar added 13 commits October 19, 2022 09:47

Merge branch 'main' of github.com:arup-group/Carbon-Assessment-Platfo…

00a1758

…rm into dev

Merge branch 'dev' of github.com:arup-group/Carbon-Assessment-Platfor…

5f25d12

…m into dev

Merge branch 'dev' of github.com:arup-group/Carbon-Assessment-Platfor…

682b555

…m into dev

Merge branch 'dev' of github.com:arup-group/Carbon-Assessment-Platfor…

e8cecf3

…m into dev

Merge branch 'dev' of github.com:arup-group/Carbon-Assessment-Platfor…

dc42d9b

…m into dev

assessment page saves in new v2 object

f1e1561

mostly working I think

6c87e8e

Merge branch 'dev' of github.com:arup-group/a-carbon-tool into report-v2

ff93578

child objects properly appear on server

966cf36

includes materials and transport colours in report parent object now

19bfe4f

removed comment

17ff378

moved around a load of functions to (hopefully) make things a little …

320e004

…cleaner

clean up

201ce76

Exilliar requested a review from ro-sa January 24, 2023 14:13

Exilliar marked this pull request as draft January 24, 2023 18:30

Exilliar added 15 commits January 25, 2023 18:31

Merge branch 'main' of github.com:arup-group/Carbon-Assessment-Platfo…

fbbfbd5

…rm into report-v2

model object id now saved to report object to be more certain that co…

2195330

…rrect model being displayed on view assessment page

child objects actually contain total carbon

4fe1bb8

wrote main parameter update function, don't know if it works yet

d0900c2

almost working

98ac005

attempted to make things work

292e9f1

adding param function works (kinda)

70969fb

cleaned up addParams method a little bit, should more reliably work now

1e782dc

model with new params being correctly uploaded

bfe9a9e

carbon heatmap inside Act!

616d97c

started adding some controls for the viewer on the report viewer page

8ae667c

continued work on the viewer controls on the report viewing page

d0a8c26

can change model views on the view report page

b07a9d9

report viewer can load both v1 and v2 reports

e63cc56

updated v1 report to v2 works

e9a0620

Exilliar added 11 commits March 9, 2023 18:16

added key to report viewer page (it's rubbish, but gets the job done)

a2d9b41

removed most of the console.log's

70c8348

added message to the final loading spinner on the assessment page

b9b0215

fixed merge conflicts with dev

996c838

object parameter grouping now properly works

3ad46be

updated version number

14f53ef

cleaned things up

fbda566

updated speckle viewer

b536162

almost working

321bc25

working (as far as I know)

dc45859

clean up

fe8abcf

Exilliar marked this pull request as ready for review March 28, 2023 16:06

ro-sa reviewed Apr 4, 2023

View reviewed changes

clean up

2eedec2

ro-sa self-requested a review April 4, 2023 14:43

ro-sa reviewed Apr 4, 2023

View reviewed changes

Exilliar added 2 commits April 4, 2023 16:40

text update

c44060a

text update 2

f3e4d1c

ro-sa self-requested a review April 4, 2023 15:46

ro-sa approved these changes Apr 4, 2023

View reviewed changes

Exilliar merged commit 478141c into dev Apr 4, 2023

Exilliar deleted the report-v2 branch April 4, 2023 15:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report v2 #201

Report v2 #201

Exilliar commented Jan 24, 2023 •

edited

Loading

ro-sa Apr 4, 2023

ro-sa Apr 4, 2023

ro-sa Apr 4, 2023

Exilliar Apr 4, 2023

ro-sa Apr 4, 2023

Report v2 #201

Report v2 #201

Conversation

Exilliar commented Jan 24, 2023 • edited Loading

ro-sa Apr 4, 2023

Choose a reason for hiding this comment

ro-sa Apr 4, 2023

Choose a reason for hiding this comment

ro-sa Apr 4, 2023

Choose a reason for hiding this comment

Exilliar Apr 4, 2023

Choose a reason for hiding this comment

ro-sa Apr 4, 2023

Choose a reason for hiding this comment

Exilliar commented Jan 24, 2023 •

edited

Loading