NO-ISSUE: Make examples better reflect their domain and contain more focused code #2726

tiagobento · 2024-11-05T21:56:51Z

In this PR I'm improving almost all examples to have a more descriptive README and package name. I also split the huge webapp example to make our builds faster, separating the serverless-workflow-editor-on-webapp example be built as part of partition1.txt.

In this PR:

Split examples/webapp into several different examples, to make our builds faster and to have the examples have less boilerplate code, allowing users to focus on the content that matters for each individual component usage inside webapps:
- examples/bpmn-editor-classic-on-webapp
- examples/dmn-editor-classic-on-webapp
- examples/dmn-editor-on-webapp
- examples/dmn-editor-standalone-on-webapp
- examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp
- examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp
- examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp
- examples/serverless-workflow-editor-standalone-on-webapp
Renamed examples/commit-message-validation-service to examples/kie-sandbox-commit-message-validation-service
Renamed examples/jbpm-compact-architecture-example to examples/process-compact-architecture
Renamed example/drools-process-usertasks-quarkus-example to examples/process-user-tasks-subsystem
Prefixed examples/ping-pong* and examples/todo-list* packages with micro-frontends-multiplying-architecture, to make it clear that those examples are related to Multiplying Architecture. The "Micro-frontends" part is to not have them be confused with Compact Architecture, which is a completely unrelated term used to signify the embedding of Data-Index, Jobs Service, and Data-Audit on Process applications.
Revisited the READMEs of all examples
Added a very short README to the packages and examples folder.

I know this is quite a lot, but there's not much difference in content. I recommend checking out this branch and looking at each of the changed examples individually, they're all quite small and simple, so shouldn't be a big effort to do it.

jomarko · 2024-11-14T06:09:38Z

kie-tools-examples-micro-frontends-multiplying-architecture-base64png-editor-vscode-extension

is not consistent in naming:

kie-tools-examples-micro-frontends-multiplying-architecture-base64png-editor-vscode-extension
vs @kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-vscode-extension,

this is also incompatible with the build command [1] KIE_TOOLS_BUILD__buildExamples=true pnpm -F @kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-vscode-extension^... build:dev

Probably also build:prod command should contain -F part.

🔴 build command [1] failed

│ > copyfiles -u 1 "src/**/*.{sass,scss,css}" dist/
└─ Running...
packages/vscode-extension build:dev$ rimraf dist && tsc -p tsconfig.json
│ src/workspace/VsCodeResourceContentServiceForWorkspaces.ts(33,27): error TS2307: Cannot find module 'isomorphic-git' or its corresponding type declarations.
│ src/workspace/VsCodeResourceContentServiceForWorkspaces.ts(81,10): error TS7006: Parameter 'p' implicitly has an 'any' type.
└─ Failed in 9.5s at /home/jomarko/kie-tools/packages/vscode-extension
/home/jomarko/kie-tools/packages/vscode-extension:
 ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL  @kie-tools-core/[email protected] build:dev: `rimraf dist && tsc -p tsconfig.json`
Exit status 2

jomarko · 2024-11-14T06:15:03Z

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view

No manual checks done, README looks fine.

jomarko · 2024-11-14T06:16:22Z

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-angular

No manual checks done. From README it is not clear to me how to start the example.

jomarko · 2024-11-14T06:17:35Z

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-react

same as above ^

jomarko · 2024-11-14T06:22:23Z

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp

Start command in readme could include -F part.

jomarko · 2024-11-14T06:25:57Z

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view

No checks done, no comments to code.

jomarko · 2024-11-14T06:35:45Z

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp

Readme start command could include -F part probably

jomarko · 2024-11-14T06:38:50Z

kie-tools-examples-micro-frontends-multuplying-architecture-todo-list-view-vscode-extension

Similar issues as base64png vscode extension package

│ [run-script-if] Finished 'pnpm build'
└─ Done in 9s
packages/editor build:dev$ rimraf dist && pnpm copy:css && tsc -p tsconfig.json
│ > @kie-tools-core/[email protected] copy:css /home/jomarko/kie-tools/packages/editor
│ > copyfiles -u 1 "src/**/*.{sass,scss,css}" dist/
└─ Done in 9.2s
packages/vscode-extension build:dev$ rimraf dist && tsc -p tsconfig.json
│ src/workspace/VsCodeResourceContentServiceForWorkspaces.ts(33,27): error TS2307: Cannot find module 'isomorphic-git' or its corresponding type declarations.
│ src/workspace/VsCodeResourceContentServiceForWorkspaces.ts(81,10): error TS7006: Parameter 'p' implicitly has an 'any' type.
└─ Failed in 6.1s at /home/jomarko/kie-tools/packages/vscode-extension
/home/jomarko/kie-tools/packages/vscode-extension:
 ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL  @kie-tools-core/[email protected] build:dev: `rimraf dist && tsc -p tsconfig.json`
Exit status 2

jomarko · 2024-11-14T07:25:06Z

[edited]

@kie-tools-examples/process-compact-architecture

🟠 I am not able to use startContainers script and follow readme steps, until I build the example with KOGITO_RUNTIME_version as 999-SNAPSHOT, otherwise user will get the error below when starting a process instance.

nator.beforeCompletion - failed for SynchronizationImple< 0:ffffac120005:a927:6735b50d:190, org.hibernate.resource.transaction.backend.jta.internal.synchronization.RegisteredSynchronization@1fcaee53 >: org.hibernate.exception.SQLGrammarException: could not execute statement [ERROR: column "recipient" is of type jsonb but expression is of type bytea
process-compact-architecture-service  |   Hint: You will need to rewrite or cast the expression.
process-compact-architecture-service  |   Position: 221] [insert into job_details (correlation_id,created,execution_counter,execution_timeout,execution_timeout_unit,fire_time,last_update,priority,recipient,retries,scheduled_id,status,trigger,id) values (?,?,?,?,?,?,?,?,?,?,?,?,?,?)]
process-compact-architecture-service  |         at org.hibernate.exception.internal.SQLStateConversionDelegate.convert(SQLStateConversionDelegate.java:91)
process-compact-architecture-service  |         at org.hibernate.exception.internal.StandardSQLExceptionConverter.convert(StandardSQLExceptionConverter.java:58)
process-compact-architecture-service  |         at org.hibernate.engine.jdbc.spi.SqlExceptionHelper.convert(SqlExceptionHelper.java:108)
process-compact-architecture-service  |         at org.hibernate.engine.jdbc.internal.ResultSetReturnImpl.executeUpdate(ResultSetReturnImpl.java:197)
process-compact-architecture-service  |         at org.hibernate.engine.jdbc.mutation.internal.AbstractMutationExecutor.performNonBatchedMutation(AbstractMutationExecutor.java:108)
process-compact-architecture-service  |         at org.hibernate.engine.jdbc.mutation.internal.MutationExecutorSingleNonBatched.performNonBatchedOperations(MutationExecutorSingleNonBatched.java:40)
process-compact-architecture-service  |         at org.hibernate.engine.jdbc.mutation.internal.AbstractMutationExecutor.execute(AbstractMutationExecutor.java:52)
process-compact-architecture-service  |         at org.hibernate.persister.entity.mutation.InsertCoordinator.doStaticInserts(InsertCoordinator.java:175)
process-compact-architecture-service  |         at org.hibernate.persister.entity.mutation.InsertCoordinator.coordinateInsert(InsertCoordinator.java:113)
process-compact-architecture-service  |         at org.hibernate.persister.entity.AbstractEntityPersister.insert(AbstractEntityPersister.java:2863)
process-compact-architecture-service  |         at org.hibernate.action.internal.EntityInsertAction.execute(EntityInsertAction.java:104)
process-compact-architecture-service  |         at org.hibernate.engine.spi.ActionQueue.executeActions(ActionQueue.java:632)
process-compact-architecture-service  |         at org.hibernate.engine.spi.ActionQueue.executeActions(ActionQueue.java:499)
process-compact-architecture-service  |         at org.hibernate.event.internal.AbstractFlushingEventListener.performExecutions(AbstractFlushingEventListener.java:363)
process-compact-architecture-service  |         at org.hibernate.event.internal.DefaultFlushEventListener.onFlush(DefaultFlushEventListener.java:41)```

We should mention `docker compose down` as prerequisite, I think.

**mvn clean package quarkus:dev** seems to work fine 🟢

jomarko · 2024-11-14T07:29:19Z

@kie-tools-examples/process-user-tasks-subsystem

🔴 there is a compilation error

[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR : 
[INFO] -------------------------------------------------------------
[ERROR] /home/jomarko/kie-tools/examples/process-user-tasks-subsystem/src/test/java/org/acme/travels/quarkus/ApprovalsProcessTest.java:[28,48] package org.jbpm.process.instance.impl.humantask does not exist
[ERROR] /home/jomarko/kie-tools/examples/process-user-tasks-subsystem/src/test/java/org/acme/travels/quarkus/ApprovalsProcessTest.java:[29,55] package org.jbpm.process.instance.impl.humantask.phases does not exist
[ERROR] /home/jomarko/kie-tools/examples/process-user-tasks-subsystem/src/test/java/org/acme/travels/quarkus/ApprovalsProcessTest.java:[30,47] package org.jbpm.process.instance.impl.workitem does not exist

jomarko · 2024-11-14T07:54:00Z

@kie-tools-examples/serverless-workflow-editor-standalone-on-webapp

Manual check passed, start command could maybe include -F part.

jomarko · 2024-11-14T08:05:27Z

@kie-tools-examples/sonataflow-greeting

No comments

jomarko · 2024-11-14T08:23:48Z

@kie-tools-examples/uniforms-patternfly

Readme could contain at least information how to build and start the example.

jomarko

Feedback shared via one comment per package. Thank you @tiagobento

tiagobento · 2024-11-20T23:21:26Z

General comments:

All commands in READMEs assume you're in the example's folder.
Bootstrapping the repo with pnpm bootstrap is always necessary.

@kie-tools-examples/dmn-editor-classic-on-webapp

✅ Fixed

@kie-tools-examples/dmn-editor-on-webapp

✅ Fixed

@kie-tools-examples/dmn-editor-on-webapp

✅ Fixed

@kie-tools-examples/dmn-editor-standalone-on-webapp

🟡 Updated the port. Will investigate the failures.

@kie-tools-examples/kie-sandbox-commit-message-validation-service

✅ There are no build instructions necessary here.. Simply "pnpm start" suffices.

@kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor

✅ True. This is not runnable. Mentioned in the README.

@kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-chrome-extension

✅ There are some in this repo! :) Or you can use the Base64 Editor VS Code Extension to create some based on PNG files.

@kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp

✅ Nothing done.

kie-tools-examples-micro-frontends-multiplying-architecture-base64png-editor-vscode-extension

✅ Not having the scope (@kie-tools) part in the name of the package is a requirement from the VS Code Marketplace. Fixed the build command. Build failed for you because you didn't bootstrap first, I guess?

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view

✅ OK

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-angular

✅ This is not runnable. I made it clear on the README now.

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-react

✅ Same as above.

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp

✅ OK

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view

🟡 Not sure I understand your feedback here...

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp

✅ OK

kie-tools-examples-micro-frontends-multuplying-architecture-todo-list-view-vscode-extension

✅ Please see the other VS Code extension example's comment from my end as they apply here too.

@kie-tools-examples/process-compact-architecture

✅ True... this is expected, and we need to upgrade the Kogito version of the repo. I'll do it soon in a separate PR.

@kie-tools-examples/process-user-tasks-subsystem

🟡 Weird... Will investigate. Thanks!

@kie-tools-examples/serverless-workflow-editor-standalone-on-webapp

✅ OK

@kie-tools-examples/sonataflow-greeting

✅ Out of scope of this PR.

@kie-tools-examples/uniforms-patternfly

✅ Out of scope of this PR.

tiagobento · 2024-12-07T00:44:19Z

@kie-tools-examples/process-user-tasks-subsystem

✅ Removed the test... The example compiles normally now. We currently don't have tests for our examples, but I guess if we want that, we need a new "examples-tests" top-level directory to host them.

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view

✅ As we discussed, this is ok.

@kie-tools-examples/dmn-editor-standalone-on-webapp

✅ Took me a while to read the comment, but I finally did:

// The paths are important here! Since path2/loan-pre-qualification.dmn is in a
// different parent path than the main content (path1/can-drive.dmn), it won't be availabe
// to be used as an included model.

I added a comment to the specific line pointing to the main comment:

["path2/loan-pre-qualification.dmn", { contentType: "text", content: loadFile("loan-pre-qualification.dmn") }], // Won't be available! Read comment above.

Hope it's in good shape now @jomarko. Thanks!

examples/micro-frontends-multiplying-architecture-todo-list-view-vscode-extension/README.md

.rat-excludes

jomarko

thank you @tiagobento , two very minor comments before approval

tiagobento · 2024-12-09T14:39:12Z

@jomarko Thanks! Comments addressed in bb960bd.

tiagobento added 28 commits November 3, 2024 20:27

.

08cbc0d

..

9ac1e4b

..

c5353ce

..

cdb1d20

..

0ba6171

..

842335e

..

92603c2

..

bd1458e

..

9bc4931

..

d489b46

..

1abbd61

..

55cb065

..

5e69084

..

e76d098

..

870a369

..

497f232

..

1de5729

..

dbc9205

..

2720b22

..

5f765f1

..

097ab4a

..

ae2496f

..

59d43de

..

87fd696

..

31a2f9d

..

cec0dbc

..

779fd4b

..

67e2e94

tiagobento requested review from porcelli and pefernan November 5, 2024 21:56

jomarko reviewed Nov 14, 2024

View reviewed changes

tiagobento added 5 commits November 20, 2024 18:23

PR review

71a1d57

Merge remote-tracking branch 'origin/main' into rename-examples

6c130ed

Fix license headers

4e22f5a

Oops

5d4645a

Final adjustments.

c174e23

jomarko reviewed Dec 9, 2024

View reviewed changes

examples/micro-frontends-multiplying-architecture-todo-list-view-vscode-extension/README.md Outdated Show resolved Hide resolved

jomarko reviewed Dec 9, 2024

View reviewed changes

.rat-excludes Outdated Show resolved Hide resolved

jomarko reviewed Dec 9, 2024

View reviewed changes

PR review

bb960bd

jomarko approved these changes Dec 9, 2024

View reviewed changes

ljmotta approved these changes Dec 11, 2024

View reviewed changes

ljmotta merged commit c681c8c into apache:main Dec 11, 2024
15 checks passed

ljmotta mentioned this pull request Dec 12, 2024

[NO-ISSUE] Adding some new dmn examples #2805

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NO-ISSUE: Make examples better reflect their domain and contain more focused code #2726

NO-ISSUE: Make examples better reflect their domain and contain more focused code #2726

tiagobento commented Nov 5, 2024 •

edited

Loading

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024 •

edited

Loading

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko commented Nov 14, 2024

jomarko left a comment

tiagobento commented Nov 20, 2024 •

edited

Loading

tiagobento commented Dec 7, 2024

jomarko left a comment

tiagobento commented Dec 9, 2024

NO-ISSUE: Make examples better reflect their domain and contain more focused code #2726

NO-ISSUE: Make examples better reflect their domain and contain more focused code #2726

Conversation

tiagobento commented Nov 5, 2024 • edited Loading

jomarko commented Nov 14, 2024

kie-tools-examples-micro-frontends-multiplying-architecture-base64png-editor-vscode-extension

jomarko commented Nov 14, 2024

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view

jomarko commented Nov 14, 2024

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-angular

jomarko commented Nov 14, 2024

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-react

jomarko commented Nov 14, 2024

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp

jomarko commented Nov 14, 2024

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view

jomarko commented Nov 14, 2024

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp

jomarko commented Nov 14, 2024

kie-tools-examples-micro-frontends-multuplying-architecture-todo-list-view-vscode-extension

jomarko commented Nov 14, 2024 • edited Loading

@kie-tools-examples/process-compact-architecture

jomarko commented Nov 14, 2024

@kie-tools-examples/process-user-tasks-subsystem

jomarko commented Nov 14, 2024

@kie-tools-examples/serverless-workflow-editor-standalone-on-webapp

jomarko commented Nov 14, 2024

@kie-tools-examples/sonataflow-greeting

jomarko commented Nov 14, 2024

@kie-tools-examples/uniforms-patternfly

jomarko left a comment

Choose a reason for hiding this comment

tiagobento commented Nov 20, 2024 • edited Loading

@kie-tools-examples/dmn-editor-classic-on-webapp

@kie-tools-examples/dmn-editor-on-webapp

@kie-tools-examples/dmn-editor-on-webapp

@kie-tools-examples/dmn-editor-standalone-on-webapp

@kie-tools-examples/kie-sandbox-commit-message-validation-service

@kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor

@kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-chrome-extension

@kie-tools-examples/micro-frontends-multiplying-architecture-base64png-editor-on-webapp

kie-tools-examples-micro-frontends-multiplying-architecture-base64png-editor-vscode-extension

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-angular

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-view-in-react

@kie-tools-examples/micro-frontends-multiplying-architecture-ping-pong-views-on-webapp

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view-on-webapp

kie-tools-examples-micro-frontends-multuplying-architecture-todo-list-view-vscode-extension

@kie-tools-examples/process-compact-architecture

@kie-tools-examples/process-user-tasks-subsystem

@kie-tools-examples/serverless-workflow-editor-standalone-on-webapp

@kie-tools-examples/sonataflow-greeting

@kie-tools-examples/uniforms-patternfly

tiagobento commented Dec 7, 2024

@kie-tools-examples/process-user-tasks-subsystem

@kie-tools-examples/micro-frontends-multiplying-architecture-todo-list-view

@kie-tools-examples/dmn-editor-standalone-on-webapp

jomarko left a comment

Choose a reason for hiding this comment

tiagobento commented Dec 9, 2024

tiagobento commented Nov 5, 2024 •

edited

Loading

jomarko commented Nov 14, 2024 •

edited

Loading

tiagobento commented Nov 20, 2024 •

edited

Loading