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

[NAE-1659] Process URI #78

Merged
merged 30 commits into from
Jul 19, 2022
Merged

[NAE-1659] Process URI #78

merged 30 commits into from
Jul 19, 2022

Conversation

renczesstefan
Copy link
Member

@renczesstefan renczesstefan commented Jun 17, 2022

Description

Implement process identifier as URI and URI system into backend.

Implements NAE-1659

Dependencies

No new dependencies were introduced.

Third party dependencies

No new dependencies were introduced.

Blocking Pull requests

There are no dependencies on other PR.

How Has Been This Tested?

This was tested manually.

Test Configuration

Netgrif Backend PR Config

Name Tested on
OS macOS Monterey 12.2.1
Runtime Java 11
Dependency Manager Maven 3.8.4
Framework version Spring Boot 2.6.2
Run parameters
Other configuration

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes have been checked, personally or remotely, with @mladoniczky
  • I have commented my code, particularly in hard-to-understand areas
  • I have resolved all conflicts with the target branch of the PR
  • I have updated and synced my code with the target branch
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes:
    • Lint test
    • Unit tests
    • Integration tests
  • I have checked my contribution with code analysis tools:
  • I have made corresponding changes to the documentation:
    • Developer documentation
    • User Guides
    • Migration Guides

- changed process identifiers to URI in engine nets
- implemented NavNode and corresponding classes
- changed naming to Uri from Nav
- changed uri of processes in default processes
- changed Java classes
- implemented methods to UriService
- changed method implementation for getOrCreate
- added default URI type
- added mapping to ElasticsearchRunner
- implemented uri for case
- implemented populating relatives
- implemented service methods
- reverted DemoRunner
- implemented UriController
- implemented action
- refactored attribute naming
- added method to ElasticCaseService
@renczesstefan renczesstefan added the improvement A change that improves on an existing feature label Jun 17, 2022
@renczesstefan renczesstefan self-assigned this Jun 17, 2022
- implemented tests
- corrected code according to tests
- corrected according to sonar check
- updated according to Sonar analysis
- started documentation
- wrote documentation
- update comments
- modified level and contentType attribute
- implemented new functions for controller
- implemented new functions default uri
- implemented UriRunner
- modified getRoot function
- modified findByLevel function
- added application property to handle props in UriService
- added base64 decoding of process identifier
- removed @JsonIgnore annotation from taskPair in Case.java
- changed process ids
- changed process ID
- reverted DemoRunner
@timbez timbez mentioned this pull request Jul 14, 2022
18 tasks
 - update identifier to uri of some test processes
 - fix wrong API annotation in UriController
 - fix method inconsistency in UriNodeRepository
@pull-request-quantifier-deprecated

This PR has 658 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +620 -38
Percentile : 88.6%

Total files changed: 45

Change summary by file extension:
.md : +30 -0
.groovy : +96 -7
.java : +472 -10
.properties : +2 -0
.xml : +20 -21

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

machacjozef
machacjozef previously approved these changes Jul 19, 2022
@@ -3,6 +3,7 @@ package com.netgrif.application.engine.startup
import com.netgrif.application.engine.elastic.domain.ElasticCaseRepository
import com.netgrif.application.engine.elastic.domain.ElasticTaskRepository
import com.netgrif.application.engine.elastic.service.interfaces.IElasticCaseService
import com.netgrif.application.engine.petrinet.domain.PetriNet
Copy link
Contributor

Choose a reason for hiding this comment

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

?

@@ -30,6 +31,9 @@ class ElasticsearchRunner extends AbstractOrderedCommandLineRunner {
@Value('${spring.data.elasticsearch.index.task}')
private String taskIndex

@Value('${spring.data.elasticsearch.index.uri}')
private String uriIndex
Copy link
Contributor

Choose a reason for hiding this comment

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

feedback about property injection via a class was given in person. Commenting just to point out where to make the changes

@@ -25,6 +25,9 @@ public class ElasticsearchConfiguration {
@Value("${spring.data.elasticsearch.index.task}")
private String taskIndex;

@Value("${spring.data.elasticsearch.index.uri}")
private String uriIndex;
Copy link
Contributor

Choose a reason for hiding this comment

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

@@ -29,10 +28,16 @@
@Document
public class PetriNet extends PetriNetObject {


/*TODO: change on UriNode Move action*/
Copy link
Contributor

Choose a reason for hiding this comment

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

is this TODO future work, or must it yet be resolved in this task?


public boolean containsNet() {
return contentTypes.contains(UriContentType.PROCESS);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

how does the DEFAULT UriContentType work?

Copy link
Member

Choose a reason for hiding this comment

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

DEFAULT UriContentType is reserved for the root node. It will be removed in the future planned refactor.

@@ -10,6 +10,7 @@ spring.data.mongodb.drop=true
spring.data.elasticsearch.drop=true
spring.data.elasticsearch.index.case=${DATABASE_NAME:nae}_dev_case
spring.data.elasticsearch.index.task=${DATABASE_NAME:nae}_dev_task
spring.data.elasticsearch.index.uri=${DATABASE_NAME:nae}_dev_nav
Copy link
Contributor

Choose a reason for hiding this comment

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

why is the index called _nav when it stores uris?

<!-- TRANSITIONS -->
<transition>
<id>1</id>
<x>379</x>
<y>273</y>
<label>Task - editable</label>
<assignPolicy>auto</assignPolicy>
<usersRef>
Copy link
Contributor

Choose a reason for hiding this comment

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

why were these userRefs removed?

Copy link
Member

Choose a reason for hiding this comment

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

For faster testing.

@@ -1,5 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<document xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:noNamespaceSchemaLocation='https://petriflow.com/petriflow.schema.xsd'>
<id>leukemia/leu</id>
Copy link
Contributor

Choose a reason for hiding this comment

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

why does an english version of this net exist when it could be internationalised in one process?

Copy link
Member

Choose a reason for hiding this comment

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

The process is for testing purposes only. The original purpose of 'en version' is not known to me.

@ExtendWith(SpringExtension.class)
class UriServiceTest {

private static final String uriSeparator = "/"
Copy link
Contributor

Choose a reason for hiding this comment

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

the constant from the service should be used instead in my oppinion

@Test
void moveTest() {
UriNode uriNode = uriService.move(testUri1, destination)
assert uriNode.uriPath == destination + uriSeparator + uriNode.name
Copy link
Contributor

Choose a reason for hiding this comment

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

parent nodes should be checked as well to see if they point to new child correctly

- Disabled test
uriNode.setParentId(null);
}
uriNode.addContentType(UriContentType.DEFAULT);
uriNode = uriNodeRepository.save(uriNode);
Copy link
Member

Choose a reason for hiding this comment

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

UP :)
}

Copy link
Member

Choose a reason for hiding this comment

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

🤔

add(WebMvcLinkBuilder.linkTo(WebMvcLinkBuilder.methodOn(UriController.class)
.getByLevel(0)).withSelfRel());
add(WebMvcLinkBuilder.linkTo(WebMvcLinkBuilder.methodOn(UriController.class)
.getByParent(null)).withSelfRel());
Copy link
Member

Choose a reason for hiding this comment

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

withSelfRel only one

@ApiResponses(value = {
@ApiResponse(code = 200, message = "OK", response = UriNodeResource.class),
})
@RequestMapping(value = "/root", method = GET, produces = MediaTypes.HAL_JSON_VALUE)
Copy link
Member

Choose a reason for hiding this comment

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

 - implemented comments from PR
 - fix uri move method
@sonarcloud
Copy link

sonarcloud bot commented Jul 19, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

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

52.4% 52.4% Coverage
0.0% 0.0% Duplication

@tuplle tuplle merged commit b2bd0e0 into release/6.2.0 Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Extra Large improvement A change that improves on an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants