4 Commits

Author SHA1 Message Date
ddc552c584 Merge pull request #3 from Inforitnl/feature/contract-testing
Added a nestJS based contract api
2022-08-15 11:46:22 +02:00
3db77f96b9 Added a nestJS based contract api
- Added an example with trucks and basic fetch in useEffect on page load
  - Added simply test to see whether any data is displayed (and shows the interceptor)
Introduced "CypressStrictMode" which wraps React.StrictMode and checks whether Cypress is involved, if so disable StrictMode.
2022-08-15 11:42:19 +02:00
c0a0ea66a6 eslint now receives the glob itself 2022-08-08 14:48:59 +02:00
4b61b4a370 Added styled components
- also removed existing css
  - left the capabilities included
2022-08-08 14:08:16 +02:00
36 changed files with 15951 additions and 536 deletions

View File

@@ -2,5 +2,6 @@
. "$(dirname -- "$0")/_/husky.sh"
npm run lint-staged
npm run lint
npm run test-ci
npm run e2e-ci

View File

@@ -3,11 +3,14 @@
"browserslist",
"camelcase",
"deepmerge",
"etags",
"flexbugs",
"Immer",
"Keycloak",
"languagedetector",
"lcov",
"luxon",
"nestjs",
"oidc",
"pmmmwh",
"preinstall",

View File

@@ -4,7 +4,7 @@
"body": [
"import { FunctionComponent } from \"react\";",
"",
"type Props = {}",
"type Props = {};",
"",
"export const ${1:${TM_FILENAME_BASE}}: FunctionComponent<Props> = () => {",
" return <h1>${1:${TM_FILENAME_BASE}}</h1>;",
@@ -72,5 +72,23 @@
"react-i18next useTranslate hook": {
"prefix": ["useTranslation", "translate", "i18-trans"],
"body": ["const [translate] = useTranslation();"]
},
"react-styled-component": {
"prefix": ["rsfc", "rsc", "react-styled-component"],
"body": [
"import { FunctionComponent } from \"react\";",
"import styled from \"styled-components\";",
"",
"type Props = { className?: string };",
"",
"const ${1:${TM_FILENAME_BASE}}: FunctionComponent<Props> = ({className}) => {",
" return <h1 className={className}>${1:${TM_FILENAME_BASE}}</h1>;",
"};",
"",
"const Styled${1:${TM_FILENAME_BASE}} = styled(${1:${TM_FILENAME_BASE}})``;",
"",
"export { Styled${1:${TM_FILENAME_BASE}} as ${1:${TM_FILENAME_BASE}} };",
""
]
}
}

View File

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.6.2] - 2022-08-15
- Added a nestJS based contract api
- Added an example with trucks and basic fetch in useEffect on page load
- Added simply test to see whether any data is displayed (and shows the interceptor)
- Introduced "CypressStrictMode" which wraps React.StrictMode and checks whether Cypress is involved, if so disable StrictMode.
## [0.6.1] - 2022-08-08
- eslint now receives the glob itself
## [0.6.0] - 2022-08-08
- Added styled components
- also removed existing css
- left the capabilities included
## [0.5.0] - 2022-06-26
- Added react-oidc (use demo/demo)

View File

@@ -0,0 +1,66 @@
module.exports = {
parser: "@typescript-eslint/parser",
parserOptions: {
project: "tsconfig.json",
tsconfigRootDir: __dirname,
sourceType: "module",
},
plugins: ["@typescript-eslint/eslint-plugin", "import"],
extends: ["plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
root: true,
env: {
node: true,
jest: true,
},
ignorePatterns: [".eslintrc.js"],
rules: {
"no-console": [
"error",
{
allow: ["debug", "error"],
},
],
"no-eval": "error",
"import/first": "error",
camelcase: [
"error",
{
ignoreImports: true,
ignoreDestructuring: true,
},
],
"consistent-return": "warn",
"comma-dangle": ["warn", "always-multiline"],
"constructor-super": "error",
curly: "error",
"eol-last": "warn",
eqeqeq: ["error", "smart"],
"import/order": "always",
"new-parens": "error",
"no-debugger": "error",
"no-fallthrough": "off",
"max-len": [
"warn",
{
code: 100,
},
],
"no-shadow": [
"error",
{
hoist: "all",
},
],
"no-trailing-spaces": "warn",
"no-underscore-dangle": "error",
"no-unsafe-finally": "error",
"no-var": "error",
"object-shorthand": "error",
"one-var": ["error", "never"],
"prefer-arrow/prefer-arrow-functions": "off",
"prefer-const": "error",
radix: "off",
"space-in-parens": ["off", "never"],
quotes: [2, "double"],
},
};

35
contracts/api/.gitignore vendored Normal file
View File

@@ -0,0 +1,35 @@
# compiled output
/dist
/node_modules
# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# OS
.DS_Store
# Tests
/coverage
/.nyc_output
# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace
# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

11
contracts/api/README.md Normal file
View File

@@ -0,0 +1,11 @@
# Contract api
This API is meant to emulate the different contracts that you have with external systems
## use api based routing
You can use the first part of the URL as your contract and put your resources after that.
e.g, for `fake` you could do:
`URL/fake/trucks` and `URL/fake/containers`.
Then simply make `URL/fake` your root url in the React config

View File

@@ -0,0 +1,5 @@
{
"$schema": "https://json.schemastore.org/nest-cli",
"collection": "@nestjs/schematics",
"sourceRoot": "src"
}

14537
contracts/api/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,73 @@
{
"name": "contract-testing-api",
"version": "0.0.1",
"description": "",
"author": "",
"private": true,
"license": "UNLICENSED",
"scripts": {
"prebuild": "rimraf dist",
"build": "nest build",
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
"start": "nest start",
"start:dev": "nest start --watch",
"start:debug": "nest start --debug --watch",
"start:prod": "node dist/main",
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
"test": "jest",
"test:watch": "jest --watch",
"test:cov": "jest --coverage",
"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
"test:e2e": "jest --config ./test/jest-e2e.json"
},
"dependencies": {
"@nestjs/common": "^9.0.0",
"@nestjs/core": "^9.0.0",
"@nestjs/platform-express": "^9.0.0",
"reflect-metadata": "^0.1.13",
"rimraf": "^3.0.2",
"rxjs": "^7.2.0"
},
"devDependencies": {
"@nestjs/cli": "^9.0.0",
"@nestjs/schematics": "^9.0.0",
"@nestjs/testing": "^9.0.0",
"@types/express": "^4.17.13",
"@types/jest": "28.1.4",
"@types/node": "^16.0.0",
"@types/supertest": "^2.0.11",
"@typescript-eslint/eslint-plugin": "^5.0.0",
"@typescript-eslint/parser": "^5.0.0",
"eslint": "^8.0.1",
"eslint-config-prettier": "^8.3.0",
"eslint-plugin-prettier": "^4.0.0",
"inforit-prettier-config": "^1.0.0",
"jest": "28.1.2",
"prettier": "^2.3.2",
"source-map-support": "^0.5.20",
"supertest": "^6.1.3",
"ts-jest": "28.0.5",
"ts-loader": "^9.2.3",
"ts-node": "^10.0.0",
"tsconfig-paths": "4.0.0",
"typescript": "^4.3.5"
},
"jest": {
"moduleFileExtensions": [
"js",
"json",
"ts"
],
"rootDir": "src",
"testRegex": ".*\\.spec\\.ts$",
"transform": {
"^.+\\.(t|j)s$": "ts-jest"
},
"collectCoverageFrom": [
"**/*.(t|j)s"
],
"coverageDirectory": "../coverage",
"testEnvironment": "node"
},
"prettier": "inforit-prettier-config"
}

View File

@@ -0,0 +1,3 @@
export const API_CONSTANTS = {
fake: "fake",
};

View File

@@ -0,0 +1,9 @@
import { Controller, Get } from "@nestjs/common";
@Controller()
export class AppController {
@Get()
getHello(): string {
return "Welcome to the contract api";
}
}

View File

@@ -0,0 +1,10 @@
import { Module } from "@nestjs/common";
import { AppController } from "./app.controller";
import { FakeTrucksController } from "./contracts/fake/trucks.controller";
@Module({
imports: [],
controllers: [AppController, FakeTrucksController],
providers: [],
})
export class AppModule {}

View File

@@ -0,0 +1,21 @@
import { Controller, Get } from "@nestjs/common";
import { API_CONSTANTS } from "./../../api.constants";
@Controller(`${API_CONSTANTS.fake}/trucks`)
export class FakeTrucksController {
@Get()
get() {
return [
{
id: "de5ddb70-b2a7-4309-a992-62260a09683a",
licensePlate: "xx-yy-zz",
color: "black",
},
{
id: "087e0b0b-1c13-46e3-8920-762f5738072e",
licensePlate: "xx-yy-zz",
color: "red",
},
];
}
}

12
contracts/api/src/main.ts Normal file
View File

@@ -0,0 +1,12 @@
import { NestFactory } from "@nestjs/core";
import { AppModule } from "./app.module";
async function bootstrap() {
const app = await NestFactory.create(AppModule);
// allow app to be called from everywhere
app.enableCors();
// you can disable etags so that you always get 200's instead of 304s :)
// app.getHttpAdapter().getInstance().set("etag", false);
await app.listen(9600);
}
bootstrap();

View File

@@ -0,0 +1,4 @@
{
"extends": "./tsconfig.json",
"exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
}

View File

@@ -0,0 +1,21 @@
{
"compilerOptions": {
"module": "commonjs",
"declaration": true,
"removeComments": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"allowSyntheticDefaultImports": true,
"target": "es2017",
"sourceMap": true,
"outDir": "./dist",
"baseUrl": "./",
"incremental": true,
"skipLibCheck": true,
"strictNullChecks": false,
"noImplicitAny": false,
"strictBindCallApply": false,
"forceConsistentCasingInFileNames": false,
"noFallthroughCasesInSwitch": false
}
}

1
contracts/docs/.gitkeep Normal file
View File

@@ -0,0 +1 @@
Put your written contracts here

View File

@@ -6,6 +6,9 @@ export default defineConfig({
// implement node event listeners here
},
},
env: {
appBaseUrl: "http://localhost:3000",
},
video: false,
reporter: "mocha-junit-reporter",
reporterOptions: {

27
cypress/e2e/trucks.cy.ts Normal file
View File

@@ -0,0 +1,27 @@
/// <reference types="cypress" />
describe("Application trucks", () => {
beforeEach(() => {
cy.visit(Cypress.env("appBaseUrl"));
});
it("Should render the navigation links", () => {
cy.get("[data-testid='nav']");
});
it("Should navigate to trucks and display a result when clicking on trucks", () => {
cy.get('[data-testid="nav.trucks"]').click();
cy.contains("trucks (contract api) page");
});
it("Should eventually (after the http call) display the results on screen", () => {
cy.intercept({
method: "GET",
url: "http://localhost:9600/fake/trucks",
}).as("getTrucks");
cy.get('[data-testid="nav.trucks"]').click();
cy.contains("trucks (contract api) page");
cy.wait("@getTrucks").its("response.statusCode").should("be.oneOf", [200, 304]);
cy.get('[data-testid="trucksResult"]').should("not.be.empty");
});
});

View File

@@ -34,4 +34,4 @@
// visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
// }
// }
// }
// }

View File

@@ -14,7 +14,7 @@
// ***********************************************************
// Import commands.js using ES2015 syntax:
import './commands'
import "./commands";
// Alternatively you can use CommonJS syntax:
// require('./commands')
// require('./commands')

1437
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "react-starter-kit",
"version": "0.5.0",
"version": "0.6.2",
"description": "A modern, create-react-app-based, starter kit for React projects",
"keywords": [
"react",
@@ -28,16 +28,19 @@
"build:prod": "npm run build",
"cypress-run": "cypress run",
"e2e": "cypress open -d --e2e",
"e2e-ci": "start-server-and-test start http://localhost:3000 cypress-run",
"postinstall": "husky install",
"lint": "GLOBIGNORE='src/types' && eslint src/**",
"e2e-ci": "start-server-and-test start-e2e-dependencies \"http://localhost:3000|9600\" cypress-run",
"postinstall": "husky install && npm install --prefix contracts/api",
"lint": "eslint \"src/**\"",
"lint-staged": "lint-staged --relative",
"organize-package-json": "npx format-package -w && npx sort-package-json",
"pretty-quick": "pretty-quick --staged",
"start": "node scripts/start.js",
"start-with-contract": "concurrently \"npm start\" \"npm run start-contract-api\"",
"start-contract-api": "npm run start:dev --prefix contracts/api",
"start-e2e-dependencies": "npm run start-with-contract",
"test": "node scripts/test.js --verbose",
"test-ci": "node scripts/test.js --ci --coverage",
"test-live-coverage": " concurrently --kill-others \"npm run test-with-coverage\" \"npx http-server -c-1 coverage/lcov-report\"",
"test-live-coverage": "concurrently \"npm run test-with-coverage\" \"npx http-server -c-1 coverage/lcov-report\"",
"test-with-coverage": "node scripts/test.js --coverage",
"test:prod": "npm run test-ci && npm run e2e-ci"
},
@@ -56,7 +59,7 @@
"react-dom": "^18.2.0",
"react-redux": "^8.0.2",
"react-router-dom": "^6.3.0",
"tailwindcss": "^3.1.6"
"styled-components": "^5.3.5"
},
"devDependencies": {
"@babel/core": "^7.18.9",
@@ -71,6 +74,7 @@
"@types/node": "^18.6.1",
"@types/react": "^18.0.15",
"@types/react-dom": "^18.0.6",
"@types/styled-components": "^5.1.25",
"babel-jest": "^27.4.2",
"babel-loader": "^8.2.5",
"babel-plugin-named-asset-import": "^0.3.8",
@@ -112,7 +116,7 @@
"mocha-junit-reporter": "^2.0.2",
"postcss": "^8.4.14",
"postcss-flexbugs-fixes": "^5.0.2",
"postcss-loader": "^6.2.1",
"postcss-loader": "^7.0.1",
"postcss-normalize": "^10.0.1",
"postcss-preset-env": "^7.7.2",
"prettier": "^2.7.1",

View File

@@ -1,6 +1,12 @@
const defaultConfig = {
version: "0.1.0",
name: "React-starter-kit",
services: {
fake: {
root: "http://localhost:9600/fake",
trucks: "trucks",
},
},
// oidc: {
// url: "private_url",
// realm: "inforit",

View File

@@ -11,7 +11,8 @@
"home": "home",
"about": "about",
"counter": "counter",
"tenders": "tenders (with auth)"
"tenders": "tenders (with auth)",
"trucks": "trucks (contract api)"
},
"about": {
"title": "About"

View File

@@ -11,7 +11,8 @@
"home": "home",
"about": "over ons",
"counter": "teller",
"tenders": "aanbestedingen (met auth)"
"tenders": "aanbestedingen (met auth)",
"trucks": "trucks (contract api)"
},
"about": {
"title": "Over ons"

View File

@@ -4,6 +4,7 @@ import { Route, Routes } from "react-router-dom";
import { AboutContainer } from "./features/about/About";
import { CounterContainer } from "./features/examples/counter/Counter";
import { Tenders } from "./features/examples/tenders/Tenders";
import { Trucks } from "./features/examples/trucks/Trucks";
import { HomeContainer } from "./features/home/Home";
type Props = {};
@@ -12,10 +13,11 @@ export const ROUTE_KEYS = {
about: "about",
counter: "counter",
tenders: "tenders",
trucks: "trucks",
};
export const AppRoutes: FunctionComponent<Props> = () => {
const { home, about, counter, tenders } = ROUTE_KEYS;
const { home, about, counter, tenders, trucks } = ROUTE_KEYS;
return (
<Routes>
<Route path={home} element={<HomeContainer />} />
@@ -30,6 +32,7 @@ export const AppRoutes: FunctionComponent<Props> = () => {
</OidcSecure>
}
/>
<Route path={trucks} element={<Trucks />} />
{/* <Route index element={<Home />} /> */}
{/* <Route path="teams" element={<Teams />}>
<Route path=":teamId" element={<Team />} />

View File

@@ -0,0 +1,34 @@
import { useOidcAccessToken } from "@axa-fr/react-oidc";
import { FunctionComponent, useEffect, useState } from "react";
import { useTranslation } from "react-i18next";
import { Config } from "../../../infrastructure/config";
type Props = {};
export const Trucks: FunctionComponent<Props> = () => {
const [trucks, setTrucks] = useState(null);
const [translate] = useTranslation();
const { accessToken } = useOidcAccessToken();
useEffect(() => {
const { fake } = Config.services;
fetch(`${fake.root}/${fake.trucks}`, {
// fetch's way of adding headers. Not required to access the api... but :shrug:
headers: new Headers({
Authorization: `Bearer ${accessToken}`,
}),
})
.then((response) => response.json())
.then((data) => {
setTrucks(data);
});
}, [accessToken]);
return (
<>
<h1>{translate("nav.trucks")} page</h1>
<div data-testid="trucksResult">
{trucks ? <pre>{JSON.stringify(trucks, null, 2)}</pre> : <h2>loading...</h2>}
</div>
</>
);
};

View File

@@ -1,11 +0,0 @@
body {
margin: 0;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans",
"Droid Sans", "Helvetica Neue", sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
code {
font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;
}

View File

@@ -1,9 +1,10 @@
import React from "react";
import { createRoot } from "react-dom/client";
import { Provider } from "react-redux";
import { createGlobalStyle } from "styled-components";
import App from "./App";
import { store } from "./app/store";
import "./index.css";
import { CypressStrictMode } from "./infrastructure/CypressStrictMode";
import "./infrastructure/i18n/init";
import { OidcProvider } from "./infrastructure/sso/OidcProvider";
import { Loader } from "./infrastructure/wrappers/WithPageSuspense";
@@ -12,8 +13,23 @@ import reportWebVitals from "./reportWebVitals";
const container = document.getElementById("root")!;
const root = createRoot(container);
const GlobalStyle = createGlobalStyle`
body {
margin: 0;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans",
"Droid Sans", "Helvetica Neue", sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
code {
font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;
}
`;
root.render(
<React.StrictMode>
<CypressStrictMode>
<GlobalStyle />
<Provider store={store}>
<OidcProvider>
<Loader>
@@ -21,7 +37,7 @@ root.render(
</Loader>
</OidcProvider>
</Provider>
</React.StrictMode>,
</CypressStrictMode>,
);
// If you want to start measuring performance in your app, pass a function

View File

@@ -0,0 +1,16 @@
import React, { FunctionComponent, ReactNode } from "react";
type Props = { children?: ReactNode };
/**
* React StrictMode that disables itself when detected to be running in Cypress
*/
export const CypressStrictMode: FunctionComponent<Props> = ({ children }) => {
const isInCypress = (window as any).Cypress;
if (isInCypress) {
return <>{children}</>;
} else {
return <React.StrictMode>{children}</React.StrictMode>;
}
};

View File

@@ -4,6 +4,13 @@ export interface RunTimeConfig {
version: number;
name: string;
services: {
fake: {
root: string;
trucks: string;
};
};
/**
* Settings for the OIDC connection
*/

View File

@@ -1,3 +0,0 @@
nav a {
padding-right: 10px;
}

View File

@@ -3,18 +3,18 @@ import { DateTime } from "luxon";
import { FunctionComponent } from "react";
import { Trans, useTranslation } from "react-i18next";
import { Link } from "react-router-dom";
import styled from "styled-components";
import { ROUTE_KEYS } from "../../Routes";
import { Config } from "../config";
import "./Navbar.css";
type Props = {};
type Props = { className?: string };
export const Navbar: FunctionComponent<Props> = () => {
const Navbar: FunctionComponent<Props> = ({ className }) => {
const [translate, i18n] = useTranslation();
const { login, logout, isAuthenticated } = useOidc();
const { accessTokenPayload } = useOidcAccessToken();
const { home, about, counter } = ROUTE_KEYS;
const { home, about, counter, tenders, trucks } = ROUTE_KEYS;
return (
<>
<div className={className}>
<h1>{translate("navBar.intro")}</h1>
<p>
{/* trans can also be used to translate */}
@@ -41,13 +41,24 @@ export const Navbar: FunctionComponent<Props> = () => {
<Link to={counter} data-testid="nav.counter">
{translate("nav.counter")}
</Link>
<Link to="/tenders" data-testid="nav.tenders">
<Link to={tenders} data-testid="nav.tenders">
{translate("nav.tenders")}
</Link>
<Link to={trucks} data-testid="nav.trucks">
{translate("nav.trucks")}
</Link>
<button onClick={() => i18n.changeLanguage("en")}>en</button>
<button onClick={() => i18n.changeLanguage("nl")}>nl</button>
<hr />
</nav>
</>
</div>
);
};
const StyledNavBar = styled(Navbar)`
nav a {
padding-right: 10px;
}
`;
export { StyledNavBar as Navbar };

View File

@@ -0,0 +1,12 @@
import { FunctionComponent } from "react";
import styled from "styled-components";
type Props = {};
const TestComponent: FunctionComponent<Props> = () => {
return <h1>TestComponent</h1>;
};
const StyledTestComponent = styled(TestComponent)``;
export { StyledTestComponent as TestComponent };