[Datahub] Feature catalog - Load attributes description from a linked record if present

conf/default.toml

@@ -48,7 +48,7 @@ proxy_path = ""
 [theme]
 primary_color = "#c82850"
 secondary_color = "#001638"
-main_color = "#555" # All-purpose text color
+main_color = "#555"          # All-purpose text color
 background_color = "#fdfbff"
 
 # These optional parameters indicate which background should be used for the main header and the text color used

libs/api/metadata-converter/src/lib/gn4/gn4.converter.spec.ts

@@ -1006,6 +1006,30 @@ describe('Gn4Converter', () => {
         })
       })
 
+      describe('feature catalog (fcats)', () => {
+        it('sets the featureCatalogIdentifier from the fcats', async () => {
+          const record = await service.readRecord({
+            ...hit,
+            _source: {
+              ...hit._source,
+              related: {
+                fcats: [
+                  {
+                    _source: {
+                      uuid: 'related-metadata-with-fcats',
+                    },
+                  },
+                ],
+              },
+            },
+          })
+
+          expect(record.featureCatalogIdentifier).toEqual(
+            'related-metadata-with-fcats'
+          )
+        })
+      })
+
       describe('full record', () => {
         it('builds a complete record object', async () => {
           const record = await service.readRecord(
@@ -2363,6 +2387,7 @@ describe('Gn4Converter', () => {
               isPublishedToAll: true,
               id: '53583',
               favoriteCount: 0,
+              featureTypes: [],
               catalogUuid: 'metawal.wallonie.be',
               edit: true,
             },
@@ -2642,6 +2667,7 @@ describe('Gn4Converter', () => {
             extras: {
               catalogUuid: 'metawal.wallonie.be',
               favoriteCount: 0,
+              featureTypes: [],
               id: '1215',
               isOpenData: false,
               isPublishedToAll: true,

libs/api/metadata-converter/src/lib/gn4/gn4.field.mapper.ts

@@ -277,6 +277,32 @@ export class Gn4FieldMapper {
         },
         output
       ),
+    featureTypes: (output, source) =>
+      this.addExtra(
+        {
+          featureTypes: selectField(source, 'featureTypes'),
+        },
+        output
+      ),
+    related: (output, source) => {
+      const fcatSource = selectField(
+        getFirstValue(
+          selectField(
+            <SourceWithUnknownProps>selectField(source, 'related'),
+            'fcats'
+          )
+        ),
+        '_source'
+      )
+      const featureCatalogIdentifier = selectField(
+        <SourceWithUnknownProps>fcatSource,
+        'uuid'
+      )
+      return {
+        ...output,
+        ...(featureCatalogIdentifier && { featureCatalogIdentifier }),
+      } as CatalogRecord
+    },
     isPublishedToAll: (output, source) =>
       this.addExtra(
         {

libs/api/metadata-converter/src/lib/gn4/types/metadata.model.ts

@@ -203,3 +203,7 @@ export interface Gn4Record {
   guestdownload?: boolean
   selected?: boolean
 }
+
+export interface Gn4RecordRelated {
+  fcats?: Gn4Record[]
+}

libs/api/repository/src/lib/gn4/gn4-repository.spec.ts

@@ -18,9 +18,13 @@ import {
   datasetRecordsFixture,
   simpleDatasetRecordAsXmlFixture,
   simpleDatasetRecordFixture,
+  simpleDatasetRecordWithFcatsFixture,
   duplicateDatasetRecordAsXmlFixture,
 } from '@geonetwork-ui/common/fixtures'
-import { CatalogRecord } from '@geonetwork-ui/common/domain/model/record'
+import {
+  CatalogRecord,
+  DatasetFeatureCatalog,
+} from '@geonetwork-ui/common/domain/model/record'
 import { map } from 'rxjs/operators'
 import { HttpErrorResponse } from '@angular/common/http'
 import {
@@ -53,7 +57,7 @@ class ElasticsearchServiceMock {
 }
 
 class SearchApiServiceMock {
-  search = jest.fn((bucket, relatedType, payload) => {
+  search(bucket, relatedType, payload) {
     const body = JSON.parse(payload)
     const count = body.size || 1234
     const result: EsSearchResponse = {
@@ -70,16 +74,16 @@ class SearchApiServiceMock {
       }
     }
     return of(result)
-  })
+  }
 }
 
 class RecordsApiServiceMock {
   getRecordAs = jest.fn((uuid) =>
     of(`<gmd:MD_Metadata>
-  <gmd:fileIdentifier>
-    <gco:CharacterString>${uuid}</gco:CharacterString>
-  </gmd:fileIdentifier>
-</gmd:MD_Metadata>`).pipe(map((xml) => ({ body: xml })))
+      <gmd:fileIdentifier>
+        <gco:CharacterString>${uuid}</gco:CharacterString>
+      </gmd:fileIdentifier>
+    </gmd:MD_Metadata>`).pipe(map((xml) => ({ body: xml })))
   )
   insert = jest.fn(() =>
     of({
@@ -253,6 +257,97 @@ describe('Gn4Repository', () => {
       })
     })
   })
+
+  describe('getFeatureCatalog', () => {
+    let catalog: DatasetFeatureCatalog
+    let metadata: CatalogRecord
+    const spySearch = jest.spyOn(SearchApiServiceMock.prototype, 'search')
+
+    describe('when extras feature catalog is defined ', () => {
+      beforeEach(async () => {
+        jest.clearAllMocks()
+        metadata = datasetRecordsFixture()[0]
+        catalog = await lastValueFrom(repository.getFeatureCatalog(metadata))
+      })
+
+      it('should not call the feature catalog API (extras contain the answer) ', () => {
+        expect(spySearch).not.toHaveBeenCalled()
+      })
+
+      it('returns the feature catalog with mapped features', () => {
+        expect(catalog).toEqual({
+          attributes: [
+            { name: 'OBJECTID', title: 'Object identifier' },
+            { name: 'Nom', title: 'Nom de la rue' },
+            { name: 'Rue', title: '' },
+          ],
+        })
+      })
+    })
+    describe('when feature catalog exists, no extras defined', () => {
+      beforeEach(async () => {
+        metadata = simpleDatasetRecordWithFcatsFixture()
+        spySearch.mockReturnValue(
+          of({ hits: { hits: datasetRecordsFixture(), total: { value: 0 } } })
+        )
+        catalog = await lastValueFrom(repository.getFeatureCatalog(metadata))
+      })
+
+      afterEach(() => {
+        spySearch.mockRestore()
+      })
+
+      it('calls the API with correct parameters', () => {
+        expect(spySearch).toHaveBeenCalledWith(
+          'bucket',
+          ['fcats'],
+          '{"uuids":["feature-catalog-identifier"]}'
+        )
+      })
+
+      it('returns the attributes coming from the linked feature catalog', () => {
+        expect(catalog).toEqual({
+          attributes: [
+            { name: 'OBJECTID', title: 'Object identifier' },
+            { name: 'Nom', title: 'Nom de la rue' },
+            { name: 'Rue', title: '' },
+          ],
+        })
+      })
+
+      it('prevent looping', async () => {
+        metadata = {
+          ...simpleDatasetRecordWithFcatsFixture(),
+          ...{ featureCatalogIdentifier: 'my-dataset-with-fcats' },
+        }
+        spySearch.mockReturnValue(
+          of({
+            hits: {
+              hits: metadata,
+              total: { value: 0 },
+            },
+          })
+        )
+        repository.getRecord = jest.fn().mockReturnValue(of(metadata))
+        catalog = await lastValueFrom(repository.getFeatureCatalog(metadata))
+        expect(catalog).toEqual(null)
+      })
+    })
+
+    describe('when feature catalog does not exist, nor in extras', () => {
+      beforeEach(async () => {
+        metadata = {
+          ...simpleDatasetRecordFixture(),
+          extras: {},
+        }
+        catalog = await lastValueFrom(repository.getFeatureCatalog(metadata))
+      })
+      it('returns null', () => {
+        expect(catalog).toEqual(null)
+      })
+    })
+  })
+
   describe('getSimilarRecords', () => {
     let results: CatalogRecord[]
     beforeEach(async () => {

libs/api/repository/src/lib/gn4/gn4-repository.ts

@@ -12,7 +12,10 @@ import {
   Iso19139Converter,
 } from '@geonetwork-ui/api/metadata-converter'
 import { PublicationVersionError } from '@geonetwork-ui/common/domain/model/error'
-import { CatalogRecord } from '@geonetwork-ui/common/domain/model/record'
+import {
+  CatalogRecord,
+  DatasetFeatureCatalog,
+} from '@geonetwork-ui/common/domain/model/record'
 import {
   Aggregations,
   AggregationsParams,
@@ -27,6 +30,7 @@ import { RecordsRepositoryInterface } from '@geonetwork-ui/common/domain/reposit
 import {
   RecordsApiService,
   SearchApiService,
+  FeatureResponseApiModel,
 } from '@geonetwork-ui/data-access/gn4'
 import {
   combineLatest,
@@ -124,7 +128,7 @@ export class Gn4Repository implements RecordsRepositoryInterface {
     return this.gn4SearchApi
       .search(
         'bucket',
-        null,
+        ['fcats'],
         JSON.stringify(
           this.gn4SearchHelper.getMetadataByIdPayload(uniqueIdentifier)
         )
@@ -137,6 +141,39 @@ export class Gn4Repository implements RecordsRepositoryInterface {
       )
   }
 
+  getFeatureCatalog(
+    record: CatalogRecord,
+    visited: Set<string> = new Set() // prevent looping
+  ): Observable<DatasetFeatureCatalog | null> {
+    if (
+      record.extras &&
+      record.extras['featureTypes'] &&
+      record.extras['featureTypes'][0]?.attributeTable &&
+      Array.isArray(record.extras['featureTypes'][0].attributeTable)
+    ) {
+      return of({
+        attributes: record.extras['featureTypes'][0]?.attributeTable?.map(
+          (attr) => ({
+            name: attr.name,
+            title: attr.definition,
+          })
+        ),
+      } as DatasetFeatureCatalog)
+    }
+
+    const featureCatalogIdentifier = record.featureCatalogIdentifier
+    if (featureCatalogIdentifier && !visited.has(featureCatalogIdentifier)) {
+      visited.add(featureCatalogIdentifier)
+      return this.getRecord(featureCatalogIdentifier).pipe(
+        switchMap((record) =>
+          record ? this.getFeatureCatalog(record, visited) : of(null)
+        )
+      )
+    }
+
+    return of(null)
+  }
+
   getSimilarRecords(similarTo: CatalogRecord): Observable<CatalogRecord[]> {
     return this.gn4SearchApi
       .search(

libs/common/domain/src/lib/model/record/metadata.model.ts

@@ -124,6 +124,7 @@ export interface BaseRecord {
   extras?: Record<string, unknown>
   landingPage?: URL
   updateFrequency?: UpdateFrequency
+  featureCatalogIdentifier?: string
 
   // information related to the resource (dataset, service)
   resourceIdentifier?: string
@@ -226,7 +227,9 @@ export interface DatasetRecord extends BaseRecord {
   temporalExtents: Array<DatasetTemporalExtent>
   spatialRepresentation?: SpatialRepresentationType
 }
-
+export type DatasetFeatureCatalog = {
+  attributes: Array<{ name: string; title: string }>
+}
 export interface ServiceEndpoint {
   endpointUrl: URL
   protocol: string
@@ -260,7 +263,7 @@ export type OnlineResource = DatasetOnlineResource | ServiceOnlineResource
 
 export type CatalogRecord = DatasetRecord | ReuseRecord | ServiceRecord
 
-export type CatalogRecordKeys =
-  | keyof DatasetRecord
-  | keyof ReuseRecord
-  | keyof ServiceRecord
+export type CatalogRecordKeys = Exclude<
+  keyof DatasetRecord | keyof ReuseRecord | keyof ServiceRecord,
+  'featureCatalogIdentifier'
+>

libs/common/domain/src/lib/repository/records-repository.interface.ts

@@ -6,12 +6,15 @@ import {
   SearchParams,
   SearchResults,
 } from '../model/search'
-import { CatalogRecord } from '../model/record'
+import { CatalogRecord, DatasetFeatureCatalog } from '../model/record'
 
 export abstract class RecordsRepositoryInterface {
   abstract search(params: SearchParams): Observable<SearchResults>
   abstract getMatchesCount(filters: FieldFilters): Observable<number>
   abstract getRecord(uniqueIdentifier: string): Observable<CatalogRecord | null>
+  abstract getFeatureCatalog(
+    record: CatalogRecord
+  ): Observable<DatasetFeatureCatalog | null>
   abstract aggregate(params: AggregationsParams): Observable<Aggregations>
   abstract getSimilarRecords(
     similarTo: CatalogRecord