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.

Sign up for GitHub

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

Jump to bottom

9725 rename and improve interfaces #9779

Merged
merged 5 commits into from
Jul 13, 2022
Merged

9725 rename and improve interfaces #9779

merged 5 commits into from
Jul 13, 2022

Conversation

pihme
Copy link
Contributor

@pihme pihme commented Jul 13, 2022

Description

  • Renames interfaces to make it clearer that there could be multiple RecordProcessor implementations
  • Define interfaces for ProcessingResultBuilder and ProcessingResult

Related issues

related to #9725

Definition of Done

Code changes:

  • The changes are backwards compatibility with previous versions
  • If it fixes a bug then PRs are created to backport the fix to the last two minor versions. You can trigger a backport by assigning labels (e.g. backport stable/1.3) to the PR, in case that fails you need to create backports manually.

Testing:

  • There are unit/integration tests that verify all acceptance criterias of the issue
  • New tests are written to ensure backwards compatibility with further versions
  • The behavior is tested manually
  • The change has been verified by a QA run
  • The impact of the changes is verified by a benchmark

Documentation:

  • The documentation is updated (e.g. BPMN reference, configuration, examples, get-started guides, etc.)
  • New content is added to the release announcement
  • If the PR changes how BPMN processes are validated (e.g. support new BPMN element) then the Camunda modeling team should be informed to adjust the BPMN linting.

Please refer to our review guidelines.

@pihme
refactor(engine): move interface to engine
b48baf2 
Only the engine needs this interface at the moment
@pihme
refactor(engine): Rename interface
552e828 
To avoid naming conflicts with future renamings
@pihme
refactor(engine): Rename interfaces
11da6fc 
Rename Engine to RecordProcessor, because there will be multiple implementations of this interface
Rename EngineContext to RecordProcessorContext to have consistent naming
Rename EngineImpl to Engine
@pihme
doc(engine): add javadocs
b02d3e6
@pihme
refactor(engine): extend interfaces
50b6189 
Add methods to ProcessingResultBuilder to add records, a client response and follow up tasks,
Add methods to ProcessingResult to serialize its content to LogStream and Command writers, and to execute post commit tasks
@pihme pihme requested a review from deepthidevaki July 13, 2022 07:17
@github-actions
Copy link
Contributor

Unit Test Results

   791 files  ±  0     791 suites  ±0   1h 38m 30s ⏱️ - 6m 13s
5 999 tests  - 38  5 992 ✔️  - 38  7 💤 ±0  0 ❌ ±0 
6 168 runs   - 38  6 161 ✔️  - 38  7 💤 ±0  0 ❌ ±0 

Results for commit 50b6189. ± Comparison against base commit 8b5c14a.

@pihme pihme changed the title 9725 rename and improve interfces 9725 rename and improve interfaces Jul 13, 2022
deepthidevaki
deepthidevaki approved these changes Jul 13, 2022
View reviewed changes
Copy link
Contributor

@deepthidevaki deepthidevaki left a comment

Choose a reason for hiding this comment

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

🚀 Thanks @pihme

@pihme
Copy link
Contributor Author

pihme commented Jul 13, 2022

bors merge

@zeebe-bors-camunda
Copy link
Contributor

Build succeeded:

@zeebe-bors-camunda zeebe-bors-camunda bot merged commit b005273 into main Jul 13, 2022
@zeebe-bors-camunda zeebe-bors-camunda bot deleted the 9725-rename-and-improve-interfces branch July 13, 2022 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthidevaki deepthidevaki deepthidevaki approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@pihme @deepthidevaki