Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KOGITO-9561: Jobs service kafka and http messaging modularization #1805

Merged
merged 2 commits into from
Jul 24, 2023

Conversation

wmedvede
Copy link
Contributor

Many thanks for submitting your Pull Request ❤️!

Please make sure that your PR meets the following requirements:

  • You have read the contributors guide
  • Pull Request title is properly formatted: KOGITO-XYZ Subject
  • [X ] Pull Request title contains the target branch if not targeting main: [0.9.x] KOGITO-XYZ Subject
  • Pull Request contains link to the JIRA issue
  • Pull Request contains link to any dependent or related Pull Request
  • Pull Request contains description of the issue
  • Pull Request does not include fixes for issues other than the main ticket
How to replicate CI configuration locally?

Build Chain tool does "simple" maven build(s), the builds are just Maven commands, but because the repositories relates and depends on each other and any change in API or class method could affect several of those repositories there is a need to use build-chain tool to handle cross repository builds and be sure that we always use latest version of the code for each repository.

build-chain tool is a build tool which can be used on command line locally or in Github Actions workflow(s), in case you need to change multiple repositories and send multiple dependent pull requests related with a change you can easily reproduce the same build by executing it on Github hosted environment or locally in your development environment. See local execution details to get more information about it.

How to retest this PR or trigger a specific build:
  • for pull request checks
    Please add comment: Jenkins retest this

  • for a specific pull request check
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] tests

  • for quarkus branch checks
    Run checks against Quarkus current used branch
    Please add comment: Jenkins run quarkus-branch

  • for a quarkus branch specific check
    Run checks against Quarkus current used branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] quarkus-branch

  • for quarkus main checks
    Run checks against Quarkus main branch
    Please add comment: Jenkins run quarkus-main

  • for a specific quarkus main check
    Run checks against Quarkus main branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] quarkus-main

  • for quarkus lts checks
    Run checks against Quarkus lts branch
    Please add comment: Jenkins run quarkus-lts

  • for a specific quarkus lts check
    Run checks against Quarkus lts branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] quarkus-lts

  • for native checks
    Run native checks
    Please add comment: Jenkins run native

  • for a specific native check
    Run native checks
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] native

  • for native lts checks
    Run native checks against quarkus lts branch
    Please add comment: Jenkins run native-lts

  • for a specific native lts check
    Run native checks against quarkus lts branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] native-lts

How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-7.67.x to backport the original PR to the 7.67.x branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

Quarkus-3 PR check is failing ... what to do ? The Quarkus 3 check is applying patches from the `.ci/environments/quarkus-3/patches`.

The first patch, called 0001_before_sh.patch, is generated from Openrewrite .ci/environments/quarkus-3/quarkus3.yml recipe. The patch is created to speed up the check. But it may be that some changes in the PR broke this patch.
No panic, there is an easy way to regenerate it. You just need to comment on the PR:

jenkins rewrite quarkus-3

and it should, after some minutes (~20/30min) apply a commit on the PR with the patch regenerated.

Other patches were generated manually. If any of it fails, you will need to manually update it... and push your changes.

@kie-ci3
Copy link
Contributor

kie-ci3 commented Jul 15, 2023

(tests) - kogito-apps job #1222 was: UNSTABLE
Possible explanation: This should be test failures

Reproducer

export BUILD_MVN_OPTS_CURRENT=-Dvalidate-formatting -Prun-code-coverage
build-chain build cross_pr -f 'https://raw.githubusercontent.com/kiegroup/kogito-pipelines/main/.ci/pull-request-config.yaml' -o 'bc' -p kiegroup/kogito-apps -u https://github.com/kiegroup/kogito-apps/pull/1805 --skipParallelCheckout

NOTE: To install the build-chain tool, please refer to https://github.com/kiegroup/github-action-build-chain#local-execution

Please look here: https://eng-jenkins-csb-business-automation.apps.ocp-c1.prod.psi.redhat.com/job/KIE/job/kogito/job/main/job/pullrequest/job/kogito-apps.tests.kogito-apps/1222/display/redirect

Test results:

  • PASSED: 2767
  • FAILED: 5

Those are the test failures:

Build projects / org.kie.kogito.it.jobs.CallbackStateTimeoutsIT.callbackStateTimeoutsExceeded java.util.concurrent.CompletionException: java.lang.RuntimeException: Unable to start Quarkus test resource class org.kie.kogito.test.resources.JobServiceCompositeQuarkusTestResource
Build projects / org.kie.kogito.it.jobs.MultipleTimerInstancesIT.boundaryTimerEvent java.util.concurrent.CompletionException: java.lang.RuntimeException: Unable to start Quarkus test resource class org.kie.kogito.test.resources.JobServiceCompositeQuarkusTestResource
Build projects / org.kie.kogito.it.jobs.ProcessAsyncIT.testAsync java.util.concurrent.CompletionException: java.lang.RuntimeException: Unable to start Quarkus test resource class org.kie.kogito.test.resources.JobServiceCompositeQuarkusTestResource
Build projects / org.kie.kogito.it.jobs.ProcessTimerIT.testDeleteTimerCycle java.util.concurrent.CompletionException: java.lang.RuntimeException: Unable to start Quarkus test resource class org.kie.kogito.test.resources.JobServiceCompositeQuarkusTestResource
Build projects / org.kie.kogito.it.jobs.SwitchStateTimeoutsIT.switchStateEventConditionTimeoutsTransitionTimeoutsExceeded java.util.concurrent.CompletionException: java.lang.RuntimeException: Unable to start Quarkus test resource class org.kie.kogito.test.resources.JobServiceCompositeQuarkusTestResource

Copy link
Contributor

@tiagodolphine tiagodolphine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I left some comments but my concern is with the profiles and profile name changes, like events-support changing this is a breaking change, mainly with probably BDD tests, operator, etc where we were injecting this profile. 🤔

kogito.jobs-service.http.job-status-change-events=false

# Job status change events are automatically enabled with the profile: http-events-support (-Dquarkus.profile=http-events-support)
%http-events-support.kogito.jobs-service.http.job-status-change-events=true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we really need the profile? I mean can't we just set the config property kogito.jobs-service.http.job-status-change-events to enable it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, we can remove. It was added to have let's say some degree of consistency with the kafka-events-support profile. But not being used too much.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it also remind us to keep consistency with the data-index, that now has the kafka-events-support and http-events-support profiles.

# This file contains the default configurations for Kafka.

# Kafka global default configurations.
%kafka-events-support.kafka.bootstrap.servers=localhost:9092
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just thinking but can't we just get rid of the profile? I think is is needed to disable during runtime right?
We can use an application properties with a suffix for the profile just to make it cleaner, https://quarkus.io/guides/config-reference#profile-aware-files

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I know this possibility of having the profile-aware-files, and in fact, it's something we use in the examples.
But, for the server modules, honestly I don't like this profile-aware-file approach, and is not aligned with data-index, etc.
I think this is ok, also now, if you look with the refactoring the configurations starts to look much clearer, etc.

@wmedvede
Copy link
Contributor Author

wmedvede commented Jul 19, 2023

LGTM, I left some comments but my concern is with the profiles and profile name changes, like events-support changing this is a breaking change, mainly with probably BDD tests, operator, etc where we were injecting this profile. thinking

This is a good point, the thing is, now we have the http based events and the kafka based events.
So, the question is, do we keep this adhered to the past, or we do something for moving forward?
Is it good to have the world "kafka" when you are configuring kafka?
I think that yes, but yeah, It's something to evaluate.

By doing a quick inspection, I'll re-review tomorrow, I believe that the potential change is not too big.
I mean, kogito-apps and kogito-runtime integration tests, etc, are working well.
Then, we have the "operator", "the image" and the "documentaion", I need to double check, but IDK if the "operator" uses this value, because for tuning of the eventing API, (when we introduced kafka events to create jobs, they added a config map in the deployment produced by the "operator" to let people add whatever config they want, and IDK if the "operator" is doing too much with this "events-support" value. Need to check.

"image" : a potential change I think is not too much.

"documentation": to change the old kogito documentation is a couple of lines.

    - keep the events-support profile for backward compatibility
# This file contains the default configurations for Kafka.

# Kafka global default configurations.
%events-support,kafka-events-support.kafka.bootstrap.servers=localhost:9092
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tiagodolphine , See here, I think we can keep the events-support for backward compatibility, that will work the same as the kafka-events-support, but, in the SW documentation we talk about kafka-events-support.

wdyt?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice I didn't know that it is possible to declare more than one profile to a property
👍

@sonarcloud
Copy link

sonarcloud bot commented Jul 21, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

75.8% 75.8% Coverage
0.0% 0.0% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@wmedvede wmedvede merged commit 2b8f52f into apache:main Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants