🎬 👩‍❤️‍💋‍👩 💯 एक समस्या सॉल्वर के रूप में टाइपस्क्रिप्ट के लिए पोर्टिंग एपीआई 🧘 🍼 🍲

Execute Program का React frontend जावास्क्रिप्ट से टाइपस्क्रिप्ट में बदल दिया गया है । लेकिन रूबी में लिखा बैकेंड टच नहीं हुआ। हालांकि, इस बैकएंड से जुड़ी समस्याओं ने प्रोजेक्ट डेवलपर्स को रूबी से टाइपस्क्रिप्ट पर स्विच करने के बारे में सोचा। आज हम जिस सामग्री का अनुवाद कर रहे हैं, वह रूबी से टाइपस्क्रिप्ट के लिए एग्ज़ेक्यूट प्रोग्राम बैकएंड को पोर्ट करने के बारे में कहानी को समर्पित है, और इससे कौन सी समस्याएं हल हुईं।

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

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

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

जावास्क्रिप्ट से टाइपस्क्रिप्ट के लिए दृश्यपटल का अनुवाद, और रूबी से टाइपस्क्रिप्ट के लिए बैकेंड का अनुवाद

पोर्टिंग प्रक्रिया के दौरान, मैंने बड़ी मात्रा में सहायक कोड लिखा। तो, हमारे पास 200 लाइनों की मात्रा के साथ परीक्षण चलाने के लिए अपना खुद का उपकरण है। हमारे पास डेटाबेस के साथ काम करने के लिए एक 120-लाइन लाइब्रेरी है, साथ ही साथ एपीआई के लिए एक बड़ा रूटिंग लाइब्रेरी है, जो फ्रंट-एंड और बैक-एंड कोड को जोड़ता है।

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

यहाँ एक बैकएंड हैंडलर है जो ब्लॉग पोस्ट की एक सूची देता है। यह सिस्टम में सबसे सरल समान कोड अंशों में से एक है:

router.handleGet(api.blog, async () => {
  return {
    posts: blog.posts,
  }
})

यदि हम मुख्य नाम postsको बदलते हैं blogPosts, तो हमें एक संकलन त्रुटि मिलती है, जिसका पाठ नीचे दिखाया गया है (यहां संक्षिप्तता के लिए, वस्तुओं के प्रकारों के बारे में जानकारी छोड़ी गई है।)

Property 'posts' is missing in type '...' but required in type '...'.

प्रत्येक समापन बिंदु को किसी दृश्य ऑब्जेक्ट द्वारा परिभाषित किया गया है api.someNameHere। यह ऑब्जेक्ट क्लाइंट और सर्वर द्वारा साझा किया जाता है। ध्यान दें कि हैंडलर घोषणा में सीधे प्रकार का उल्लेख नहीं किया गया है। वे सभी तर्क से प्रभावित हैं api.blog।

यह दृष्टिकोण सरल समापन बिंदुओं के लिए काम करता है, जैसे कि ऊपर वर्णित समापन बिंदु blog। लेकिन यह अधिक जटिल समापन बिंदुओं के लिए उपयुक्त है। उदाहरण के लिए, पाठ के साथ काम करने के लिए एक समापन बिंदु एपीआई में तार्किक प्रकार की गहरी नेस्टेड कुंजी होती है .lesson.steps[index].isInteractive। इस सब के लिए धन्यवाद, अब निम्नलिखित गलतियाँ करना असंभव है:

यदि हम isinteractiveक्लाइंट तक पहुँचने की कोशिश करते हैं, या सर्वर से ऐसी चाबी वापस करने की कोशिश करते हैं, तो कोड संकलित नहीं होगा। मुख्य नाम isInteractiveराजधानी की तरह दिखना चाहिए I।
isInteractive — .
isInteractive number, , , .
API, , isInteractive — , , , , , , , .

ध्यान दें कि इस सब में कोड जनरेशन शामिल है। यह हमारे अपने राउटर से io-ts और कोड की सौ लाइनों की एक जोड़ी का उपयोग करके किया जाता है ।

एपीआई प्रकारों की घोषणा करने के लिए अतिरिक्त काम की आवश्यकता होती है, लेकिन काम सरल है। एपीआई की संरचना को बदलते समय, हमें यह जानना होगा कि कोड की संरचना कैसे बदलती है। हम एपीआई घोषणाओं में परिवर्तन करते हैं, और फिर संकलक हमें उन सभी स्थानों पर इंगित करता है जहां कोड को ठीक करने की आवश्यकता होती है।

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

यहाँ एक वास्तविक उदाहरण है। मैंने हाल ही में एपीआई एक्सिक्यूट प्रोग्राम को नया स्वरूप देने के लिए चार दिनों में लगभग 20 घंटे बिताए । एपीआई की पूरी संरचना बदल गई है। पुराने के साथ नए क्लाइंट और सर्वर कोड की तुलना करते समय, दसियों हजार लाइन परिवर्तन दर्ज किए गए। मैंने सर्वर-साइड रूटिंग कोड (ऊपर की तरह) को फिर से डिज़ाइन कियाhandleGet) मैंने एपीआई के लिए सभी प्रकार की घोषणाओं को फिर से लिखा, जिससे उनमें से कई बड़े संरचनात्मक परिवर्तन हुए। और, इसके अलावा, मैंने क्लाइंट के सभी हिस्सों को फिर से लिखा है जिसमें परिवर्तित एपीआई को बुलाया गया था। इस काम के दौरान, 292 स्रोत फ़ाइलों में से 246 को बदल दिया गया था।

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

ये सभी तार्किक त्रुटियां थीं: ऐसी परिस्थितियां जो गलती से कार्यक्रम को गलत जगह ले गईं। आमतौर पर, एक प्रकार की प्रणाली ऐसी त्रुटियों को खोजने में मदद नहीं करती है। इन त्रुटियों को ठीक करने में कई मिनट लगे। इस पुन: डिज़ाइन किए गए API को कुछ महीने पहले तैनात किया गया था। जब आप कुछ पढ़ते हैंहमारी साइट - यह एपीआई है जो प्रासंगिक सामग्री जारी करता है।

इसका मतलब यह नहीं है कि स्थिर प्रकार की प्रणाली गारंटी देती है कि कोड हमेशा सही होगा। यह प्रणाली बिना परीक्षणों के करने की अनुमति नहीं देती है। लेकिन यह रिफैक्टिंग को बहुत सरल करता है।

मैं आपको स्वचालित कोड पीढ़ी के बारे में बताऊंगा। अर्थात्, हम अपने डेटाबेस की संरचना से प्रकार की परिभाषाएँ बनाने के लिए स्कीमाट्स का उपयोग करते हैं । सिस्टम पोस्टग्रेज डेटाबेस से कनेक्ट होता है, कॉलम प्रकारों का विश्लेषण करता .d.tsहै और एप्लिकेशन द्वारा उपयोग की जाने वाली नियमित फ़ाइल के लिए इसी टाइपस्क्रिप्ट टाइप परिभाषाएँ लिखता है ।

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

यह सब मिलकर सूचना हस्तांतरण की एक विश्वसनीय सांख्यिकीय रूप से टाइप की गई श्रृंखला बनाता है, जो डेटाबेस से सामने वाले हिस्से में रिएक्ट घटकों के गुणों तक फैली हुई है:

, ( API) , .
API , API, ( ) .
React- , API, .

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

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

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

टाइपस्क्रिप्ट का उपयोग परियोजना के फ्रंट और बैकएंड पर किया जाता है।

यहां हमने ऐसे प्रकाशनों के लिए सामान्य प्रश्न नहीं उठाया है, जो कि टाइपिंग के माध्यम से नहीं, बल्कि परीक्षणों के उपयोग के माध्यम से समान परिणाम प्राप्त करना है। केवल परीक्षण का उपयोग करके ऐसे परिणाम प्राप्त नहीं किए जा सकते हैं। हम, संभवतः, इस बारे में अधिक बात करेंगे।

प्रिय पाठकों! क्या आपने टाइपस्क्रिप्ट में अन्य भाषाओं में लिखी परियोजनाओं का अनुवाद किया था?

एक समस्या सॉल्वर के रूप में टाइपस्क्रिप्ट के लिए पोर्टिंग एपीआई

More articles: