Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 13 additions & 9 deletions src/client/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import https from "node:https";
import { dirname, join } from "node:path";
import { fileURLToPath } from "node:url";

import axios, { AxiosInstance } from "axios";
import axios, { AxiosInstance, AxiosResponse } from "axios";
import { parse as csvParse } from "csv-parse/sync";
import { z } from "zod";

Expand Down Expand Up @@ -153,24 +153,28 @@ export class BaseIterableClient {

/**
* Parse CSV response into an array of objects using csv-parse library
* @throws IterableResponseValidationError if CSV parsing fails
*/
public parseCsv(data: string): any[] {
if (!data) {
public parseCsv(response: AxiosResponse<string>): Record<string, string>[] {
if (!response.data) {
return [];
}

try {
return csvParse(data, {
return csvParse(response.data, {
columns: true, // Use first line as headers
skip_empty_lines: true,
trim: true,
});
} catch (error) {
// Log error but don't throw - return empty array for graceful degradation
logger.warn("Failed to parse CSV data", {
error: error instanceof Error ? error.message : String(error),
});
return [];
// Throw validation error to maintain consistent error handling
// This allows callers to handle parse failures appropriately
throw new IterableResponseValidationError(
200,
response.data,
`CSV parse error: ${error instanceof Error ? error.message : String(error)}`,
response.config?.url
);
}
}

Expand Down
5 changes: 3 additions & 2 deletions src/client/campaigns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
ArchiveCampaignsParams,
ArchiveCampaignsResponse,
ArchiveCampaignsResponseSchema,
CampaignMetricsResponse,
CancelCampaignParams,
CreateCampaignParams,
CreateCampaignResponse,
Expand Down Expand Up @@ -111,7 +112,7 @@ export function Campaigns<T extends Constructor<BaseIterableClient>>(Base: T) {

async getCampaignMetrics(
options: GetCampaignMetricsParams
): Promise<any[]> {
): Promise<CampaignMetricsResponse> {
const params = new URLSearchParams();
params.append("campaignId", options.campaignId.toString());
if (options.startDateTime)
Expand All @@ -127,7 +128,7 @@ export function Campaigns<T extends Constructor<BaseIterableClient>>(Base: T) {
);

// Parse CSV response into array of objects
return this.parseCsv(response.data);
return this.parseCsv(response);
}

async scheduleCampaign(
Expand Down
2 changes: 1 addition & 1 deletion src/client/experiments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export function Experiments<T extends Constructor<BaseIterableClient>>(
});

// Parse CSV response into array of objects
return this.parseCsv(response.data);
return this.parseCsv(response);
}
};
}
7 changes: 6 additions & 1 deletion src/types/campaigns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ export type GetCampaignResponse = z.infer<typeof GetCampaignResponseSchema>;
export type GetCampaignMetricsParams = z.infer<
typeof GetCampaignMetricsParamsSchema
>;
export type CampaignMetricsResponse = z.infer<
typeof CampaignMetricsResponseSchema
>;
export type CreateCampaignParams = z.infer<typeof CreateCampaignParamsSchema>;
export type CreateCampaignResponse = z.infer<
typeof CreateCampaignResponseSchema
Expand All @@ -136,8 +139,10 @@ export const CampaignsResponseSchema = z.object({
campaigns: z.array(CampaignDetailsSchema),
});

// The API returns CSV data which we parse into objects
// All CSV values are strings
export const CampaignMetricsResponseSchema = z
.array(z.record(z.string(), z.any()))
.array(z.record(z.string(), z.string()))
.describe("Parsed campaign metrics data");

// Campaign creation schemas
Expand Down
2 changes: 1 addition & 1 deletion src/types/experiments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { IterableDateTimeSchema } from "./common.js";

// The API returns CSV data which we parse into objects
export const ExperimentMetricsResponseSchema = z
.array(z.record(z.string(), z.any()))
.array(z.record(z.string(), z.string()))
.describe("Parsed experiment metrics data");

export const GetExperimentMetricsParamsSchema = z
Expand Down
9 changes: 9 additions & 0 deletions tests/unit/campaigns.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,15 @@ describe("Campaign Management", () => {
{ responseType: "text" }
);
});

it("should throw IterableResponseValidationError for invalid CSV", async () => {
const mockResponse = { data: "invalid,csv\n\ndata" };
mockAxiosInstance.get.mockResolvedValue(mockResponse);

await expect(
client.getCampaignMetrics({ campaignId: 12345 })
).rejects.toThrow("CSV parse error");
});
});

describe("getChildCampaigns", () => {
Expand Down
9 changes: 9 additions & 0 deletions tests/unit/experiments.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,5 +217,14 @@ describe("Experiment Operations", () => {
expect(result).toEqual(expectedParsedData);
expect(Array.isArray(result)).toBe(true);
});

it("should throw IterableResponseValidationError for invalid CSV", async () => {
const mockResponse = { data: "invalid,csv\n\ndata" };
mockAxiosInstance.get.mockResolvedValue(mockResponse);

await expect(client.getExperimentMetrics()).rejects.toThrow(
"CSV parse error"
);
});
});
});
Loading