Potential optimisation for LicenseCompareHelper.matchingStandardLicenseIdsWithinText()
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 28/100
- Issue 類型
- 重構
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- java
- 領域
- performance
研究方向
從 src/main/java/org/spdx/utility/compare/LicenseCompareHelper.java 開始,特別檢查 matchingStandardLicenseIdsWithinText() 及其相關方法。首先確認匹配結果是否提供原始文字的索引,以及如何處理 GPL-2.0-only 和 GPL-2.0-or-later 這類彼此重疊的範本。完成的標準是:定義匹配順序與文字移除策略,在保留必要結果及索引行為的同時,證明效能有所提升。
由索引模型根據 Issue 內容生成。
描述
It occurred to me that there may be a potentially substantial performance optimisation possible within the org.spdx.utility.compare.LicenseCompareHelper.matchingStandardLicenseIdsWithinText() family of methods, beyond the existing "quick check regex" optimisation.
Specifically, the idea is that when a match is found for a given license within an input text, the subset of text that matched is removed from the input text before further matching is performed. This not only speeds up subsequent matching (by reducing the size of the input), it also allows for early termination once the input is exhausted (i.e. below the size of the smallest possible match).
This enhancement could (should?) also order matching by approximate license popularity (i.e. the most popular licenses are checked first), since that would tend to result in early termination being reached more frequently in real world use. The OSI publishes such a list, albeit only for OSI-approved licenses - I'm fairly certain I've seen other sources of license popularity that would be more than enough for this purpose (after all it doesn't have to be precise - even using an approximate popularity order would be a lot better than random, or alphabetical, matching processing).
One possible complication is when two templates match the same text - for example the GPL-2.0-only and GPL-2.0-or-later templates tend to match the same thing. If this optimisation were implemented as I'm envisaging, whichever license template is used first would be the only one to show up in the result. Though if that behaviour is undesirable there may be workarounds - the library might maintain a list of "overlapping" templates, and ensure that when one of them matches a given text, the other overlapping templates are always checked too, prior to the matched text being removed from the input.
Another possible complication is if LicenseCompareHelper provides indexes into the original input text where a match was found (I don't recall if it does this or not; if it does I'm not currently using that capability). If so, there will be some extra bookkeeping needed to make sure that those indexes remain correct, given that each subsequent match attempt might only be looking at a fragmented subset of the original input.
- 主要語言
- Java
- 星號
- 71
- 分支
- 44
- 平均合併
- 16 小時 17 分鐘
- 30 天內合併 PR
- 9
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
spdx/Spdx-Java-Library 的其他 Issue
-
question
難度 5/5 一週以上 新手友好度 30/100
spdx/Spdx-Java-Library#449 ·
-
question
難度 5/5 一週以上 新手友好度 30/100
spdx/Spdx-Java-Library#398 ·
-
wontfix
難度 3/5 1-2 天 新手友好度 45/100
spdx/Spdx-Java-Library#393 · 2 則留言 · 1 個 reaction ·
-
matching
難度 5/5 一週以上 新手友好度 35/100
spdx/Spdx-Java-Library#392 · 4 則留言 ·
-
enhancement
難度 5/5 一週以上 新手友好度 30/100
spdx/Spdx-Java-Library#390 · 11 則留言 · 1 個 reaction ·
查看 spdx/Spdx-Java-Library 的全部 Issue
相似的 Issue
-
backend
難度 2/5 1-3 小時 新手友好度 76/100
bcgov/nr-forest-client#2524 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 67/100
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 74/100
維護者通常 1 天內回覆
-
team:Lumberjack
難度 2/5 1-3 小時 新手友好度 76/100
OpenLiberty/open-liberty#35998 ·
維護者通常 1 天內回覆
-
[BUG] SQS SendMessageBatch accepts more than 10 entries instead of TooManyEntriesInBatchRequest可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉
難度 2/5 1-3 小時 新手友好度 67/100
維護者通常 1 天內回覆