[LW-10042] chore: accept older minor/patch versions in routes (#1146)

* chore: accept older minor/patch versions in routes

LW-10042

chore: reuse only the same major versions in supportedVersions.json

chore: syntax errors, whitespace

chore: cardano-services-client build in the Dockerfile (?)

chore: revive `createVersionSource.js --check`

* ci: try setting `max_old_space_size = 8192`

… but it doesn’t make sense, since the build works on my machine?

Author: michalrus

nix/cardano-services/deployments/backend-ingress.nix

@@ -68,7 +68,7 @@
             ++ lib.optionals config.providers.stake-pool-provider.enabled [
               {
                 pathType = "Prefix";
-                path = "/v${values.cardano-services.versions.stakePool}/stake-pool";
+                path = "/v${lib.last (lib.sort lib.versionOlder values.cardano-services.versions.stakePool)}/stake-pool";
                 backend.service = {
                   name = "${chart.name}-stake-pool-provider";
                   port.name = "http";
@@ -78,7 +78,7 @@
             ++ lib.optionals config.providers.handle-provider.enabled [
               {
                 pathType = "Prefix";
-                path = "/v${values.cardano-services.versions.handle}/handle";
+                path = "/v${lib.last (lib.sort lib.versionOlder values.cardano-services.versions.handle)}/handle";
                 backend.service = {
                   name = "${chart.name}-handle-provider";
                   port.name = "http";
@@ -88,7 +88,7 @@
             ++ lib.optionals config.providers.asset-provider.enabled [
               {
                 pathType = "Prefix";
-                path = "/v${values.cardano-services.versions.handle}/asset";
+                path = "/v${lib.last (lib.sort lib.versionOlder values.cardano-services.versions.handle)}/asset";
                 backend.service = {
                   name = "${chart.name}-asset-provider";
                   port.name = "http";

nix/cardano-services/deployments/default.nix

@@ -83,7 +83,7 @@ in
           image = oci.image.name;
           buildInfo = oci.meta.buildInfo;
           versions = oci.meta.versions;
-          httpPrefix = "/v${oci.meta.versions.root}";
+          httpPrefix = "/v${lib.last (lib.sort lib.versionOlder oci.meta.versions.root)}";
 
           loggingLevel = "debug";
           tokenMetadataServerUrl = "http://${final.namespace}-cardano-stack-metadata.${final.namespace}.svc.cluster.local";
@@ -131,18 +131,19 @@ in
           };
           routes = let
             inherit (oci.meta) versions;
-          in [
-            "/v${versions.root}/health"
-            "/v${versions.root}/live"
-            "/v${versions.root}/meta"
-            "/v${versions.root}/ready"
-            "/v${versions.assetInfo}/asset"
-            "/v${versions.chainHistory}/chain-history"
-            "/v${versions.networkInfo}/network-info"
-            "/v${versions.rewards}/rewards"
-            "/v${versions.txSubmit}/tx-submit"
-            "/v${versions.utxo}/utxo"
-          ];
+          in
+            lib.concatLists [
+              (map (v: "/v${v}/health") versions.root)
+              (map (v: "/v${v}/live") versions.root)
+              (map (v: "/v${v}/meta") versions.root)
+              (map (v: "/v${v}/ready") versions.root)
+              (map (v: "/v${v}/asset") versions.assetInfo)
+              (map (v: "/v${v}/chain-history") versions.chainHistory)
+              (map (v: "/v${v}/network-info") versions.networkInfo)
+              (map (v: "/v${v}/rewards") versions.rewards)
+              (map (v: "/v${v}/tx-submit") versions.txSubmit)
+              (map (v: "/v${v}/utxo") versions.utxo)
+            ];
         };
       };
       imports = [

nix/cardano-services/oci-images.nix

@@ -16,7 +16,7 @@ in {
     name = "926093910549.dkr.ecr.us-east-1.amazonaws.com/cardano-services";
     operable = cell.operables.cardano-services;
     meta.description = "Minimal Cardano Services OCI Image";
-    meta.versions = builtins.fromJSON (builtins.readFile (self + /packages/cardano-services-client/version.json));
+    meta.versions = builtins.fromJSON (builtins.readFile (self + /packages/cardano-services-client/supportedVersions.json));
     meta.buildInfo = buildInfo;
   };
 }

nix/cardano-services/packages.nix

@@ -28,6 +28,7 @@ in {
         oldAttrs.configurePhase;
       # A bunch of deps build binaries using node-gyp that requires Python
       PYTHON = "${nixpkgs.python3}/bin/python3";
+      NODE_OPTIONS = "--max_old_space_size=8192";
       # node-hid uses pkg-config to find sources
       buildInputs = oldAttrs.buildInputs ++ [nixpkgs.pkg-config nixpkgs.libusb1];
 
@@ -46,6 +47,7 @@ in {
     project.overrideAttrs (oldAttrs: {
       # A bunch of deps build binaries using node-gyp that requires Python
       PYTHON = "${nixpkgs.python3}/bin/python3";
+      NODE_OPTIONS = "--max_old_space_size=8192";
       # playwright build fixes
       PLAYWRIGHT_BROWSERS_PATH = nixpkgs.playwright-driver.browsers;
       PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD = 1;

packages/cardano-services-client/scripts/createVersionSource.js

@@ -22,21 +22,42 @@ const apiVersion = Object.fromEntries(
   ])
 );
 
-const versionFile = path.join(__dirname, '../version.json');
+const supportedVersionsFile = path.join(__dirname, '../supportedVersions.json');
+const sameMajorVersion = (a) => (b) => {
+  const [majorA] = a.split('.');
+  const [majorB] = b.split('.');
+  return majorA === majorB;
+};
+const supportedVersions = (() => {
+  let rv = {};
+  if (fs.existsSync(supportedVersionsFile)) {
+    const data = fs.readFileSync(supportedVersionsFile, { encoding: 'utf8' });
+    rv = JSON.parse(data);
+  }
+  for (const [api, version] of Object.entries(apiVersion)) {
+    const previouslySupported = rv[api] ?? [];
+    rv[api] = previouslySupported.includes(apiVersion[api])
+      ? previouslySupported
+      : [...previouslySupported.filter(sameMajorVersion(version)), version];
+  }
+  return rv;
+})();
+
 const create = () => {
-  const version = JSON.stringify(apiVersion, null, 2);
+  fs.writeFileSync(supportedVersionsFile, `${JSON.stringify(supportedVersions, null, 2)}\n`, {
+    encoding: 'utf8',
+    flag: 'w'
+  });
   const contents = `// auto-generated using ../scripts/createVersionSource.js
-  export const apiVersion = ${version};
-  `;
-
+export const apiVersion = ${JSON.stringify(apiVersion, null, 2)};
+`;
   fs.writeFileSync(path.join(__dirname, '../src/version.ts'), contents, { encoding: 'utf8', flag: 'w' });
-  fs.writeFileSync(versionFile, `${version}\n`, { encoding: 'utf8', flag: 'w' });
 };
 
 switch (argv[2]) {
   case '--check':
     try {
-      deepEqual(JSON.parse(fs.readFileSync(versionFile, { encoding: 'utf8' })), apiVersion);
+      deepEqual(JSON.parse(fs.readFileSync(supportedVersionsFile, { encoding: 'utf8' })), supportedVersions);
       exit(1);
     } catch {
       exit(0);

packages/cardano-services-client/supportedVersions.json

@@ -0,0 +1,30 @@
+{
+  "assetInfo": [
+    "1.0.0"
+  ],
+  "chainHistory": [
+    "3.0.0",
+    "3.0.1"
+  ],
+  "handle": [
+    "1.0.0"
+  ],
+  "networkInfo": [
+    "1.0.0"
+  ],
+  "rewards": [
+    "1.0.0"
+  ],
+  "root": [
+    "1.0.0"
+  ],
+  "stakePool": [
+    "1.1.0"
+  ],
+  "txSubmit": [
+    "2.0.0"
+  ],
+  "utxo": [
+    "2.0.0"
+  ]
+}