1729711 - Incorrect relative header path debug information when object directory is under source directory

Status: RESOLVED FIXED

(Core :: Storage: Quota Manager, task, P3)

Description

[Jari Jalkanen [:jari]]

In function mozilla::dom::quota::MakeSourceFileRelativePath, in file dom/quota/QuotaCommon.cpp, header file path from macro __FILE__ is compared to top of the source directory, and if the beginnings of the paths match, the rest of the header file path is returned as the relative path.

When the object directory is under the top of the source directory, for example when using the macro @TOPSRCDIR@ in the mozconfig file, this leads to an incorrect relative file path.

The issue was found by tests TEST(QuotaCommon_MakeSourceFileRelativePath, DomQuotaSourceFile_Exported) and TEST(QuotaCommon_MakeSourceFileRelativePath, DomLocalstorageSourceFile_Exported_Mapped).

Because it is less common to have the source under the object directory, one way out might be to check for this possibility first, as is later done in the code.

The issue impacts only debug message information.

Comment 1

[Jari Jalkanen [:jari]]

Attachment: Bug 1729711 - Fix __FILE__ path separator handling in QuotaCommon on Windows. r=#dom-storage

On Windows, FILE can produce paths with backslashes, but the
quota manager's error logging compares against hardcoded forward-slash
suffixes. This causes an assertion failure in GetTreeBase.

Additionally, when the objdir is under the source tree, the source
tree base is a prefix of the objdir base, so exported headers
incorrectly match the source tree check first.

Fix both by adding a constexpr NormalizedSourcePath template that
normalizes backslashes to forward slashes at compile time, used in the
QM_HANDLE_ERROR macros and in GetSourceTreeBase/GetObjdirDistInclude-
TreeBase. Also reorder the objdir check before the source tree check
in MakeSourceFileRelativePath.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/0bb5c0d49506
https://hg.mozilla.org/integration/autoland/rev/e455ef7d3ba3
Fix __FILE__ path separator handling in QuotaCommon on Windows. r=dom-storage-reviewers,asuth

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/5d40e2a1d701
https://hg.mozilla.org/integration/autoland/rev/e3f24a336334
Revert "Bug 1729711 - Fix __FILE__ path separator handling in QuotaCommon on Windows. r=dom-storage-reviewers,asuth" for causing build bustages at /QuotaCommon.h

Comment 4

[Silaghi Andreea]

Backed out for causing build bustages as QuotaCommon.h
Backout Link
Push with failures
Failure Log
Failure line /builds/worker/checkouts/gecko/dom/quota/QuotaCommon.h:1379:13: error: bad implicit conversion constructor for 'NormalizedSourcePath'

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/4fd92e7ad15a
https://hg.mozilla.org/integration/autoland/rev/36e6977d0f89
Fix __FILE__ path separator handling in QuotaCommon on Windows. r=dom-storage-reviewers,asuth

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/71329aca5b15
https://hg.mozilla.org/integration/autoland/rev/a12ec7fc8b37
Revert "Bug 1729711 - Fix __FILE__ path separator handling in QuotaCommon on Windows. r=dom-storage-reviewers,asuth" for causing test failure

Comment 7

[amarc]

backed out for causing test failure ( by request ) : https://hg.mozilla.org/integration/autoland/rev/a12ec7fc8b37e39c4af837959cf8fb475f55ba47

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/9f2e8c25f0b4
https://hg.mozilla.org/integration/autoland/rev/6d21b1fa30fe
Fix __FILE__ path separator handling in QuotaCommon on Windows. r=dom-storage-reviewers,asuth

Comment 9

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/6d21b1fa30fe