Refactor to RTK Query

[sergkudinov]

Which issue(s) this PR fixes

Fixes #173 Fixes #112 Fixes #113 Fixes #114 Fixes #126 Fixes #168 Fixes #28

Replaces #201

Additional comments

It fully replaces the old way of querying the server and eliminates using OpenAPI generator on Java.

Agreements

• [x] I hereby declare this contribution to be licensed under the Apache License Version 2.0, January 2004.
• [x] I hereby agree to grant TOSIT a copyright license to use my contributions.

[sergkudinov]

Just descovered a few issues:

• change env vars to config from the react state here
• when switching between components on a service page, variables are not correctly changing in the Monaco edditor

Fixing it now

[PaulFarault]

We should add yarn.lock and package-lock.json to the .gitignore until the first release at least.

[sergkudinov]

added lock files to gitignore

[PaulFarault]

Looks promising!! RTK query definitely simplify the code.

If I'm not mistaken, it's missing:

• Authentication
• Remove the need for a NEXT_PUBLIC_TDP_API_URL=http://localhost:8000 variable in the .env file

Do you see anything else to add / do you need some help?

---

Also:

• We may want to refactor it a bit (code is spited between src/scripts/, src/features and src/store.ts). Maybe we could put all Redux related code in a src/store/ directory?
• I'm not sure that we should commit the /src/features/tdpApi.ts file as it is generated. We could generate it programmatically from the schema to ensure that the file is not altered.

[sergkudinov]

@PaulFarault

Authentication

Done

Remove the need for a NEXT_PUBLIC_TDP_API_URL=http://localhost:8000 variable in the .env file

Done

We may want to refactor it a bit (code is spited between src/scripts/, src/features and src/store.ts). Maybe we could put all Redux related code in a src/store/ directory?

Agree, work in progress

I'm not sure that we should commit the /src/features/tdpApi.ts file as it is generated. We could generate it programmatically from the schema to ensure that the file is not altered.

Most likely, I'll check

[PaulFarault]

I've checked previously opened issues. Your PR will:

Fixes #112 Fixes #113 Fixes #114 Fixes #126 Fixes #168 Fixes #173 (current)

@sergkudinov you should add those on your PR description in order to close them automatically after merge.

[sergkudinov]

I'm not sure that we should commit the /src/features/tdpApi.ts file as it is generated. We could generate it programmatically from the schema to ensure that the file is not altered.

I tried the programmatic usage, but it doesn't work for in browser environment. Check this issue.

I think it is doesn't make a big sence commiting the genereated API in src/features/api/tdpApi.ts or not. We have a full control over the schema and it is stored in the same repository. Once it is changed, we regenerate the API and commit both. Git-ignoring it would just make the source code less dependent on instructions in the doc.

If we ignore, I would suggest:

• keeping generate script
• adding postinstall script calling generate

Example:

    ...
    "generate": "npx @rtk-query/codegen-openapi ./scripts/openapi-config.ts",
    "postinstall": "npm run generate"
    ...

[PaulFarault]

I'm not sure to understand the issue but you're right, that's not very important. The solution that you propose using the postinstall script would be enought!

Idk if we could have another opinion but IMO we shouldn't commit the generated output.

[sergkudinov]

Done:

• [x] We may want to refactor it a bit (code is spited between src/scripts/, src/features and src/store.ts). Maybe we could put all Redux related code in a src/store/ directory?
• [x] I'm not sure that we should commit the /src/features/tdpApi.ts file as it is generated.

Working on:

• [x] when switching between components on a service page, variables are not correctly changing in the Monaco edditor

[sergkudinov]

when switching between components on a service page, variables are not correctly changing in the Monaco edditor

Fixed this. However, swithing beteween components is not smooth anymore. Didn't have time to improve it. The was a problem of react rerendering when variables change.

There is now an issue with validating. It is not working as expected. I'll continue next week on fixing it.

[sergkudinov]

However, swithing beteween components is not smooth anymore.

Done

There is now an issue with validating. It is not working as expected.

Done

[sergkudinov]

@PaulFarault review please, it is ready

[PaulFarault]

I'll have a look at it. You still have some conflicts to resolve before merging it to master.

[sergkudinov]

rebased

[PaulFarault]

Seems like you involuntarily "broke" some previous features while rebasing, pagination doesn't seem to work as expected: https://github.com/TOSIT-IO/tdp-ui/pull/185

[sergkudinov]

Seems like you involuntarily "broke" some previous features while rebasing, pagination doesn't seem to work as expected: https://github.com/TOSIT-IO/tdp-ui/pull/185

fixed