Modules or DIY

Use cases of pre made code vs. custom code

Transcript

1. MODULES OR DIY USE CASES OF PRE-MADE CODE VS. CUSTOM CODE coding leipzig meet-up on Oct. 10th, 2019 - https://www.meetup.com/coding-leipzig/
2. MODULES OR DIY TALKING POINTS ▸ Different types of third-party code ▸ Examples ▸ Things to consider during implementation ▸ Things to consider during code maintenance ▸ Legal aspects ▸ Checklist ▸ Sources
3. DIFFERENT TYPES OF THIRD-PARTY CODE
4. DEFINITIONS FRAMEWORK -> LIBRARY -> MODULE -> PLUGIN ▸ Framework: -> complete system -> The flow of control and the flow of data is managed by the framework, you fill in the details ▸ Library: -> collection of related functionality -> you call on it to fill in the details ▸ Module: -> provides a single piece of functionality -> explicit exports and imports, implementation and interface are separate ▸ Plugin: -> ready to use code component that can be added to an existing application to change its features
5. DEFINITIONS MODULES ▸ encapsulates code and data to implement a particular functionality ▸ has an interface that lets clients access its functionality in an uniform manner ▸ is easily pluggable with another module that expects its interface ▸ is usually packaged in a single unit so that it can be easily deployed
6. EXAMPLES
7. EXAMPLES TETHER.IO Download: https://github.com/shipshapecode/tether Install: npm install tether Import: import * as Tether from ‘tether’ Adjust / Use: new Tether({ element: yellowBox, target: greenBox, attachment: 'top right', targetAttachment: 'top left' });
8. EXAMPLES END-USER MODULES Charts Map functionality Widget grid Date conversion Page layout helper Date picker with calendar Tab menu Popup positioning
9. EXAMPLES DEV MODULES Mock data Testing Replace strings Syntax checker
10. THINGS TO CONSIDER DURING IMPLEMENTATION
11. THINGS TO CONSIDER DURING IMPLEMENTATION ADVANTAGES OF MODULES VS. CUSTOM CODE ▸ Saves time when creating a feature ▸ Has community backing in case of problems with implementation ▸ Is already tested ▸ Offers features that would otherwise be inaccessible “provides a single piece of functionality … … with less effort than coding this piece of functionality yourself”
12. THINGS TO CONSIDER DURING IMPLEMENTATION ▸ Higher cost of bandwidth and file size ▸ Generalised functionality can mean a high effort in customisation ▸ Introducing code interference with other modules / custom code ▸ Varying code quality DISADVANTAGES OF MODULES VS. CUSTOM CODE
13. THINGS TO CONSIDER DURING MAINTENANCE
14. THINGS TO CONSIDER DURING CODE MAINTENANCE ▸ Effort of maintenance and bug fixing are taken care of by the module creator ▸ Good reaction times on tickets when the community is active enough ▸ Option to submit code improvements one self ▸ Encapsulation means little effort when module has to be removed ADVANTAGES OF MODULES VS. CUSTOM CODE
15. THINGS TO CONSIDER DURING CODE MAINTENANCE ▸ Danger of no support with bugs and maintenance ▸ Danger of insufficient or non- existing documentation ▸ Using a lot of modules could mean a sluggish application ▸ Major updates can cause unforeseen breaking changes DISADVANTAGES OF MODULES VS. CUSTOM CODE
16. LEGAL ASPECTS
17. LEGAL ASPECTS PITFALLS OF OPEN SOURCE LICENSES ▸ Around 40 different open source license types ▸ Licenses for modules can change ▸ With Open Source, the liability is generally shifted to the user of the code ▸ CopyLeft: “is the practice of offering people the right to freely distribute copies and modified versions of a work with the stipulation that the same rights be preserved in derivative works created later." “… All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the <organization>. …”
18. LEGAL ASPECTS EXAMPLES FOR COPYLEFT LICENSES ▸ Wiki.js, BerkeleyDB, Mattermost, MongoDB (until late 2018), Bitwarden : GNU Affero GPL -> 82 217 repositories in github ▸ Magento, PrestaShop: OSL (Open Source License) -> 2586 repositories in github ▸ Cairo, H2, Armadillo: Mozilla Public License -> 43 011 repositories in github ▸ GLib, Checkstyle: Lesser GPL -> 77 083 repositories in github “SAFE” LICENSES: ▸ MIT -License: https://en.wikipedia.org/wiki/MIT_License ▸ Unlicense: https://en.wikipedia.org/wiki/Unlicense ▸ Apache License: https://en.wikipedia.org/wiki/Apache_License ▸ WTFPL License: https://en.wikipedia.org/wiki/WTFPL
19. CHECKLIST
20. CHECKLIST MODULES OR DIY?
21. SOURCES ▸ https://en.wikipedia.org/wiki/Software_framework ▸ https://en.wikipedia.org/wiki/Control_flow ▸ https://en.wikipedia.org/wiki/Library_(computing) ▸ https://en.wikipedia.org/wiki/List_of_JavaScript_libraries ▸ https://en.wikipedia.org/wiki/Modular_programming ▸ https://github.com/aravindnc/A-to-Z-List-of-Useful-Node.js-Modules ▸ https://en.wikipedia.org/wiki/Plug-in_(computing) ▸ http://tether.io/ ▸ https://github.com/tiberiuzuld/angular-gridster2 ▸ https://leafletjs.com/ ▸ https://d3js.org/ ▸ https://github.com/marak/Faker.js/ ▸ https://karma-runner.github.io/latest/index.html ▸ https://github.com/stylelint/stylelint DEFINITIONS EXAMPLES
22. SOURCES ▸ https://blog.softwaremill.com/it-depends-the-art-of-dependency-management-in-javascript-f1f9c3cde3f7 ▸ https://hackernoon.com/whats-really-wrong-with-node-modules-and-why-this-is-your-fault-8ac9fa893823 IMPLEMENTATION ▸ https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/ ▸ https://octoverse.github.com/2017/ MAINTENANCE ▸ https://opensource.guide/legal/ ▸ http://www.bswd.com/CNSV-1304-Saper%28IP-SIG%29.pdf ▸ https://en.wikipedia.org/wiki/Comparison_of_free_and_open- source_software_licenses#FOSS_licenses ▸ https://en.wikipedia.org/wiki/Copyleft, ▸ https://en.wikipedia.org/wiki/GNU_General_Public_License LEGAL ASPECTS Presentation by Tatjana Royal - post@scubbo.de - https://www.scubbo.de