Rewrite (programming)

A rewrite in computer programming is the act or result of re-implementing a large portion of existing functionality without re-use of its source code. When the rewrite uses no existing code at all, it is common to speak of a rewrite from scratch.

Motivations

A piece of software is typically rewritten when one or more of the following apply:
*its source code is not available or is only available under an incompatible license
*its code cannot be adapted to a new target platform
*its existing code has become too difficult to handle and extend
*the task of debugging it seems too complicated
*the programmer finds it difficult to understand its source code
*developers learn new techniques or wish to do a big feature overhaul which requires much change
*the programming language of the source code has to be changed

Risks

Several software engineers, such as Joel Spolsky have warned against total rewrites, especially under schedule constraints or competitive pressures. While developers may initially welcome the chance to correct historical design mistakes, a rewrite also discards those parts of the design that work as required. A rewrite commits the development team to deliver not just new features, but all those that exist in the previous code, while potentially introducing new bugs or regressions of previously fixed bugs. A rewrite also interferes with the tracking of unfixed bugs in the old version.

The incremental rewrite is an alternative approach, in which developers gradually replace the existing code with calls into a new implementation, expanding that implementation until it fully replaces the old one. This approach avoids a broad loss of functionality during the rewrite. Cleanroom software engineering is another approach, which requires the team to work from an exhaustive written specification of the software's functionality, without access to its code.

Examples

Netscape's project to improve HTML layout in Navigator 4 has been cited as an example of a failed rewrite. The new layout engine (Gecko) had developed independently of Navigator and did not integrate readily with Navigator's code; hence, Navigator itself was rewritten around the new engine, breaking many existing features and delaying release by several months. Meanwhile, Microsoft focused on incremental improvements to Internet Explorer and did not face the same obstacles. Ironically, Navigator itself was a successful cleanroom rewrite of NCSA Mosaic overseen by that program's developers. See Browser wars.

Some projects mentioning major rewrites in their history:

* Apache HTTP Server (1)
* AOL Instant Messenger (1)
* BIND (1)
* Freenet (1)
* GRUB (1)
* Majordomo (1)
* MediaWiki (1)
* Mozilla/Netscape (1)
* Icecast (0–1)
* netcat (1)
* OpenRPG (1)
* PHP (1–2)
* Project Xanadu (0–1)
* Sun Secure Global Desktop (1)
* vBulletin (2)
* WebObjects (1)
* Zope (1)

Techniques

* Strangler fig pattern

See also

* Code refactoring
* Open source software development
* Technical debt
* Development hell
* Porting
* Game engine recreation
* Reverse engineering

References

External links

* {{Cite journal , last=Sneed , first=Harry , last2=Verhoef , first2=Chris , date=2019-09-01 , title=Re-implementing a legacy system , url=https://www.sciencedirect.com/science/article/pii/S0164121219301050 , journal=Journal of Systems and Software , volume=155 , pages=162–184 , doi=10.1016/j.jss.2019.05.012 , issn=0164-1212

RewriteCodeFromScratch at C2 Wiki


by Joel Spolsky

Computer programming