Skip to content

Add tinybird.config.json support #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manumartinm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add tinybird.config.json support #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions src/api/branches.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,38 @@ describe("Branch API client", () => {
);
});

it("uses last_partition=1 wire format when option is enabled", async () => {
const mockBranch = {
id: "branch-123",
name: "my-feature",
token: "p.branch-token",
created_at: "2024-01-01T00:00:00Z",
};

mockFetch.mockResolvedValueOnce({
ok: true,
json: () => Promise.resolve({
job: { id: "job-123", status: "waiting" },
workspace: { id: "ws-123" },
}),
});
mockFetch.mockResolvedValueOnce({
ok: true,
json: () => Promise.resolve({ id: "job-123", status: "done" }),
});
mockFetch.mockResolvedValueOnce({
ok: true,
json: () => Promise.resolve(mockBranch),
});

await createBranch(config, "my-feature", { lastPartition: true });

const [createUrl] = mockFetch.mock.calls[0];
const createParsed = expectFromParam(createUrl);
expect(createParsed.searchParams.get("name")).toBe("my-feature");
expect(createParsed.searchParams.get("last_partition")).toBe("1");
});

it("uses custom fetch when provided", async () => {
const customFetch = vi
.fn()
Expand Down
177 changes: 177 additions & 0 deletions src/cli/commands/build.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
import { runBuild } from "./build.js";
import { BranchDataOnCreate } from "../config-types.js";

// Mock all dependencies
vi.mock("../config.js", () => ({
Expand Down Expand Up @@ -64,6 +65,7 @@ describe("Build Command", () => {
gitBranch: "feature-test",
tinybirdBranch: "feature_test",
isMainBranch: false,
branchDataOnCreate: null,
});

vi.mocked(buildFromInclude).mockResolvedValue({
Expand Down Expand Up @@ -156,6 +158,7 @@ describe("Build Command", () => {
gitBranch: "feature-test",
tinybirdBranch: "feature_test",
isMainBranch: false,
branchDataOnCreate: null,
});

vi.mocked(buildFromInclude).mockResolvedValue({
Expand Down Expand Up @@ -242,6 +245,7 @@ describe("Build Command", () => {
gitBranch: "feature-test",
tinybirdBranch: "feature_test",
isMainBranch: false,
branchDataOnCreate: null,
});

vi.mocked(buildFromInclude).mockResolvedValue({
Expand Down Expand Up @@ -307,4 +311,177 @@ describe("Build Command", () => {
expect(getLocalTokens).toHaveBeenCalled();
});
});

describe("branch_data_on_create wiring", () => {
it("uses config-only last_partition when flag is absent", async () => {
const { loadConfigAsync } = await import("../config.js");
const { buildFromInclude } = await import("../../generator/index.js");
const { getOrCreateBranch } = await import("../../api/branches.js");
const { buildToTinybird } = await import("../../api/build.js");
const { getWorkspace } = await import("../../api/workspaces.js");
const { getBranchDashboardUrl } = await import("../../api/dashboard.js");

vi.mocked(loadConfigAsync).mockResolvedValue({
include: ["test.ts"],
token: "p.test-token",
baseUrl: "https://api.tinybird.co",
configPath: "/test/tinybird.config.json",
devMode: "branch",
cwd: "/test",
gitBranch: "feature-test",
tinybirdBranch: "feature_test",
isMainBranch: false,
branchDataOnCreate: BranchDataOnCreate.LAST_PARTITION,
});
vi.mocked(buildFromInclude).mockResolvedValue({
resources: { datasources: [], pipes: [], connections: [] },
entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
});
vi.mocked(getOrCreateBranch).mockResolvedValue({
id: "branch-id",
name: "feature_test",
token: "branch-token",
wasCreated: false,
created_at: "2024-01-01",
});
vi.mocked(getWorkspace).mockResolvedValue({
id: "ws-id",
name: "test-workspace",
user_id: "user-id",
user_email: "user@test.com",
scope: "USER",
main: null,
});
vi.mocked(getBranchDashboardUrl).mockReturnValue("https://app.tinybird.co/dashboard");
vi.mocked(buildToTinybird).mockResolvedValue({
success: true,
result: "success",
datasourceCount: 0,
pipeCount: 0,
connectionCount: 0,
});

await runBuild();
expect(getOrCreateBranch).toHaveBeenCalledWith(
expect.any(Object),
"feature_test",
{ lastPartition: true }
);
});

it("keeps CLI --last-partition precedence over config", async () => {
const { loadConfigAsync } = await import("../config.js");
const { buildFromInclude } = await import("../../generator/index.js");
const { getOrCreateBranch } = await import("../../api/branches.js");
const { buildToTinybird } = await import("../../api/build.js");
const { getWorkspace } = await import("../../api/workspaces.js");
const { getBranchDashboardUrl } = await import("../../api/dashboard.js");

vi.mocked(loadConfigAsync).mockResolvedValue({
include: ["test.ts"],
token: "p.test-token",
baseUrl: "https://api.tinybird.co",
configPath: "/test/tinybird.config.json",
devMode: "branch",
cwd: "/test",
gitBranch: "feature-test",
tinybirdBranch: "feature_test",
isMainBranch: false,
branchDataOnCreate: null,
});
vi.mocked(buildFromInclude).mockResolvedValue({
resources: { datasources: [], pipes: [], connections: [] },
entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
});
vi.mocked(getOrCreateBranch).mockResolvedValue({
id: "branch-id",
name: "feature_test",
token: "branch-token",
wasCreated: false,
created_at: "2024-01-01",
});
vi.mocked(getWorkspace).mockResolvedValue({
id: "ws-id",
name: "test-workspace",
user_id: "user-id",
user_email: "user@test.com",
scope: "USER",
main: null,
});
vi.mocked(getBranchDashboardUrl).mockReturnValue("https://app.tinybird.co/dashboard");
vi.mocked(buildToTinybird).mockResolvedValue({
success: true,
result: "success",
datasourceCount: 0,
pipeCount: 0,
connectionCount: 0,
});

await runBuild({ lastPartition: true });
expect(getOrCreateBranch).toHaveBeenCalledWith(
expect.any(Object),
"feature_test",
{ lastPartition: true }
);
});

it("ignores config branch_data_on_create in local mode", async () => {
const { loadConfigAsync } = await import("../config.js");
const { buildFromInclude } = await import("../../generator/index.js");
const { getOrCreateBranch } = await import("../../api/branches.js");
const { getLocalTokens, getOrCreateLocalWorkspace, getLocalWorkspaceName } = await import("../../api/local.js");
const { buildToTinybird } = await import("../../api/build.js");
const { getWorkspace } = await import("../../api/workspaces.js");
const { getLocalDashboardUrl } = await import("../../api/dashboard.js");

vi.mocked(loadConfigAsync).mockResolvedValue({
include: ["test.ts"],
token: "p.test-token",
baseUrl: "https://api.tinybird.co",
configPath: "/test/tinybird.config.json",
devMode: "local",
cwd: "/test",
gitBranch: "feature-test",
tinybirdBranch: "feature_test",
isMainBranch: false,
branchDataOnCreate: BranchDataOnCreate.LAST_PARTITION,
});
vi.mocked(buildFromInclude).mockResolvedValue({
resources: { datasources: [], pipes: [], connections: [] },
entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
});
vi.mocked(getLocalTokens).mockResolvedValue({
admin_token: "admin-token",
user_token: "user-token",
workspace_admin_token: "workspace-admin-token",
});
vi.mocked(getWorkspace).mockResolvedValue({
id: "ws-id",
name: "test-workspace",
user_id: "user-id",
user_email: "user@test.com",
scope: "USER",
main: null,
});
vi.mocked(getLocalWorkspaceName).mockReturnValue("feature_test_workspace");
vi.mocked(getOrCreateLocalWorkspace).mockResolvedValue({
workspace: { id: "local-ws-id", name: "feature_test_workspace", token: "local-token" },
wasCreated: false,
});
vi.mocked(getLocalDashboardUrl).mockReturnValue("http://localhost:7181/dashboard");
vi.mocked(buildToTinybird).mockResolvedValue({
success: true,
result: "success",
datasourceCount: 0,
pipeCount: 0,
connectionCount: 0,
});

await runBuild();
expect(getOrCreateBranch).not.toHaveBeenCalled();
});
});
});
6 changes: 5 additions & 1 deletion src/cli/commands/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*/

import { loadConfigAsync, LOCAL_BASE_URL, type ResolvedConfig, type DevMode } from "../config.js";
import { BranchDataOnCreate } from "../config-types.js";
import { buildFromInclude, type BuildFromIncludeResult } from "../../generator/index.js";
import { buildToTinybird, type BuildApiResult } from "../../api/build.js";
import { getOrCreateBranch } from "../../api/branches.js";
Expand Down Expand Up @@ -225,13 +226,16 @@ export async function runBuild(options: BuildCommandOptions = {}): Promise<Build
console.log(`[debug] Getting/creating Tinybird branch: ${config.tinybirdBranch}`);
}
try {
const lastPartitionFromConfig =
config.branchDataOnCreate === BranchDataOnCreate.LAST_PARTITION;
const lastPartitionFromFlag = Boolean(options.lastPartition);
const tinybirdBranch = await getOrCreateBranch(
{
baseUrl: config.baseUrl,
token: config.token,
},
config.tinybirdBranch!,
{ lastPartition: options.lastPartition }
{ lastPartition: lastPartitionFromFlag || lastPartitionFromConfig }
);

if (!tinybirdBranch.token) {
Expand Down
1 change: 1 addition & 0 deletions src/cli/commands/deploy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ describe("Deploy command", () => {
tinybirdBranch: "feature_pro_610",
isMainBranch: false,
devMode: "branch",
branchDataOnCreate: null,
});

vi.mocked(buildFromInclude).mockResolvedValue({
Expand Down
6 changes: 5 additions & 1 deletion src/cli/commands/dev.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
type ResolvedConfig,
type DevMode,
} from "../config.js";
import { BranchDataOnCreate } from "../config-types.js";
import { runBuild, type BuildCommandResult } from "./build.js";
import { getOrCreateBranch, type TinybirdBranch } from "../../api/branches.js";
import { browserLogin } from "../auth.js";
Expand Down Expand Up @@ -239,6 +240,9 @@ export async function runDev(
// Use tinybirdBranch (sanitized name) for Tinybird API, gitBranch for display
if (config.tinybirdBranch) {
const branchName = config.tinybirdBranch; // Sanitized name for Tinybird
const lastPartitionFromConfig =
config.branchDataOnCreate === BranchDataOnCreate.LAST_PARTITION;
const lastPartitionFromFlag = Boolean(options.lastPartition);

// Always fetch fresh from API to avoid stale cache issues
const tinybirdBranch = await getOrCreateBranch(
Expand All @@ -247,7 +251,7 @@ export async function runDev(
token: config.token,
},
branchName,
{ lastPartition: options.lastPartition }
{ lastPartition: lastPartitionFromFlag || lastPartitionFromConfig }
);

if (!tinybirdBranch.token) {
Expand Down
3 changes: 3 additions & 0 deletions src/cli/commands/generate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ describe("Generate command", () => {
tinybirdBranch: "feature_x",
isMainBranch: false,
devMode: "branch",
branchDataOnCreate: null,
});

vi.mocked(buildFromInclude).mockResolvedValue({
Expand Down Expand Up @@ -108,6 +109,7 @@ describe("Generate command", () => {
tinybirdBranch: "feature_x",
isMainBranch: false,
devMode: "branch",
branchDataOnCreate: null,
});

vi.mocked(buildFromInclude).mockResolvedValue({
Expand Down Expand Up @@ -167,6 +169,7 @@ describe("Generate command", () => {
tinybirdBranch: "feature_x",
isMainBranch: false,
devMode: "branch",
branchDataOnCreate: null,
});
vi.mocked(buildFromInclude).mockRejectedValue(
new Error("generator failed")
Expand Down
Loading
Loading