Move standardReportMeasure to MeasureManager, test updates to measures by version id and timestamp

Author: macumber

src/openstudio_app/OpenStudioApp.cpp

@@ -221,6 +221,8 @@ OpenStudioApp::OpenStudioApp(int& argc, char** argv)
   waitDialog->show();
   emit resetWaitDialog();
 
+  measureManager().setResourcesPath(resourcesPath());
+
   // Non blocking
   startMeasureManagerProcess();
 

src/openstudio_lib/OSDocument.cpp

@@ -1315,7 +1315,7 @@ void OSDocument::addStandardMeasures() {
 
   // standard report measure
   bool srmAdded = false;
-  boost::optional<BCLMeasure> srm = standardReportMeasure();
+  boost::optional<BCLMeasure> srm = OSAppBase::instance()->measureManager().standardReportMeasure();
   if (srm) {
     try {
       std::pair<bool, std::string> result = OSAppBase::instance()->measureManager().updateMeasure(*srm);
@@ -1480,32 +1480,6 @@ std::vector<BCLComponent> OSDocument::componentAttributeSearch(const std::vector
   return result;
 }
 
-boost::optional<BCLMeasure> OSDocument::standardReportMeasure() {
-  // DLM: Breaking changes in openstudio_results measures prevent us from being able to ensure
-  // that measure in users local BCL or remote BCL will work, just use measure in installer
-  return BCLMeasure::load(m_resourcesPath / toPath("openstudio_results"));
-
-  /*
-  const std::string uid("a25386cd-60e4-46bc-8b11-c755f379d916");
-  boost::optional<BCLMeasure> result = getLocalMeasure(uid);
-
-  if (!result) {
-    // if we don't have a result measure in local bcl, use the one in the installer
-    result = BCLMeasure::load(m_resourcesPath / toPath("openstudio_results"));
-  }
-
-  if (m_haveLocalBCL && RemoteBCL::isOnline()) {
-    RemoteBCL remoteBCL;
-    boost::optional<BCLMeasure> onlineResult = remoteBCL.getMeasure(uid);
-    if (onlineResult) {
-      result = onlineResult;
-    }
-  }
-
-  return result;
-  */
-}
-
 bool OSDocument::save() {
   LOG(Debug, "OSDocument::save");
   bool fileSaved = false;

src/openstudio_lib/OSDocument.hpp

@@ -137,8 +137,6 @@ class OPENSTUDIO_API OSDocument : public OSQObjectController
 
   std::vector<BCLComponent> componentAttributeSearch(const std::vector<std::pair<std::string, std::string>>& pairs) const;
 
-  boost::optional<BCLMeasure> standardReportMeasure();
-
   // Returns IddObjectType from either model, componentLibrary, or BCL
   boost::optional<IddObjectType> getIddObjectType(const OSItemId& itemId) const;
 

src/shared_gui_components/MeasureManager.cpp

@@ -96,6 +96,10 @@ void MeasureManager::setUrl(const QUrl& url) {
   m_url = url;
 }
 
+void MeasureManager::setResourcesPath(const openstudio::path& resourcesPath) {
+  m_resourcesPath = resourcesPath;
+}
+
 bool MeasureManager::waitForStarted(int msec) {
   if (m_started) {
     return true;
@@ -199,6 +203,13 @@ void MeasureManager::saveTempModel(const path& tempDir) {
   m_measureArguments.clear();
 }
 
+
+boost::optional<BCLMeasure> MeasureManager::standardReportMeasure() const {
+  // DLM: Breaking changes in openstudio_results measures prevent us from being able to ensure
+  // that measure in users local BCL or remote BCL will work, just use measure in installer
+  return BCLMeasure::load(m_resourcesPath / toPath("openstudio_results"));
+}
+
 std::vector<BCLMeasure> MeasureManager::bclMeasures() const {
   std::vector<BCLMeasure> result;
   result.reserve(m_bclMeasures.size());
@@ -224,6 +235,7 @@ std::vector<BCLMeasure> MeasureManager::combinedMeasures() const {
   result.reserve(m_myMeasures.size() + m_bclMeasures.size());
 
   std::set<UUID> resultUUIDs;
+
   // insert my measures
   for (auto it = m_myMeasures.begin(), itend = m_myMeasures.end(); it != itend; ++it) {
     if (resultUUIDs.find(it->first) == resultUUIDs.end()) {
@@ -958,11 +970,25 @@ bool MeasureManager::checkForUpdates(const openstudio::path& measureDir, bool fo
 
 void MeasureManager::checkForRemoteBCLUpdates() {
   RemoteBCL remoteBCL;
-  int numUpdates = remoteBCL.checkForMeasureUpdates();
+  remoteBCL.checkForMeasureUpdates();
+  std::vector<BCLSearchResult> updates = remoteBCL.measuresWithUpdates();
+
+  // remove false updates (e.g. measure was updated after downloading from bcl due to incorrect sha)
+  updates.erase(std::remove_if(updates.begin(), updates.end(), [this](const BCLSearchResult& update) { 
+     auto current = m_bclMeasures.find(toUUID(update.uid()));
+      if (current != m_bclMeasures.end()) {
+        if (update.versionModified() && current->second.versionModified()) {
+          return update.versionModified().get() < current->second.versionModified().get();
+        }
+      }
+      return false;
+  }), updates.end());
+
+  int numUpdates = updates.size();
+
   if (numUpdates == 0) {
     QMessageBox::information(m_app->mainWidget(), tr("Measures Updated"), tr("All measures are up-to-date."));
-  } else {
-    std::vector<BCLSearchResult> updates = remoteBCL.measuresWithUpdates();
+  } else {    
 
     QString text(QString::number(numUpdates) + tr(" measures have been updated on BCL compared to your local BCL directory.\n")
                  + tr("Would you like update them?"));
@@ -997,50 +1023,6 @@ void MeasureManager::checkForRemoteBCLUpdates() {
   }
 }
 
-void MeasureManager::downloadBCLMeasures() {
-  RemoteBCL remoteBCL;
-  int numUpdates = remoteBCL.checkForMeasureUpdates();
-  if (numUpdates == 0) {
-    QMessageBox::information(m_app->mainWidget(), "Measures Updated", "All measures are up-to-date.");
-  } else {
-    std::vector<BCLSearchResult> updates = remoteBCL.measuresWithUpdates();
-
-    QString detailedText;
-    for (const BCLSearchResult& update : updates) {
-      detailedText += toQString("* name: " + update.name() + "\n");
-      detailedText += toQString(" - uid: " + update.uid() + "\n");
-      auto current = m_bclMeasures.find(toUUID(update.uid()));
-      if (current != m_bclMeasures.end()) {
-        detailedText += toQString(" - old versionId: " + current->second.versionId() + "\n");
-      }
-      detailedText += toQString(" - new versionId: " + update.versionId() + "\n\n");
-    }
-
-    remoteBCL.updateMeasures();
-
-    // remoteBCL.updateMeasures should remove outdated measures, but won't work correctly until https://github.com/NREL/OpenStudio/pull/5129
-    // if we have the new measure, delete outdated ones
-    for (const BCLSearchResult& update : updates) {
-      if (OSAppBase::instance()->currentDocument()->getLocalMeasure(update.uid(), update.versionId())) {
-        OSAppBase::instance()->currentDocument()->removeOutdatedLocalMeasures(update.uid(), update.versionId());
-      }
-    }
-
-    updateMeasuresLists(false);
-
-    QMessageBox msg(m_app->mainWidget());
-    msg.setIcon(QMessageBox::Information);
-    msg.setWindowTitle("Measures Updated");
-    if (numUpdates == 1) {
-      msg.setText("1 measure has been updated.");
-    } else {
-      msg.setText(QString::number(numUpdates) + " measures have been updated.");
-    }
-    msg.setDetailedText(detailedText);
-    msg.exec();
-  }
-}
-
 void MeasureManager::addMeasure() {
   // open modal dialog
   //QSharedPointer<BCLMeasureDialog> dialog(new BCLMeasureDialog(this->mainWindow));

src/shared_gui_components/MeasureManager.hpp

@@ -104,6 +104,8 @@ class MeasureManager : public QObject
 
   void setUrl(const QUrl& url);
 
+  void setResourcesPath(const openstudio::path& resourcesPath);
+
   bool waitForStarted(int msec = 10000);
 
   void setLibraryController(const QSharedPointer<LocalLibraryController>& t_libraryController);
@@ -114,6 +116,9 @@ class MeasureManager : public QObject
   //// Saves the current model to a temp location, used when computing arguments
   void saveTempModel(const path& tempDir);
 
+  /// The standard report measure that comes with the application
+  boost::optional<BCLMeasure> standardReportMeasure() const;
+
   //// Measures downloaded from the BCL.
   std::vector<BCLMeasure> bclMeasures() const;
 
@@ -178,9 +183,6 @@ class MeasureManager : public QObject
   // Checks for updated versions
   void checkForRemoteBCLUpdates();
 
-  /// Downloads updated versions of all BCL measures
-  void downloadBCLMeasures();
-
   void addMeasure();
 
   void duplicateSelectedMeasure();
@@ -210,6 +212,7 @@ class MeasureManager : public QObject
   std::map<UUID, BCLMeasure> m_bclMeasures;
   std::map<openstudio::path, std::vector<measure::OSArgument>> m_measureArguments;
   QUrl m_url;
+  openstudio::path m_resourcesPath;
   QSharedPointer<LocalLibraryController> m_libraryController;
   bool m_started;
   QMutex m_mutex;

src/shared_gui_components/SyncMeasuresDialog.cpp

@@ -124,7 +124,13 @@ void SyncMeasuresDialog::findUpdates() {
     boost::optional<BCLMeasure> workflowMeasure = m_workflow.getBCLMeasureByUUID(measure.uuid());
     if (workflowMeasure) {
       if (workflowMeasure->versionUUID() != measure.versionUUID()) {
-        m_measuresNeedingUpdates.push_back(measure);
+        if (workflowMeasure->versionModified() && measure.versionModified()) {
+          if (workflowMeasure->versionModified().get() < measure.versionModified().get()) {
+            m_measuresNeedingUpdates.push_back(measure);
+          }
+        } else {
+          m_measuresNeedingUpdates.push_back(measure);
+        }
       }
     }