"Osu!" खेलें, गलतियों के बारे में मत भूलिए

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

खेल

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

मुझे प्रोजेक्ट के स्रोत कोड में अधिक रुचि है, जो GitHub से डाउनलोड के लिए उपलब्ध है । भंडार में एक महत्वपूर्ण संख्या (24 हजार से अधिक) तुरंत ध्यान आकर्षित करती है, जो परियोजना के सक्रिय विकास को इंगित करता है, जो आज भी जारी है (खेल 2007 में जारी किया गया था, लेकिन काम शायद पहले शुरू किया गया था)। इसी समय, बहुत अधिक स्रोत कोड नहीं है - 1813 .cs फाइलें जिसमें 135 हजार कोड की लाइनें होती हैं, खाली को छोड़कर। इस कोड में परीक्षण शामिल हैं जो मैं आमतौर पर चेक में नहीं लेता हूं। परीक्षण कोड 306 .cs फ़ाइलों में समाहित है और, तदनुसार, रिक्त को छोड़कर कोड की 25 हजार लाइनें। यह एक छोटी सी परियोजना है: तुलना के लिए, पीवीएस-स्टूडियो विश्लेषक के सी # कोर में लगभग 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)); 

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

इसी तरह की एक और त्रुटि:

• 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? के माध्यम से चर का उपयोग करने के लिए एक सुरक्षित विकल्प का उपयोग किया जाता है । 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); 

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

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; } } } 

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

पीवीएस-स्टूडियो इस तरह की त्रुटियों को कैसे पाता है, इसके बारे में अधिक जानकारी के लिए, साथ ही समान विषयों से संबंधित सी # 8.0 नवाचारों के बारे में (संभावित अशक्त संदर्भों के साथ काम करना), लेख " सी # 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; 

विश्लेषक एक ओवरराइड या वर्चुअल इवेंट का उपयोग करने के खतरों के बारे में चेतावनी देता है। वास्तव में क्या खतरा है - मैं निदान के लिए विवरण में पढ़ने का सुझाव देता हूं। इसके अलावा, एक समय में मैंने इस विषय पर एक लेख लिखा था, " C # में वर्चुअल ईवेंट: कुछ गलत हुआ ।"

कोड में एक और समान असुरक्षित निर्माण:

• 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; } } 

यहां, पिछले कोड के टुकड़े के रूप में, ऑपरेटरों की प्राथमिकता को ध्यान में नहीं रखा गया था। अब Math.bs विधि में उत्तीर्ण की गई अभिव्यक्ति का मूल्यांकन इस प्रकार किया जाता है:

 (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; .... } 

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

 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>(); .... } 

विश्लेषक नियमों को मानता है। CreateInstance () कॉल असुरक्षित है। GetRuleset को कॉल करने के परिणामस्वरूप पहले वाला नियम चर प्राप्त करता है:

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

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

निष्कर्ष

सामान्य तौर पर, गेम प्रोजेक्ट "ओसु!" छोटी संख्या में त्रुटियों से प्रसन्न होता है। फिर भी, मैं डेवलपर्स को सुझाए गए समस्याओं पर ध्यान देने की सलाह देता हूं। और खेल को अपने प्रशंसकों को खुश करने के लिए जारी रखें।

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

सौभाग्य और सफलता!

संदर्भ

यह 2020 में पहला प्रकाशन है। यह अवसर लेते हुए, मैं पिछले साल C # परियोजनाओं की जाँच करने पर लेखों के लिंक प्रदान करूँगा:

• .NET स्रोत कोड के लिए अमेज़ॅन वेब सेवा एसडीके में बग की तलाश है
• रोजलिन के स्रोत कोड की जाँच करना
• C # 8.0 और स्टेटिक विश्लेषण में अशक्त संदर्भ प्रकार
• WinForms: त्रुटियां, होम्स
• कैसे PVS- स्टूडियो में इस्तेमाल की गई लाइब्रेरी में त्रुटि पाई गई ... PVS-Studio की कहानी
• पीवीएस-स्टूडियो स्थिर विश्लेषक द्वारा .NET कोर पुस्तकालयों के स्रोत कोड का सत्यापन
• रोसलिन विश्लेषक की जाँच करना
• PVS-Studio से परिचित होने के लिए UWP के लिए Telerik UI देखें
• Azure PowerShell: "ज्यादातर हानिरहित"
• हम ऑर्चर्ड सीएमएस कोड में त्रुटियों को खोजते हैं और उनका विश्लेषण करते हैं
• PVS-Studio के साथ OpenCV पर OpenCvSharp आवरण की जाँच करना
• .NET के लिए Azure SDK: एक मुश्किल बग खोजक की कहानी
• SARIF SDK और इसकी त्रुटियां
• 2019 के लिए सी # परियोजनाओं में शीर्ष 10 कीड़े

यदि आप इस लेख को अंग्रेजी बोलने वाले दर्शकों के साथ साझा करना चाहते हैं, तो कृपया अनुवाद के लिंक का उपयोग करें: सर्गेई ख्रेनोव। "ओसु!" खेलें, लेकिन बग्स के लिए देखें ।