Finalise shareKeys #5055

nf-s · 2020-12-03T05:32:04Z

Finalise `shareKeys`

Fixes ##4774

See https://github.com/TerriaJS/terriajs/blob/next/architecture/0005-root-group-ids-and-shareKeys.md for background

V7 catalog support

Partially fixes #4897

This replaces https://github.com/TerriaJS/terrace/pull/158

Adds v7initializationUrls to terria config. It will convert catalogs to v8 and print messages to console.

For example:

    {
      "v7initializationUrls": [
        "https://raw.githubusercontent.com/GeoscienceAustralia/dea-config/master/dev/terria/dea-maps.json",
        "https://maps.dea.ga.gov.au/init/terria-cube.json"
      ]
    },

ShareKeys support for root group of Magda map config

To map map-config-de-australia to the root group (now "/") you can add a shareKey like so:

{
  "aspects": {
    "terria": {
      "id": "map-config-de-australia",
      "shareKeys": [
        "map-config-de-australia"
      ],
      "type": "group"
    },
    ...
  },
  "id": "map-config-de-australia",
  ...
}

ShareKeys support for dynamic groups

See ADR for more info - https://github.com/TerriaJS/terriajs/blob/77a25b6967281e1f6189ccf54d77b2974730d4e1/architecture/0006-dynamic-groups-and-shareKeys.md

Change how WMS group sets `id` for items

To mimic v7. See https://github.com/TerriaJS/terriajs/blob/77a25b6967281e1f6189ccf54d77b2974730d4e1/architecture/0006-dynamic-groups-and-shareKeys.md#wms-group

Other small changes

Added InitDataPromise to InitSources
Add reverse modelIdShareKeysMap map - model.id -> shareKeys
Reverted Legend use of object instead of img - sometimes it was showing html error responses
Legend will now hide if an error is thrown

Checklist

Add test for magda map config shareKeys
Add test for GroupMixin shareKeys
Add test for v7 catalog
I've updated CHANGES.md with what I changed.

nf-s · 2020-12-09T11:06:16Z

lib/Models/InitSource.ts

+export function isInitDataPromise(
+  initSource: InitSource
+): initSource is InitDataPromise {
+  return (
+    initSource &&
+    Object.prototype.toString.call(initSource) === "[object Promise]"
+  );
+}
+


Used for v7-v8 catalog converting

nf-s · 2020-12-09T11:06:36Z

lib/Core/addedByUser.ts

-      addedByUser(
-        <BaseModel>catalogMember.terria.getModelById(BaseModel, containerId),
-        { depth: depth + 1 }
-      )
+      addedByUser(catalogMember.terria.getModelById(BaseModel, containerId), {
+        depth: depth + 1
+      })


Removed bad <BaseModel> typing here

nf-s · 2020-12-09T11:07:00Z

lib/Models/Terria.ts

@@ -1026,7 +1051,8 @@ export default class Terria {
      let existingReference = this.getModelById(MagdaReference, id);
      if (existingReference === undefined) {
        existingReference = new MagdaReference(id, this);
-        this.addModel(existingReference);
+        // Add model with terria aspects shareKeys
+        this.addModel(existingReference, aspects?.terria?.shareKeys);


For magda root group sharekeys

nf-s · 2020-12-09T11:07:29Z

lib/Models/Terria.ts

 const loadInitSource = createTransformer(
-  (initSource: InitSource): Promise<JsonObject | undefined> => {
-    let promise: Promise<JsonValue | undefined>;
-
+  async (initSource: InitSource): Promise<JsonObject | undefined> => {
+    let jsonValue: JsonValue | undefined;
    if (isInitUrl(initSource)) {
-      promise = loadJson5(initSource.initUrl);
+      jsonValue = await loadJson5(initSource.initUrl);
    } else if (isInitOptions(initSource)) {
-      promise = initSource.options.reduce((previousOptionPromise, option) => {
-        return previousOptionPromise
-          .then(json => {
-            if (json === undefined) {
-              return loadInitSource(option);
-            }
-            return json;
-          })
-          .catch(_ => {
+      await initSource.options.reduce(async (previousOptionPromise, option) => {
+        try {
+          const json = await previousOptionPromise;
+          if (json === undefined) {
            return loadInitSource(option);
-          });
+          }
+          return json;
+        } catch (_) {
+          return loadInitSource(option);
+        }
      }, Promise.resolve<JsonObject | undefined>(undefined));
-    } else {
-      promise = Promise.resolve(initSource.data);
+    } else if (isInitData(initSource)) {
+      jsonValue = initSource.data;
+    } else if (isInitDataPromise(initSource)) {
+      jsonValue = (await initSource).data;
    }

-    return promise.then(jsonValue => {
-      if (isJsonObject(jsonValue)) {
-        return jsonValue;
-      }
-      return undefined;
-    });
+    if (jsonValue && isJsonObject(jsonValue)) {
+      return jsonValue;
+    }
+    return undefined;


Asyncified + added support for InitDataPromise - which is just a Promise which resolves to InitData

Still reviewing this

nf-s · 2020-12-11T01:01:55Z

lib/Models/WebMapServiceCatalogGroup.ts

@@ -288,7 +288,7 @@ class GetCapabilitiesStratum extends LoadableStratum(
    if (!isDefined(this.catalogGroup.uniqueId)) {
      return;
    }
-    return `${this.catalogGroup.uniqueId}/${layer.Name || layer.Title}`;
+    return `${this.catalogGroup.uniqueId}/${layer.Title}`;


Revert WMS id to match v7

nf-s · 2020-12-15T02:09:13Z

lib/ReactViews/Workbench/Controls/Legend.tsx

-  // If we legends need scaling, this is the only way to do it :/
-  // See https://stackoverflow.com/questions/7699621/display-image-at-50-of-its-native-size
-  // or https://stackoverflow.com/questions/35711807/display-high-dpi-image-at-50-scaling-using-just-css
-  resizeLegendImage(
-    evt: SyntheticEvent<HTMLObjectElement>,
+  onImageLoad(
+    evt: SyntheticEvent<HTMLImageElement>,
    legend: Model<LegendTraits>
  ) {
-    if (!isDefined(legend.imageScaling) || legend.imageScaling === 1) return;
    const image = evt.target as HTMLObjectElement;
+    image.style.display = "none";
+    image.style.maxWidth = "none";

-    image.style.width = `${legend.imageScaling * image.offsetWidth}px`;
+    if (evt.type === "error") {
+      return;
+    }
+
+    image.style.display = "initial";
+
+    // If legend need scaling, this is the only way to do it :/
+    // See https://stackoverflow.com/questions/7699621/display-image-at-50-of-its-native-size
+    // or https://stackoverflow.com/questions/35711807/display-high-dpi-image-at-50-scaling-using-just-css
+
+    image.style.width = `${(legend.imageScaling ?? 1) * image.offsetWidth}px`;
    // Must set maxWidth *after* setting width, as it may change offsetWidth
    image.style.maxWidth = "100%";
  }


Refactored this to hide if an image request gives error response.

nf-s · 2020-12-15T02:09:33Z

package.json

@@ -58,7 +58,7 @@
    "@vx/tooltip": "^0.0.193-alpha.2",
    "babel-loader": "^8.0.5",
    "babel-plugin-jsx-control-statements": "^4.0.0",
-    "catalog-converter": "^0.0.2-alpha.3",
+    "catalog-converter": "^0.0.2-alpha.4",


This depends on TerriaJS/catalog-converter#32

nf-s · 2020-12-15T02:11:42Z

Before merging - merge Sharekeys support catalog-converter#32 and publish new catalog-converter version

lib/ModelMixins/GroupMixin.ts

lib/Models/Terria.ts

lib/ReactViews/Notification/shareConvertNotification.tsx

Co-authored-by: Stephen Davies <steve9164@gmail.com>

lib/Models/Terria.ts

Co-authored-by: Stephen Davies <steve9164@gmail.com>

lib/Models/WebMapServiceCatalogItem.ts

nf-s · 2020-12-16T05:59:35Z

lib/Models/WebMapServiceCatalogItem.ts

-          // Geoserver fontColor must be a hex value
-          // enable if we can ensure a dark background
-          const fontColor = terriaTheme.textLight.split("#")?.[1];
+          // Geoserver fontColor must be a hex value - use `textLight` theme colour
+          let fontColor = terriaTheme.textLight.split("#")?.[1];
          if (isDefined(fontColor)) {
-            legendOptions += `;fontColor:0x${
-              terriaTheme.textLight.split("#")[1]
-            }`;
+            // If fontColor is a 3-character hex -> turn into 6
+            if (fontColor.length === 3) {
+              fontColor = `${fontColor[0]}${fontColor[0]}${fontColor[1]}${fontColor[1]}${fontColor[2]}${fontColor[2]}`;
+            }
+            legendOptions += `;fontColor:0x${fontColor}`;


If textLight is #fff - Geoserver gives us a blue legend ?!

tephenavies

Tests pass locally

nf-s added 2 commits December 3, 2020 00:30

add v7 catalog support through v7initializationUrls

1b09433

add test

cd6cd4c

This was referenced Dec 3, 2020

Model architecture: "Alias IDs" or shareKeys #4774

Closed

Root group IDs, shareKeys and share link compatibility ADR #5056

Merged

nf-s added 5 commits December 9, 2020 17:10

Merge remote-tracking branch 'origin/next' into v7-catalog-support-clean

1b2f479

add v7initUrls docs + fix wrong v7 autoID

aac476d

add magda record terria aspect sharekeys to root group

9bbcc1c

fix bad typing

7c1a9f9

add dodgy GroupMixin shareKeys

fc7b9c1

nf-s changed the title ~~add v7 catalog support through v7initializationUrls (FIXED)~~ Finalise shareKeys Dec 9, 2020

nf-s commented Dec 9, 2020

View reviewed changes

nf-s marked this pull request as draft December 10, 2020 00:58

nf-s added 7 commits December 10, 2020 12:49

add dynamic group sharekeys ADR

4b8c333

add 0006 adr decision

4c611f8

adr type

9b115c2

change WMS-group member ids to match v7

87c23f1

add group shareKeys propagation

bdd332a

fix tests

77a25b6

fix test

1be250c

nf-s commented Dec 11, 2020

View reviewed changes

add WMS group skareKeys test

5d13c2b

nf-s marked this pull request as ready for review December 11, 2020 01:21

nf-s added 5 commits December 11, 2020 13:08

bump catalog converter versoin

7839d85

fix legend image scaling

cd079bb

fix test

717152a

Merge remote-tracking branch 'origin/next' into v7-catalog-support-clean

66905da

udpate changes

5d072b1

comment

05369a9

nf-s commented Dec 15, 2020

View reviewed changes

changes

f4804ef

nf-s added 2 commits December 15, 2020 19:37

move catalog-share conversion from server to terriajs

a3eb9a5

remove makeModelsMagdaCompatible

9a5501b

tephenavies requested changes Dec 16, 2020

View reviewed changes

lib/ModelMixins/GroupMixin.ts Outdated Show resolved Hide resolved

lib/Models/Terria.ts Outdated Show resolved Hide resolved

lib/ReactViews/Notification/shareConvertNotification.tsx Outdated Show resolved Hide resolved

nf-s and others added 2 commits December 16, 2020 16:02

Update lib/ModelMixins/GroupMixin.ts

9059ccd

Co-authored-by: Stephen Davies <steve9164@gmail.com>

Update lib/Models/Terria.ts

e2d552a

Co-authored-by: Stephen Davies <steve9164@gmail.com>

tephenavies reviewed Dec 16, 2020

View reviewed changes

lib/Models/Terria.ts Outdated Show resolved Hide resolved

nf-s and others added 4 commits December 16, 2020 16:39

Update lib/ReactViews/Notification/shareConvertNotification.tsx

ca117c8

Co-authored-by: Stephen Davies <steve9164@gmail.com>

fix geoserver legend font colour

2b61cf8

refactor initSource.optoins

f4ebdcd

fix shareConvertNotification

6f129b8

nf-s commented Dec 16, 2020

View reviewed changes

lib/Models/WebMapServiceCatalogItem.ts Outdated Show resolved Hide resolved

nf-s added 2 commits December 16, 2020 16:54

changes

81fb978

remove unused vars

c5e9fc3

nf-s commented Dec 16, 2020

View reviewed changes

tephenavies approved these changes Dec 16, 2020

View reviewed changes

tephenavies merged commit c71f7de into next Dec 16, 2020

tephenavies deleted the v7-catalog-support-clean branch December 16, 2020 06:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Finalise shareKeys #5055

Finalise shareKeys #5055

nf-s commented Dec 3, 2020 •

edited

Loading

nf-s Dec 9, 2020

nf-s Dec 9, 2020

nf-s Dec 9, 2020

nf-s Dec 9, 2020

tephenavies Dec 16, 2020

nf-s Dec 11, 2020

nf-s Dec 15, 2020

nf-s Dec 15, 2020

nf-s commented Dec 15, 2020 •

edited

Loading

nf-s Dec 16, 2020

tephenavies left a comment

Finalise shareKeys #5055

Finalise shareKeys #5055

Conversation

nf-s commented Dec 3, 2020 • edited Loading