Merge pull request #6047 from continuedev/pe/onboarding-card-refactor

feat: onboarding card upgrade tab

Author: RomneyDa

core/config/usesFreeTrialApiKey.test.ts

@@ -0,0 +1,344 @@
+import { jest } from "@jest/globals";
+import { BrowserSerializedContinueConfig } from "..";
+
+// Create the mock before importing anything else
+const mockDecodeSecretLocation = jest.fn();
+
+// Mock the module
+jest.unstable_mockModule("@continuedev/config-yaml", () => ({
+  SecretType: {
+    User: "user",
+    Organization: "organization",
+    FreeTrial: "free_trial",
+  },
+  decodeSecretLocation: mockDecodeSecretLocation,
+}));
+
+// Import after mocking
+const { usesFreeTrialApiKey } = await import("./usesFreeTrialApiKey");
+const { SecretType } = await import("@continuedev/config-yaml");
+
+beforeEach(() => {
+  mockDecodeSecretLocation.mockReset();
+});
+
+test("usesFreeTrialApiKey should return false when config is null", () => {
+  const result = usesFreeTrialApiKey(null);
+  expect(result).toBe(false);
+});
+
+test("usesFreeTrialApiKey should return false when config is undefined", () => {
+  const result = usesFreeTrialApiKey(undefined as any);
+  expect(result).toBe(false);
+});
+
+test("usesFreeTrialApiKey should return false when no models have apiKeyLocation", () => {
+  const config: BrowserSerializedContinueConfig = {
+    modelsByRole: {
+      chat: [
+        {
+          title: "Model 1",
+          provider: "test",
+          model: "test-model",
+          underlyingProviderName: "test",
+        },
+        {
+          title: "Model 2",
+          provider: "test",
+          model: "test-model-2",
+          underlyingProviderName: "test",
+        },
+      ],
+      edit: [],
+      apply: [],
+      summarize: [],
+      autocomplete: [],
+      rerank: [],
+      embed: [],
+    },
+    selectedModelByRole: {
+      chat: null,
+      edit: null,
+      apply: null,
+      summarize: null,
+      autocomplete: null,
+      rerank: null,
+      embed: null,
+    },
+    contextProviders: [],
+    slashCommands: [],
+    tools: [],
+    mcpServerStatuses: [],
+    usePlatform: false,
+    rules: [],
+  };
+
+  const result = usesFreeTrialApiKey(config);
+  expect(result).toBe(false);
+});
+
+test("usesFreeTrialApiKey should return false when models have apiKeyLocation but none are free trial", () => {
+  const config: BrowserSerializedContinueConfig = {
+    modelsByRole: {
+      chat: [
+        {
+          title: "Model 1",
+          provider: "test",
+          model: "test-model",
+          apiKeyLocation: "user:testuser/api-key",
+          underlyingProviderName: "test",
+        },
+      ],
+      edit: [
+        {
+          title: "Model 2",
+          provider: "test",
+          model: "test-model-2",
+          apiKeyLocation: "organization:testorg/api-key",
+          underlyingProviderName: "test",
+        },
+      ],
+      apply: [],
+      summarize: [],
+      autocomplete: [],
+      rerank: [],
+      embed: [],
+    },
+    selectedModelByRole: {
+      chat: null,
+      edit: null,
+      apply: null,
+      summarize: null,
+      autocomplete: null,
+      rerank: null,
+      embed: null,
+    },
+    contextProviders: [],
+    slashCommands: [],
+    tools: [],
+    mcpServerStatuses: [],
+    usePlatform: false,
+    rules: [],
+  };
+
+  mockDecodeSecretLocation
+    .mockReturnValueOnce({
+      secretType: SecretType.User,
+      userSlug: "testuser",
+      secretName: "api-key",
+    })
+    .mockReturnValueOnce({
+      secretType: SecretType.Organization,
+      orgSlug: "testorg",
+      secretName: "api-key",
+    });
+
+  const result = usesFreeTrialApiKey(config);
+  expect(result).toBe(false);
+  expect(mockDecodeSecretLocation).toHaveBeenCalledTimes(2);
+});
+
+test("usesFreeTrialApiKey should return true when at least one model uses free trial API key", () => {
+  const config: BrowserSerializedContinueConfig = {
+    modelsByRole: {
+      chat: [
+        {
+          title: "Model 1",
+          provider: "test",
+          model: "test-model",
+          apiKeyLocation: "user:testuser/api-key",
+          underlyingProviderName: "test",
+        },
+        {
+          title: "Free Trial Model",
+          provider: "test",
+          model: "free-trial-model",
+          apiKeyLocation: "free_trial:owner/package/api-key",
+          underlyingProviderName: "test",
+        },
+      ],
+      edit: [],
+      apply: [],
+      summarize: [],
+      autocomplete: [],
+      rerank: [],
+      embed: [],
+    },
+    selectedModelByRole: {
+      chat: null,
+      edit: null,
+      apply: null,
+      summarize: null,
+      autocomplete: null,
+      rerank: null,
+      embed: null,
+    },
+    contextProviders: [],
+    slashCommands: [],
+    tools: [],
+    mcpServerStatuses: [],
+    usePlatform: false,
+    rules: [],
+  };
+
+  mockDecodeSecretLocation
+    .mockReturnValueOnce({
+      secretType: SecretType.User,
+      userSlug: "testuser",
+      secretName: "api-key",
+    })
+    .mockReturnValueOnce({
+      secretType: SecretType.FreeTrial,
+      blockSlug: { ownerSlug: "owner", packageSlug: "package" },
+      secretName: "api-key",
+    });
+
+  const result = usesFreeTrialApiKey(config);
+  expect(result).toBe(true);
+  expect(mockDecodeSecretLocation).toHaveBeenCalledTimes(2);
+});
+
+test("usesFreeTrialApiKey should return true when free trial model is in a different role", () => {
+  const config: BrowserSerializedContinueConfig = {
+    modelsByRole: {
+      chat: [
+        {
+          title: "Model 1",
+          provider: "test",
+          model: "test-model",
+          apiKeyLocation: "user:testuser/api-key",
+          underlyingProviderName: "test",
+        },
+      ],
+      edit: [
+        {
+          title: "Free Trial Edit Model",
+          provider: "test",
+          model: "free-trial-edit-model",
+          apiKeyLocation: "free_trial:owner/package/api-key",
+          underlyingProviderName: "test",
+        },
+      ],
+      apply: [],
+      summarize: [],
+      autocomplete: [],
+      rerank: [],
+      embed: [],
+    },
+    selectedModelByRole: {
+      chat: null,
+      edit: null,
+      apply: null,
+      summarize: null,
+      autocomplete: null,
+      rerank: null,
+      embed: null,
+    },
+    contextProviders: [],
+    slashCommands: [],
+    tools: [],
+    mcpServerStatuses: [],
+    usePlatform: false,
+    rules: [],
+  };
+
+  mockDecodeSecretLocation
+    .mockReturnValueOnce({
+      secretType: SecretType.User,
+      userSlug: "testuser",
+      secretName: "api-key",
+    })
+    .mockReturnValueOnce({
+      secretType: SecretType.FreeTrial,
+      blockSlug: { ownerSlug: "owner", packageSlug: "package" },
+      secretName: "api-key",
+    });
+
+  const result = usesFreeTrialApiKey(config);
+  expect(result).toBe(true);
+});
+
+test("usesFreeTrialApiKey should return false and log error when decodeSecretLocation throws", () => {
+  const consoleSpy = jest.spyOn(console, "error").mockImplementation(() => {});
+
+  const config: BrowserSerializedContinueConfig = {
+    modelsByRole: {
+      chat: [
+        {
+          title: "Model 1",
+          provider: "test",
+          model: "test-model",
+          apiKeyLocation: "invalid-secret-location",
+          underlyingProviderName: "test",
+        },
+      ],
+      edit: [],
+      apply: [],
+      summarize: [],
+      autocomplete: [],
+      rerank: [],
+      embed: [],
+    },
+    selectedModelByRole: {
+      chat: null,
+      edit: null,
+      apply: null,
+      summarize: null,
+      autocomplete: null,
+      rerank: null,
+      embed: null,
+    },
+    contextProviders: [],
+    slashCommands: [],
+    tools: [],
+    mcpServerStatuses: [],
+    usePlatform: false,
+    rules: [],
+  };
+
+  mockDecodeSecretLocation.mockImplementation(() => {
+    throw new Error("Invalid secret location format");
+  });
+
+  const result = usesFreeTrialApiKey(config);
+  expect(result).toBe(false);
+  expect(consoleSpy).toHaveBeenCalledWith(
+    "Error checking for free trial API key:",
+    expect.any(Error),
+  );
+
+  consoleSpy.mockRestore();
+});
+
+test("usesFreeTrialApiKey should handle empty modelsByRole object", () => {
+  const config: BrowserSerializedContinueConfig = {
+    modelsByRole: {
+      chat: [],
+      edit: [],
+      apply: [],
+      summarize: [],
+      autocomplete: [],
+      rerank: [],
+      embed: [],
+    },
+    selectedModelByRole: {
+      chat: null,
+      edit: null,
+      apply: null,
+      summarize: null,
+      autocomplete: null,
+      rerank: null,
+      embed: null,
+    },
+    contextProviders: [],
+    slashCommands: [],
+    tools: [],
+    mcpServerStatuses: [],
+    usePlatform: false,
+    rules: [],
+  };
+
+  const result = usesFreeTrialApiKey(config);
+  expect(result).toBe(false);
+  expect(mockDecodeSecretLocation).not.toHaveBeenCalled();
+});

gui/src/util/freeTrialHelpers.ts renamed to core/config/usesFreeTrialApiKey.ts

@@ -1,5 +1,6 @@
 import { decodeSecretLocation, SecretType } from "@continuedev/config-yaml";
-import { BrowserSerializedContinueConfig } from "core";
+import { BrowserSerializedContinueConfig } from "..";
+
 /**
  * Helper function to determine if the config uses a free trial API key
  * @param config The serialized config object

core/control-plane/client.ts

@@ -182,4 +182,38 @@ export class ControlPlaneClient {
       return null;
     }
   }
+
+  /**
+   * JetBrains does not support deep links, so we only check for `vsCodeUriScheme`
+   * @param vsCodeUriScheme
+   * @returns
+   */
+  public async getModelsAddOnCheckoutUrl(
+    vsCodeUriScheme?: string,
+  ): Promise<{ url: string } | null> {
+    if (!(await this.isSignedIn())) {
+      return null;
+    }
+
+    try {
+      const params = new URLSearchParams({
+        // LocalProfileLoader ID
+        profile_id: "local",
+      });
+
+      if (vsCodeUriScheme) {
+        params.set("vscode_uri_scheme", vsCodeUriScheme);
+      }
+
+      const resp = await this.request(
+        `ide/get-models-add-on-checkout-url?${params.toString()}`,
+        {
+          method: "GET",
+        },
+      );
+      return (await resp.json()) as { url: string };
+    } catch (e) {
+      return null;
+    }
+  }
 }