Generate OpenAPI spec during compile #1279

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

No description provided.

…mpatibility issue with CRA

… UserService.test.ts

UI generate spec for api

belfz · 2024-08-28T11:59:47Z

ui/package.json

@@ -18,11 +18,13 @@
    "@types/react-router-bootstrap": "^0.26.6",
    "@types/react-router-dom": "^5.3.3",
    "@types/yup": "^0.32.0",
-    "axios": "^1.6.5",
+    "axios": "0.27.2",


I was getting an error like described here: openapistack/openapi-client-axios#172
Turns out, this is an incompatibility issue related to create-react-app.

I had it fixed by downgrading axios' version, as suggested here: facebook/create-react-app#12823 (comment)

In the long run, we might think about migrating this project out of CRA and into Vite-backed codebase, as suggested in the first link.

hm that's from 2022, shouldn't we be concerned that we're using such an old dependency? CRA maybe needs to be updated?

ah you write about that. Probably this vite thing should happen sooner rather than later?

adamw · 2024-09-05T07:34:44Z

ui/README.md

@@ -12,6 +12,12 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 The page will reload if you make edits.<br />
 You will also see any lint errors in the console.

+#### API client & associated types
+
+Before running `yarn start`, make sure to run `sbt "backend/generateOpenAPISpec"` in the project's root directory. This command will generate the `<project_root>/backend/target/openapi.yaml` file.


ok so I did yarn start after pulling these changes, and the terminal hangs on:

[~/projects/bootzooka/ui]% yarn start yarn run v1.22.19 $ yarn generate:openapi-types && concurrently "react-scripts start" "yarn watch:openapi" $ npx openapicmd typegen ../backend/target/openapi.yaml > src/api-client/openapi.d.ts

While in src/api-client/openapi.d.ts I got:

Need to install the following packages: openapicmd Ok to proceed? (y)

this probably should go to the terminal? ;)

After answering "y" to the (hidden) question, I got:

/bin/sh: concurrently: command not found error Command failed with exit code 127.

probably some setup that I'm missing?

Ok so running ./frontend-start.sh, which does yarn install helped ;) Maybe consolidating the READMEs would be a good idea?

Now I got:

error @oclif/[email protected]: The engine "node" is incompatible with this module. Expected version ">=18.0.0". Got "16.15.1" error Found incompatible module.

node 16 is specified as the minimum in package.json. Maybe this should be updated?

adamw · 2024-09-05T07:42:35Z

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

adamw · 2024-09-05T07:43:08Z

@katekozlowska @belfz ^

adamw · 2024-09-05T07:49:26Z

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?

adamw · 2024-09-05T07:50:33Z

More warnings, these seem to be connected to the client generation:

[0] WARNING in ./node_modules/openapi-client-axios/client.js
[0] Module Warning (from ./node_modules/source-map-loader/dist/cjs.js):
[0] Failed to parse source map from '/Users/adamw/projects/bootzooka/ui/node_modules/openapi-client-axios/src/client.ts' file: Error: ENOENT: no such file or directory, open '/Users/adamw/projects/bootzooka/ui/node_modules/openapi-client-axios/src/client.ts'
[0]
[0] WARNING in ./node_modules/openapi-client-axios/index.js
[0] Module Warning (from ./node_modules/source-map-loader/dist/cjs.js):
[0] Failed to parse source map from '/Users/adamw/projects/bootzooka/ui/node_modules/openapi-client-axios/src/index.ts' file: Error: ENOENT: no such file or directory, open '/Users/adamw/projects/bootzooka/ui/node_modules/openapi-client-axios/src/index.ts'
[0]
[0] WARNING in ./node_modules/openapi-client-axios/types/client.js
[0] Module Warning (from ./node_modules/source-map-loader/dist/cjs.js):
[0] Failed to parse source map from '/Users/adamw/projects/bootzooka/ui/node_modules/openapi-client-axios/src/types/client.ts' file: Error: ENOENT: no such file or directory, open '/Users/adamw/projects/bootzooka/ui/node_modules/openapi-client-axios/src/types/client.ts'

@katekozlowska

adamw · 2024-09-05T07:59:03Z

But despite the warnings, the UI works :)

adamw · 2024-09-05T08:23:56Z

ui/src/services/UserService/UserService.ts

+    .then((client) => client.postUserLogin(null, { ...params, apiKeyValidHours: 1 }))
+    .then(({ data }) => apiKeySchema.validate(data));
+
+export const register = (payload: RegisterParamsPayload) =>


can we generate these values as well? they seem to follow the same pattern, and that they can be fully computed from the API spec? this applies to the validation as well, doesn't it exactly follow what's in the OpenAPI schema?

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

Marcin Baraniecki and others added 3 commits August 26, 2024 13:51

removes unused js-yaml dependency

6391886

Merge pull request #1289 from softwaremill/ui-generate-spec-for-api

51e0a5c

UI generate spec for api

augments README for the ui

cd1742b

belfz reviewed Aug 28, 2024

View reviewed changes

adamw commented Sep 5, 2024

View reviewed changes

Avoid password4j warnings

1951387

adamw commented Sep 5, 2024

View reviewed changes

Katarzyna Kozlowska and others added 13 commits September 6, 2024 11:35

frontend tooling description

88c8153

Update dependencies, use macwire

120dc8f

Cleanup

bc43505

Dependencies

5a59070

Cleanup

0cdb967

Update macwire

c9b7e87

Remove unused

a4c10b3

Merge branch 'master' into generate-openapi-spec

f5c481c

Cleanup

4a345d5

Update CI

25ad6dc

Bridge JUL to SLF4J, fix docker build

6e5d6a7

Grafana LGTM in docker compose

48706d6

JMX metrics

cea46e7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate OpenAPI spec during compile #1279

Generate OpenAPI spec during compile #1279

adamw commented Aug 6, 2024

belfz Aug 28, 2024

adamw Sep 5, 2024

adamw Sep 5, 2024

adamw Sep 5, 2024

adamw Sep 5, 2024

adamw Sep 5, 2024

adamw Sep 5, 2024

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

adamw Sep 5, 2024

Generate OpenAPI spec during compile #1279

Are you sure you want to change the base?

Generate OpenAPI spec during compile #1279

Conversation

adamw commented Aug 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

adamw commented Sep 5, 2024

Choose a reason for hiding this comment