👩🏻‍🤝‍👨🏽 🙋🏻 🐝 "ओसु!" खेलें, लेकिन बग्स के लिए देखें 👨🏿‍🚀 🌊 ⛴️

चित्र 1

नमस्ते, आप सभी विदेशी और सादे कीड़े के समान रूप से इकट्ठा होते हैं! हमें आज अपने पीवीएस-स्टूडियो टेस्ट बेंच पर एक दुर्लभ नमूना मिला है - एक गेम जिसे "ओशु!" कहा जाता है, सी # में लिखा गया है। हमेशा की तरह, हम बग की तलाश करेंगे, उनका विश्लेषण करेंगे और खेलेंगे।

खेल

Osu! एक ओपन-सोर्स रिदम गेम है। गेम की वेबसाइट के अनुसार, यह काफी लोकप्रिय है, जिसमें 15 मिलियन से अधिक खिलाड़ी खाते हैं। इस परियोजना में मुफ्त गेमप्ले, रंगीन डिज़ाइन, मानचित्र अनुकूलन, एक उन्नत ऑनलाइन प्लेयर रैंकिंग सिस्टम, मल्टीप्लेयर मोड और संगीत के एक समृद्ध सेट की सुविधा है। खेल के बारे में विस्तार से बताने का कोई मतलब नहीं है; आप इंटरनेट पर इसके बारे में सब पढ़ सकते हैं। इस पृष्ठ से शुरू करें।

मुझे प्रोजेक्ट के सोर्स कोड में ज्यादा दिलचस्पी है, जो GitHub पर उपलब्ध है । एक चीज जो आपकी आंख को तुरंत पकड़ लेती है वह बड़ी संख्या में रिपॉजिटरी कमिट (24 हजार से अधिक) है, जो गहन, चल रहे विकास का संकेत है (खेल पहली बार 2007 में जारी किया गया था, लेकिन काम पहले भी शुरू हो चुका होगा)। हालांकि यह परियोजना बड़ी नहीं है: केवल १३१३ .cs फाइलें कुल १३५ हजार गैर-खाली एलओसी हैं। इस संख्या में परीक्षण भी शामिल हैं, जिन्हें मैं आमतौर पर चेक चलाते समय ध्यान में नहीं रखता हूं। परीक्षण 25 हजार LOC के साथ .cs फ़ाइलों की 306 बनाते हैं। परियोजना वास्तव में छोटी है: उदाहरण के लिए, पीवीएस-स्टूडियो का सी # कोर लगभग 300 हजार एलओसी लंबा है।

परीक्षण फ़ाइलों को छोड़कर, मैंने 1507 फाइलें 110 हजार एलओसी लंबी जाँच की। चेक ने कुछ दिलचस्प बग प्रकट किए, जो मैं आपको दिखाने के लिए तैयार हूं।

कीड़े

V3001 समान उप-अभिव्यक्तियाँ हैं 'परिणाम == HitResult.Perfect' बाईं और दाईं ओर '' ऑपरेटर। ड्राएबलहोल्डनोट। 266

protected override void CheckForResult(....) { .... ApplyResult(r => { if (holdNote.hasBroken && (result == HitResult.Perfect || result == HitResult.Perfect)) result = HitResult.Good; .... }); }

यह कॉपी-पेस्ट ओरिएंटेड प्रोग्रामिंग का एक अच्छा उदाहरण है, जो कि हाल ही में मेरे सहकर्मी वेलेरी कोमारोव द्वारा अपने लेख " 2019 में जावा प्रोजेक्ट्स में शीर्ष 10 कीड़े मिला " में इस्तेमाल किया गया एक विनोदी शब्द है।

वैसे भी, दो समान चेक एक पंक्ति में निष्पादित किए जाते हैं। उनमें से एक शायद HitResult गणन के कुछ अन्य निरंतर जाँच करने के लिए था:

 public enum HitResult { None, Miss, Meh, Ok, Good, Great, Perfect, }

किस कन्टेस्टेंट को चेक किया जाना था? या हो सकता है कि दूसरी जाँच बिल्कुल नहीं होनी चाहिए? ये ऐसे सवाल हैं जिनका जवाब केवल लेखक ही दे सकते हैं। वैसे भी, यह एक त्रुटि है जो प्रोग्राम के निष्पादन तर्क को विकृत करता है।

V3001 समान उप-अभिव्यक्तियाँ हैं 'परिवार! = GetFamilyString (TournamentTypeface.Aquatico)' बाईं ओर और '&&' ऑपरेटर के दाईं ओर। टूर्नामेंटफोंट.के 64

 public static string GetWeightString(string family, FontWeight weight) { .... if (weight == FontWeight.Regular && family != GetFamilyString(TournamentTypeface.Aquatico) && family != GetFamilyString(TournamentTypeface.Aquatico)) weightString = string.Empty; .... }

फिर से कॉपी-पेस्ट करें। मैंने कोड फिर से बनाया है इसलिए गलती अब आसानी से देखी जा सकती है लेकिन मूल रूप से यह एक पंक्ति में लिखा गया था। पिछले उदाहरण की तरह, मैं निश्चित रूप से यह नहीं कह सकता कि यह कैसे तय किया जाना चाहिए। टूर्नामेंट टूर्नामेंट प्रचार में केवल एक स्थिरांक होता है:

 public enum TournamentTypeface { Aquatico }

शायद गलती दो बार परिवार चर की जाँच के बारे में है, लेकिन मैं गलत हो सकता है।

V3009 [CWE-393] यह विचित्र है कि यह विधि हमेशा एक और 'समान' मूल्य को वापस करती है। KeyCounterAction.cs 19

 public bool OnPressed(T action, bool forwards) { if (!EqualityComparer<T>.Default.Equals(action, Action)) return false; IsLit = true; if (forwards) Increment(); return false; }

यह विधि हर बार झूठी होती है। इस तरह के मामलों में, मैं आमतौर पर फ़ंक्शन कॉल की जांच करूंगा, क्योंकि आप अक्सर पा सकते हैं कि कॉलर रिटर्न मूल्य का उपयोग नहीं करता है, जिसका अर्थ है कि कोई मुद्दा नहीं है (खराब शैली के अलावा)। इस मामले में कॉल कैसा दिखता है:

 public bool OnPressed(T action) => Target.Children .OfType<KeyCounterAction<T>>() .Any(c => c.OnPressed(action, Clock.Rate >= 0));

जैसा कि आप देख सकते हैं, कॉलर ऑनपेड विधि द्वारा लौटाए गए मूल्य का उपयोग करता है। चूँकि वह मान हमेशा गलत होता है , इसलिए कॉल करने वाला खुद भी हमेशा झूठ बोलता है। इस कोड में गलती होने की संभावना है और इसे संशोधित किया जाना चाहिए।

एक और समान बग:

V3009 [CWE-393] यह विचित्र है कि यह विधि हमेशा एक और 'समान' मूल्य को वापस करती है। KeyCounterAction.cs 30

V3042 [CWE-476] संभावित NullReferenceException। '?' और '' ऑपरेटरों का उपयोग 'val.NewValue' ऑब्जेक्ट टूर्नामेंट टूर्नामेंट के सदस्यों तक पहुँचने के लिए किया जाता है। 41

 public TournamentTeam() { Acronym.ValueChanged += val => { if (....) FlagName.Value = val.NewValue.Length >= 2 // <= ? val.NewValue?.Substring(0, 2).ToUpper() : string.Empty; }; .... }

Val.NewValue वैरिएबल की स्थिति में खतरनाक तरीके से नियंत्रित किया जाता है ?: ऑपरेटर। विश्लेषक क्या सोचता है, यह तथ्य है कि बाद में तत्कालीन शाखा में, उसी चर को सशर्त पहुंच ऑपरेटर का उपयोग करके सुरक्षित तरीके से नियंत्रित किया जाता है: val.NewValue .Substring (....) ।

एक और समान बग:

V3042 [CWE-476] संभावित NullReferenceException। '?' और '' ऑपरेटरों का उपयोग 'val.NewValue' ऑब्जेक्ट टूर्नामेंट टूर्नामेंट के सदस्यों तक पहुँचने के लिए किया जाता है। 48

V3042 [CWE-476] संभावित NullReferenceException। '?' और '' ऑपरेटरों का उपयोग 'एपीआई' ऑब्जेक्ट SetupScreen.cs 77 के सदस्यों तक पहुँचने के लिए किया जाता है

 private void reload() { .... new ActionableInfo { Label = "Current User", ButtonText = "Change Login", Action = () => { api.Logout(); // <= .... }, Value = api?.LocalUser.Value.Username, .... }, .... } private class ActionableInfo : LabelledDrawable<Drawable> { .... public Action Action; .... }

यह एक अधिक अस्पष्ट है, लेकिन मेरा मानना है कि यह एक बग भी है। प्रोग्रामर ActionableInfo प्रकार का एक ऑब्जेक्ट बनाता है। एक्शन फ़ील्ड को एक लैम्ब्डा फ़ंक्शन का उपयोग करके आरंभीकृत किया जाता है, जो खतरनाक तरीके से संभावित अशक्त संदर्भ एपी को संभालता है। विश्लेषक इस पैटर्न को एक त्रुटि मानते हैं क्योंकि एपी चर को बाद में एक सुरक्षित तरीके से संभाला जाता है, जब मूल्य पैरामीटर को इनिशियलाइज़ किया जाता है। मैंने इस मामले को अस्पष्ट कहा, क्योंकि लंबो फ़ंक्शन में कोड का अर्थ है कि निष्पादन में देरी, जिसके परिणामस्वरूप डेवलपर किसी तरह गारंटी दे सकता है कि एपीआई संदर्भ गैर-शून्य होगा। लेकिन मुझे इस बारे में यकीन नहीं है क्योंकि लैंबडा फ़ंक्शन का शरीर किसी भी सुरक्षित संदर्भ हैंडलिंग का उपयोग नहीं करता है जैसे कि पूर्व चेक।

V3066 [CWE-683] 'Atan2' विधि: 'diff.X' और 'diff.Y' में पारित किए गए तर्कों का संभावित गलत क्रम। SliderBall.cs 182

 public void UpdateProgress(double completionProgress) { .... Rotation = -90 + (float)(-Math.Atan2(diff.X, diff.Y) * 180 / Math.PI); .... }

विश्लेषक को संदेह है कि अतन 2 विधि के तर्क गलत क्रम में पारित किए गए हैं। यह विधि की घोषणा है:

 // Parameters: // y: // The y coordinate of a point. // // x: // The x coordinate of a point. public static double Atan2(double y, double x);

मूल्यों को रिवर्स ऑर्डर में पारित किया गया था। मुझे यकीन नहीं है कि यह एक बग है क्योंकि UpdateProgress विधि में बहुत अधिक मात्रा में गणनाएं शामिल हैं; मैं बस इसे एक संभावित बग के रूप में उल्लेख कर रहा हूं।

V3080 [CWE-476] संभावित अशांति । 'बीटमैप' के निरीक्षण पर विचार करें। वर्कबीटमैप .cs 57

 protected virtual Track GetVirtualTrack() { .... var lastObject = Beatmap.HitObjects.LastOrDefault(); .... }

विश्लेषक बीटमैप के संभावित अशक्तता को इंगित करता है :

 public IBeatmap Beatmap { get { try { return LoadBeatmapAsync().Result; } catch (TaskCanceledException) { return null; } } }

खैर, विश्लेषक सही है।

पीवीएस-स्टूडियो इस तरह बग का पता लगाता है, और C # 8.0 में जोड़े गए नए फीचर्स के बारे में अधिक जानने के लिए, संभावित रूप से अशक्त संदर्भों को संभालने के साथ क्या करना है, लेख " C # 8.0 और स्थैतिक विश्लेषण में अशक्त संदर्भ प्रकार " देखें।

V3083 [CWE-367] 'ऑब्जेक्टकॉनवर्टेड' इवेंट का असुरक्षित इनवॉइस, NullReferenceException संभव है। इसे लागू करने से पहले एक स्थानीय चर को घटना असाइन करने पर विचार करें। बीटमैपकॉर्टर

 private List<T> convertHitObjects(....) { .... if (ObjectConverted != null) { converted = converted.ToList(); ObjectConverted.Invoke(obj, converted); } .... }

यह मामूली और काफी सामान्य त्रुटि है। ग्राहक अशक्त चेक और ईवेंट इनवोकेशन के बीच ईवेंट से सदस्यता समाप्त कर सकते हैं, जिसके परिणामस्वरूप क्रैश हो सकता है। यह बग को ठीक करने का एक तरीका है:

 private List<T> convertHitObjects(....) { .... converted = converted.ToList(); ObjectConverted?.Invoke(obj, converted); .... }

V3095 [CWE-476] नल के खिलाफ सत्यापित होने से पहले 'कॉलम' ऑब्जेक्ट का उपयोग किया गया था। चेक लाइनें: 141, 142. स्क्वायरग्राफ.कैंस 141

 private void redrawProgress() { for (int i = 0; i < ColumnCount; i++) columns[i].State = i <= progress ? ColumnState.Lit : ColumnState.Dimmed; columns?.ForceRedraw(); }

कॉलम संग्रह पर पुनरावृत्ति एक खतरनाक तरीके से की जाती है। डेवलपर ने माना कि कॉलम संदर्भ शून्य हो सकता है, जो कि कोड में संग्रह को आगे एक्सेस करने के लिए सशर्त एक्सेस ऑपरेटर के उपयोग द्वारा इंगित किया गया है।

V3119 अतिव्यापी घटना 'OnNewResult' को कॉल करने से अप्रत्याशित व्यवहार हो सकता है। स्पष्ट रूप से ईवेंट एक्सेसर्स को लागू करने पर विचार करें या 'सील' कीवर्ड का उपयोग करें। DrawableRuleset.cs 256

 private void addHitObject(TObject hitObject) { .... drawableObject.OnNewResult += (_, r) => OnNewResult?.Invoke(r); .... } public override event Action<JudgementResult> OnNewResult;

विश्लेषक का कहना है कि किसी ओवरराइड या आभासी घटना का उपयोग करना खतरनाक है। स्पष्टीकरण के लिए नैदानिक विवरण देखें। मैंने इस विषय पर एक लेख भी लिखा है: " सी # में आभासी घटनाएं: कुछ गलत हुआ "।

यहाँ एक और समान निर्माण है:

V3119 एक ओवरराइड घटना को कॉल करने से अप्रत्याशित व्यवहार हो सकता है। स्पष्ट रूप से ईवेंट एक्सेसर्स को लागू करने पर विचार करें या 'सील' कीवर्ड का उपयोग करें। ड्राएबलरुल्सेट। 257

V3123 [CWE-783] शायद '??' ऑपरेटर अपेक्षा के अनुरूप काम करता है। इसकी प्राथमिकता इसके बाएं हिस्से में अन्य ऑपरेटरों की प्राथमिकता से कम है। OsuScreenStack.cs 45

 private void onScreenChange(IScreen prev, IScreen next) { parallaxContainer.ParallaxAmount = ParallaxContainer.DEFAULT_PARALLAX_AMOUNT * ((IOsuScreen)next)?.BackgroundParallaxAmount ?? 1.0f; }

एक बेहतर समझ के लिए, इस कोड के मूल तर्क का प्रदर्शन करने वाला एक सिंथेटिक उदाहरण यहां दिया गया है:

 x = (c * a) ?? b;

बग इस तथ्य से उपजा है कि "*" ऑपरेटर की पूर्वता "??" से अधिक है ऑपरेटर। यह वही है जो निश्चित कोड जैसा दिखना चाहिए (कोष्ठक जोड़े जाने के साथ):

 private void onScreenChange(IScreen prev, IScreen next) { parallaxContainer.ParallaxAmount = ParallaxContainer.DEFAULT_PARALLAX_AMOUNT * (((IOsuScreen)next)?.BackgroundParallaxAmount ?? 1.0f); }

एक और समान बग:

V3123 [CWE-783] शायद '??' ऑपरेटर अपेक्षा के अनुरूप काम करता है। इसकी प्राथमिकता इसके बाएं हिस्से में अन्य ऑपरेटरों की प्राथमिकता से कम है। FramedReplayInputHandler.cs 103

 private bool inImportantSection { get { .... return IsImportant(frame) && Math.Abs(CurrentTime - NextFrame?.Time ?? 0) <= AllowedImportantTimeSpan; } }

पिछले मामले की तरह, प्रोग्रामर में ऑपरेटरों की पूर्वता के बारे में गलत धारणाएं थीं। मूल अभिव्यक्ति मैथ्स में उत्तीर्ण की गई है। इस पद्धति का मूल्यांकन इस प्रकार है:

 (a – b) ?? 0

यहां बताया गया है कि इसे कैसे तय किया जाना चाहिए:

 private bool inImportantSection { get { .... return IsImportant(frame) && Math.Abs(CurrentTime – (NextFrame?.Time ?? 0)) <= AllowedImportantTimeSpan; } }

V3142 [CWE-561] अगम्य कोड का पता चला। यह संभव है कि कोई त्रुटि मौजूद हो। ड्राबलहोल्डनोट्स.के 214

 public override bool OnPressed(ManiaAction action) { if (!base.OnPressed(action)) return false; if (Result.Type == HitResult.Miss) // <= holdNote.hasBroken = true; .... }

विश्लेषक का मानना है कि ऑनप्रेस्ड हैंडलर का कोड अप्रतिबंधित हो सकता है यदि कथन के साथ दूसरा। यह इस तथ्य से निम्नानुसार है कि पहली शर्त हमेशा सही होती है, अर्थात यह कि आधार। कोई भी तरीका हमेशा गलत होगा । आइए आधार पर एक नज़र डालें।

 public virtual bool OnPressed(ManiaAction action) { if (action != Action.Value) return false; return UpdateResult(true); }

और अब UpdateResult मेथड पर:

 protected bool UpdateResult(bool userTriggered) { if (Time.Elapsed < 0) return false; if (Judged) return false; .... return Judged; }

ध्यान दें कि जज की गई संपत्ति का कार्यान्वयन यहां मायने नहीं रखता क्योंकि UpdateResult पद्धति का तर्क यह बताता है कि अंतिम रिटर्न स्टेटमेंट निम्न के बराबर है:

 return false;

इसका मतलब यह है कि UpdateResult विधि हर समय झूठी वापस आ जाएगी, इस प्रकार स्टैक में पहले अगम्य-कोड समस्या के लिए अग्रणी।

V3146 [CWE-476] 'नियम' की संभावित अशांति । 'FirstOrDefault' डिफ़ॉल्ट अशक्त मान लौटा सकता है। APILegacyScoreInfo.cs 24

 public ScoreInfo CreateScoreInfo(RulesetStore rulesets) { var ruleset = rulesets.GetRuleset(OnlineRulesetID); var mods = Mods != null ? ruleset.CreateInstance() // <= .GetAllMods().Where(....) .ToArray() : Array.Empty<Mod>(); .... }

विश्लेषक का मानना है कि ruleset.CreateInstance () कॉल असुरक्षित है। इस कॉल से पहले, गेटसेट विधि को कॉल करने के परिणामस्वरूप नियम चर को एक मान दिया जाता है:

 public RulesetInfo GetRuleset(int id) => AvailableRulesets.FirstOrDefault(....);

जैसा कि आप देख सकते हैं, चेतावनी मान्य है क्योंकि कॉल अनुक्रम में FirstOrDefault विधि शामिल है, जो अशक्त हो सकती है ।

निष्कर्ष

"Osu!" के कोड में कई बग नहीं हैं, और यह अच्छा है। लेकिन मैं अभी भी सिफारिश करूंगा कि लेखक विश्लेषक द्वारा रिपोर्ट किए गए मुद्दों की जांच करें। मुझे उम्मीद है कि इससे उच्च गुणवत्ता बनाए रखने में मदद मिलेगी और खेल खिलाड़ियों के लिए खुशी लाता रहेगा।

यदि आप स्रोत कोड के साथ छेड़छाड़ करना पसंद करते हैं, तो अनुस्मारक के रूप में, पीवीएस-स्टूडियो एक अच्छा विकल्प है। विश्लेषक आधिकारिक वेबसाइट पर डाउनलोड के लिए उपलब्ध है। एक और बात जो मैं आपको ध्यान में रखना चाहूंगा वह यह है कि वास्तविक विकास प्रक्रिया में स्थैतिक विश्लेषण के सामान्य उपयोग से इस तरह के एक बार के चेक का कोई लेना-देना नहीं है। यह केवल तभी प्रभावी होता है जब बिल्ड सर्वर और डेवलपर्स कंप्यूटरों पर नियमित रूप से उपयोग किया जाता है (इसे वृद्धिशील विश्लेषण कहा जाता है)। आपका अंतिम लक्ष्य कोडिंग चरण में उन्हें पकड़कर संस्करण नियंत्रण प्रणाली में फिसलने से कीड़े रखना है।

शुभकामनाएँ, और रचनात्मक रहें!

संदर्भ

यह 2020 में हमारा पहला लेख है। जब हम इस पर हैं, तो यहाँ पिछले # पर की गई C # परियोजनाओं की जाँच के लिंक दिए गए हैं:

"ओसु!" खेलें, लेकिन बग्स के लिए देखें

खेल

कीड़े

निष्कर्ष

संदर्भ

More articles: