├── .gitignore
├── README.md
├── cypress.json
├── cypress
    ├── .eslintrc.json
    ├── .gitignore
    ├── global.d.ts
    ├── integration
    │   └── App.spec.js
    ├── plugins
    │   └── index.js
    └── support
    │   ├── commands.js
    │   └── index.js
├── jest-puppeteer.config.js
├── jest.config.js
├── package-lock.json
├── package.json
├── public
    ├── favicon.ico
    ├── index.html
    └── manifest.json
├── src
    ├── App.css
    ├── App.e2e.js
    ├── App.js
    ├── App.test.js
    ├── feedbackMachine.js
    ├── index.css
    ├── index.js
    ├── logo.svg
    └── serviceWorker.js
└── yarn.lock


/.gitignore:
--------------------------------------------------------------------------------
 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 2 | 
 3 | # dependencies
 4 | /node_modules
 5 | /.pnp
 6 | .pnp.js
 7 | 
 8 | # testing
 9 | /coverage
10 | 
11 | # production
12 | /build
13 | 
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 | 
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Model-Based Testing with `@xstate/test` and React Demo
 2 | 
 3 | This is a React project bootstrapped with [Create React App](https://github.com/facebook/create-react-app). It demonstrates how to use `@xstate/test` with React to automate the generation of integration and end-to-end (E2E) tests of an example application.
 4 | 
 5 | ![End-to-end tests for Feedback app being run in a browser with Puppeteer](https://i.imgur.com/W5CaIIP.gif)
 6 | 
 7 | ## Running the Tests
 8 | 
 9 | To run the **integration tests**, run `npm test`. This will run the tests found in [`./src/App.test.js`](https://github.com/davidkpiano/xstate-test-demo/blob/master/src/App.test.js).
10 | 
11 | To run the **E2E tests**, run `npm run e2e`. This will run the tests found in [`./src/App.e2e.js`](https://github.com/davidkpiano/xstate-test-demo/blob/master/src/App.e2e.js).
12 | 
13 | NOTE: To run the **E2E tests** on a different port: `PORT=3001 npm run e2e`
14 | 
15 | ## Resources
16 | 
17 | - [Github: `@xstate/test`](https://github.com/davidkpiano/xstate/tree/master/packages/xstate-test)
18 | - [Slides: Write Less Tests! From Automation to Autogeneration](https://slides.com/davidkhourshid/mbt/) (React Rally 2019)
19 | - [Article: Model-Based Testing in React with State Machines](https://css-tricks.com/?p=286484) (CSS-Tricks)
20 | 


--------------------------------------------------------------------------------
/cypress.json:
--------------------------------------------------------------------------------
1 | {
2 |     "chromeWebSecurity": false
3 | }


--------------------------------------------------------------------------------
/cypress/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": ["plugin:cypress/recommended"]
3 | }
4 | 


--------------------------------------------------------------------------------
/cypress/.gitignore:
--------------------------------------------------------------------------------
1 | screenshots/*
2 | videos/*
3 | 


--------------------------------------------------------------------------------
/cypress/global.d.ts:
--------------------------------------------------------------------------------
  1 | /// <reference types="cypress" />
  2 | 
  3 | declare namespace Cypress {
  4 |   import { authService } from "../src/machines/authMachine";
  5 |   import { createTransactionService } from "../src/machines/createTransactionMachine";
  6 |   import { publicTransactionService } from "../src/machines/publicTransactionsMachine";
  7 |   import { contactsTransactionService } from "../src/machines/contactsTransactionsMachine";
  8 |   import { personalTransactionService } from "../src/machines/personalTransactionsMachine";
  9 |   import {
 10 |     User,
 11 |     BankAccount,
 12 |     Like,
 13 |     Comment,
 14 |     Transaction,
 15 |     BankTransfer,
 16 |     Contact,
 17 |   } from "../src/models";
 18 | 
 19 |   interface CustomWindow extends Window {
 20 |     authService: typeof authService;
 21 |     createTransactionService: typeof createTransactionService;
 22 |     publicTransactionService: typeof publicTransactionService;
 23 |     contactTransactionService: typeof contactsTransactionService;
 24 |     personalTransactionService: typeof personalTransactionService;
 25 |   }
 26 | 
 27 |   type dbQueryArg = {
 28 |     entity: string;
 29 |     query: object | [object];
 30 |   };
 31 | 
 32 |   interface Chainable {
 33 |     /**
 34 |      *  Window object with additional properties used during test.
 35 |      */
 36 |     window(options?: Partial<Loggable & Timeoutable>): Chainable<CustomWindow>;
 37 | 
 38 |     /**
 39 |      * Custom command to make taking Percy snapshots with full name formed from the test title + suffix easier
 40 |      */
 41 |     visualSnapshot(maybeName?): Chainable<any>;
 42 | 
 43 |     getBySel(dataTestAttribute: string, args?: any): Chainable<Element>;
 44 |     getBySelLike(dataTestPrefixAttribute: string, args?: any): Chainable<Element>;
 45 | 
 46 |     /**
 47 |      *  Cypress task for directly querying to the database within tests
 48 |      */
 49 |     task(
 50 |       event: "filter:database",
 51 |       arg: dbQueryArg,
 52 |       options?: Partial<Loggable & Timeoutable>
 53 |     ): Chainable<any[]>;
 54 | 
 55 |     /**
 56 |      *  Cypress task for directly querying to the database within tests
 57 |      */
 58 |     task(
 59 |       event: "find:database",
 60 |       arg?: any,
 61 |       options?: Partial<Loggable & Timeoutable>
 62 |     ): Chainable<any>;
 63 | 
 64 |     /**
 65 |      * Find a single entity via database query
 66 |      */
 67 |     database(operation: "find", entity: string, query?: object, log?: boolean): Chainable<any>;
 68 | 
 69 |     /**
 70 |      * Filter for data entities via database query
 71 |      */
 72 |     database(operation: "filter", entity: string, query?: object, log?: boolean): Chainable<any[]>;
 73 | 
 74 |     /**
 75 |      * Fetch React component instance associated with received element subject
 76 |      */
 77 |     reactComponent(): Chainable<any>;
 78 | 
 79 |     /**
 80 |      * Select data range within date range picker component
 81 |      */
 82 |     pickDateRange(startDate: Date, endDate: Date): Chainable<void>;
 83 | 
 84 |     /**
 85 |      * Select transaction amount range
 86 |      */
 87 |     setTransactionAmountRange(min: number, max: number): Chainable<any>;
 88 | 
 89 |     /**
 90 |      * Paginate to the next page in transaction infinite-scroll pagination view
 91 |      */
 92 |     nextTransactionFeedPage(service: string, page: number): Chainable<any>;
 93 | 
 94 |     /**
 95 |      * Logs-in user by using UI
 96 |      */
 97 |     login(username: string, password: string, rememberUser?: boolean): void;
 98 | 
 99 |     /**
100 |      * Logs-in user by using API request
101 |      */
102 |     loginByApi(username: string, password?: string): Chainable<Response>;
103 | 
104 |     /**
105 |      * Logs in bypassing UI by triggering XState login event
106 |      */
107 |     loginByXstate(username: string, password?: string): Chainable<any>;
108 | 
109 |     /**
110 |      * Logs out via bypassing UI by triggering XState logout event
111 |      */
112 |     logoutByXstate(): Chainable<void>;
113 | 
114 |     /**
115 |      * Switch current user by logging out current user and logging as user with specified username
116 |      */
117 |     switchUser(username: string): Chainable<any>;
118 | 
119 |     /**
120 |      * Create Transaction via bypassing UI and using XState createTransactionService
121 |      */
122 |     createTransaction(payload): Chainable<any>;
123 |   }
124 | }
125 | 


--------------------------------------------------------------------------------
/cypress/integration/App.spec.js:
--------------------------------------------------------------------------------
  1 | /// <reference types="cypress" />
  2 | 
  3 | import { Machine } from "xstate";
  4 | import { createModel } from "@xstate/test";
  5 | 
  6 | const feedbackMachine = Machine({
  7 |   id: "feedback",
  8 |   initial: "question",
  9 |   on: {
 10 |     ESC: "closed",
 11 |   },
 12 |   states: {
 13 |     question: {
 14 |       on: {
 15 |         CLICK_GOOD: "thanks",
 16 |         CLICK_BAD: "form",
 17 |         CLOSE: "closed",
 18 |       },
 19 |       meta: {
 20 |         test: function () {
 21 |           cy.get("[data-testid=question-screen]").contains(
 22 |             "How was your experience?"
 23 |           );
 24 |         },
 25 |       },
 26 |     },
 27 |     form: {
 28 |       on: {
 29 |         SUBMIT: [
 30 |           {
 31 |             target: "thanks",
 32 |             cond: (_, e) => e.value.length,
 33 |           },
 34 |           // This should probably target "closed",
 35 |           // but the demo app doesn't behave that way!
 36 |           { target: "thanks" },
 37 |         ],
 38 |         CLOSE: "closed",
 39 |       },
 40 |       meta: {
 41 |         test: function () {
 42 |           cy.get("[data-testid=form-screen]").contains("Care to tell us why?");
 43 |         },
 44 |       },
 45 |     },
 46 |     thanks: {
 47 |       on: {
 48 |         CLOSE: "closed",
 49 |       },
 50 |       meta: {
 51 |         test: function () {
 52 |           cy.get("[data-testid=thanks-screen]").contains(
 53 |             "Thanks for your feedback."
 54 |           );
 55 |         },
 56 |       },
 57 |     },
 58 |     closed: {
 59 |       type: "final",
 60 |       meta: {
 61 |         test: function () {
 62 |           cy.get("[data-testid=question-screen]").should("not.exist");
 63 |           cy.get("[data-testid=form-screen]").should("not.exist");
 64 |           cy.get("[data-testid=thanks-screen]").should("not.exist");
 65 |         },
 66 |       },
 67 |     },
 68 |   },
 69 | });
 70 | 
 71 | const testModel = createModel(feedbackMachine, {
 72 |   events: {
 73 |     CLICK_GOOD: function () {
 74 |       cy.get("[data-testid=good-button]").click();
 75 |     },
 76 |     CLICK_BAD: function () {
 77 |       cy.get("[data-testid=bad-button]").click();
 78 |     },
 79 |     CLOSE: function () {
 80 |       cy.get("[data-testid=close-button]").click();
 81 |     },
 82 |     ESC: function () {
 83 |       cy.get("body").type("{esc}");
 84 |       // And do this once again to avoid some occasional flake...
 85 |       cy.get("body").type("{esc}");
 86 |     },
 87 |     SUBMIT: {
 88 |       exec: function (_, event) {
 89 |         if (event.value?.length)
 90 |           cy.get("[data-testid=response-input]").type(event.value);
 91 |         cy.get("[data-testid=submit-button]").click();
 92 |       },
 93 |       cases: [{ value: "something" }, { value: "" }],
 94 |     },
 95 |   },
 96 | });
 97 | 
 98 | const itVisitsAndRunsPathTests = (url) => (path) =>
 99 |   it(path.description, function () {
100 |     cy.visit(url).then(path.test);
101 |   });
102 | 
103 | const itTests = itVisitsAndRunsPathTests(
104 |   `http://localhost:${process.env.PORT || "3000"}`
105 | );
106 | 
107 | context("Feedback App", () => {
108 |   const testPlans = testModel.getSimplePathPlans();
109 |   testPlans.forEach((plan) => {
110 |     describe(plan.description, () => {
111 |       plan.paths.forEach(itTests);
112 |     });
113 |   });
114 | });
115 | 


--------------------------------------------------------------------------------
/cypress/plugins/index.js:
--------------------------------------------------------------------------------
 1 | /// <reference types="cypress" />
 2 | // ***********************************************************
 3 | // This example plugins/index.js can be used to load plugins
 4 | //
 5 | // You can change the location of this file or turn off loading
 6 | // the plugins file with the 'pluginsFile' configuration option.
 7 | //
 8 | // You can read more here:
 9 | // https://on.cypress.io/plugins-guide
10 | // ***********************************************************
11 | 
12 | // This function is called when a project is opened or re-opened (e.g. due to
13 | // the project's config changing)
14 | 
15 | /**
16 |  * @type {Cypress.PluginConfig}
17 |  */
18 | module.exports = (on, config) => {
19 |   // `on` is used to hook into various events Cypress emits
20 |   // `config` is the resolved Cypress config
21 | }
22 | 


--------------------------------------------------------------------------------
/cypress/support/commands.js:
--------------------------------------------------------------------------------
 1 | // ***********************************************
 2 | // This example commands.js shows you how to
 3 | // create various custom commands and overwrite
 4 | // existing commands.
 5 | //
 6 | // For more comprehensive examples of custom
 7 | // commands please read more here:
 8 | // https://on.cypress.io/custom-commands
 9 | // ***********************************************
10 | //
11 | //
12 | // -- This is a parent command --
13 | // Cypress.Commands.add("login", (email, password) => { ... })
14 | //
15 | //
16 | // -- This is a child command --
17 | // Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
18 | //
19 | //
20 | // -- This is a dual command --
21 | // Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
22 | //
23 | //
24 | // -- This will overwrite an existing command --
25 | // Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
26 | 


--------------------------------------------------------------------------------
/cypress/support/index.js:
--------------------------------------------------------------------------------
 1 | // ***********************************************************
 2 | // This example support/index.js is processed and
 3 | // loaded automatically before your test files.
 4 | //
 5 | // This is a great place to put global configuration and
 6 | // behavior that modifies Cypress.
 7 | //
 8 | // You can change the location of this file or turn off
 9 | // automatically serving support files with the
10 | // 'supportFile' configuration option.
11 | //
12 | // You can read more here:
13 | // https://on.cypress.io/configuration
14 | // ***********************************************************
15 | 
16 | // Import commands.js using ES2015 syntax:
17 | import './commands'
18 | 
19 | // Alternatively you can use CommonJS syntax:
20 | // require('./commands')
21 | 


--------------------------------------------------------------------------------
/jest-puppeteer.config.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |   server: {
 3 |     command: `npm start`,
 4 |     port: 3000,
 5 |     launchTimeout: 5000
 6 |   },
 7 |   launch: {
 8 |     headless: false,
 9 |     slowMo: 50
10 |   }
11 | };
12 | 


--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 |   preset: 'jest-puppeteer',
3 |   testRegex: './*\\.e2e\\.js$'
4 | };
5 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "feedback",
 3 |   "version": "0.1.0",
 4 |   "private": true,
 5 |   "dependencies": {
 6 |     "@xstate/graph": "0.0.1",
 7 |     "@xstate/react": "^0.1.0",
 8 |     "react": "^16.9.0",
 9 |     "react-dom": "^16.9.0",
10 |     "react-scripts": "^2.1.8",
11 |     "styled-components": "^4.3.2",
12 |     "xstate": "^4.16.2"
13 |   },
14 |   "scripts": {
15 |     "start": "react-scripts start",
16 |     "build": "react-scripts build",
17 |     "test": "react-scripts test",
18 |     "eject": "react-scripts eject",
19 |     "e2e": "jest -c jest.config.js --verbose",
20 |     "cypress": "cypress run",
21 |     "cypress:open": "cypress open",
22 |     "cypress:chrome": "cypress open --browser chrome"
23 |   },
24 |   "eslintConfig": {
25 |     "extends": "react-app"
26 |   },
27 |   "browserslist": [
28 |     ">0.2%",
29 |     "not dead",
30 |     "not ie <= 11",
31 |     "not op_mini all"
32 |   ],
33 |   "devDependencies": {
34 |     "@testing-library/react": "^9.1.3",
35 |     "@xstate/test": "^0.4.2",
36 |     "chai": "^4.2.0",
37 |     "cypress": "^6.5.0",
38 |     "eslint-plugin-cypress": "^2.11.2",
39 |     "jest-puppeteer": "^4.3.0",
40 |     "puppeteer": "^5.3.1"
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/davidkpiano/xstate-test-demo/be018908f24f61c6898f74065c20233225f190e6/public/favicon.ico


--------------------------------------------------------------------------------
/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8" />
 5 |     <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" />
 6 |     <meta
 7 |       name="viewport"
 8 |       content="width=device-width, initial-scale=1, shrink-to-fit=no"
 9 |     />
10 |     <meta name="theme-color" content="#000000" />
11 |     <!--
12 |       manifest.json provides metadata used when your web app is added to the
13 |       homescreen on Android. See https://developers.google.com/web/fundamentals/web-app-manifest/
14 |     -->
15 |     <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
16 |     <!--
17 |       Notice the use of %PUBLIC_URL% in the tags above.
18 |       It will be replaced with the URL of the `public` folder during the build.
19 |       Only files inside the `public` folder can be referenced from the HTML.
20 | 
21 |       Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
22 |       work correctly both with client-side routing and a non-root public URL.
23 |       Learn how to configure a non-root public URL by running `npm run build`.
24 |     -->
25 |     <title>React App</title>
26 |   </head>
27 |   <body>
28 |     <noscript>You need to enable JavaScript to run this app.</noscript>
29 |     <div id="root"></div>
30 |     <!--
31 |       This HTML file is a template.
32 |       If you open it directly in the browser, you will see an empty page.
33 | 
34 |       You can add webfonts, meta tags, or analytics to this file.
35 |       The build step will place the bundled scripts into the <body> tag.
36 | 
37 |       To begin the development, run `npm start` or `yarn start`.
38 |       To create a production bundle, use `npm run build` or `yarn build`.
39 |     -->
40 |   </body>
41 | </html>
42 | 


--------------------------------------------------------------------------------
/public/manifest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "short_name": "React App",
 3 |   "name": "Create React App Sample",
 4 |   "icons": [
 5 |     {
 6 |       "src": "favicon.ico",
 7 |       "sizes": "64x64 32x32 24x24 16x16",
 8 |       "type": "image/x-icon"
 9 |     }
10 |   ],
11 |   "start_url": ".",
12 |   "display": "standalone",
13 |   "theme_color": "#000000",
14 |   "background_color": "#ffffff"
15 | }
16 | 


--------------------------------------------------------------------------------
/src/App.css:
--------------------------------------------------------------------------------
 1 | .App {
 2 |   text-align: center;
 3 | }
 4 | 
 5 | .App-logo {
 6 |   animation: App-logo-spin infinite 20s linear;
 7 |   height: 40vmin;
 8 | }
 9 | 
10 | .App-header {
11 |   background-color: #282c34;
12 |   min-height: 100vh;
13 |   display: flex;
14 |   flex-direction: column;
15 |   align-items: center;
16 |   justify-content: center;
17 |   font-size: calc(10px + 2vmin);
18 |   color: white;
19 | }
20 | 
21 | .App-link {
22 |   color: #61dafb;
23 | }
24 | 
25 | @keyframes App-logo-spin {
26 |   from {
27 |     transform: rotate(0deg);
28 |   }
29 |   to {
30 |     transform: rotate(360deg);
31 |   }
32 | }
33 | 


--------------------------------------------------------------------------------
/src/App.e2e.js:
--------------------------------------------------------------------------------
  1 | const { Machine } = require('xstate');
  2 | const { createModel } = require('@xstate/test');
  3 | 
  4 | describe('feedback app', () => {
  5 |   const feedbackMachine = Machine({
  6 |     id: 'feedback',
  7 |     initial: 'question',
  8 |     states: {
  9 |       question: {
 10 |         on: {
 11 |           CLICK_GOOD: 'thanks',
 12 |           CLICK_BAD: 'form',
 13 |           CLOSE: 'closed'
 14 |         },
 15 |         meta: {
 16 |           test: async page => {
 17 |             await page.waitFor('[data-testid="question-screen"]');
 18 |           }
 19 |         }
 20 |       },
 21 |       form: {
 22 |         on: {
 23 |           SUBMIT: [
 24 |             {
 25 |               target: 'thanks',
 26 |               cond: (_, e) => e.value.length
 27 |             }
 28 |           ],
 29 |           CLOSE: 'closed'
 30 |         },
 31 |         meta: {
 32 |           test: async page => {
 33 |             await page.waitFor('[data-testid="form-screen"]');
 34 |           }
 35 |         }
 36 |       },
 37 |       thanks: {
 38 |         on: {
 39 |           CLOSE: 'closed'
 40 |         },
 41 |         meta: {
 42 |           test: async page => {
 43 |             await page.waitFor('[data-testid="thanks-screen"]');
 44 |           }
 45 |         }
 46 |       },
 47 |       closed: {
 48 |         type: 'final',
 49 |         meta: {
 50 |           test: async page => {
 51 |             return true;
 52 |           }
 53 |         }
 54 |       }
 55 |     }
 56 |   });
 57 | 
 58 |   const testModel = createModel(feedbackMachine, {
 59 |     events: {
 60 |       CLICK_GOOD: async page => {
 61 |         await page.click('[data-testid="good-button"]');
 62 |       },
 63 |       CLICK_BAD: async page => {
 64 |         await page.click('[data-testid="bad-button"]');
 65 |       },
 66 |       CLOSE: async page => {
 67 |         await page.click('[data-testid="close-button"]');
 68 |       },
 69 |       ESC: async page => {
 70 |         await page.press('Escape');
 71 |       },
 72 |       SUBMIT: {
 73 |         exec: async (page, event) => {
 74 |           await page.type('[data-testid="response-input"]', event.value);
 75 |           await page.click('[data-testid="submit-button"]');
 76 |         },
 77 |         cases: [{ value: 'something' }, { value: '' }]
 78 |       }
 79 |     }
 80 |   });
 81 | 
 82 |   const testPlans = testModel.getSimplePathPlans();
 83 | 
 84 |   testPlans.forEach((plan, i) => {
 85 |     describe(plan.description, () => {
 86 |       plan.paths.forEach((path, i) => {
 87 |         it(
 88 |           path.description,
 89 |           async () => {
 90 |             await page.goto(`http://localhost:${process.env.PORT || '3000'}`);
 91 |             await path.test(page);
 92 |           },
 93 |           10000
 94 |         );
 95 |       });
 96 |     });
 97 |   });
 98 | 
 99 |   it('coverage', () => {
100 |     testModel.testCoverage();
101 |   });
102 | });
103 | 


--------------------------------------------------------------------------------
/src/App.js:
--------------------------------------------------------------------------------
  1 | // @ts-check
  2 | 
  3 | import React, { useReducer, useEffect } from 'react';
  4 | import styled from 'styled-components';
  5 | 
  6 | function useKeyDown(key, onKeyDown) {
  7 |   useEffect(() => {
  8 |     const handler = e => {
  9 |       if (e.key === key) {
 10 |         onKeyDown();
 11 |       }
 12 |     };
 13 | 
 14 |     window.addEventListener('keydown', handler);
 15 | 
 16 |     return () => window.removeEventListener('keydown', handler);
 17 |   }, [onKeyDown]);
 18 | }
 19 | 
 20 | const StyledScreen = styled.div`
 21 |   padding: 1rem;
 22 |   padding-top: 2rem;
 23 |   background: white;
 24 |   box-shadow: 0 1rem 2rem rgba(0, 0, 0, 0.1);
 25 |   border-radius: 0.5rem;
 26 | 
 27 |   > header {
 28 |     margin-bottom: 1rem;
 29 |   }
 30 | 
 31 |   button {
 32 |     background: #4088da;
 33 |     appearance: none;
 34 |     border: none;
 35 |     text-transform: uppercase;
 36 |     color: white;
 37 |     letter-spacing: 0.5px;
 38 |     font-weight: bold;
 39 |     padding: 0.5rem 1rem;
 40 |     border-radius: 20rem;
 41 |     align-self: flex-end;
 42 |     cursor: pointer;
 43 |     font-size: 0.75rem;
 44 | 
 45 |     + button {
 46 |       margin-left: 0.5rem;
 47 |     }
 48 | 
 49 |     &[data-variant='good'] {
 50 |       background-color: #7cbd67;
 51 |     }
 52 |     &[data-variant='bad'] {
 53 |       background-color: #ff4652;
 54 |     }
 55 |   }
 56 | 
 57 |   textarea {
 58 |     display: block;
 59 |     margin-bottom: 1rem;
 60 |     border: 1px solid #dedede;
 61 |     font-size: 1rem;
 62 |   }
 63 | 
 64 |   [data-testid='close-button'] {
 65 |     position: absolute;
 66 |     top: 0;
 67 |     right: 0;
 68 |     appearance: none;
 69 |     height: 2rem;
 70 |     width: 2rem;
 71 |     line-height: 0;
 72 |     border: none;
 73 |     background: transparent;
 74 |     text-align: center;
 75 |     display: flex;
 76 |     justify-content: center;
 77 |     align-items: center;
 78 | 
 79 |     &:before {
 80 |       content: '×';
 81 |       font-size: 1.5rem;
 82 |       color: rgba(0, 0, 0, 0.5);
 83 |     }
 84 |   }
 85 | `;
 86 | 
 87 | function QuestionScreen({ onClickGood, onClickBad, onClose }) {
 88 |   useKeyDown('Escape', onClose);
 89 | 
 90 |   return (
 91 |     <StyledScreen data-testid="question-screen">
 92 |       <header>How was your experience?</header>
 93 |       <button
 94 |         onClick={onClickGood}
 95 |         data-testid="good-button"
 96 |         data-variant="good"
 97 |       >
 98 |         Good
 99 |       </button>
100 |       <button onClick={onClickBad} data-testid="bad-button" data-variant="bad">
101 |         Bad
102 |       </button>
103 |       <button data-testid="close-button" title="close" onClick={onClose} />
104 |     </StyledScreen>
105 |   );
106 | }
107 | 
108 | function FormScreen({ onSubmit, onClose }) {
109 |   useKeyDown('Escape', onClose);
110 | 
111 |   return (
112 |     <StyledScreen
113 |       as="form"
114 |       data-testid="form-screen"
115 |       onSubmit={e => {
116 |         e.preventDefault();
117 |         const { response } = e.target.elements;
118 | 
119 |         onSubmit({
120 |           value: response
121 |         });
122 |       }}
123 |     >
124 |       <header>Care to tell us why?</header>
125 |       <textarea
126 |         data-testid="response-input"
127 |         name="response"
128 |         placeholder="Complain here"
129 |         onKeyDown={e => {
130 |           if (e.key === 'Escape') {
131 |             e.stopPropagation();
132 |           }
133 |         }}
134 |       />
135 |       <button data-testid="submit-button">Submit</button>
136 |       <button
137 |         data-testid="close-button"
138 |         title="close"
139 |         type="button"
140 |         onClick={onClose}
141 |       />
142 |     </StyledScreen>
143 |   );
144 | }
145 | 
146 | function ThanksScreen({ onClose }) {
147 |   useKeyDown('Escape', onClose);
148 | 
149 |   return (
150 |     <StyledScreen data-testid="thanks-screen">
151 |       <header>Thanks for your feedback.</header>
152 |       <button data-testid="close-button" title="close" onClick={onClose} />
153 |     </StyledScreen>
154 |   );
155 | }
156 | 
157 | function feedbackReducer(state, event) {
158 |   switch (state) {
159 |     case 'question':
160 |       switch (event.type) {
161 |         case 'GOOD':
162 |           return 'thanks';
163 |         case 'BAD':
164 |           return 'form';
165 |         case 'CLOSE':
166 |           return 'closed';
167 |         default:
168 |           return state;
169 |       }
170 |     case 'form':
171 |       switch (event.type) {
172 |         case 'SUBMIT':
173 |           return 'thanks';
174 |         case 'CLOSE':
175 |           return 'closed';
176 |         default:
177 |           return state;
178 |       }
179 |     case 'thanks':
180 |       switch (event.type) {
181 |         case 'CLOSE':
182 |           return 'closed';
183 |         default:
184 |           return state;
185 |       }
186 |     default:
187 |       return state;
188 |   }
189 | }
190 | 
191 | function Feedback() {
192 |   const [state, send] = useReducer(feedbackReducer, 'question');
193 | 
194 |   switch (state) {
195 |     case 'question':
196 |       return (
197 |         <QuestionScreen
198 |           onClickGood={() => send({ type: 'GOOD' })}
199 |           onClickBad={() => send({ type: 'BAD' })}
200 |           onClose={() => send({ type: 'CLOSE' })}
201 |         />
202 |       );
203 |     case 'form':
204 |       return (
205 |         <FormScreen
206 |           onSubmit={value => send({ type: 'SUBMIT', value })}
207 |           onClose={() => send({ type: 'CLOSE' })}
208 |         />
209 |       );
210 |     case 'thanks':
211 |       return <ThanksScreen onClose={() => send({ type: 'CLOSE' })} />;
212 |     case 'closed':
213 |       return null;
214 |   }
215 | }
216 | 
217 | const StyledApp = styled.main`
218 |   height: 100vh;
219 |   width: 100vw;
220 |   background: #f5f8f9;
221 |   display: flex;
222 |   justify-content: center;
223 |   align-items: center;
224 | 
225 |   &,
226 |   * {
227 |     position: relative;
228 |     box-sizing: border-box;
229 |   }
230 | `;
231 | 
232 | function App() {
233 |   return (
234 |     <StyledApp>
235 |       <Feedback />
236 |     </StyledApp>
237 |   );
238 | }
239 | 
240 | export default App;
241 | 


--------------------------------------------------------------------------------
/src/App.test.js:
--------------------------------------------------------------------------------
  1 | import React from 'react';
  2 | import Feedback from './App';
  3 | import { Machine } from 'xstate';
  4 | import { render, fireEvent, cleanup } from '@testing-library/react';
  5 | import { assert } from 'chai';
  6 | import { createModel } from '@xstate/test';
  7 | 
  8 | // describe('feedback app', () => {
  9 | //   afterEach(cleanup);
 10 | 
 11 | //   it('should show the thanks screen when "Good" is clicked', () => {
 12 | //     const { getByTestId } = render(<Feedback />);
 13 | 
 14 | //     // The question screen should be visible at first
 15 | //     assert.ok(getByTestId('question-screen'));
 16 | 
 17 | //     // Click the "Good" button
 18 | //     fireEvent.click(getByTestId('good-button'));
 19 | 
 20 | //     // Now the thanks screen should be visible
 21 | //     assert.ok(getByTestId('thanks-screen'));
 22 | //   });
 23 | 
 24 | //   it('should show the form screen when "Bad" is clicked', () => {
 25 | //     const { getByTestId } = render(<Feedback />);
 26 | 
 27 | //     // The question screen should be visible at first
 28 | //     assert.ok(getByTestId('question-screen'));
 29 | 
 30 | //     // Click the "Bad" button
 31 | //     fireEvent.click(getByTestId('bad-button'));
 32 | 
 33 | //     // Now the form screen should be visible
 34 | //     assert.ok(getByTestId('form-screen'));
 35 | //   });
 36 | // });
 37 | 
 38 | // ............
 39 | 
 40 | describe('feedback app', () => {
 41 |   const feedbackMachine = Machine({
 42 |     id: 'feedback',
 43 |     initial: 'question',
 44 |     states: {
 45 |       question: {
 46 |         on: {
 47 |           CLICK_GOOD: 'thanks',
 48 |           CLICK_BAD: 'form',
 49 |           CLOSE: 'closed'
 50 |         },
 51 |         meta: {
 52 |           test: ({ getByTestId }) => {
 53 |             assert.ok(getByTestId('question-screen'));
 54 |           }
 55 |         }
 56 |       },
 57 |       form: {
 58 |         on: {
 59 |           SUBMIT: [
 60 |             {
 61 |               target: 'thanks',
 62 |               cond: (_, e) => e.value.length
 63 |             }
 64 |           ],
 65 |           CLOSE: 'closed'
 66 |         },
 67 |         meta: {
 68 |           test: ({ getByTestId }) => {
 69 |             assert.ok(getByTestId('form-screen'));
 70 |           }
 71 |         }
 72 |       },
 73 |       thanks: {
 74 |         on: {
 75 |           CLOSE: 'closed'
 76 |         },
 77 |         meta: {
 78 |           test: ({ getByTestId }) => {
 79 |             assert.ok(getByTestId('thanks-screen'));
 80 |           }
 81 |         }
 82 |       },
 83 |       closed: {
 84 |         type: 'final',
 85 |         meta: {
 86 |           test: ({ queryByTestId }) => {
 87 |             assert.isNull(queryByTestId('thanks-screen'));
 88 |           }
 89 |         }
 90 |       }
 91 |     }
 92 |   });
 93 | 
 94 |   const testModel = createModel(feedbackMachine, {
 95 |     events: {
 96 |       CLICK_GOOD: ({ getByText }) => {
 97 |         fireEvent.click(getByText('Good'));
 98 |       },
 99 |       CLICK_BAD: ({ getByText }) => {
100 |         fireEvent.click(getByText('Bad'));
101 |       },
102 |       CLOSE: ({ getByTestId }) => {
103 |         fireEvent.click(getByTestId('close-button'));
104 |       },
105 |       ESC: ({ baseElement }) => {
106 |         fireEvent.keyDown(baseElement, { key: 'Escape' });
107 |       },
108 |       SUBMIT: {
109 |         exec: async ({ getByTestId }, event) => {
110 |           fireEvent.change(getByTestId('response-input'), {
111 |             target: { value: event.value }
112 |           });
113 |           fireEvent.click(getByTestId('submit-button'));
114 |         },
115 |         cases: [{ value: 'something' }, { value: '' }]
116 |       }
117 |     }
118 |   });
119 | 
120 |   const testPlans = testModel.getSimplePathPlans();
121 | 
122 |   testPlans.forEach(plan => {
123 |     describe(plan.description, () => {
124 |       afterEach(cleanup);
125 | 
126 |       plan.paths.forEach(path => {
127 |         it(path.description, () => {
128 |           const rendered = render(<Feedback />);
129 |           return path.test(rendered);
130 |         });
131 |       });
132 |     });
133 |   });
134 | 
135 |   it('coverage', () => {
136 |     testModel.testCoverage();
137 |   });
138 | });
139 | 


--------------------------------------------------------------------------------
/src/feedbackMachine.js:
--------------------------------------------------------------------------------
 1 | import { Machine } from 'xstate';
 2 | 
 3 | export const feedbackMachine = Machine({
 4 |   id: 'feedback',
 5 |   initial: 'question',
 6 |   states: {
 7 |     question: {
 8 |       on: {
 9 |         CLICK_GOOD: 'acknowledge',
10 |         CLICK_BAD: 'form',
11 |         CLOSE: 'closed',
12 |         ESC: 'closed'
13 |       }
14 |     },
15 |     form: {
16 |       initial: 'pending',
17 |       states: {
18 |         pending: {
19 |           on: {
20 |             SUBMIT: [
21 |               { target: 'submitted', cond: 'formValid' },
22 |               { target: 'invalid' }
23 |             ]
24 |           }
25 |         },
26 |         invalid: {
27 |           on: {
28 |             FOCUS: 'pending'
29 |           }
30 |         },
31 |         submitted: {}
32 |       },
33 |       on: {
34 |         CLOSE: 'closed',
35 |         ESC: 'closed'
36 |       }
37 |     },
38 |     acknowledge: {
39 |       on: {
40 |         CLOSE: 'closed',
41 |         ESC: 'closed'
42 |       }
43 |     },
44 |     closed: {
45 |       type: 'final'
46 |     }
47 |   }
48 | });
49 | 


--------------------------------------------------------------------------------
/src/index.css:
--------------------------------------------------------------------------------
 1 | body {
 2 |   margin: 0;
 3 |   padding: 0;
 4 |   font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
 5 |     'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
 6 |     sans-serif;
 7 |   -webkit-font-smoothing: antialiased;
 8 |   -moz-osx-font-smoothing: grayscale;
 9 |   font-size: 24px;
10 | }
11 | 
12 | code {
13 |   font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
14 |     monospace;
15 | }
16 | 


--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import ReactDOM from 'react-dom';
 3 | import './index.css';
 4 | import App from './App';
 5 | import * as serviceWorker from './serviceWorker';
 6 | 
 7 | ReactDOM.render(<App />, document.getElementById('root'));
 8 | 
 9 | // If you want your app to work offline and load faster, you can change
10 | // unregister() to register() below. Note this comes with some pitfalls.
11 | // Learn more about service workers: http://bit.ly/CRA-PWA
12 | serviceWorker.unregister();
13 | 


--------------------------------------------------------------------------------
/src/logo.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
2 |     <g fill="#61DAFB">
3 |         <path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/>
4 |         <circle cx="420.9" cy="296.5" r="45.7"/>
5 |         <path d="M520.5 78.1z"/>
6 |     </g>
7 | </svg>
8 | 


--------------------------------------------------------------------------------
/src/serviceWorker.js:
--------------------------------------------------------------------------------
  1 | // This optional code is used to register a service worker.
  2 | // register() is not called by default.
  3 | 
  4 | // This lets the app load faster on subsequent visits in production, and gives
  5 | // it offline capabilities. However, it also means that developers (and users)
  6 | // will only see deployed updates on subsequent visits to a page, after all the
  7 | // existing tabs open on the page have been closed, since previously cached
  8 | // resources are updated in the background.
  9 | 
 10 | // To learn more about the benefits of this model and instructions on how to
 11 | // opt-in, read http://bit.ly/CRA-PWA
 12 | 
 13 | const isLocalhost = Boolean(
 14 |   window.location.hostname === 'localhost' ||
 15 |     // [::1] is the IPv6 localhost address.
 16 |     window.location.hostname === '[::1]' ||
 17 |     // 127.0.0.1/8 is considered localhost for IPv4.
 18 |     window.location.hostname.match(
 19 |       /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
 20 |     )
 21 | );
 22 | 
 23 | export function register(config) {
 24 |   if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
 25 |     // The URL constructor is available in all browsers that support SW.
 26 |     const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
 27 |     if (publicUrl.origin !== window.location.origin) {
 28 |       // Our service worker won't work if PUBLIC_URL is on a different origin
 29 |       // from what our page is served on. This might happen if a CDN is used to
 30 |       // serve assets; see https://github.com/facebook/create-react-app/issues/2374
 31 |       return;
 32 |     }
 33 | 
 34 |     window.addEventListener('load', () => {
 35 |       const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
 36 | 
 37 |       if (isLocalhost) {
 38 |         // This is running on localhost. Let's check if a service worker still exists or not.
 39 |         checkValidServiceWorker(swUrl, config);
 40 | 
 41 |         // Add some additional logging to localhost, pointing developers to the
 42 |         // service worker/PWA documentation.
 43 |         navigator.serviceWorker.ready.then(() => {
 44 |           console.log(
 45 |             'This web app is being served cache-first by a service ' +
 46 |               'worker. To learn more, visit http://bit.ly/CRA-PWA'
 47 |           );
 48 |         });
 49 |       } else {
 50 |         // Is not localhost. Just register service worker
 51 |         registerValidSW(swUrl, config);
 52 |       }
 53 |     });
 54 |   }
 55 | }
 56 | 
 57 | function registerValidSW(swUrl, config) {
 58 |   navigator.serviceWorker
 59 |     .register(swUrl)
 60 |     .then(registration => {
 61 |       registration.onupdatefound = () => {
 62 |         const installingWorker = registration.installing;
 63 |         if (installingWorker == null) {
 64 |           return;
 65 |         }
 66 |         installingWorker.onstatechange = () => {
 67 |           if (installingWorker.state === 'installed') {
 68 |             if (navigator.serviceWorker.controller) {
 69 |               // At this point, the updated precached content has been fetched,
 70 |               // but the previous service worker will still serve the older
 71 |               // content until all client tabs are closed.
 72 |               console.log(
 73 |                 'New content is available and will be used when all ' +
 74 |                   'tabs for this page are closed. See http://bit.ly/CRA-PWA.'
 75 |               );
 76 | 
 77 |               // Execute callback
 78 |               if (config && config.onUpdate) {
 79 |                 config.onUpdate(registration);
 80 |               }
 81 |             } else {
 82 |               // At this point, everything has been precached.
 83 |               // It's the perfect time to display a
 84 |               // "Content is cached for offline use." message.
 85 |               console.log('Content is cached for offline use.');
 86 | 
 87 |               // Execute callback
 88 |               if (config && config.onSuccess) {
 89 |                 config.onSuccess(registration);
 90 |               }
 91 |             }
 92 |           }
 93 |         };
 94 |       };
 95 |     })
 96 |     .catch(error => {
 97 |       console.error('Error during service worker registration:', error);
 98 |     });
 99 | }
100 | 
101 | function checkValidServiceWorker(swUrl, config) {
102 |   // Check if the service worker can be found. If it can't reload the page.
103 |   fetch(swUrl)
104 |     .then(response => {
105 |       // Ensure service worker exists, and that we really are getting a JS file.
106 |       const contentType = response.headers.get('content-type');
107 |       if (
108 |         response.status === 404 ||
109 |         (contentType != null && contentType.indexOf('javascript') === -1)
110 |       ) {
111 |         // No service worker found. Probably a different app. Reload the page.
112 |         navigator.serviceWorker.ready.then(registration => {
113 |           registration.unregister().then(() => {
114 |             window.location.reload();
115 |           });
116 |         });
117 |       } else {
118 |         // Service worker found. Proceed as normal.
119 |         registerValidSW(swUrl, config);
120 |       }
121 |     })
122 |     .catch(() => {
123 |       console.log(
124 |         'No internet connection found. App is running in offline mode.'
125 |       );
126 |     });
127 | }
128 | 
129 | export function unregister() {
130 |   if ('serviceWorker' in navigator) {
131 |     navigator.serviceWorker.ready.then(registration => {
132 |       registration.unregister();
133 |     });
134 |   }
135 | }
136 | 


--------------------------------------------------------------------------------