ReapplyLocalizationsToAllComponents aborts (and keeps aborting) on a disposed registered control

未关闭 适合新手
#175 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
csharp

调研方向

从 XliffLocalizationManagerWinforms.cs 中的 ReapplyLocalizationsToAllComponents 开始,阅读已注册组件的存储和本地化方式。issue 提供了 XliffLocalizationManagerTests.cs 的复现步骤:在配有显示器的 Windows 上运行,并确认已释放的控件不再中止处理过程,后续仍有效的标签也能完成本地化。回归测试通过后,此项更改即告完成。

由索引模型根据 Issue 内容生成。

描述

Summary

ReapplyLocalizationsToAllComponents() (invoked by LocalizationManagerWinforms.SetUILanguage(langId, true), which every WinForms app calls on every UI language switch) walks ComponentCache with no check for whether a registered control has already been disposed, and the foreach has no per-item try/catch:

// XliffLocalizationManagerWinforms.cs
public void ReapplyLocalizationsToAllComponents()
{
    foreach (var component in ComponentCache.Keys)
        ApplyLocalization(component);
}

ComponentCache itself never has entries removed — a control registered once via an L10NSharpExtender's SetLocalizingId (i.e. nearly every control in every dialog a typical app ever shows) stays in the cache for the life of the process, even long after its owning form has been closed and disposed.

Real-world crash

Hit this in SayMore (reported by a user switching from English to Tibetan mid-session, after having opened and closed an unrelated short-lived dialog earlier):

System.ObjectDisposedException: Cannot access a disposed object.
Object name: 'AutoHeightLabel'.
   at System.Windows.Forms.Control.CreateHandle()
   at System.Windows.Forms.Control.get_Handle()
   at System.Windows.Forms.Control.CreateGraphicsInternal()
   at System.Windows.Forms.Control.CreateGraphics()
   at SIL.Windows.Forms.Widgets.AutoHeightLabel.AdjustHeight()
   at L10NSharp.Windows.Forms.XLiffUtils.XliffLocalizationManagerWinforms.ApplyLocalizationsToControl(Control ctrl, String id)
   at L10NSharp.Windows.Forms.XLiffUtils.XliffLocalizationManagerWinforms.ApplyLocalization(IComponent component)
   at L10NSharp.Windows.Forms.XLiffUtils.XliffLocalizationManagerWinforms.ReapplyLocalizationsToAllComponents()
   at L10NSharp.Windows.Forms.LocalizationManagerInternalWinforms`1.ReapplyLocalizationsToAllObjectsInAllManagers()
   at L10NSharp.Windows.Forms.LocalizationManagerWinforms.SetUILanguage(String langId, Boolean reapplyLocalizationsToAllObjectsInAllManagers)

AutoHeightLabel (from SIL.Windows.Forms) reacts to a text/font change by calling CreateGraphics() to remeasure itself, which throws once the control is disposed — but this is not really an AutoHeightLabel-specific problem: it is just the first control type anyone noticed hitting it, because it happens to touch its own handle on a text change. Any control that does the same is exposed the same way.

Severity beyond the crash itself

Because the foreach has no per-item recovery, the exception does not just affect the one stale control — it aborts the whole reapply pass partway through, silently leaving every component that happens to be registered after the disposed one in ComponentCache's enumeration order un-relocalized for that language switch. And because the stale entry is never removed, every subsequent language switch for the rest of the process hits the same wall at the same point, so this is not a one-time blip — once a single short-lived dialog has been shown and closed, language switching is effectively broken for the rest of that run.

Proposed minimal test

This reproduces the failure directly against XliffLocalizationManagerWinforms, without needing SIL.Windows.Forms — a plain Control subclass that touches its handle on OnTextChanged stands in for AutoHeightLabel. Verified failing against current master (pre-fix); confirmed on both net48 and net8.0-windows.

/// ------------------------------------------------------------------------------------
/// <summary>
/// Reproduces a crash seen in a real application (SayMore): ReapplyLocalizationsToAllComponents
/// -- called from SetUILanguage(..., true), i.e. every time the user switches UI language --
/// walks ComponentCache with no check for whether a registered control has already been
/// disposed, and the foreach has no per-item try/catch. A disposed control that reacts to
/// its own OnTextChanged by touching its handle -- as SIL.Windows.Forms' AutoHeightLabel does,
/// calling CreateGraphics() to remeasure itself -- throws ObjectDisposedException the moment
/// ApplyLocalizationsToControl sets its Text, and nothing catches it: the one disposed control
/// aborts the whole pass, silently leaving every component registered after it in the cache
/// (here, a perfectly live Label) un-relocalized for this and every later language switch,
/// since the disposed entry is never removed from ComponentCache.
/// </summary>
/// ------------------------------------------------------------------------------------
[Test]
[Category("RequiresDisplay")]
public void ReapplyLocalizationsToAllComponents_OneRegisteredControlIsDisposed_ThrowsAndLeavesLaterComponentsUnlocalized()
{
    LocalizationManagerWinforms.SetUILanguage("en", true);
    LocalizationManagerInternalWinforms<XLiffDocument>.LoadedManagers.Clear();
    using (var folder = new L10NSharp.Tests.TempFolder())
    {
        var installedFolder = Path.Combine(folder.Path, "installed");
        // ReSharper disable once AssignNullToNotNullAttribute
        var userRelativeFolder = Path.Combine("Temp", Path.GetFileName(Path.GetDirectoryName(folder.Path)),
            Path.GetFileName(folder.Path), "user");

        // Give each control's id a real, retrievable English string up front (unlike
        // RegisterComponentForLocalizing's defaultText parameter, which XliffTransUnitUpdater.Update
        // silently ignores whenever LangId isn't set -- not the bug this test is about, so
        // side-stepping it here by seeding the string cache the same way the other tests in
        // this file do for their own ids).
        var englishDoc = CreateNewDocument(AppVersion, "en");
        englishDoc.AddTransUnit(CreateTransUnit("disposed.id", false,
            CreateTransUnitVariant("en", "original disposed text")));
        englishDoc.AddTransUnit(CreateTransUnit("live.id", false,
            CreateTransUnitVariant("en", "live label text")));
        englishDoc.Save(Path.Combine(installedFolder,
            LocalizationManager.GetTranslationFileNameForLanguage(AppId, "en")));

        var manager = (XliffLocalizationManagerWinforms)LocalizationManagerWinforms.Create("en", AppId,
            AppName, AppVersion, installedFolder, userRelativeFolder, null, new string[] { });

        // Registration happens the way it does in a real app -- after Create(), as each
        // dialog/control is constructed over the app's lifetime -- not before it.
        var disposedControl = new ControlThatTouchesItsHandleOnTextChanged();
        manager.RegisterComponentForLocalizing(disposedControl, "disposed.id",
            "original disposed text", null, null, null);
        disposedControl.Dispose();

        // Registered AFTER the disposed control, so it sits later in ComponentCache's
        // enumeration order and would be the casualty of an aborted reapply pass.
        var liveLabel = new Label();
        manager.RegisterComponentForLocalizing(liveLabel, "live.id", "live label text", null, null, null);

        Assert.That(() => manager.ReapplyLocalizationsToAllComponents(),
            Throws.InstanceOf<ObjectDisposedException>(),
            "ReapplyLocalizationsToAllComponents should not let one disposed control's " +
            "ObjectDisposedException escape unhandled.");

        // The real-world consequence of that unhandled exception: the foreach loop
        // aborted at disposedControl and never reached liveLabel. liveLabel is otherwise
        // perfectly healthy, but it was never relocalized to its registered text.
        Assert.That(liveLabel.Text, Is.EqualTo(string.Empty),
            "liveLabel was registered after the disposed control, so the aborted reapply " +
            "loop never reached it and it was never relocalized to 'live label text'.");
    }
}

/// <summary>
/// Mirrors SIL.Windows.Forms.Widgets.AutoHeightLabel, which reacts to a Text/Font change
/// by calling CreateGraphics() to remeasure itself. CreateGraphics() throws
/// ObjectDisposedException once the control has been disposed.
/// </summary>
private class ControlThatTouchesItsHandleOnTextChanged : Control
{
    protected override void OnTextChanged(EventArgs e)
    {
        base.OnTextChanged(e);
        using (CreateGraphics()) { }
    }
}

(Drops into XliffLocalizationManagerTests.cs, alongside the existing tests there; needs using System.Windows.Forms; added to that file's usings.)

Possible directions for an actual fix (not proposed here, just flagging)

  • ReapplyLocalizationsToAllComponents/ApplyLocalization could skip (or try/catch and continue past) a component whose Control IsDisposed.
  • ComponentCache could have entries removed proactively — e.g. a control's Disposed event could unregister it — rather than only ever growing for the life of the process.

No public API currently exists for a consuming application to remove a disposed control from a LocalizationManager's cache itself, so a host app's only options right now are to avoid ever disposing a registered control (impractical) or to reflect into ComponentCache via the internal ILocalizationManagerInternal interface (fragile — which is what we ended up doing as a stopgap in SayMore).

主要语言
C#
星标
3
派生
10
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

sillsdev/l10nsharp 的其他 Issue

查看 sillsdev/l10nsharp 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。