refactor: add base path in Operate and Tasklist apps urls #18604

houssain-barouni · 2024-05-16T19:57:58Z

Description

The Camunda single application should serve Zeebe, Operate and Tasklist using one running application.

To dispatch between Operate and Tasklist UIs, we need to add /operate and /tasklist base paths to the URLs respectively used by Operate and Tasklist UIs
For consistency, the same base paths will be used when Operate and Tasklist are run in standalone mode.

requests to /tasklist and /operate are redirected to Tasklist or Operate index file
requests to the root domain are redirect to either /tasklist or /operate depending on the used profile in standalone mode, it defaults to /operate in single application mode.
backend API urls do not change and do not contain the base paths.
old app URLs not containing the base path (example http://localhost:8080/processes) will not be working, the app base path should be provided in the URL (example http://localhost:8080/tasklist/processes)
Tasklist public forms URLs (/new/{bpmnProcessId}do not require the base path and will continue to be working as they are served by a dedicated endpoint in backend.

Related issues

relates to #18535

github-actions · 2024-05-16T20:04:06Z

Operate Test Results

132 files ±0 132 suites ±0 8m 15s ⏱️ +25s
798 tests ±0 793 ✅ - 2 3 💤 ±0 2 ❌ +2
797 runs - 1 792 ✅ - 3 3 💤 ±0 2 ❌ +2

For more details on these failures, see this check.

Results for commit 3b1ed0a. ± Comparison against base commit 01c1855.

♻️ This comment has been updated with latest results.

github-actions · 2024-05-16T20:28:38Z

Tasklist Test Results

143 files ± 0 143 suites ±0 1h 27m 2s ⏱️ - 16m 6s
551 tests + 2 546 ✅ + 2 5 💤 ±0 0 ❌ ±0
517 runs - 30 512 ✅ - 30 5 💤 ±0 0 ❌ ±0

Results for commit d6e6238. ± Comparison against base commit 0283ee6.

This pull request removes 13 and adds 15 tests. Note that renamed tests count towards both.

io.camunda.tasklist.webapp.api.rest.v1.controllers.external.ProcessExternalControllerTest ‑ startProcessWithEmbeddedForm(HttpStatus, String, ProcessEntity, ProcessInstanceDTO)[1] expectedHttpStatus=200 OK, bpmnProcessId=StartProcessByForm, processEntity=TenantAwareTasklistEntity[id='1', tenantId='<default>'], providedProcessInstanceDTO=io.camunda.tasklist.webapp.graphql.entity.ProcessInstanceDTO@9368393b
io.camunda.tasklist.webapp.api.rest.v1.controllers.external.ProcessExternalControllerTest ‑ startProcessWithLinkedForm(HttpStatus, String, ProcessEntity, ProcessInstanceDTO)[1] expectedHttpStatus=200 OK, bpmnProcessId=StartProcessByForm, processEntity=TenantAwareTasklistEntity[id='1', tenantId='<default>'], providedProcessInstanceDTO=io.camunda.tasklist.webapp.graphql.entity.ProcessInstanceDTO@872afa3f
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginAndUsageOfGraphQlApi(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007bafc5317db8@1a300b53
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginAndUsageOfRestApi(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007bafc5317db8@1a300b53
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginFailedWithNoPermissions(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007bafc5317db8@1a300b53
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginFailedWithNoReadPermissions(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007bafc5317db8@1a300b53
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginSucceedWithNoWritePermissions(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007bafc5317db8@1a300b53
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginSuccess(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007bafc5317db8@1a300b53
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLogout(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007bafc5317db8@1a300b53
io.camunda.tasklist.webapp.security.sso.AuthenticationWithPersistentSessionsIT ‑ testLoginFailedWithNoPermissions(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationWithPersistentSessionsIT$$Lambda/0x00007945ad35eb40@586bc8ed
…

io.camunda.tasklist.modules.OnlyArchiverIT ‑ testTasklistIndexControllerIsNotPresent
io.camunda.tasklist.modules.OnlyImportIT ‑ testTasklistIndexControllerIsNotPresent
io.camunda.tasklist.webapp.api.rest.v1.controllers.external.ProcessExternalControllerTest ‑ startProcessWithEmbeddedForm(HttpStatus, String, ProcessEntity, ProcessInstanceDTO)[1] expectedHttpStatus=200 OK, bpmnProcessId=StartProcessByForm, processEntity=TenantAwareTasklistEntity[id='1', tenantId='<default>'], providedProcessInstanceDTO=io.camunda.tasklist.webapp.graphql.entity.ProcessInstanceDTO@bab23d2
io.camunda.tasklist.webapp.api.rest.v1.controllers.external.ProcessExternalControllerTest ‑ startProcessWithLinkedForm(HttpStatus, String, ProcessEntity, ProcessInstanceDTO)[1] expectedHttpStatus=200 OK, bpmnProcessId=StartProcessByForm, processEntity=TenantAwareTasklistEntity[id='1', tenantId='<default>'], providedProcessInstanceDTO=io.camunda.tasklist.webapp.graphql.entity.ProcessInstanceDTO@6186d546
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginAndUsageOfGraphQlApi(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007dff5d331858@52833d4b
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginAndUsageOfRestApi(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007dff5d331858@52833d4b
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginFailedWithNoPermissions(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007dff5d331858@52833d4b
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginFailedWithNoReadPermissions(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007dff5d331858@52833d4b
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginSucceedWithNoWritePermissions(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007dff5d331858@52833d4b
io.camunda.tasklist.webapp.security.sso.AuthenticationIT ‑ testLoginSuccess(BiFunction)[1] orgExtractor=io.camunda.tasklist.webapp.security.sso.AuthenticationIT$$Lambda/0x00007dff5d331858@52833d4b
…

♻️ This comment has been updated with latest results.

github-actions · 2024-05-17T14:30:16Z

Operate Unit Tests Results

299 tests ±0 298 ✅ ±0 6m 28s ⏱️ +28s
45 suites ±0 1 💤 ±0
45 files ±0 0 ❌ ±0

Results for commit d6e6238. ± Comparison against base commit 0283ee6.

♻️ This comment has been updated with latest results.

github-actions · 2024-05-17T14:36:41Z

Operate Integration Tests Results

525 tests 523 ✅ 7m 57s ⏱️
88 suites 2 💤
88 files 0 ❌

Results for commit d6e6238.

♻️ This comment has been updated with latest results.

github-actions · 2024-05-17T19:02:43Z

Operate Opensearch ITs Results

182 tests ±0 182 ✅ ±0 1m 8s ⏱️ +7s
19 suites ±0 0 💤 ±0
19 files ±0 0 ❌ ±0

Results for commit d6e6238. ± Comparison against base commit 0283ee6.

♻️ This comment has been updated with latest results.

tasklist/config/docker-compose.identity.yml

tasklist/client/e2e/pages/TestSetupPage.ts

…cProcessController

houssain-barouni · 2024-06-04T07:35:14Z

For transparency, a discussion with @vsgoulart about public-forms E2E test that always fail the first time on this branch, but always passes on main:

On main branch:

the process is not found in the first hit when /new/{processId} .you can also notice the title is missing
even though the process is not found, the backend returns 200 and forwards to index.html
the reason is that:
- PublicProcessController does not extend ApiErrorController , so all the exceptions are transformed into 500
- we had an ErrorController that catches all 500 responses and forwards to index.html with 200 status
the UI then fetches the form, which can be not found in the first hit, but the UI does retries to fetch the form
this ends-up by working after some retries

On this branch, as the ErrorController was removed, the backend returns 500 when the process is not found

To fix this:

PublicProcessController should extend ApiErrorController so that 404 is returned when process is not found
then we have two options:
- Make the UI handle the 404 returned /new/{processId} , do some retries, and display the error-robot if the process cannot be found
- catch the 404 in backend and returnindex.htmlwith 200 status, the UI will fail to fetch the form if the process does not really exist (as before)

pedesen

@houssain-barouni There is an issue with the local dev environment the Operate FE team is using.

if you run yarn start in operate/client/, Operate provides a hot reload dev environment running at localhost:3000
with your changes /client-config.js can't be retrieved anymore in that dev environment

I think the reason for this is that we use a middleware (see setupProxy.js) to redirect localhost:3000/client-config.js to localhost:8080/client-config.js. But now it needs to be redirected to localhost:8080/operate/client-config.ts

So you would either move client-config.ts or redirect to localhost:8080/operate/client-config.ts

houssain-barouni · 2024-06-04T10:20:03Z

@houssain-barouni There is an issue with the local dev environment the Operate FE team is using.

if you run yarn start in operate/client/, Operate provides a hot reload dev environment running at localhost:3000

with your changes /client-config.js can't be retrieved anymore in that dev environment

I think the reason for this is that we use a middleware (see setupProxy.js) to redirect localhost:3000/client-config.js to localhost:8080/client-config.js. But now it needs to be redirected to localhost:8080/operate/client-config.ts

So you would either move client-config.ts or redirect to localhost:8080/operate/client-config.ts

I added the base path in setupProxy.js , and tested that is working with yarn start
I also added -DskipQaBuild in makefile build commands. QA modules depend on dist so it can fail if /dist contain changes and is not built beforehand. QA modules are not needed anyway to start the application

operate/client/src/setupProxy.js

pedesen

I checked that everything works fine. There is just one change needed in the playwright.config (see my comment there).

pedesen · 2024-06-05T07:52:00Z

operate/client/e2e-playwright/test-fixtures.ts

+      if (baseURL && baseURL.endsWith('/')) {
+        baseURL = baseURL.slice(0, -1);
+      }
+
      // Important: make sure we authenticate in a clean environment by unsetting storage state.
      const page = await browser.newPage({storageState: undefined});
      await page.goto(`${baseURL}/login`);


🔧 Maybe you can utilize URL here instead of manually stripping the trailing slash. This should also remove any double slashes:

new URL('/login', baseURL).toString()

Hi @pedesen
new URL('/login', baseURL).toString() uses absolute path and would return http://localhost:8080/login instead of http://localhost:8080/operate/login
I can use absolute path new URL('/operate/login', baseURL).toString() but that would make the other CIs failing like a11y

For transparency: We discussed to leave it as it is, because it was not possible to use new URL without breaking other things.

operate/client/e2e-playwright/tests/login.spec.ts

operate/client/playwright.config.ts

Co-authored-by: Patrick Dehn <pedesen@users.noreply.github.com>

This reverts commit 7fdc6cb.

github-actions bot added component/zeebe Related to the Zeebe component/team component/operate Related to the Operate component/team component/tasklist Related to the Tasklist component/team labels May 16, 2024

houssain-barouni force-pushed the commom_index_controller branch from 8faadd0 to 23e0642 Compare May 16, 2024 20:04

houssain-barouni force-pushed the commom_index_controller branch 4 times, most recently from 01a7763 to f4e79f3 Compare May 16, 2024 21:21

refactor: create common IndexController for Operate and Tasklist

63a3a56

houssain-barouni force-pushed the commom_index_controller branch from f4e79f3 to 63a3a56 Compare May 16, 2024 21:42

houssain-barouni added 3 commits May 17, 2024 09:39

fix: fix E2E tests

3b1ed0a

refactor: update tasklist Makefile

de91088

refactor: move ForwardErrorController to dist

66db623

Base automatically changed from move_tasklist_application to main May 17, 2024 14:31

houssain-barouni force-pushed the commom_index_controller branch 2 times, most recently from 577b40f to 7907345 Compare May 17, 2024 20:25

fix: fix Tasklist E2E tests

6c94d23

houssain-barouni force-pushed the commom_index_controller branch from 7907345 to 6c94d23 Compare May 18, 2024 19:16

houssain-barouni added 3 commits May 18, 2024 21:20

Merge branch 'main' into commom_index_controller

7703175

ci: update build command

139cd30

Merge branch 'tasklist_properties' into commom_index_controller

0e29c58

houssain-barouni changed the base branch from main to tasklist_properties May 21, 2024 09:18

Base automatically changed from tasklist_properties to main May 21, 2024 12:37

houssain-barouni added 2 commits May 21, 2024 16:18

fix: fix Tasklist integration tests

37114c8

fix: fix public-start-form.spec.ts

84f606e

vsgoulart reviewed May 31, 2024

View reviewed changes

tasklist/config/docker-compose.identity.yml Outdated Show resolved Hide resolved

ralfpuchert approved these changes May 31, 2024

View reviewed changes

houssain-barouni added 2 commits May 31, 2024 14:36

Merge branch 'main' into commom_index_controller

6c8ed9d

build: undo tasklist docker image version change

00c87aa

vsgoulart requested changes May 31, 2024

View reviewed changes

tasklist/client/e2e/pages/TestSetupPage.ts Outdated Show resolved Hide resolved

fix: do not return Server error when process cannot be found in Publi…

e7616f3

…cProcessController

vsgoulart added 2 commits June 4, 2024 11:05

test: Use absolute path on Tasklist E2E tests

9ec027e

refactor: Remove unused property

4efc999

vsgoulart approved these changes Jun 4, 2024

View reviewed changes

pedesen requested changes Jun 4, 2024

View reviewed changes

test: fix Operate yarn start and makefile cmds

032687d

pedesen requested changes Jun 4, 2024

View reviewed changes

operate/client/src/setupProxy.js Outdated Show resolved Hide resolved

test: fix setupProxy

63e69d9

houssain-barouni force-pushed the commom_index_controller branch from b54c353 to 63e69d9 Compare June 4, 2024 11:46

houssain-barouni and others added 2 commits June 4, 2024 15:49

test: add redirection to /operate when FE is served by CRA at 3000

65c5c02

fix: Proxy dev env requests to correct basename

0fd8fd5

pedesen self-requested a review June 5, 2024 09:59

pedesen requested changes Jun 5, 2024

View reviewed changes

houssain-barouni and others added 3 commits June 5, 2024 12:06

ci: Update operate/client/playwright.config.ts

19faf64

Co-authored-by: Patrick Dehn <pedesen@users.noreply.github.com>

refactor: use absolute paths in E2E tests

7fdc6cb

Revert "refactor: use absolute paths in E2E tests"

d6e6238

This reverts commit 7fdc6cb.

pedesen self-requested a review June 5, 2024 14:52

pedesen approved these changes Jun 5, 2024

View reviewed changes

houssain-barouni added this pull request to the merge queue Jun 5, 2024

Merged via the queue into main with commit a7af48f Jun 5, 2024
66 of 67 checks passed

houssain-barouni deleted the commom_index_controller branch June 5, 2024 15:12

leiicamundi mentioned this pull request Jun 13, 2024

silence: Nightly AWS EKS Operational Procedure Test camunda/c8-multi-region#92

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: add base path in Operate and Tasklist apps urls #18604

refactor: add base path in Operate and Tasklist apps urls #18604

houssain-barouni commented May 16, 2024 •

edited

Loading

github-actions bot commented May 16, 2024 •

edited

Loading

github-actions bot commented May 16, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

houssain-barouni commented Jun 4, 2024

pedesen left a comment

houssain-barouni commented Jun 4, 2024 •

edited

Loading

pedesen left a comment

pedesen Jun 5, 2024 •

edited

Loading

houssain-barouni Jun 5, 2024 •

edited

Loading

pedesen Jun 5, 2024

refactor: add base path in Operate and Tasklist apps urls #18604

refactor: add base path in Operate and Tasklist apps urls #18604

Conversation

houssain-barouni commented May 16, 2024 • edited Loading

Description

Related issues

github-actions bot commented May 16, 2024 • edited Loading

Operate Test Results

github-actions bot commented May 16, 2024 • edited Loading

Tasklist Test Results

github-actions bot commented May 17, 2024 • edited Loading

Operate Unit Tests Results

github-actions bot commented May 17, 2024 • edited Loading

Operate Integration Tests Results

github-actions bot commented May 17, 2024 • edited Loading

Operate Opensearch ITs Results

houssain-barouni commented Jun 4, 2024

pedesen left a comment

Choose a reason for hiding this comment

houssain-barouni commented Jun 4, 2024 • edited Loading

pedesen left a comment

Choose a reason for hiding this comment

pedesen Jun 5, 2024 • edited Loading

Choose a reason for hiding this comment

houssain-barouni Jun 5, 2024 • edited Loading

Choose a reason for hiding this comment

pedesen Jun 5, 2024

Choose a reason for hiding this comment

houssain-barouni commented May 16, 2024 •

edited

Loading

github-actions bot commented May 16, 2024 •

edited

Loading

github-actions bot commented May 16, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

github-actions bot commented May 17, 2024 •

edited

Loading

houssain-barouni commented Jun 4, 2024 •

edited

Loading

pedesen Jun 5, 2024 •

edited

Loading

houssain-barouni Jun 5, 2024 •

edited

Loading