[ME]: Add coverage field (toggle) #983

Angi-Kinas · 2024-09-02T14:28:21Z

Description

This PR introduces an addition to the spatial extent field which is the coverage field. This field can be toggled between predefined values (as Keywords). For now we have "national" and "regional" as options.
When a value is selected, the corresponding Keyword will be added to the list of Keywords in the record.

Note

Update: No need to add the thesauri. Having the keywords in the fields config should be enough.
I'm not sure if this is testable without me changing the dump, or manually adding the two new thesauri in geonetwork.
The urls for them are:
https://inspire.ec.europa.eu/metadata-codelist/SpatialScope/regional
https://inspire.ec.europa.eu/metadata-codelist/SpatialScope/national

And for adding them in geonetwork you need to provide the url to the RDF/XML:
national: RDF/XML
regional: RDF/XML

Screenshots

Quality Assurance Checklist

Commit history is devoid of any merge commits and readable to facilitate reviews
If new logic ⚙️ is introduced: unit tests were added
If new user stories 🤏 are introduced: E2E tests were added
If new UI components 🕹️ are introduced: corresponding stories in Storybook were created
If breaking changes 🪚 are introduced: add the breaking change label
If bugs 🐞 are fixed: add the backport <release branch> label
The documentation website 📚 has received the love it deserves

github-actions · 2024-09-02T14:29:35Z

Affected libs: feature-editor, ui-inputs, feature-dataviz, feature-record, feature-router, feature-search, feature-map, ui-elements, feature-notifications, feature-catalog, ui-catalog, ui-search, ui-layout,
Affected apps: metadata-editor, datafeeder, demo, metadata-converter, datahub, webcomponents, search, map-viewer,

🚀 Build and deploy storybook and demo on GitHub Pages
📦 Build and push affected docker images

github-actions · 2024-09-02T14:34:20Z

📷 Screenshots are here!

coveralls · 2024-09-02T14:39:03Z

coverage: 81.448% (-0.3%) from 81.781%
when pulling 29da5ca on ME-coverage-record-field
into 6f312e6 on main.

tkohr

Thanks @Angi-Kinas ! I've left some suggestions. The logic seems to work fine. I was not able to save a metadata record yet, but this is likely an issue on my side.

tkohr · 2024-09-03T14:23:17Z

...record-form/form-field/form-field-spatial-extent/form-field-spatial-extent.component.spec.ts

+    url: new URL(
+      'http://localhost:8080/geonetwork/srv/api/registries/vocabularies/external.place.national.en'
+    ),
+    type: 'place',


Shouldn't this be of type theme?

tkohr · 2024-09-03T14:23:27Z

...record-form/form-field/form-field-spatial-extent/form-field-spatial-extent.component.spec.ts

+    })
+    describe('#onSpatialScopeChange', () => {
+      it('removes all existing spatial scope keywords and add the selected one', async () => {
+        const spatialScopes = [{ label: 'national' }, { label: 'regional' }]


Aren't the labels expected to be uppercase?

tkohr · 2024-09-03T14:23:37Z

...ents/record-form/form-field/form-field-spatial-extent/form-field-spatial-extent.component.ts

@@ -98,12 +108,32 @@ export class FormFieldSpatialExtentComponent {
    shareReplay(1)
  )

+  switchToggleOptions$: Observable<SwitchToggleOption[]>


I'm wondering if we could add a pipe on allKeywords$ here directly, so we wouldn't even need the ngOnInit with a subscription...

Yes that makes more sense! Thanks for the suggestion. It was not easy for me to assign the switchToggleOptions$ initially based on the keywords, but now I have a solution that works. Maybe you can have another look?

Nice, it looks good to me. If you move the switchToggleOptions$ behind the allKeywords$ you could even reuse the latter and only need one map like:

switchToggleOptions$: Observable<SwitchToggleOption[]> = this.allKeywords$.pipe( map((keywords) => ...

tkohr · 2024-09-03T14:23:43Z

...ents/record-form/form-field/form-field-spatial-extent/form-field-spatial-extent.component.ts

  constructor(
    private platformService: PlatformServiceInterface,
    private editorFacade: EditorFacade,
    private translateService: TranslateService
  ) {}

+  ngOnInit(): void {
+    this.editorFacade.record$.subscribe((data) => {


If we subscribe here we should also unsubscribe in the ngOnDestroy I think, but maybe we can even get rid of the ngOnInit entirely. WDYT?

tkohr · 2024-09-03T14:23:48Z

libs/ui/inputs/src/lib/switch-toggle/switch-toggle.component.ts

@@ -10,7 +10,7 @@ import { MatButtonToggleModule } from '@angular/material/button-toggle'

 export type SwitchToggleOption = {
  label: string
-  value: string
+  value: any


Is there a way we could still type this?

I removed it completely since it will be of different value for each component that will use the SwitchToggleComponent. And it is also not used anymore inside the component. WDYT?

tkohr

Thanks for the adaption @Angi-Kinas. I was also able to retest it on my side and it works fine. I just see that there are some conflicts to be resolved before merging.

to use the label as identifier for the selected value. Make value of type any to allow for flexibility in the value type (e.g. Keyword)

as Keywords for the spatial scope / coverage

field which adds/removes a Keyword that can be specified in the config file. For now it is a toggle between "national" or "regional"

for spatial scope in form-field-spatial-extent component

component as it can be of any type and is not necessary. chore(editor): Update spatial extent form field to not use ngOnit and subscribe funtionalities and assign options directly to the Observable, adapt tests accordingly.

tkohr reviewed Sep 3, 2024

View reviewed changes

tkohr approved these changes Sep 5, 2024

View reviewed changes

Angi-Kinas added 8 commits September 9, 2024 08:56

chore(ui-inputs): change switch toggle component

0fbf748

to use the label as identifier for the selected value. Make value of type any to allow for flexibility in the value type (e.g. Keyword)

feat(editor-config): Add configurable values

6f83425

as Keywords for the spatial scope / coverage

feat(editor): add spatial scope to spatial extent

5cf9f68

field which adds/removes a Keyword that can be specified in the config file. For now it is a toggle between "national" or "regional"

chore(form-field-spatial-extent): add unit tests

0637dc7

for spatial scope in form-field-spatial-extent component

chore(e2e): Add e2e for spatial scope

5dc5579

chore(fields): Update keywords in config

8c9b037

feat(ui-inputs): Remove value from switch-toggle

e5d2cbe

component as it can be of any type and is not necessary. chore(editor): Update spatial extent form field to not use ngOnit and subscribe funtionalities and assign options directly to the Observable, adapt tests accordingly.

chore(spatial-extent): Simplify Observable

29da5ca

Angi-Kinas force-pushed the ME-coverage-record-field branch from cd2bdf6 to 29da5ca Compare September 9, 2024 06:59

Angi-Kinas merged commit 8b395cf into main Sep 9, 2024
14 checks passed

Angi-Kinas deleted the ME-coverage-record-field branch September 9, 2024 07:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ME]: Add coverage field (toggle) #983

[ME]: Add coverage field (toggle) #983

Angi-Kinas commented Sep 2, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

coveralls commented Sep 2, 2024 •

edited

Loading

tkohr left a comment

tkohr Sep 3, 2024

tkohr Sep 3, 2024

tkohr Sep 3, 2024

Angi-Kinas Sep 4, 2024

tkohr Sep 5, 2024

tkohr Sep 3, 2024

tkohr Sep 3, 2024

Angi-Kinas Sep 4, 2024

tkohr left a comment

[ME]: Add coverage field (toggle) #983

[ME]: Add coverage field (toggle) #983

Conversation

Angi-Kinas commented Sep 2, 2024 • edited Loading

Description

Note

Screenshots

Quality Assurance Checklist

github-actions bot commented Sep 2, 2024 • edited Loading

github-actions bot commented Sep 2, 2024 • edited Loading

coveralls commented Sep 2, 2024 • edited Loading

tkohr left a 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

tkohr left a comment

Choose a reason for hiding this comment

Angi-Kinas commented Sep 2, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

github-actions bot commented Sep 2, 2024 •

edited

Loading

coveralls commented Sep 2, 2024 •

edited

Loading