Add pre build command to Windows to remove potentially stale json files #2208

[sjanzou]

Removes the api/api_autogen/library/defaults folder before regenerating json files when the Release build of export_config is run

[brtietz]

Thanks for adding this! I'm seeing more deletions than I expected:

Has there been a change to the api autogen defaults that would lead to this?

[sjanzou]

Thanks for adding this! I'm seeing more deletions than I expected:

Has there been a change to the api autogen defaults that would lead to this?

@brtietz , that is the expected behavior - to remove all of the .json files in the prebuild and then regenerate only the active ones. Were there any change to commit after you built the Release version of export_config (where the .json files are regenerated in the post-build event)?

[brtietz]

Thanks for adding this! I'm seeing more deletions than I expected:

Has there been a change to the api autogen defaults that would lead to this?

@brtietz , that is the expected behavior - to remove all of the .json files in the prebuild and then regenerate only the active ones. Were there any change to commit after you built the Release version of export_config (where the .json files are regenerated in the post-build event)?

Yes, the screenshot is post-build after export_config has run.

[sjanzou]

Thanks for adding this! I'm seeing more deletions than I expected:

Has there been a change to the api autogen defaults that would lead to this?

@brtietz , that is the expected behavior - to remove all of the .json files in the prebuild and then regenerate only the active ones. Were there any change to commit after you built the Release version of export_config (where the .json files are regenerated in the post-build event)?

Yes, the screenshot is post-build after export_config has run.

I do get the files deleted but then are recreated and there are no changes to commit when I do a full rebuild - can you please provide the steps to reproduce the deleted json files when you go to commit changes? Thanks

[brtietz]

I do get the files deleted but then are recreated and there are no changes to commit when I do a full rebuild - can you please provide the steps to reproduce the deleted json files when you go to commit changes? Thanks

I tried a clean build this morning and get the same result:

CMake command used (adjusted for git bash):
cmake -G "Visual Studio 17 2022" -DCMAKE_CONFIGURATION_TYPES="Debug;Release" -DSAMAPI_EXPORT=1 -DSAMPRIVATE=1 -DSAM_SKIP_AUTOGEN=0 -DUSE_XPRESS=0 -DUSE_COINOR=1 -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_SYSTEM_PREFIX_PATH=$ORTOOLSDIR -Dabsl_DIR=$ORTOOLSDIR"\lib\cmake\absl" Dutf8_range_DIR=$ORTOOLSDIR"\lib\cmake\utf8_range" -Dortools_DIR=$ORTOOLSDIR"\lib\cmake\ortools" ..

Then run all configurations (except export config and sam api debug) in batch build:

git status shows the missing files:

A full build log is here:
build_log_260615.txt

It looks like the issue is that export config builds and runs, and then (despite leaving the box unchecked in batch build) export_configd builds but does not run. Simply re-running batch build with both boxes checked does not solve the problem.

Thoughts on whether this is easier to correct in batch build settings or CMakeLists?

[sjanzou]

I do get the files deleted but then are recreated and there are no changes to commit when I do a full rebuild - can you please provide the steps to reproduce the deleted json files when you go to commit changes? Thanks

I tried a clean build this morning and get the same result:

CMake command used (adjusted for git bash): `cmake -G "Visual Studio 17 2022" -DCMAKE_CONFIGURATION_TYPES="Debug;Release" -DSAMAPI_EXPORT=1 -DSAMPRIVATE=1 -DSAM_SKIP_AUTOGEN=0 -DUSE_XPRESS=0 -DUSE_COINOR=1 -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_SYSTEM_PREFIX_PATH=$ORTOOLSDIR -Dabsl_DIR=$ORTOOLSDIR"\lib\cmake\absl" Dutf8_range_DIR=$ORTOOLSDIR"\lib\cmake\utf8_range" -Dortools_DIR=$ORTOOLSDIR"\lib\cmake\ortools" .. `

Then run all configurations (except export config and sam api debug) in batch build:

git status shows the missing files:

A full build log is here: build_log_260615.txt

It looks like the issue is that export config builds and runs, and then (despite leaving the box unchecked in batch build) export_configd builds but does not run. Simply re-running batch build with both boxes checked does not solve the problem.

Thoughts on whether this is easier to correct in batch build settings or CMakeLists?

@brtietz , thanks for the detailed workflow....

You are correct on the debug version causing the issue.

With the latest commit, the json files are only deleted for the release build of api_autogen, so the debug version should not cause the issue regardless of the batch build options - working for me...

[brtietz]

@brtietz , thanks for the detailed workflow....

You are correct on the debug version causing the issue.

With the latest commit, the json files are only deleted for the release build of api_autogen, so the debug version should not cause the issue regardless of the batch build options - working for me...

Thanks for adding that. It looks like there was a second problem: if the defaults folder doesn't exist, my machine will silently fail to write the files to the folder. Deleting all of the files within the defaults folder (rather than the folder itself) solves that problem for me.

Does the latest commit work for you?

[sjanzou]

@brtietz , thanks for the detailed workflow....
You are correct on the debug version causing the issue.
With the latest commit, the json files are only deleted for the release build of api_autogen, so the debug version should not cause the issue regardless of the batch build options - working for me...

Thanks for adding that. It looks like there was a second problem: if the defaults folder doesn't exist, my machine will silently fail to write the files to the folder. Deleting all of the files within the defaults folder (rather than the folder itself) solves that problem for me.

Does the latest commit work for you?

Complete rebuild working for me - 836 files deleted and one changed during rebuild

Note - the one changed file is due to overwriting the api/modules - during the rebuild one of the files is listed as changed as it is regenerated...

after rebuild - no overall changes and nothing to commit

So, yes, the last commit is working for me!

Thanks! Feel free to merge after you approve ;-)