Audacity Bug Summary
••• Introduction •••
••• Keywords •••
    Audacity 3.0.3 development began 19th April 2021

Audacity Bugzilla



Bug 2143 - Effects fail silently (and with buildup of .tmp files) when pluginsettings.cfg is locked
Effects fail silently (and with buildup of .tmp files) when pluginsettings.cf...
Status: RESOLVED FIXED
Product: Audacity
Classification: Unclassified
Component: Built-in FX
2.3.3
Per OS All
: P3 RepeatableAll
Assigned To: Default Assignee for New Bugs
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2019-06-29 10:16 UTC by Peter Sampson
Modified: 2021-02-01 12:43 UTC (History)
6 users (show)

See Also:
Steps To Reproduce:
1) lock the pluginsettings.cfg file 2) launch Audacity 3) get some audio 4) make a selection 5) Effect > Echo (but any will do) 6) click Preview 7) Observe: the Preview plays OK 8) Click OK to apply the effect 9) Observe nothing happens - the effect is not applied and no error message is generated 10) also observe a .tmp file of the form plu****.tmp is created (and does not get cleaned up) in the audacity settings folder --------------------------------------- 11) change the default settings 12) Click Manage 13) Save Preset 14) Observe the preset gets saved and can be recalled (but only for this session) 15) Exit Audacity 16) Observe: 2 error messages 16) Relaunch Audacity 17) get some audio anf make a selection 18) Effect > Echo 19) Click Manage 20) observe preset from Step 13 is not present
Release Note:
Group: Problems reopening, saving or crashing in projects *If your pluginsettings.cfg file becomes locked then when you try to use effects they may fail silently (with no error message) and a build-up of plu****.tmp files may occur in your audacity settings folder. Note that this should not happen in normal circumstances, but some virus checker apps have been know to lock the file.
First Git SHA:
Group: ---
Workaround:
Unlock your pluginsettings.cfg file - please see: https://manual.audacityteam.org/man/faq_installation_and_plug_ins.html#reset Delete the aud****.tmp files
Closed: 2021-02-01 00:00:00
petersampsonaudacity: Test‑OK‑Win+
petersampsonaudacity: Test‑OK‑Mac+
petersampsonaudacity: Test‑OK‑Mac+


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Peter Sampson 2019-06-29 10:16:19 UTC
Effects fail silently (and with build up of plu****.tmp files) when pluginsettings.cfg is locked.

The preview works fine but the effect fails to work - trying to OK the effect causes a build of the plu****.tmp files (for which there is no clean-up).

The user is not told that the effect has failed to work.

The user can apparently save user presets but these only hold for this current Audacity session.

On exiting Audacity the user sees two error messages:

1) message-1
>15:01:35: Error: can't remove file
>'C:\Users\Peter\AppData\Roaming\audacity\pluginsettings,cfg
>'(error5: Access is denied.)

2) message-2
>15:02:06: Error: Failed to update user configuration file.
Comment 1 Peter Sampson 2019-06-30 12:20:34 UTC
Testing on macOS 10.14.5 Mojave with alpha 2.3.3 jc002 of 30Jun19
Similar to Windows

1) at Step 9 the effect is not applied - and there is no error or warning message
2) 3 temp file sof the form pluginsettings****** sre created )and there is no clean-up)

3) and steps 11-16 fail in the same way as on Windows
Comment 2 Paul L 2019-07-14 08:28:49 UTC
The buildup if temporary files appears to be a bug in wxWidgets, where wxFileConfig::Flush() uses wxTempFile::Commit(), which fails, and then the destructor of wxTempFile fails to clean up
Comment 3 Paul L 2019-07-14 08:41:51 UTC
These lines in EffectUIHost::OnApply explain the quiet failure to do anything when OK is pressed:

   // This will take care of calling TransferDataFromWindow() for an effect.
   if (mEffect &&  !mEffect->SaveUserPreset(mEffect->GetCurrentSettingsGroup()))
   {
      return;
   }
Comment 4 Paul L 2019-07-14 08:47:32 UTC
These symptoms date from at least Audacity 2.2.2, so they are not regressions, and not caused by the last wxWidgets upgrade
Comment 5 Peter Sampson 2019-07-14 15:23:05 UTC
(In reply to Paul L from comment #4)
>These symptoms date from at least Audacity 2.2.2, so they are not regressions
Indeed - and this bug was never flagged as such
Comment 6 Peter Sampson 2019-07-27 10:11:19 UTC
Demoting to P2 as this is not caused in normal usage of Audacity - possible use cases are:
a) Virus checker locks the file

b) user locks the file thinking that it protects contents from change
Comment 7 Peter Sampson 2019-08-22 06:43:51 UTC
Demoted to P3 with a Release Note and Workaround as this file should not become locked in normal use of Audacity.
Comment 8 Peter Sampson 2021-01-12 11:13:45 UTC
We used to get user reports on the Forum with this happening - but we have not had this for a very long while now - we used to think that maybe the files got locked by virus checkers,

So the basic way of this happening is "extreme user error" i.e. the user deliberately locking the file.

Accordingly I am going to downgrade this to P4
Comment 9 Peter Sampson 2021-01-31 11:58:48 UTC
Tested on W10 with Audacity 3.0.0 21296b0

This now works properly on Windows, with
a) an message shown to the user
b) help button in the message
c) no launch of the effect while the problem remains
d) fixing the problem by unlocking and then using the Retry button proceeds to launch the effect
e) the Quit Audacity button - "does what it says on the tin"

And of course the blocking at step a) means that there is no longer a build-up of tmp files
Comment 10 Peter Sampson 2021-01-31 12:14:57 UTC
(In reply to Peter Sampson from comment #9)
The nuclear "Quit Audacity" button is maybe a little drastic for effects (temporarily) not working.

But I think it's OK in the context of a single consolidated error message for all the use cases.   ;-)
Comment 11 Peter Sampson 2021-01-31 12:55:39 UTC
Tested on macOS 11.1 Big Sur with Audacity 3.0.0 21296b0

This now works properly on Windows, with
a) an message shown to the user
b) help button in the message
c) no launch of the effect while the problem remains
d) fixing the problem by unlocking and then using the Retry button proceeds to launch the effect
e) the Quit Audacity button - "does what it says on the tin"

And of course the blocking at step a) means that there is no longer a build-up of tmp files
Comment 12 Peter Sampson 2021-02-01 12:43:14 UTC
In the light of the crash failure on Mac with Bug ]2652

I retested this on macOS 11.1 Big Sur with Audacity 3.0.0 accd177

Still works fine