The Life-Changing Magic of Tidying Up your Test Warnings

Rate this content
Bookmark

Even though we write tests for our web applications, the reality is that bugs still happen. Fortunately, many of these are easily preventable paying more attention to the warnings from our apps. However, it's often so easy to put them under the rug and never come back until we find a bug in production, which leads to hundreds if now thousands of warnings appearing in our test output. This talk is about how to prevent this situation and how to get out of it.

This talk has been presented at TestJS Summit - January, 2021, check out the latest edition of this JavaScript Conference.

FAQ

Test warnings are messages created by developers of third-party libraries or other technologies that give clues about potential issues such as bugs, performance problems, and security concerns.

Test warnings accumulate because they are easy to ignore, do not cause continuous integration (CI) to fail, and are often not prioritized due to competing product and technical tasks.

Ignoring test warnings can lead to bugs, performance issues, and security vulnerabilities. It can also negatively impact developer experience by making it harder to debug issues and maintain clean code.

Automation can help manage test warnings by setting validations for certain patterns, allowing fail-safes for unavoidable warnings, failing builds for unknown warnings, and keeping the warning registry up-to-date.

Jsreporter log validator is a small library that helps add rules to test warnings, preventing new ones from being created. It includes features like pattern validation, fail-safes for unavoidable warnings, and build failures for unknown warnings.

Fixing test warnings should be prioritized based on risk and effort. Warnings that could lead to potential bugs should be addressed first, while less critical ones like deprecation warnings can be deprioritized.

Establishing an anti-warning culture is crucial because it encourages developers to address warnings early, preventing the accumulation of technical debt and improving overall code quality and developer experience.

Organizing and distributing the work can be done through simple analysis and distribution. An 80-20 analysis can help identify the most problematic files, allowing teams to prioritize and tackle warnings piece by piece.

An example is a small application with a book inventory where sorting functionality fails for one attribute due to a warning about unique keys in React. This demonstrates how ignored warnings can lead to bugs.

If you already have a lot of test warnings, you should prevent new ones from being added by using automation tools and systematically address existing ones through prioritization and distribution of work.

Victor Cordova
Victor Cordova
8 min
15 Jun, 2021

Comments

Sign in or register to post your comment.

Video Summary and Transcription

Today's Talk focuses on preventing test warnings in software development. Test warnings are often ignored and can lead to bugs, performance issues, and security concerns. The speaker introduces a library called jsreporter log validator that automates the process of adding rules to prevent new warnings and fixing existing ones. The library provides a summary of expected behavior, failures, and actions to take. Overall, the Talk emphasizes the importance of paying attention to test warnings and using automation to improve developer experience and prevent issues in large and legacy applications.

1. Introduction to Test Warnings

Short description:

Today we're going to be talking about preventing test warnings, with two goals in mind: preventing bugs and improving developer experience. Test warnings are messages created by developers to avoid bugs, performance issues, security concerns, and more. Warnings tend to accumulate because they're easy to ignore, don't make CI fail, and are often not a priority. Ignoring warnings can have consequences, as I'll demonstrate with a small application example.

Hello, everyone, and thank you for joining to the life-changing magic of tiding up your test warnings. Today we're going to be talking about preventing test warnings, with two goals in mind. The first one is going to be to prevent bugs. This is the most important one, and the second one is to improve developer experience.

A little bit about myself. My name is Victor Cordova. I work at TravelPerk, a Barcelona start-up. We're building the world's best business travel platform. If you're interested, please feel free to join us.

All right. So let's start by asking what are test warnings for? Test warnings are essentially messages created by developers of third-party libraries or other technologies that give us clues about what to avoid. For example, we want to definitely avoid bugs. We want to avoid performance issues. We want to avoid security concerns, amongst many others. This is just a very small sample. We also have accessibility issues, deprecations, and so on.

Now, the thing about warnings is that they tend to accumulate with time, and it's worth it to ask why this is the case. The first one is because they're pretty easy to ignore. So essentially, test warnings are just texts being generated either in your local machine or on another server. So this text, by itself, doesn't do anything. The second reason is because they don't make your CI fail. As developers, we all know that we pay much more attention to this red color that pops up whenever something fails. And finally, because they usually are not a priority. We live in a complex world. We have product tasks, technical tasks, so warnings can easily go to the end of this list.

Now, it's important to ask why do we even care, honestly. I ask myself that. So what happens if we ignore warnings? I'm going to give you a very small sample of what can happen. This is a small application with a book inventory where we have the title, the registration date, and the condition of the book. So let's imagine I'm going to fill this right now.

2. Preventing Test Warnings

Short description:

I'm going to put fair, good, and terrible. Now, why is this concerning? Because this might very easily be your output in the test run. React will give you a warning that says, every element must have a unique key. That's why we need to pay attention to these warnings. This is the developer experience side of things. If you're trying to do TDD, if you're trying to debug an issue, nobody wants to see this. It's quite annoying. The developer experience is affected. It's a very common issue in large applications, legacy applications. But we're engineers. So let's use some automation. I created this very small library called jsreporter log validator. It allows you to add different rules to your warnings so that your team doesn't create new ones. You can add validations for certain patterns. Sometimes they have a dynamic part. You can put a maximum. You can also have a fail-safe for unavoidable warnings. We sometimes install third-party libraries that generate messages we don't want. But we cannot do anything about it at times. We also have an option to fail if an unknown warning is found.

I'm going to put fair, good, and terrible. So now I'm going to try to use this sorting functionality. And we'll see that everything but the condition is sorted.

Now, why is this concerning? Because this might very easily be your output in the test run. So everything is green, which is really not a reflection of what's happening. So React, which is just an example, will give you a warning that says, every element must have a unique key. That's why we need to pay attention to these warnings. This is the developer experience side of things. If you're trying to do TDD, if you're trying to debug an issue, nobody wants to see this. It's quite annoying. It's difficult to find important stuff. So the developer experience is affected.

Now, we can ask ourselves what do we do about it? It's a very common issue in large applications, legacy applications. And it feels sometimes like we really can't do anything. But we're engineers. So let's use some automation. So I created this very small library. It's called jsreporter log validator. And it allows you to add these different rules to your warnings so that your team doesn't create new ones. The first feature it has is that you can add validations for certain patterns. As you will see, it's not a single string for each one of the patterns. Sometimes they have a dynamic part. You can put a maximum. So you are basically saying, okay, we know we have this number of warnings of this type. But I don't want any more. The second one is that you can have a fail-safe for unavoidable warnings. We sometimes install third-party libraries that generate messages we don't want. But we cannot do anything about it at times. So we can just ignore it for now. We also have an option to fail if an unknown warning is found.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

Network Requests with Cypress
TestJS Summit 2021TestJS Summit 2021
33 min
Network Requests with Cypress
Top Content
Cecilia Martinez, a technical account manager at Cypress, discusses network requests in Cypress and demonstrates commands like cydot request and SCI.INTERCEPT. She also explains dynamic matching and aliasing, network stubbing, and the pros and cons of using real server responses versus stubbing. The talk covers logging request responses, testing front-end and backend API, handling list length and DOM traversal, lazy loading, and provides resources for beginners to learn Cypress.
Testing Pyramid Makes Little Sense, What We Can Use Instead
TestJS Summit 2021TestJS Summit 2021
38 min
Testing Pyramid Makes Little Sense, What We Can Use Instead
Top Content
Featured Video
Gleb Bahmutov
Roman Sandler
2 authors
The testing pyramid - the canonical shape of tests that defined what types of tests we need to write to make sure the app works - is ... obsolete. In this presentation, Roman Sandler and Gleb Bahmutov argue what the testing shape works better for today's web applications.
Full-Circle Testing With Cypress
TestJS Summit 2022TestJS Summit 2022
27 min
Full-Circle Testing With Cypress
Top Content
Cypress is a powerful tool for end-to-end testing and API testing. It provides instant feedback on test errors and allows tests to be run inside the browser. Cypress enables testing at both the application and network layers, making it easier to reach different edge cases. With features like AppActions and component testing, Cypress allows for comprehensive testing of individual components and the entire application. Join the workshops to learn more about full circle testing with Cypress.
Test Effective Development
TestJS Summit 2021TestJS Summit 2021
31 min
Test Effective Development
Top Content
This Talk introduces Test Effective Development, a new approach to testing that aims to make companies more cost-effective. The speaker shares their personal journey of improving code quality and reducing bugs through smarter testing strategies. They discuss the importance of finding a balance between testing confidence and efficiency and introduce the concepts of isolated and integrated testing. The speaker also suggests different testing strategies based on the size of the application and emphasizes the need to choose cost-effective testing approaches based on the specific project requirements.
Playwright Test Runner
TestJS Summit 2021TestJS Summit 2021
25 min
Playwright Test Runner
Top Content
The Playwright Test Runner is a cross-browser web testing framework that allows you to write tests using just a few lines of code. It supports features like parallel test execution, device emulation, and different reporters for customized output. Code-Gen is a new feature that generates code to interact with web pages. Playwright Tracing provides a powerful tool for debugging and analyzing test actions, with the ability to explore trace files using TraceViewer. Overall, Playwright Test offers installation, test authoring, debugging, and post-mortem debugging capabilities.
Everyone Can Easily Write Tests
TestJS Summit 2023TestJS Summit 2023
21 min
Everyone Can Easily Write Tests
Playwright is a reliable end-to-end testing tool for modern web apps that provides one API, full isolation, fast execution, and supports multiple languages. It offers features like auto-weighting, retrying assertions, seamless testing of iframes and shadow DOM, test isolation, parallelism, and scalability. Playwright provides tools like VS Code extension, UiMode, and Trace Viewer for writing, debugging, and running tests. Effective tests prioritize user-facing attributes, use playwright locators and assertions, and avoid testing third-party dependencies. Playwright simplifies testing by generating tests, providing code generation and UI mode, and allows for easy running and debugging of tests. It helps in fixing failed tests and analyzing DOM changes, fixing locator mismatches, and scaling tests. Playwright is open source, free, and continuously growing.

Workshops on related topic

Designing Effective Tests With React Testing Library
React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Top Content
Featured Workshop
Josh Justice
Josh Justice
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn
How to Start With Cypress
TestJS Summit 2022TestJS Summit 2022
146 min
How to Start With Cypress
Featured WorkshopFree
Filip Hric
Filip Hric
The web has evolved. Finally, testing has also. Cypress is a modern testing tool that answers the testing needs of modern web applications. It has been gaining a lot of traction in the last couple of years, gaining worldwide popularity. If you have been waiting to learn Cypress, wait no more! Filip Hric will guide you through the first steps on how to start using Cypress and set up a project on your own. The good news is, learning Cypress is incredibly easy. You'll write your first test in no time, and then you'll discover how to write a full end-to-end test for a modern web application. You'll learn the core concepts like retry-ability. Discover how to work and interact with your application and learn how to combine API and UI tests. Throughout this whole workshop, we will write code and do practical exercises. You will leave with a hands-on experience that you can translate to your own project.
Detox 101: How to write stable end-to-end tests for your React Native application
React Summit 2022React Summit 2022
117 min
Detox 101: How to write stable end-to-end tests for your React Native application
Top Content
WorkshopFree
Yevheniia Hlovatska
Yevheniia Hlovatska
Compared to unit testing, end-to-end testing aims to interact with your application just like a real user. And as we all know it can be pretty challenging. Especially when we talk about Mobile applications.
Tests rely on many conditions and are considered to be slow and flaky. On the other hand - end-to-end tests can give the greatest confidence that your app is working. And if done right - can become an amazing tool for boosting developer velocity.
Detox is a gray-box end-to-end testing framework for mobile apps. Developed by Wix to solve the problem of slowness and flakiness and used by React Native itself as its E2E testing tool.
Join me on this workshop to learn how to make your mobile end-to-end tests with Detox rock.
Prerequisites- iOS/Android: MacOS Catalina or newer- Android only: Linux- Install before the workshop
API Testing with Postman Workshop
TestJS Summit 2023TestJS Summit 2023
48 min
API Testing with Postman Workshop
Top Content
WorkshopFree
Pooja Mistry
Pooja Mistry
In the ever-evolving landscape of software development, ensuring the reliability and functionality of APIs has become paramount. "API Testing with Postman" is a comprehensive workshop designed to equip participants with the knowledge and skills needed to excel in API testing using Postman, a powerful tool widely adopted by professionals in the field. This workshop delves into the fundamentals of API testing, progresses to advanced testing techniques, and explores automation, performance testing, and multi-protocol support, providing attendees with a holistic understanding of API testing with Postman.
1. Welcome to Postman- Explaining the Postman User Interface (UI)2. Workspace and Collections Collaboration- Understanding Workspaces and their role in collaboration- Exploring the concept of Collections for organizing and executing API requests3. Introduction to API Testing- Covering the basics of API testing and its significance4. Variable Management- Managing environment, global, and collection variables- Utilizing scripting snippets for dynamic data5. Building Testing Workflows- Creating effective testing workflows for comprehensive testing- Utilizing the Collection Runner for test execution- Introduction to Postbot for automated testing6. Advanced Testing- Contract Testing for ensuring API contracts- Using Mock Servers for effective testing- Maximizing productivity with Collection/Workspace templates- Integration Testing and Regression Testing strategies7. Automation with Postman- Leveraging the Postman CLI for automation- Scheduled Runs for regular testing- Integrating Postman into CI/CD pipelines8. Performance Testing- Demonstrating performance testing capabilities (showing the desktop client)- Synchronizing tests with VS Code for streamlined development9. Exploring Advanced Features - Working with Multiple Protocols: GraphQL, gRPC, and more
Join us for this workshop to unlock the full potential of Postman for API testing, streamline your testing processes, and enhance the quality and reliability of your software. Whether you're a beginner or an experienced tester, this workshop will equip you with the skills needed to excel in API testing with Postman.
Monitoring 101 for React Developers
React Summit US 2023React Summit US 2023
107 min
Monitoring 101 for React Developers
Top Content
WorkshopFree
Lazar Nikolov
Sarah Guthals
2 authors
If finding errors in your frontend project is like searching for a needle in a code haystack, then Sentry error monitoring can be your metal detector. Learn the basics of error monitoring with Sentry. Whether you are running a React, Angular, Vue, or just “vanilla” JavaScript, see how Sentry can help you find the who, what, when and where behind errors in your frontend project. 
Workshop level: Intermediate
Testing Web Applications Using Cypress
TestJS Summit - January, 2021TestJS Summit - January, 2021
173 min
Testing Web Applications Using Cypress
WorkshopFree
Gleb Bahmutov
Gleb Bahmutov
This workshop will teach you the basics of writing useful end-to-end tests using Cypress Test Runner.
We will cover writing tests, covering every application feature, structuring tests, intercepting network requests, and setting up the backend data.
Anyone who knows JavaScript programming language and has NPM installed would be able to follow along.