[NAE-1945] External resource loader #246

Kovy95 · 2024-02-22T14:46:44Z

Description

implementing our own resource loader for files from directory reources/ in root

Implements NAE-1945

Dependencies

none

Third party dependencies

No new dependencies were introduced

Blocking Pull requests

There are no dependencies on other PR

How Has Been This Tested?

manually

Test Configuration

Name	Tested on
OS	LinuxMint 20
Runtime	Java 11
Dependency Manager	Maven 3.8.4
Framework version	SpringBoot 2.6.2
Run parameters
Other configuration

Checklist:

- implementing our own resource loader for files from directory reources/ in root

pull-request-quantifier-deprecated · 2024-02-22T14:47:12Z

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

Quantification details

Label      : Small
Size       : +77 -0
Percentile : 30.8%

Total files changed: 4

Change summary by file extension:
.md : +24 -0
.java : +53 -0

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 detected.
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.

tuplle · 2024-03-19T08:15:42Z

docs/resources/resources_loading.md

+# Resource Loading
+
+If you want to load resources, which will not be in JAR(for example big files), you can use our resource loader.
+ResourceLoader return InputStreamResource, from which you can use InputStream, and loading resources from directory **resource/** in root of the project.


The resource directory is in set up working directory of the app. If you run a jar it can be configured per environment.

tuplle · 2024-03-19T08:37:54Z

src/main/java/com/netgrif/application/engine/resource/domain/NetgrifResource.java

+import java.io.IOException;
+import java.io.InputStream;
+
+public class NetgrifResource {


Rename class to ExternalResource

tuplle · 2024-03-19T08:39:44Z

src/main/java/com/netgrif/application/engine/resource/domain/NetgrifResourceLoader.java

+import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
+
+public class NetgrifResourceLoader implements ResourceLoader {


Rename class to ExternalResourceLoader

tuplle · 2024-03-19T08:40:17Z

src/main/java/com/netgrif/application/engine/resource/domain/NetgrifResourceLoader.java

+
+public class NetgrifResourceLoader implements ResourceLoader {
+
+    public static final String RESOURCE_PREFIX = "resource://";


As a resource is not a protocol the double slash is not necessary.

tuplle · 2024-03-19T08:41:53Z

src/main/java/com/netgrif/application/engine/resource/domain/NetgrifResourceLoader.java

+
+public class NetgrifResourceLoader implements ResourceLoader {
+
+    public static final String RESOURCE_PREFIX = "resource://";


Add control for multiple prefixes to recognise a NAE external resource:

resource:

nae:

nae-resource:

nr:

tuplle · 2024-03-19T09:28:42Z

src/main/java/com/netgrif/application/engine/resource/domain/NetgrifResourceLoader.java

+        if(location.startsWith(RESOURCE_PREFIX)) {
+            String path = location.substring(RESOURCE_PREFIX.length());
+            NetgrifResource resource = new NetgrifResource();
+            return resource.getResource("resources/" + path);


extract path prefix as a constant

...ain/java/com/netgrif/application/engine/resource/service/NetgrifResourceLoaderProcessor.java

- changes according to PR

pull-request-quantifier-deprecated · 2024-03-20T12:22:19Z

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

Quantification details

Label      : Small
Size       : +91 -0
Percentile : 36.4%

Total files changed: 4

Change summary by file extension:
.md : +24 -0
.java : +67 -0

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 detected.
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.

renczesstefan · 2024-05-21T11:47:39Z

...in/java/com/netgrif/application/engine/resource/service/ExternalResourceLoaderProcessor.java

+
+    @Override
+    public Resource resolve(String location, ResourceLoader resourceLoader) {
+        if(location.startsWith(ExternalResourceLoader.RESOURCE_PREFIX) ||


For better readability, may export this long if condition to a function.

minop · 2024-05-21T12:21:58Z

docs/resources/resources_loading.md

+
+If you want to load resources, which will not be in JAR(for example big files), you can use our resource loader.
+ResourceLoader return InputStreamResource, from which you can use InputStream, and loading resources from directory **resource/**  inworking directory of the app.
+The prefix for NetgrifResourceLoaser is 


If you want to load resources, which are not included in the JAR (for example large files), you can use the resource loader.
ResourceLoader returns an InputStreamResource. You can turn it into an InputStream and load resources from the resource/ directory in the working directory of the app.

minop · 2024-05-22T10:45:50Z

src/main/java/com/netgrif/application/engine/resource/domain/ExternalResourceLoader.java

+    private Resource substringAndGetResource(String location, String prefix) {
+        String path = location.substring(prefix.length());
+        ExternalResource resource = new ExternalResource();
+        return resource.getResource(StringUtils.chop(prefix)+ "/" + path);


shouldn't "/" be File.pathSeparator instead?

- refactor of prefix detection of external resource

[NAE-1945] External resource loader

44a8d33

- implementing our own resource loader for files from directory reources/ in root

Kovy95 added new feature A change that introduces new functionality Small labels Feb 22, 2024

Kovy95 requested review from tuplle, renczesstefan, machacjozef and mazarijuraj February 22, 2024 14:46

Kovy95 self-assigned this Feb 22, 2024

tuplle previously approved these changes Mar 19, 2024

View reviewed changes

[NAE-1945] External resource loader

2270dac

- changes according to PR

Kovy95 dismissed tuplle’s stale review via 2270dac March 20, 2024 12:22

Kovy95 requested a review from tuplle March 20, 2024 12:23

renczesstefan approved these changes May 21, 2024

View reviewed changes

renczesstefan previously approved these changes May 21, 2024

View reviewed changes

minop reviewed May 22, 2024

View reviewed changes

[NAE-1945] External resource loader

a55d5d8

- refactor of prefix detection of external resource

tuplle dismissed renczesstefan’s stale review via a55d5d8 May 29, 2024 13:13

[NAE-1945] External resource loader

5d347ee

- refactor of prefix detection of external resource

renczesstefan approved these changes Jul 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NAE-1945] External resource loader #246

[NAE-1945] External resource loader #246

Kovy95 commented Feb 22, 2024 •

edited by jira bot

Loading

pull-request-quantifier-deprecated bot commented Feb 22, 2024

What can I do to optimize my changes

How to interpret the change counts in git diff output

tuplle Mar 19, 2024

Kovy95 Mar 20, 2024

tuplle Mar 19, 2024

Kovy95 Mar 20, 2024

tuplle Mar 19, 2024

Kovy95 Mar 20, 2024

tuplle Mar 19, 2024

Kovy95 Mar 20, 2024

tuplle Mar 19, 2024

Kovy95 Mar 20, 2024

tuplle Mar 19, 2024

Kovy95 Mar 20, 2024

pull-request-quantifier-deprecated bot commented Mar 20, 2024

What can I do to optimize my changes

How to interpret the change counts in git diff output

renczesstefan May 21, 2024

tuplle May 29, 2024

minop May 21, 2024

tuplle May 29, 2024

minop May 22, 2024

tuplle May 29, 2024


		public class NetgrifResourceLoader implements ResourceLoader {

		public static final String RESOURCE_PREFIX = "resource://";

[NAE-1945] External resource loader #246

Are you sure you want to change the base?

[NAE-1945] External resource loader #246

Conversation

Kovy95 commented Feb 22, 2024 • edited by jira bot Loading

Description

Dependencies

Third party dependencies

Blocking Pull requests

How Has Been This Tested?

Test Configuration

Checklist:

pull-request-quantifier-deprecated bot commented Feb 22, 2024

What can I do to optimize my changes

How to interpret the change counts in git diff output

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pull-request-quantifier-deprecated bot commented Mar 20, 2024

What can I do to optimize my changes

How to interpret the change counts in git diff output

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kovy95 commented Feb 22, 2024 •

edited by jira bot

Loading