Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix floorplanjs issue #5341

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Fix floorplanjs issue #5341

wants to merge 3 commits into from

Conversation

wenyikuang
Copy link
Collaborator

@wenyikuang wenyikuang commented Jan 8, 2025 •
edited
Loading

Pull request overview

Fix the test about floorPlanJS.

The line:

std::string storyName = stories[storyIdx].get("name", storyName).asString();

contains bad initilization which is using the storyName before it initilizaed properly.

The bad initiliazation trigger some kind of undefined behavior and the undefined behavior is ....undefined.

Therefore, somehow it works, somehow it broken.

Pull Request Author

  • Model API Changes / Additions
  • Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
  • Model API methods are tested (in src/model/test)
  • EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
  • If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
  • If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
  • Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
  • All new and existing tests passes
  • If methods have been deprecated, update rest of code to use the new methods

Labels:

  • If change to an IDD file, add the label IDDChange
  • If breaking existing API, add the label APIChange
  • If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • Code Style, strip trailing whitespace, etc.
  • All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
  • Labeling is ok
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified

A run of tests from the remote CI box:

[----------] 173 tests from GeometryFixture
[ RUN      ] GeometryFixture.BoundingBox
[       OK ] GeometryFixture.BoundingBox (0 ms)
[ RUN      ] GeometryFixture.BoundingBox_Empty
[       OK ] GeometryFixture.BoundingBox_Empty (0 ms)
[ RUN      ] GeometryFixture.BoundingBox_Touching
[       OK ] GeometryFixture.BoundingBox_Touching (0 ms)
[ RUN      ] GeometryFixture.BoundingBox_NoIntersection
[       OK ] GeometryFixture.BoundingBox_NoIntersection (0 ms)
[ RUN      ] GeometryFixture.FloorplanJS
[       OK ] GeometryFixture.FloorplanJS (9 ms)

./Products/openstudio_model_tests --gtest_filter="*ThreeJSReverseTranslator_FloorplanJS*"
Running main() from gmock_main.cc
Note: Google Test filter = *ThreeJSReverseTranslator_FloorplanJS*
[==========] Running 15 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 15 tests from ModelFixture
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS
Starting toThreeScene in source
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS (37 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_SurfaceMatch
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_SurfaceMatch (20 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Doors
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Doors (16 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Windows
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Windows (60 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_SimAUD_Paper
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_SimAUD_Paper (231 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Shading
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Shading (11 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_SplitLevel
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_SplitLevel (17 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_StorySpaceHeights
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_StorySpaceHeights (24 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Colors
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Colors (8 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_DifferingNumVertices
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_DifferingNumVertices (10 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_School
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_School (295 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_StoryMultipliers
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_StoryMultipliers (28 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_StoryMultipliers2
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_StoryMultipliers2 (22 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_OpenToBelow
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_OpenToBelow (18 ms)
[ RUN      ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Site_ClimateZones_4166
Starting toThreeScene in source
[       OK ] ModelFixture.ThreeJSReverseTranslator_FloorplanJS_Site_ClimateZones_4166 (28 ms)
[----------] 15 tests from ModelFixture (831 ms total)

[----------] Global test environment tear-down
[==========] 15 tests from 1 test suite ran. (832 ms total)
[  PASSED  ] 15 tests.

TODO:

  • Make the CI passed since some update probably needed to add in the machine.

@wenyikuang wenyikuang added severity - Normal Bug Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Jan 8, 2025
@wenyikuang wenyikuang requested a review from jmarrec January 8, 2025 06:49
@wenyikuang wenyikuang self-assigned this Jan 8, 2025
@wenyikuang wenyikuang changed the title Fix floor js issue Fix floorplanjs issue Jan 8, 2025
jmarrec
jmarrec approved these changes Jan 8, 2025
View reviewed changes
src/utilities/geometry/FloorplanJS.cpp Outdated
}

std::string storyColor;
std::string storyColor = "";
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is pointless. The default ctor is an empty string already, equivalent to ""

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we don't need it, was thinking following the next lines.

src/utilities/geometry/FloorplanJS.cpp Outdated Show resolved Hide resolved
src/utilities/geometry/FloorplanJS.cpp
@@ -1078,11 +1078,10 @@ ThreeScene FloorplanJS::toThreeScene(bool openstudioFormat) const {
for (Json::ArrayIndex storyIdx = 0; storyIdx < storyN; ++storyIdx) {

if (checkKeyAndType(stories[storyIdx], "name", Json::stringValue)) {
std::string storyName = stories[storyIdx].get("name", storyName).asString();
buildingStoryNames.push_back(storyName);
buildingStoryNames.push_back(stories[storyIdx].get("name", "").asString());
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The old notation was definitely extremely weird to look at. It's weird that this compiles, but I guess we shush some warnings, and especially we use -Wno-uninitialized

@ci-commercialbuildings
Copy link
Collaborator

ci-commercialbuildings commented Jan 8, 2025 •
edited
Loading

CI Results for d25307b:

@DavidGoldwasser DavidGoldwasser added this to the OpenStudio SDK 3.10.0 milestone Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmarrec jmarrec jmarrec approved these changes

Assignees

@wenyikuang wenyikuang

Labels
Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. severity - Normal Bug
Projects
None yet
Milestone
OpenStudio SDK 3.10.0
Development

Successfully merging this pull request may close these issues.

[CI] Mac incremental has failing tests on all branches
4 participants
@wenyikuang @ci-commercialbuildings @jmarrec @DavidGoldwasser