fix(config): allow concurrent access to pyrevit_config.ini

[sanzoghenzo]

fixes #2463 #2512

It seems to work on my machine, I ran 3 instances of revit 2023 one after another, and then 2 instances of revit 2025.

[jmcouffin]

I will try it with the installers tomorrow morning
Thanks @sanzoghenzo Keep them coming 🤖

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25013+1857-wip

[jmcouffin]

I launched 3x2024 within seconds, no issues
3x2023, 1 out of 3 greeted me with

This is a great improvement

[jmcouffin]

exception raised here https://github.com/sanzoghenzo/pyRevit/blob/cc11f7680b8bea25bee8360c318445cfbbd6026e/dev/pyRevitLabs/pyRevitLabs.PyRevit/PyRevitConfig.cs#L53

[jmcouffin]

Me and my friend ChatG got this working using an ugly retry mechanism:

        using System.IO;
        
        //...


        // save config file to standard location
        public void SaveConfigFile()
        {
            if (_adminMode)
            {
                logger.Debug("Config is in admin mode. Skipping save");
                return;
            }

            logger.Debug("Saving config file \"{0}\"", PyRevitConsts.ConfigFilePath);

            int retryCount = 5;            // Number of retry attempts
            int delayMilliseconds = 100;   // Delay between retries

            while (retryCount > 0)
            {
                try
                {
                    _config.Save(PyRevitConsts.ConfigFilePath);
                    return; // Exit method if successful
                }
                catch (IOException ex) // Catch only IO exceptions related to file locking
                {
                    retryCount--;
                    if (retryCount == 0)
                    {
                        throw new PyRevitException(string.Format("Failed to save config to \"{0}\" after multiple attempts. | {1}",
                                                                 PyRevitConsts.ConfigFilePath, ex.Message));
                    }

                    logger.Debug("Retrying to save config file \"{0}\"... Remaining retries: {1}", 
                                 PyRevitConsts.ConfigFilePath, retryCount);

                    System.Threading.Thread.Sleep(delayMilliseconds); // Wait before retrying
                }
                catch (Exception ex)
                {
                    throw new PyRevitException(string.Format("Failed to save config to \"{0}\". | {1}",
                                                             PyRevitConsts.ConfigFilePath, ex.Message));
                }
            }
        }

Thoughts @sanzoghenzo, except that it is a crappy way of doing it ;p

[sanzoghenzo]

Why does the "get current attachments" need to save the file? This clones and attachments thing starts to driving me mad 🤯

From a quick look at it, I believe this is the culprit:

pyRevit/dev/pyRevitLabs/pyRevitLabs.PyRevit/PyRevitClones.cs

Line 124 in 6c94474

SaveRegisteredClones(validatedClones);

We need to write back only if the list of attachments have changed.

But in any case yes, we need to add some checks in the save method to handle this kind of concurrency.
But anyway, who's the crazy person that starts multiple revit instances at the same time?? 🤣

[jmcouffin]

But anyway, who's the crazy person that starts multiple revit instances at the same time?? 🤣

Trust me, plenty of BIM Managers do when they review files in Revit!

From a quick look at it, I believe this is the culprit:

pyRevit/dev/pyRevitLabs/pyRevitLabs.PyRevit/PyRevitClones.cs

Line 124 in 6c94474

SaveRegisteredClones(validatedClones);

We need to write back only if the list of attachments have changed.

Want to do it @sanzoghenzo ?

[sanzoghenzo]

I'll try it, not sure if I can do this today;

For the retry solution you proposed, this mitigates the problem but doesn't solve the root issue: what to do when multiple instances try to write on the same file? It's the whole git/cloud storage problem again and again...
Let's see if we can reduce the problem as much as possible.

[jmcouffin]

but doesn't solve the root issue:

Agree 💯

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25015+1341-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25015+1357-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25024+1520-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25024+1957-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25025+1310-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25030+1056-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25030+1130-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25030+1138-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25031+1700-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25032+1615-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25032+1635-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25032+1841-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25033+1337-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25033+1402-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25034+1241-wip

[github-actions]

📦 New work-in-progress (wip) builds are available for 5.0.0.25034+1511-wip

[github-actions]

📦 New public release are available for 5.0.0.24174+2300