Push property localization down to getValues instead of part of parsing the property values.

Author: cbeer

__tests__/src/selectors/manifests.test.js

@@ -59,12 +59,6 @@ describe('getManifestoInstance', () => {
     const received = getManifestoInstance(state, { manifestId: 'x' });
     expect(received.id).toEqual('http://iiif.io/api/presentation/2.1/example/fixtures/19/manifest.json');
   });
-  it('is cached based off of input props', () => {
-    const state = { manifests: { x: { json: manifestFixture019 } } };
-    const received = getManifestoInstance(state, { manifestId: 'x' });
-    expect(getManifestoInstance(state, { manifestId: 'x' })).toBe(received);
-    expect(getManifestoInstance(state, { manifestId: 'x', windowId: 'y' })).not.toBe(received);
-  });
 });
 
 describe('getManifestLogo()', () => {

src/state/selectors/canvases.js

@@ -6,6 +6,7 @@ import { miradorSlice } from './utils';
 import { getWindow } from './getters';
 import { getSequence } from './sequences';
 import { getWindowViewType } from './windows';
+import { getManifestLocale } from './manifests';
 
 /**
  * Returns the info response.
@@ -183,10 +184,10 @@ export const getPreviousCanvasGrouping = createSelector(
  * @returns {string|number}
  */
 export const getCanvasLabel = createSelector(
-  [getCanvas],
-  canvas => (canvas && (
+  [getCanvas, getManifestLocale],
+  (canvas, locale) => (canvas && (
     canvas.getLabel().length > 0
-      ? canvas.getLabel().getValue()
+      ? canvas.getLabel().getValue(locale)
       : String(canvas.index + 1)
   )),
 );

src/state/selectors/manifests.js

@@ -1,5 +1,4 @@
 import { createSelector } from 'reselect';
-import { createCachedSelector } from 're-reselect';
 import { PropertyValue, Utils, Resource } from 'manifesto.js';
 import getThumbnail from '../../lib/ThumbnailFactory';
 import asArray from '../../lib/asArray';
@@ -24,9 +23,10 @@ export const getLocale = createSelector(
   [
     getCompanionWindowLocale,
     getConfig,
+    (state, { locale }) => locale,
   ],
-  (companionWindowLocale, config = {}) => (
-    companionWindowLocale || config.language
+  (companionWindowLocale, config = {}, locale) => (
+    locale || companionWindowLocale || config.language || config.fallbackLanguages
   ),
 );
 
@@ -57,17 +57,9 @@ export const getManifestError = createSelector(
 );
 
 /** Instantiate a manifesto instance */
-const getContextualManifestoInstance = createCachedSelector(
+const getContextualManifestoInstance = createSelector(
   getManifest,
-  getLocale,
-  (manifest, locale) => manifest
-    && createManifestoInstance(manifest.json, locale),
-)(
-  (state, { companionWindowId, manifestId, windowId }) => [
-    manifestId,
-    windowId,
-    getLocale(state, { companionWindowId }),
-  ].join(' - '), // Cache key consisting of manifestId, windowId, and locale
+  manifest => manifest && createManifestoInstance(manifest.json),
 );
 
 /**
@@ -80,15 +72,14 @@ const getContextualManifestoInstance = createCachedSelector(
 export const getManifestoInstance = createSelector(
   getContextualManifestoInstance,
   (state, { json }) => json,
-  getLocale,
-  (manifesto, manifestJson, locale) => (
+  (manifesto, manifestJson) => (
     manifestJson && createManifestoInstance(manifestJson, locale)
   ) || manifesto,
 );
 
 export const getManifestLocale = createSelector(
-  [getManifestoInstance],
-  manifest => manifest && manifest.options && manifest.options.locale && manifest.options.locale.replace(/-.*$/, ''),
+  [getManifestoInstance, getLocale],
+  (manifest, locale) => locale ?? (manifest && manifest.options && manifest.options.locale && manifest.options.locale.replace(/-.*$/, '')),
 );
 
 /** */
@@ -114,7 +105,7 @@ export const getManifestProviderName = createSelector(
   ],
   (provider, locale) => provider
     && provider[0].label
-    && PropertyValue.parse(provider[0].label, locale).getValue(),
+    && PropertyValue.parse(provider[0].label).getValue(locale),
 );
 
 /**
@@ -159,8 +150,8 @@ export const getManifestHomepage = createSelector(
   (homepages, locale) => homepages
     && asArray(homepages).map(homepage => (
       {
-        label: PropertyValue.parse(homepage.label, locale)
-          .getValue(),
+        label: PropertyValue.parse(homepage.label)
+          .getValue(locale),
         value: homepage.id || homepage['@id'],
       }
     )),
@@ -175,11 +166,11 @@ export const getManifestHomepage = createSelector(
  * @returns {string|null}
  */
 export const getManifestRenderings = createSelector(
-  [getManifestoInstance],
-  manifest => manifest
+  [getManifestoInstance, getManifestLocale],
+  (manifest, locale) => manifest
     && manifest.getRenderings().map(rendering => (
       {
-        label: rendering.getLabel().getValue(),
+        label: rendering.getLabel().getValue(locale),
         value: rendering.id,
       }
     )),
@@ -202,8 +193,8 @@ export const getManifestSeeAlso = createSelector(
     && asArray(seeAlso).map(related => (
       {
         format: related.format,
-        label: PropertyValue.parse(related.label, locale)
-          .getValue(),
+        label: PropertyValue.parse(related.label)
+          .getValue(locale),
         value: related.id || related['@id'],
       }
     )),
@@ -243,8 +234,8 @@ export const getManifestRelated = createSelector(
         }
         : {
           format: related.format,
-          label: PropertyValue.parse(related.label, locale)
-            .getValue(),
+          label: PropertyValue.parse(related.label)
+            .getValue(locale),
           value: related.id || related['@id'],
         }
     )),
@@ -259,13 +250,13 @@ export const getManifestRelated = createSelector(
  * @returns {string|null}
  */
 export const getRequiredStatement = createSelector(
-  [getManifestoInstance],
-  manifest => manifest
+  [getManifestoInstance, getManifestLocale],
+  (manifest, locale) => manifest
     && asArray(manifest.getRequiredStatement())
       .filter(l => l && l.getValues().some(v => v))
       .map(labelValuePair => ({
-        label: (labelValuePair.label && labelValuePair.label.getValue()) || null,
-        values: labelValuePair.getValues(),
+        label: (labelValuePair.label && labelValuePair.label.getValue(locale)) || null,
+        values: labelValuePair.getValues(locale),
       })),
 );
 
@@ -285,7 +276,7 @@ export const getRights = createSelector(
   ],
   (rights, license, locale) => {
     const data = rights || license;
-    return asArray(PropertyValue.parse(data, locale).getValues());
+    return asArray(PropertyValue.parse(data).getValues(locale));
   },
 );
 
@@ -319,9 +310,9 @@ export function getManifestThumbnail(state, props) {
  * @returns {string}
  */
 export const getManifestTitle = createSelector(
-  [getManifestoInstance],
-  manifest => manifest
-    && manifest.getLabel().getValue(),
+  [getManifestoInstance, getManifestLocale],
+  (manifest, locale) => manifest
+    && manifest.getLabel().getValue(locale),
 );
 
 /**
@@ -352,7 +343,7 @@ export const getManifestSummary = createSelector(
     getManifestLocale,
   ],
   (summary, locale) => summary
-    && PropertyValue.parse(summary, locale).getValue(locale),
+    && PropertyValue.parse(summary).getValue(locale),
 );
 
 /**
@@ -377,11 +368,11 @@ export const getManifestUrl = createSelector(
  * @param iiifResource
  * @returns {Array[Object]}
  */
-export function getDestructuredMetadata(iiifResource) {
+export function getDestructuredMetadata(iiifResource, locale = undefined) {
   return (iiifResource
     && iiifResource.getMetadata().map(labelValuePair => ({
-      label: labelValuePair.getLabel(),
-      values: labelValuePair.getValues(),
+      label: labelValuePair.getLabel(locale),
+      values: labelValuePair.getValues(locale),
     }))
   );
 }
@@ -395,8 +386,8 @@ export function getDestructuredMetadata(iiifResource) {
  * @returns {Array[Object]}
  */
 export const getManifestMetadata = createSelector(
-  [getManifestoInstance],
-  manifest => manifest && getDestructuredMetadata(manifest),
+  [getManifestoInstance, getManifestLocale],
+  (manifest, locale) => manifest && getDestructuredMetadata(manifest, locale),
 );
 
 /** */

src/state/selectors/searches.js

@@ -294,7 +294,7 @@ export const getResourceAnnotationLabel = createSelector(
       !(resourceAnnotation && resourceAnnotation.resource && resourceAnnotation.resource.label)
     ) return [];
 
-    return PropertyValue.parse(resourceAnnotation.resource.label, locale).getValues();
+    return PropertyValue.parse(resourceAnnotation.resource.label).getValues(locale);
   },
 );