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

Use caching for Discovery Finder requests for performance reasons #225

Closed
6 tasks
jzbmw opened this issue Oct 25, 2023 · 5 comments
Closed
6 tasks

Use caching for Discovery Finder requests for performance reasons #225

jzbmw opened this issue Oct 25, 2023 · 5 comments
Assignees
@ds-jhartmann @ds-psosnowski
Labels
dependencies Pull requests that update a dependency file hardening measurements to increase resiliency linked_to_feature Issue is linked to a feature

Comments

@jzbmw
Copy link
Contributor

jzbmw commented Oct 25, 2023 •
edited by mkanal
Loading

As Developers
I want
so that

Hints / Details

  • link to Thomas Henn

Outcome / Acceptance Criteria

Outcome

  • ...

Acceptance Criteria

  • Responses of Discovery Finder Service is cached
  • Cache uses ttl for cached responses
  • Default TTL is 1 day
  • TTL could be configured via IRS config (App Configuration + Helm Charts)
  • Admin manual covers required information about cache and cache settings
  • ARC42 is extended

Out of Scope

  • ...
@jzbmw jzbmw added dependencies Pull requests that update a dependency file hardening measurements to increase resiliency labels Oct 25, 2023
@jzbmw jzbmw mentioned this issue Oct 26, 2023
Open
@mkanal mkanal changed the title Define a default ttl for Caching data from dependent services Use Caching for Discovery Finder requests for performance reasons Nov 22, 2023
@mkanal mkanal changed the title Use Caching for Discovery Finder requests for performance reasons Use caching for Discovery Finder requests for performance reasons Nov 22, 2023
@mkanal
Copy link
Contributor

mkanal commented Nov 22, 2023

@jzbmw Please let us develop a User Story on friday

@ds-jhartmann
Copy link
Contributor

Planning 2

@ds-psosnowski
Copy link
Contributor

Also PR's from previous step of this caching may be helpful (see @ds-jhartmann comment above)
https://github.com/catenax-ng/tx-item-relationship-service/pull/623/files
https://github.com/catenax-ng/tx-item-relationship-service/pull/636/files
https://github.com/catenax-ng/tx-item-relationship-service/pull/656/files

@dsmf dsmf self-assigned this Nov 30, 2023
@dsmf
Copy link
Contributor

dsmf commented Dec 8, 2023 •
edited
Loading

Outcome:

  • provider method for DiscoveryFinderClient has been added to RegistryConfiguration to enable the use of Spring annotations in DiscoveryFinderClient
  • DiscoveryFinderClientImpl.findDiscoveryEndpoints Cache is introduced
  • TTL can be configured via IRS config (App Configuration + Helm Charts)...
  • ... defaults to 1 day
  • ... and TTL is applied to cache
  • Caching and eviction is covered by org/eclipse/tractusx/irs/DiscoveryFinderClientTest.java
  • Admin manual covers required information about cache and cache settings
  • Documentation concerning configuration corrected in the Administration Guide (include lines from values.yaml adjusted)
  • ARC42 documentation describes the caching from Use caching for Discovery Finder requests for performance reasons #225 and from Increases the performance of EDC Discovery Service requests #210

@dsmf dsmf mentioned this issue Dec 9, 2023
Merged
@dsmf dsmf assigned ds-jhartmann and ds-psosnowski and unassigned dsmf Dec 9, 2023
@dsmf
Copy link
Contributor

dsmf commented Dec 12, 2023 •
edited
Loading

Hi @ds-jhartmann, as discussed I updated the ARC42 documentation. Could you have a look at it, please? See catenax-ng@52efb9e

This was referenced Dec 12, 2023
Closed
Merged
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Introduce bean provider method for DiscoveryFinderC…
68c3429 
…lient in order to be able to apply caching annotations later
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Cache DiscoveryFinderClientImpl#findDiscoveryEndpoi…
681ca37 
…nts calls
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Add test for caching DiscoveryFinderClientImpl#find…
0f83990 
…DiscoveryEndpoints calls
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Improve test for caching DiscoveryFinderClientImpl#…
131bc8b 
…findDiscoveryEndpoints calls

- harden asserts
- prefer constants over duplicated literals
- improve structure and naming
- remove superfluous assertion descriptions
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Configuration and documentation for discoveryFinder…
82038db 
…Client.cacheTTL
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Improve cache eviction test via Awaitility instead …
b10598a 
…of calling method directly in the test
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Fix PMD warning UnnecessaryAnnotationValueElement
c57c2e9
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Update CHANGELOG.md
44f4519
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Fix merge conflict
b88eed4 
Merge remote-tracking branch 'origin/feat(impl)/225-Use-caching-for-Discovery-Finder-requests' into feat(impl)/225-Use-caching-for-Discovery-Finder-requests

# Conflicts:
#	CHANGELOG.md
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Increase unit test coverage
8a467e1
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Increase unit test coverage
cdb3499
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Update CHANGELOG.md according to suggestion from re…
1c8a2ce 
…view
ds-jhartmann pushed a commit that referenced this issue Dec 13, 2023
@dsmf
feat(impl):[#225] Add section about caching to ARC42 documentation
52efb9e
ds-jhartmann added a commit that referenced this issue Dec 13, 2023
@dsmf @ds-jhartmann
feat(impl):[#225]: apply suggestion from peer review
0566c2b 
Co-authored-by: Jaro Hartmann <57985712+ds-jhartmann@users.noreply.github.com>
ds-jhartmann added a commit that referenced this issue Dec 13, 2023
@dsmf @ds-jhartmann
feat(impl):[#225]: apply suggestion from peer review
e551e63 
Co-authored-by: Jaro Hartmann <57985712+ds-jhartmann@users.noreply.github.com>
ds-jhartmann added a commit that referenced this issue Dec 13, 2023
@dsmf @ds-jhartmann
feat(impl):[#225]: apply suggestion from peer review
d8bfde4 
Co-authored-by: Jaro Hartmann <57985712+ds-jhartmann@users.noreply.github.com>
@jzbmw jzbmw closed this as completed Dec 22, 2023
@mkanal mkanal added the linked_to_feature Issue is linked to a feature label Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ds-jhartmann ds-jhartmann

@ds-psosnowski ds-psosnowski

Labels
dependencies Pull requests that update a dependency file hardening measurements to increase resiliency linked_to_feature Issue is linked to a feature
Projects
IRS
Status: done
Milestone
No milestone
Development

No branches or pull requests
5 participants
@dsmf @jzbmw @ds-jhartmann @mkanal @ds-psosnowski