Normalizer versioning fix (#1785)

* Normalizer versioning fix

* Fix error

* add logic to find newest service

* Add util-semver package

* Move logic to normalizeServices

Author: jribbink

.changeset/early-olives-explode.md

@@ -0,0 +1,5 @@
+---
+"@onflow/fcl": patch
+---
+
+Fix version normalization of services in FCL

package-lock.json

@@ -67,14 +67,15 @@
     "@onflow/util-address": "^1.1.0",
     "@onflow/util-invariant": "^1.1.0",
     "@onflow/util-logger": "^1.2.2",
+    "@onflow/util-semver": "^1.0.0",
     "@onflow/util-template": "^1.1.0",
     "@onflow/util-uid": "^1.1.0",
     "cross-fetch": "^3.1.6"
   },
   "peerDependencies": {
     "@react-native-async-storage/async-storage": "^1.13.0",
-    "expo-web-browser": "^12.0.0",
     "expo-linking": "^4.0.0",
+    "expo-web-browser": "^12.0.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-native": "^0.0.0-0 || 0.60 - 0.72 || 1000.0.0"
   },

packages/fcl/package.json

@@ -3,7 +3,11 @@ import * as rlp from "@onflow/rlp"
 import {fetchServices} from "./fetch-services"
 import {mergeServices} from "./merge-services"
 import {USER_PRAGMA} from "../normalizers/service/__vsn"
-import {normalizeService} from "../normalizers/service/service"
+import {
+  normalizeService,
+  normalizeServices,
+} from "../normalizers/service/service"
+import {serviceOfType} from "./service-of-type"
 
 function deriveCompositeId(authn) {
   return rlp
@@ -20,19 +24,14 @@ function normalizeData(data) {
   return data
 }
 
-function findService(type, services) {
-  return services.find(d => d.type === type)
-}
-
 export async function buildUser(data) {
   data = normalizeData(data)
 
-  var services = mergeServices(
-    data.services || [],
-    await fetchServices(data.hks, data.code)
-  ).map(service => normalizeService(service, data))
+  var services = normalizeServices(
+    mergeServices(data.services || [], await fetchServices(data.hks, data.code))
+  )
 
-  const authn = findService("authn", services)
+  const authn = serviceOfType(services, "authn")
 
   return {
     ...USER_PRAGMA,

packages/fcl/src/current-user/build-user.js

@@ -1,5 +1,3 @@
-import {withPrefix} from "@onflow/util-address"
-
 export function mergeServices(sx1 = [], sx2 = []) {
   // TODO: Make this smarter
   return [...sx1, ...sx2]

packages/fcl/src/current-user/merge-services.js

@@ -1,3 +1,14 @@
+import * as semver from "@onflow/util-semver"
+
 export function serviceOfType(services = [], type) {
-  return services.find(service => service.type === type)
+  // Find the greatest version of the service type
+  return services.reduce(
+    (mostRecent, service) =>
+      service.type === type
+        ? !mostRecent || semver.compare(service.f_vsn, mostRecent.f_vsn) > 0
+          ? service
+          : mostRecent
+        : mostRecent,
+    null
+  )
 }

packages/fcl/src/current-user/service-of-type.js

@@ -0,0 +1,40 @@
+import {serviceOfType} from "./service-of-type"
+
+describe("service-of-type", () => {
+  it("should choose the most recent version of a service", () => {
+    const services = [
+      {
+        type: "authn",
+        f_vsn: "1.0.0",
+      },
+      {
+        type: "authn",
+        f_vsn: "2.0.0",
+      },
+    ]
+
+    const service = serviceOfType(services, "authn")
+
+    expect(service).toEqual({
+      type: "authn",
+      f_vsn: "2.0.0",
+    })
+  })
+
+  it("should return null if no service of type exists", () => {
+    const services = [
+      {
+        type: "authn",
+        f_vsn: "1.0.0",
+      },
+      {
+        type: "authn",
+        f_vsn: "2.0.0",
+      },
+    ]
+
+    const service = serviceOfType(services, "non-existent")
+
+    expect(service).toBe(null)
+  })
+})

packages/fcl/src/current-user/service-of-type.test.js

@@ -15,11 +15,15 @@
 export function normalizeAccountProof(service) {
   if (service == null) return null
 
+  if (!service["f_vsn"]) {
+    throw new Error(`FCL Normalizer Error: Invalid account-proof service`)
+  }
+
   switch (service["f_vsn"]) {
     case "1.0.0":
       return service
 
     default:
-      throw new Error(`FCL Normalizer Error: Invalid account-proof service`)
+      return null
   }
 }

packages/fcl/src/normalizers/service/account-proof.js

@@ -12,11 +12,15 @@
 export function normalizeAuthnRefresh(service) {
   if (service == null) return null
 
+  if (!service["f_vsn"]) {
+    throw new Error("Invalid authn-refresh service")
+  }
+
   switch (service["f_vsn"]) {
     case "1.0.0":
       return service
 
     default:
-      throw new Error("Invalid authn-refresh service")
+      return null
   }
 }

packages/fcl/src/normalizers/service/authn-refresh.js

@@ -21,22 +21,26 @@ import {SERVICE_PRAGMA} from "./__vsn"
 export function normalizeAuthn(service) {
   if (service == null) return null
 
+  if (!service["f_vsn"]) {
+    return {
+      ...SERVICE_PRAGMA,
+      type: service.type,
+      uid: service.id,
+      endpoint: service.authn,
+      id: service.pid,
+      provider: {
+        address: withPrefix(service.addr),
+        name: service.name,
+        icon: service.icon,
+      },
+    }
+  }
+
   switch (service["f_vsn"]) {
     case "1.0.0":
       return service
 
     default:
-      return {
-        ...SERVICE_PRAGMA,
-        type: service.type,
-        uid: service.id,
-        endpoint: service.authn,
-        id: service.pid,
-        provider: {
-          address: withPrefix(service.addr),
-          name: service.name,
-          icon: service.icon,
-        },
-      }
+      return null
   }
 }