Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

refactor(sdk-bundle): Adjust SDK compatibility warning messages and banners (#63919)

Timofey Kachalov84efc79be40d
diff --git a/e2e/test-component/scenarios/embedding-sdk/incompatibility-with-instance-banner.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/incompatibility-with-instance-banner.cy.spec.tsx
index 8fa7338fb50..01ab22e9815 100644
--- a/e2e/test-component/scenarios/embedding-sdk/incompatibility-with-instance-banner.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/incompatibility-with-instance-banner.cy.spec.tsx
@@ -34,7 +34,7 @@ describe("scenarios > embedding-sdk > incompatibility-with-instance-banner", ()
mockAuthProviderAndJwtSignIn();
});
- describe("when the SDK is incompatible with an instance", () => {
+ describe("when the SDK bundle is incompatible with an instance", () => {
it("should show an error with a close button", () => {
cy.mount(
<MetabaseProvider authConfig={DEFAULT_SDK_AUTH_PROVIDER_CONFIG}>
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkVersionCompatibilityHandler/SdkIncompatibilityWithInstanceBanner.tsx b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkVersionCompatibilityHandler/SdkIncompatibilityWithInstanceBanner.tsx
index e27e7c8cd7b..01f567d85c5 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkVersionCompatibilityHandler/SdkIncompatibilityWithInstanceBanner.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/components/private/SdkVersionCompatibilityHandler/SdkIncompatibilityWithInstanceBanner.tsx
@@ -7,31 +7,31 @@ import { getMetabaseInstanceVersion } from "embedding-sdk-bundle/store/selectors
import { getBuildInfo } from "embedding-sdk-shared/lib/get-build-info";
import {
isInvalidMetabaseVersion,
- isSdkPackageCompatibleWithSdkBundle,
+ isSdkBundleCompatibleWithMetabaseInstance,
} from "embedding-sdk-shared/lib/version-utils";
import { Anchor } from "metabase/ui";
export function SdkIncompatibilityWithInstanceBanner() {
- const sdkPackageVersion = getBuildInfo(
- "METABASE_EMBEDDING_SDK_PACKAGE_BUILD_INFO",
- ).version;
- const sdkBundleVersion = useSdkSelector(getMetabaseInstanceVersion);
+ const sdkBundleVersion = getBuildInfo(
+ "METABASE_EMBEDDING_SDK_BUNDLE_BUILD_INFO",
+ )?.version;
+ const metabaseInstanceVersion = useSdkSelector(getMetabaseInstanceVersion);
const isSdkCompatibleWithInstance = useMemo(() => {
- if (!sdkBundleVersion || !sdkPackageVersion) {
+ if (!sdkBundleVersion || !metabaseInstanceVersion) {
// If we don't have the Metabase version, we can't determine compatibility.
return true;
}
- if (isInvalidMetabaseVersion(sdkBundleVersion)) {
+ if (isInvalidMetabaseVersion(metabaseInstanceVersion)) {
return true;
}
- return isSdkPackageCompatibleWithSdkBundle({
- sdkPackageVersion,
+ return isSdkBundleCompatibleWithMetabaseInstance({
sdkBundleVersion,
+ metabaseInstanceVersion,
});
- }, [sdkPackageVersion, sdkBundleVersion]);
+ }, [sdkBundleVersion, metabaseInstanceVersion]);
if (isSdkCompatibleWithInstance) {
return null;
diff --git a/enterprise/frontend/src/embedding-sdk-bundle/hooks/private/use-log-version-info/use-log-version-info.unit.spec.tsx b/enterprise/frontend/src/embedding-sdk-bundle/hooks/private/use-log-version-info/use-log-version-info.unit.spec.tsx
index e7a0c5636f8..e24fc30d1fa 100644
--- a/enterprise/frontend/src/embedding-sdk-bundle/hooks/private/use-log-version-info/use-log-version-info.unit.spec.tsx
+++ b/enterprise/frontend/src/embedding-sdk-bundle/hooks/private/use-log-version-info/use-log-version-info.unit.spec.tsx
@@ -46,14 +46,14 @@ describe("useLogVersionInfo", () => {
describe("SDK version compatibility", () => {
it("should show a message when the SDK version is not compatible with the Metabase version", async () => {
await setup({
- sdkPackageVersion: "0.52.10",
- sdkBundleVersion: "v1.55.0",
+ sdkPackageVersion: "0.55.10",
+ sdkBundleVersion: "v1.52.0",
});
expect(
getWarnMessages().filter((message) =>
message.includes(
- "SDK package version 0.52.10 is not compatible with SDK bundle version v1.55.0, this might cause issues.",
+ "SDK package version 0.55.10 is not compatible with SDK bundle version v1.52.0, this might cause issues.",
),
),
).toHaveLength(1);
@@ -61,7 +61,7 @@ describe("useLogVersionInfo", () => {
it("should not show a warning when the SDK version is compatible with the Metabase version", async () => {
await setup({
- sdkPackageVersion: "0.55.10",
+ sdkPackageVersion: "0.52.10",
sdkBundleVersion: "v1.55.1",
});
diff --git a/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.ts b/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.ts
index 17e53d5b721..efb56c4ac6f 100644
--- a/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.ts
+++ b/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.ts
@@ -24,5 +24,27 @@ export const isSdkPackageCompatibleWithSdkBundle = ({
const sdkBundleVersionComponents =
versionToNumericComponents(sdkBundleVersion);
- return sdkBundleVersionComponents?.[1] === sdkPackageVersionComponents?.[1];
+ if (!sdkPackageVersionComponents || !sdkBundleVersionComponents) {
+ return true;
+ }
+
+ return sdkBundleVersionComponents?.[1] >= sdkPackageVersionComponents?.[1];
+};
+
+export const isSdkBundleCompatibleWithMetabaseInstance = ({
+ sdkBundleVersion,
+ metabaseInstanceVersion,
+}: {
+ sdkBundleVersion: string;
+ metabaseInstanceVersion: string;
+}) => {
+ const sdkBundleVersionComponents =
+ versionToNumericComponents(sdkBundleVersion);
+ const metabaseInstanceVersionComponents = versionToNumericComponents(
+ metabaseInstanceVersion,
+ );
+
+ return (
+ sdkBundleVersionComponents?.[1] === metabaseInstanceVersionComponents?.[1]
+ );
};
diff --git a/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.unit.spec.ts b/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.unit.spec.ts
index 5c640b81988..5472c861cd2 100644
--- a/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.unit.spec.ts
+++ b/enterprise/frontend/src/embedding-sdk-shared/lib/version-utils.unit.spec.ts
@@ -2,10 +2,11 @@ import { EMBEDDING_SDK_BUNDLE_UNKNOWN_VERSION } from "build-configs/embedding-sd
import {
isInvalidMetabaseVersion,
+ isSdkBundleCompatibleWithMetabaseInstance,
isSdkPackageCompatibleWithSdkBundle,
} from "./version-utils";
-const expectCompatibility = ({
+const expectPackageAndBundleCompatibility = ({
sdkPackageVersion,
sdkBundleVersion,
expected,
@@ -24,6 +25,25 @@ const expectCompatibility = ({
});
};
+const expectBundleAndInstanceCompatibility = ({
+ sdkBundleVersion,
+ metabaseInstanceVersion,
+ expected,
+}: {
+ sdkBundleVersion: string;
+ metabaseInstanceVersion: string;
+ expected: boolean;
+}) => {
+ it(`expect sdk bundle version ${sdkBundleVersion} and metabase instance version ${metabaseInstanceVersion} to be ${expected ? "compatible" : "incompatible"}`, () => {
+ expect(
+ isSdkBundleCompatibleWithMetabaseInstance({
+ sdkBundleVersion,
+ metabaseInstanceVersion,
+ }),
+ ).toBe(expected);
+ });
+};
+
describe("sdk version utils", () => {
describe.each([
{
@@ -58,31 +78,30 @@ describe("sdk version utils", () => {
describe('isSdkPackageCompatibleWithSdkBundle, naming used: "{0,1}.{major}.{minor}"', () => {
describe('should return true only if the "major" version is the same', () => {
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: "v0.52.10",
sdkPackageVersion: "0.52.10",
expected: true,
});
- expectCompatibility({
- sdkBundleVersion: "v1.50.10",
- sdkPackageVersion: "0.51.10",
- expected: false,
+ expectPackageAndBundleCompatibility({
+ sdkBundleVersion: "v1.51.10",
+ sdkPackageVersion: "0.50.10",
+ expected: true,
});
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: "v1.50.10",
- sdkPackageVersion: "0.53.10",
+ sdkPackageVersion: "0.51.10",
expected: false,
});
});
describe('should ignore "minors"', () => {
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: "v1.50.10",
sdkPackageVersion: "0.50.11",
expected: true,
});
-
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: "v1.50.10",
sdkPackageVersion: "0.50.9",
expected: true,
@@ -90,13 +109,13 @@ describe("sdk version utils", () => {
});
describe("sdk version 0.xx.yy should be compatible both with MB 0.xx.yy (OSS) and 1.xx.yy (EE)", () => {
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: "v0.52.10",
sdkPackageVersion: "0.52.10",
expected: true,
});
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: "v1.52.10",
sdkPackageVersion: "0.52.10",
expected: true,
@@ -105,7 +124,7 @@ describe("sdk version utils", () => {
describe("should ignore build tags like snapshot, alpha, beta, rc", () => {
for (const tag of ["snapshot", "alpha", "beta", "rc", "X-NOT-EXISTING"]) {
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: `v0.52.10-${tag}`,
sdkPackageVersion: "0.52.10",
expected: true,
@@ -114,17 +133,51 @@ describe("sdk version utils", () => {
});
describe("should handle versions of the sdk wrapped in double quotes (metabase#50014)", () => {
- expectCompatibility({
+ expectPackageAndBundleCompatibility({
sdkBundleVersion: "v1.55.0",
sdkPackageVersion: '"0.55.0"',
expected: true,
});
- expectCompatibility({
- sdkBundleVersion: "v1.55.0",
- sdkPackageVersion: '"0.54.0"',
+ expectPackageAndBundleCompatibility({
+ sdkBundleVersion: "v1.54.0",
+ sdkPackageVersion: '"0.55.0"',
+ expected: false,
+ });
+ });
+ });
+
+ describe('isSdkBundleCompatibleWithMetabaseInstance, naming used: "{0,1}.{major}.{minor}"', () => {
+ describe('should return true only if the "major" version is the same', () => {
+ expectBundleAndInstanceCompatibility({
+ sdkBundleVersion: "v0.52.10",
+ metabaseInstanceVersion: "v0.52.10",
+ expected: true,
+ });
+ expectBundleAndInstanceCompatibility({
+ sdkBundleVersion: "v1.50.10",
+ metabaseInstanceVersion: "v1.51.10",
+ expected: false,
+ });
+ expectBundleAndInstanceCompatibility({
+ sdkBundleVersion: "v1.50.10",
+ metabaseInstanceVersion: "v0.53.10",
expected: false,
});
});
+
+ describe('should ignore "minors"', () => {
+ expectBundleAndInstanceCompatibility({
+ sdkBundleVersion: "v1.50.10",
+ metabaseInstanceVersion: "v0.50.11",
+ expected: true,
+ });
+
+ expectBundleAndInstanceCompatibility({
+ sdkBundleVersion: "v1.50.10",
+ metabaseInstanceVersion: "v0.50.9",
+ expected: true,
+ });
+ });
});
});