What I learned working at a mature startup that’s building new things but also has a ton of customers and products in production.
This post is a WIP.
Table of Contents
This section discusses when to test, how much testing, and breadth and depth of the coverage.
- Test Driven Development (TDD)
- Write Good Unit Tests. How to test? What to test? Link to Jest article
- Testing in multiple browsers
- Testing on staging.
- Monitoring after deployment to Production
- CI/CD - triggers typecheck
When to Write Tests
If it’s hard to test, that means you didn’t design your software well.
For things in production, ensure thorough test coverage. For greenfield projects, usually you don’t have good picture of what correct looks like, or it’s difficult to verify quantitatively. It’s acceptable to iterate on the experimental code without tests at first. But once you are settled on the algorithm and design, you should turn your experimental code into production-ready code with a fews phases of refactoring and tests, depending on the complexity of the code.
Tests hinders rapid prototyping. Once design is locked down, then add tests.
As discussed in this post about unit testing, test driven development (TDD) requires that you write your tests before you write code. For projects that have a lot of uncertainties on design and implementation, we cannot implement true TDD. True TDD is implementable for projects that include extensive functional requirements which drive development. For instance, safety critcal software or software developed to meet specific contracts have functional requirements and product specification that specify exactly how the software should behave. Tests can be written based on these functional requirements.
- stress testing
- usability / accessibility
// TODO: add discussion about Automated Testing vs. Manual Testing
// TODO: add discussion about Feature Parity
Best practice for accessibility
- Can I use the entire page using only the keyboard but not the mouse?
- you should be able to Tab around the page and to go to every input and button on the page
- Protip: Document.activeElement - add a focus state on it.
- Tabbing through the page increments through the elements in the correct order
- Protip: use TabIndex = 0 or TabIndex = -1
- Pressing enter on a focused element should achieve the same result as clicking. ProTip: In addition to onClick, also add onKeyboard enter
- Don’t make spans buttons, use button for buttons. Use the correct HTML markup. That gives you accessibility out of the box. Use correct landmarks (eg, nav, aside, footer)
- Use Alt Text: Make sure your pencil icon has the correct alt text (alt text fulfills the same promise as what the icon represents). make altText “edit”
- Esc key closes the modal
- Use automated test (1) chrome developer tool (Lighthouse) -Audit - accessibility checkbox, (2) Storybook Accessibility Tab, (3) accessibility eslint plugin: eslint-plugin-jsx-a11y
When deploying a new feature to a widely used product, it’s a good idea to do a gradual rollout so the new feature will be available to a smaller group of users at first. This approach gives us the ability to iron out bugs and assess the usability of the feature on a smaller group of users before rolling out the feature to the broader user base.
Deploying with feature toggles allows us to minimize the risk of introducing new features. At Smartling, we use Launch Darkly for feature flag and toggle management.
Another risk of adding a new feature to a product is that you don’t know if the feature will truly provide the value that you expect. There are also multiple ways to implement a feature to achieve a certain object. Metrics tracking provides a way to gather quantitative data on how the feature is being used (e.g., number of clicks, type of user who uses the feature) to validate the hypothesis that a new feature is adding value.
New Relic is an instrumentation tool that integrates with your applications that provides realtime metrics and insight on how your applications are being used.
Metrics tracking can also be used to gather data before deprecating / end support of a rarely used feature.
While New Relic helps you gathers aggregate data on how your product is being used, sometimes you need data on how an individual user uses the data. FullStory provides the ability to capture a session of how a single user interacts with your product. This is useful for insight but is more widely used for troubleshooting a user reported bug.
- Opsgenie - Integrates with TrackJS and sends a notification to the people on call When error rate increases beyond a certain threshold.
emergencychannel on Slack.
Every refactoring has the potential to break existing functionality. Before attempting a refactor, make sure to reduce the the risks of breaking something by
- Writing unit tests - Having existing unit tests in place to help you understand the impact of your refactoring is very important.
- Add static typing to code - it’s scary to make changes to untyped code.
Whenever you are adding a new feature to a component and you find yourself copying-and-pasting a block of code from another component, that’s when you know you should add a method to your utilities class to share this block of code between the components. Good software design hides complexity with abstraction.
Avoid pre-mature optimization. Avoid writing throwaway code (tests for WIP code) Once your design approach and implementation is firmed up, add tests. Refactoring vs not refactoring. Some considerations:
Make sure to use good version control. What I like to do is to refactor something small, test, commit, repeat.
Cost of Refactoring
There’s cost to refactoring, specifically time and effort. You need to spend time and effort to reduce tech debt or to implement new features. Also, code reviews are more difficult. Risk of refactoring - Massive refactoring carries the risk of breaking existing functionality but unit tests and regression tests help to reduce that risk.
Cost of not refactoring could potentially be higher. As tech tech accumulates, software becomes harder to extend, understand, and maintain. Adding even the smallest change requires a ton of effort and QA. Cost of testing and QA go up. See Lesson from 6 software rewrite stories. Not refactoring also caries risks of code entropy and tech debt increase. Codebase becomes increasingly difficult and unpleasant to work with, which could result in difficulties with retaining and attracting talent to work on the codebase.
On the other hand, while refactoring code makes code more scalable, easier to extend/maintain, and more pleasant to work with, it has to balanced with the time and risk of refactoring, especially when you are working on a production-grade software. The rule of thumb is if you are working with a large codebase that often has new features requests, it’s always worth refactoring if it will make it easier and faster to add new features to the codebase on a go-forward basis and make the codebase more maintainable and less buggy. If you think the long term benefit of refactoring outweighs the cost but the refactoring effort is extensive and management has different priorities and/or a “if it’s not broken, don’t fix it” culture, then convince management to let you work on the refactoring / code rewrite in a separate branch as a side project.
I don’t think refactoring should always be pursued for a product that’s rarely used or rarely updated.
How to Refactor
Source Making provides an excellent discussion on various bad code smells, how to recognize them, and strategies for getting rid of the bad code smells. I highly recommend checking out Source Making’s website as it provides an extensive list of code smells and refactoring techniques:
- My code has a lot of if() statements right now, it calls out for a refactor
- how many if statements is the threshold for refactoring?
- also, are they nested if statements? If so, how many levels of nesting?
My favorite refactoring techniques:
- Replace Nested Conditionals with Guard Clauses
- Replace Conditional With Polymorphism
- Replace Conditionals with a dictionary. State machine: IsLoading….isSelecting…isBrowsing. we can map UI / representation to a state instead of having a lot of nested ternary operators in render
Use Monad (e.g.,
Maybe, Null Object) avoids callback hell. Avoid callback hell - Make asynchronous behavior synchronous (React Hooks)
// TODO: dictionary example
The evils of boilerplate
- Hard to review
- Shotgun surgery needed to extend a feature
- Creates Bloaters. In files that are over 1000 lines of code, lint stops working and editor becomes slow.
Avoid boilerplate by
- Create abstractions
- Copy-paste programming is evil. Please create mocks, generator functions, higher order functions…whatever it takes to get rid of boilerplate.
- Don’t copy-paste.
- Create Mocks and import mocks in tests.
- Create generator functions. Create higher order functions.
Close source vs Open source. Turnover. Knowledge Transfer.
Make sure to have README.md for every repo. Make sure to include information like how to set the project up for local development.
// TODO: Add example UML from react-process-flowchart
Self Documenting Code
Self Documenting Code possible with static typing.
We want to separate behavior from presentation so code is self documenting and easy to test. Use:
- react hooks
- state machine
- container components vs view components
Naming variables to describe what they do/mean also constributes to self-documenting code.
- Design systems: UI
- design systems - UI kit. UIC. Typography, etc
- Goal: You want your users to have a consistent experience
- Benefits: better user experience. Help with recruiting. Easier onboarding. Increase efficiency. Easier design changes
- Components work well together. They have the same design principle under the hood.
- Palette (colors palette)
- Support theme
Storybook lets you create a catalog of UI components.
Use Open Source vs Roll Your Own
When you need a library, there are two options. You can
- Find an existing library that accomplishes what you need, or
- Write your own library.
In most cases, you should choose to adopt an open source library because it’s (1) Already implemented and tested, (2) support from other users of the open source library (if it’s a popular library).
If there a precedent for what you’re trying to do, don’t waste time rebuilding something someone else has built.
The cost of using the library code is low if the library is well built and maintained and has a lot of users and active contributions.
Using Open Source is great if you have simple need and is covered by the general use case. If you have special needs, adopting an open source library could be high. If your use case is not exactly the typical use case of the library code, you have to build adapters to make your data model has to conform to the library’s data model and decorators to extend the functionality of the library. In the worst case, you may have to fork the library if you can’t get the maintainer of the library to make changes.
Getting maintainers of the library to make a change can be a frustrating process. Fragmentation is dangerous for open source.
That said, you should consider writing your own library if
- You have a very clear vision of what you need and no existing open source libraries meet that need
- It’s less costly to implement your own than to try to tweak the open source library
- You need full control over functionality and aesthetics
- You need a library Can iterate. Open source solutions could be too complex for your use case.
Advantages of Monorepo: consistency. Good for UI library. Use Lerna.
- If you are submitting a breaking change, put “Breaking Change” in both title and body of the commit / PR
- Don’t address too many things in one commit. PR review will be painful if you have too many extraneous clean-up changes in your PR
- If you have PR that includes the absolutely necessary changes to implement the feature, followups from previous PRs, and a bug fix, the PR should include 3 commits so you can see those changes.
Use this PR Template. Simply add
pull-request-template.md to the root of your repo.
### Jira Issue [Jira Link]() ### Notable changes (add line annotations and or files) ### Screenshots (optional) (provide visual feedback about what's changed) ### Cleanup (mention any cleanup, like typescript types, renaming, etc) ### Test Plan #### Special test cases (e.g. Tested for plurals, CJK and RTL) #### Manual Testing (what might need to be tested that was difficult to capture with unit tests) #### Regression Testing (what existing functionality might break as a result of this change) ### Preview link (optional) [Link on Staging]()
In the Notable Changes section, make sure to reference specific lines of code (the most important ones) and/or files, in addition to describing what the changes are about and the high level design. This saves a lot of time for the reviewer and improves the experience of the review process.
Agile and Jira
- Story Points
- Tech Debt
- Agile - Weekly Sprints, Estimates. Backlog, Points
- Daily Standup, Task Breakdown, Dev Diary
- Agile, Scrum, Test Driven Development (TDD), Service Oriented Architecture and APIs (SOA)
- Continuous Deployment - multiple times a day
- Full test automation - we have no QA Team
- DevOps is not a team, it’s a culture