Generate OpenAPI spec during compile by adamw · Pull Request #1279 · softwaremill/bootzooka

adamw · 2024-08-06T15:29:05Z

No description provided.

…mpatibility issue with CRA

… UserService.test.ts

grubach · 2024-12-30T12:20:26Z

ui/src/pages/Login/Login.tsx

+  const login = mutation.mutateAsync;
+
+  useEffect(() => {
+    if (isSuccess) {


Could it be done still with onSuccess option, but passed to usePostUserLogin hook?

Ok, fixed as proposed

grubach · 2024-12-30T12:22:15Z

ui/src/pages/Profile/components/PasswordDetails.tsx

-import { userService } from "services";
 import { FormikInput, FeedbackButton } from "components";
-import { useMutation } from "react-query";
+import { usePostUserChangepassword } from "../../../api/apiComponents";


api can be also a named path like contexts or services

Already fixed

adamw · 2024-12-31T14:35:12Z

@katekozlowska the tests seem to be failing

adamw · 2024-12-31T14:38:37Z

ui/package.json

    "@types/react-router-dom": "^5.3.3",
    "@types/yup": "^0.32.0",
-    "axios": "^1.6.5",
+    "axios": "0.27.2",


@katekozlowska so we're still using a downgraded axios?

axios has been removed

adamw · 2024-12-31T14:39:18Z

ui/package.json

    "eslint-config-prettier": "^9.1.0",
    "formik": "^2.4.5",
    "immer": "^10.0.3",
+    "openapicmd": "^2.4.0",


is this the openapi generator that we are using? the docs in stack.md mention openapi-codegen, is that still used?

not needed anymore. Removed it

adamw · 2024-12-31T14:39:30Z

ui/package.json

    "react-router-dom": "^6.21.1",
    "react-scripts": "^5.0.1",
-    "typescript": "5.1.6",
+    "typescript": "4.9.5",


is the TS downgrade necessary?

Upgraded to latest

adamw · 2024-12-31T14:40:37Z

ui/src/api/apiComponents.ts

@@ -0,0 +1,321 @@
+/**
+ * Generated by @openapi-codegen


if this is generated, should it be checked in to VCS?

adamw · 2024-12-31T14:44:37Z

yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.


Should this be here?

(the entire file)

The yarn.lock file is added to a frontend project to ensure consistent dependency versions across all environments where the project is installed. It locks the specific versions of dependencies and their sub-dependencies, preventing potential issues caused by version mismatches. Including it in the repository ensures that all team members and deployment environments use the exact same dependency tree, improving reliability and avoiding unexpected bugs.

yeah, but this one is in the top-level directory, shouldn't we have a non-empty ui/yarn.lock?

olafkrawczyk · 2025-01-03T10:00:12Z

nice job @katekozlowska 👏
since services are no longer mocked I think that a slight change in tests is required. From the jest logs looks like we should wrap components with query provider https://tanstack.com/query/v4/docs/framework/react/guides/testing

…ooka into generate-openapi-spec

BartoszButrymSoftwareMill · 2025-01-14T15:14:24Z

Somewhat unrelated to the core task, but maybe https://softwaremill.github.io/bootzooka/stack.html would be good to extend with the main libraries used on the frontend - there are things like Formik or Yup (and possibly others) which I might guess as to why they are used, but it would be good to describe it too

This information has been added to the stack.md file. I'm guessing you can't see it at the given address because the changes haven't been deployed yet.

BartoszButrymSoftwareMill · 2025-01-14T15:15:09Z

After starting I get a warning:

[0] Browserslist: caniuse-lite is outdated. Please run:
[0]   npx update-browserslist-db@latest
[0]   Why you should do it regularly: https://github.com/browserslist/update-db#readme
[0] (node:38772) [DEP_WEBPACK_DEV_SERVER_ON_AFTER_SETUP_MIDDLEWARE] DeprecationWarning: 'onAfterSetupMiddleware' option is deprecated. Please use the 'setupMiddlewares' option.
[0] (Use `node --trace-deprecation ...` to show where the warning was created)
[0] (node:38772) [DEP_WEBPACK_DEV_SERVER_ON_BEFORE_SETUP_MIDDLEWARE] DeprecationWarning: 'onBeforeSetupMiddleware' option is deprecated. Please use the 'setupMiddlewares' option.
[0] Starting the development server...
[0]
[0] Browserslist: caniuse-lite is outdated. Please run:
[0]   npx update-browserslist-db@latest
[0]   Why you should do it regularly: https://github.com/browserslist/update-db#readme
[0] Compiled with warnings.

Another thing to update probably?

Fixed, not showing anymore

Separate endpoints description from implemenation

6f96681

adamw marked this pull request as draft August 6, 2024 15:29

adamw and others added 28 commits August 7, 2024 11:49

Task to generate openapi spec

cec53c5

generate spec

738fb84

moved scripts and deps to ui, added typescript

6c6ba37

uses 'concurrently' instead of '&&' in a 'start' script

006e3d2

uses chokidar-cli

4593ad0

sets up scripts for types generation and downgrades axios due to a co…

6b1d759

…mpatibility issue with CRA

base working version of user registration using openapi-client-axios

8df0966

build script: generate openapi-types before building an app

beed970

removes the "packageManager" field from package.json

62530a8

fixes tests for Register component

025a666

removes unused .gitignore path

f488c11

removes 'registerUser' method from UserService

aea0d00

migrates "login" method & related use

5ca5c77

adds "Generate OpenAPI Spec" step to CI workflow (verify)

92fd984

moves redefined login and register methods to UserService and removes…

16ac4df

… UserService.test.ts

migrates logout method

5ec529f

migrates getCurrentUser

b235c5e

migrates changeProfileDetails

25f5278

migrates changePassword

8bbcfc7

avoids using real impl of getCurrentUser in test

8597773

migrates getVersion

ef8084e

migrates claimPasswordReset

547a4cc

migrates resetPassword

55c7639

removes unused file

063a12f

removes needless ui/public/openapi.yaml file

6048f90

fixes "watch:openapi" command

5ac7806

better start script

226457a

uses proper apiSpecPath, pointing to the backend endpoint

bd0fed8

env example

331686b

katekozlowska marked this pull request as ready for review December 30, 2024 08:10

clearouts

e546bbd

grubach reviewed Dec 30, 2024

View reviewed changes

Katarzyna Kozlowska and others added 4 commits December 30, 2024 23:52

paths and refactor

b58a4cc

Merge branch 'master' into generate-openapi-spec

cea46ae

Fix build

6a30655

Remove IO

d93c602

adamw commented Dec 31, 2024

View reviewed changes

Katarzyna Kozlowska and others added 3 commits January 10, 2025 09:14

generated api

2d9a7e8

Merge branch 'generate-openapi-spec' of github.com:softwaremill/bootz…

6f8728d

…ooka into generate-openapi-spec

update unit test after connecting openapi library for services

0f0d2fc

Bartosz Butrym and others added 8 commits January 14, 2025 16:48

fixes and changes according to dev review

cfc294d

fix build script inside package.json

cf5a9bc

upgrade packages

ff9aec4

set node versioon to 18

a982d87

set node version to 22

693d1df

Update ubuntu

40d1b83

Install sbt

61c7730

setup node

9289c0e

adamw merged commit 12fbde1 into master Jan 15, 2025
8 checks passed

adamw deleted the generate-openapi-spec branch July 31, 2025 09:02

		@@ -0,0 +1,4 @@
		# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.

Conversation

adamw commented Aug 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamw commented Dec 31, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

olafkrawczyk commented Jan 3, 2025

Uh oh!

BartoszButrymSoftwareMill commented Jan 14, 2025

Uh oh!

BartoszButrymSoftwareMill commented Jan 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants