feat: compatibility endpoint

.github/workflows/release.yml

@@ -47,10 +47,18 @@ jobs:
         run: pnpm build
 
       - name: Create Release Pull Request or Publish to npm
+        id: release
         uses: changesets/action@v1
         with:
           title: Release tracking
           publish: npx changeset publish
         env:
           GITHUB_TOKEN: ${{ secrets.GIT_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Versions
+        if: ${{ steps.release.outputs.published == 'true' }}
+        run: |
+          touch .env
+          echo PUBLISHED_PACKAGES=${{ steps.versions.outputs.publishedPackages }} >> .env
+          pnpm changeset-version

cli/package.json

@@ -32,6 +32,7 @@
     "@rollup/plugin-virtual": "^3.0.2",
     "@types/ini": "^1.3.32",
     "@types/prompts": "^2.4.7",
+    "@types/semver": "^7.5.3",
     "@xata.io/client": "workspace:*",
     "@xata.io/codegen": "workspace:*",
     "@xata.io/importer": "workspace:*",
@@ -60,6 +61,7 @@
     "rollup-plugin-hypothetical": "^2.1.1",
     "rollup-plugin-import-cdn": "^0.2.2",
     "rollup-plugin-virtual-fs": "^4.0.1-alpha.0",
+    "semver": "^7.5.4",
     "text-table": "^0.2.0",
     "tmp": "^0.2.1",
     "which": "^4.0.0",
@@ -86,6 +88,9 @@
   },
   "oclif": {
     "bin": "xata",
+    "hooks": {
+      "init": "./dist/hooks/init/compatibility"
+    },
     "dirname": "xata",
     "commands": "./dist/commands",
     "plugins": [
@@ -130,7 +135,7 @@
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "npm run lint",
     "prepack": "oclif manifest && oclif readme",
-    "version": "oclif readme && git add README.md",
+    "changeset-version": "oclif readme && git add README.md && node ../scripts/changeset-version.mjs && git add ../scripts/changeset-version.mjs",
     "start": "node ./bin/run.js"
   },
   "engines": {

cli/src/hooks/init/compatibility.ts

@@ -0,0 +1,94 @@
+import { Hook } from '@oclif/core';
+import { readFile, stat, writeFile } from 'fs/promises';
+import semver from 'semver';
+import { mkdir } from 'fs';
+import path from 'path';
+import fetch from 'node-fetch';
+
+export type Packages = 'cli' | 'sdk';
+export type Compatibility = {
+  [key in Packages]: {
+    latest: string;
+    compatibility: { range: string; compatible: boolean; error?: string }[];
+  };
+};
+export type Latest = { latest: { [key in Packages]: string } };
+export type PackageJson = { dependencies: Record<string, string> };
+
+const hook: Hook<'init'> = async function (_options) {
+  const ONE_DAY = 1000 * 60 * 60 * 24 * 1;
+  const dir = path.join(process.cwd(), '.xata', 'version');
+  const latestFile = `${dir}/version.json`;
+  const compatibilityFile = `${dir}/compatibility.json`;
+  const compatibilityUri = 'https://raw.githubusercontent.com/xataio/client-ts/main/compatibility.json';
+
+  const displayWarning = async () => {
+    await check('cli', this.config.version);
+    const sdkVersion = await getSdkVersion();
+    sdkVersion && (await check('sdk', sdkVersion));
+  };
+
+  const check = async (pkg: 'cli' | 'sdk', currentVersion: string) => {
+    // Latest version check
+    const tag: Latest = JSON.parse(await readFile(latestFile, 'utf-8'));
+    const updateAvailable = semver.lt(this.config.version, tag.latest[pkg]);
+    if (updateAvailable)
+      this.log(
+        `✨ A newer version of the Xata ${pkg.toUpperCase()} is now available: ${
+          tag.latest[pkg]
+        }. You are currently using version: ${currentVersion}`
+      );
+    // Compatibility check
+    const compatibility: Compatibility = JSON.parse(await readFile(compatibilityFile, 'utf-8'));
+    const compatibleRange = compatibility[pkg].compatibility
+      .filter((v) => v.compatible)
+      .map((v) => v.range)
+      .join('||');
+    const semverCompatible = semver.satisfies(currentVersion, compatibleRange);
+    if (!semverCompatible)
+      this.error(
+        `Incompatible version of ${pkg.toUpperCase()}: ${currentVersion}. Please upgrade to a version that satisfies: ${compatibleRange}.`
+      );
+  };
+
+  const getSdkVersion = async (): Promise<null | string> => {
+    const packageJson: PackageJson = JSON.parse(await readFile(`${path.join(process.cwd())}/package.json`, 'utf-8'));
+    return packageJson && packageJson.dependencies && packageJson.dependencies['@xata.io/client']
+      ? packageJson.dependencies['@xata.io/client']
+      : null;
+  };
+
+  const fetchInfo = async () => {
+    let shouldRefresh = true;
+    try {
+      // Latest time of one of the files should be enough
+      const statResult = await stat(latestFile);
+      const lastModified = new Date(statResult.mtime);
+      // Last param is the number of days - we fetch new package info if the file is older than 1 day
+      const staleAt = new Date(lastModified.valueOf() + ONE_DAY);
+      shouldRefresh = new Date() > staleAt;
+    } catch (_e) {
+      // Do nothing
+    }
+    if (shouldRefresh) {
+      try {
+        mkdir(dir, { recursive: true }, () => {});
+        const latestCompatibilityResponse = await fetch(compatibilityUri);
+        const body = latestCompatibilityResponse.body;
+        await writeFile(compatibilityFile, body as NodeJS.ReadStream);
+        const compatibility: Compatibility = JSON.parse(await readFile(compatibilityFile, 'utf-8'));
+        await writeFile(
+          latestFile,
+          JSON.stringify({ latest: { cli: compatibility.cli.latest, sdk: compatibility.sdk.latest } }, null, 2)
+        );
+      } catch (_e) {
+        // Do nothing
+      }
+    }
+  };
+
+  await fetchInfo();
+  await displayWarning();
+};
+
+export default hook;

compatibility.json

@@ -0,0 +1,30 @@
+{
+  "cli": {
+    "latest": "0.14.2",
+    "compatibility": [
+      {
+        "range": ">0.0.1",
+        "compatible": true
+      },
+      {
+        "range": "<0.0.1",
+        "compatbile": false,
+        "error": "Please update to v0.0.1"
+      }
+    ]
+  },
+  "sdk": {
+    "latest": "0.26.9",
+    "compatibility": [
+      {
+        "range": ">0.0.1",
+        "compatible": true
+      },
+      {
+        "range": "<0.0.1",
+        "compatbile": false,
+        "error": "Please update to v0.0.1"
+      }
+    ]
+  }
+}

packages/client/package.json

@@ -18,7 +18,8 @@
   "scripts": {
     "build": "rimraf dist && rollup -c",
     "tsc": "tsc --noEmit",
-    "add-version": "node ../../scripts/add-version-file.mjs"
+    "add-version": "node ../../scripts/add-version-file.mjs",
+    "changeset-version": "node ../../scripts/changeset-version.mjs && git add ../../scripts/changeset-version.mjs"
   },
   "peerDependencies": {
     "typescript": ">=4.5"

scripts/changeset-version.mjs

@@ -0,0 +1,18 @@
+import fs from 'fs';
+import path from 'path';
+
+//[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]
+const packageNames = ["@xata.io/client", "@xata.io/cli"]
+const packages = JSON.parse(process.env.PUBLISHED_PACKAGES).filter(pkg => packageNames.includes(pkg.name));
+
+const compatibilityPath = path.join(process.cwd(), 'compatibility.json');
+const compatibility = fs.readFileSync(compatibilityPath, 'utf8');
+
+for (const pkg of packages) {
+    const oldVersion = JSON.parse(compatibility)[name].latest
+    const newVersion = pkg.version
+    const name = pkg.name
+    compatibility.replace(oldVersion, newVersion)
+}
+
+fs.writeFileSync(compatibilityPath, compatibility);