Add a format:json (default) to seed_type fetch.

This is effectively a workaround for json template extraction being broken (#59).

Part of #45.

README.md

@@ -495,12 +495,13 @@ Environment:
 
 #### fetch
 
-Fetches a remote resource and returns the text of the resoponse. You can extract the JSON of the response using the `extract` seed_type with the template `{{data|json}}`.
+Fetches a remote resource and returns the text of the resoponse.
 
 Parameters:
 - `resource` - The URL of the resource to fetch
 - `method` - (optional) the HTTP method (GET or PUT). Defaults to GET
 - `body` - (optional) the body to provide in the resource if it is not a GET method.
+- `format` - (optional) whehter the result should be parsed as json or left as text. Values are `json` (default) and `text`.
 
 Environment:
 - `mock` - If true, will return a string representation of the request that would have been sent.

seed-schema.json

@@ -1873,6 +1873,31 @@
 									"description": "The body to pass"
 								}
 							]
+						},
+						"format": {
+							"anyOf": [
+								{
+									"$ref": "#/definitions/seedData"
+								},
+								{
+									"$ref": "#/definitions/seedData/anyOf/0/properties/prompt/anyOf/1"
+								},
+								{
+									"anyOf": [
+										{
+											"not": {}
+										},
+										{
+											"type": "string",
+											"enum": [
+												"json",
+												"text"
+											]
+										}
+									],
+									"description": "The format of the result, default json"
+								}
+							]
 						}
 					},
 					"required": [

src/grow.ts

@@ -52,11 +52,13 @@ import {
 	SeedDataSplit,
 	SeedDataJoin,
 	SeedDataFetch,
-	fetchMethod
+	fetchMethod,
+	fetchFormat
 } from './types.js';
 
 import {
-	assertUnreachable, getObjectProperty, mockedResult
+	assertUnreachable,
+	getObjectProperty
 } from './util.js';
 
 import {
@@ -433,33 +435,48 @@ const growFetch = async (seed : Seed<SeedDataFetch>, env : Environment) : Promis
 	let body = null;
 	if (method != 'GET') body = extractString(await getProperty(seed, env, data.body, ''));
 
+	const rawFormat = extractString(await getProperty(seed, env, data.format, 'json'));
+	const format = fetchFormat.parse(rawFormat.toLowerCase().trim());
+
 	if (!isLocalLocation(seed.location)) {
 		const domain = locationDomain(resource);
 		const allowFetch = await seed.garden.profile.allowFetch(seed.location, domain);
 		if (!allowFetch) throw new Error(`User did not allow fetch from ${seed.location} to ${domain}`);
 	}
 
+	let result = '';
+
 	if (env.getKnownProtectedKey('mock')) {
 		const data = {
+			mock: true,
 			resource,
 			method,
-			body
+			body,
+			format
 		};
-		return mockedResult(JSON.stringify(data, null, '\t'));
+		result = JSON.stringify(data);
+	} else if (isLocalLocation(resource)) {
+		//If it's a local fetch then use the localFetch machinery.
+		//TODO: this logic will be wrong in cases where it's hosted on a domain
+		result = await seed.garden.profile.localFetch(resource);
+	} else {
+		const fetchResult = await fetch(resource, {
+			method,
+			body
+		});
+		if (!fetchResult.ok) throw new Error(`Result status was not ok: ${fetchResult.status}: ${fetchResult.statusText}`);
+		result = await fetchResult.text();
 	}
-
-	//If it's a local fetch then use the localFetch machinery.
-	//TODO: this logic will be wrong in cases where it's hosted on a domain
-	if (isLocalLocation(resource)) {
-		return seed.garden.profile.localFetch(resource);
+	switch(format) {
+	case 'json':
+		return JSON.parse(result);
+	case 'text':
+		return result;
+	default:
+		assertUnreachable(format);
 	}
+	return result;
 
-	const result = await fetch(resource, {
-		method,
-		body
-	});
-	if (!result.ok) throw new Error(`Result status was not ok: ${result.status}: ${result.statusText}`);
-	return result.text();
 };
 
 const growProperty = async (seed : Seed<SeedDataProperty>, env : Environment) : Promise<Value> => {

src/types.ts

@@ -700,12 +700,20 @@ export const fetchMethod = z.union([
 
 export type FetchMethod = z.infer<typeof fetchMethod>;
 
+export const fetchFormat = z.union([
+	z.literal('json'),
+	z.literal('text')
+]);
+
+export type FetchFormat = z.infer<typeof fetchFormat>;
+
 const seedDataConfigFetch = {
 	type: z.literal('fetch'),
 	properties: {
 		resource: seedPacketLocation.describe('The URL of the resource to fetch'),
 		method: fetchMethod.optional().describe('The method (default GET)'),
-		body: z.string().optional().describe('The body to pass')
+		body: z.string().optional().describe('The body to pass'),
+		format: fetchFormat.optional().describe('The format of the result, default json')
 	}
 };
 

test/base/test.ts

@@ -932,12 +932,14 @@ Suffix`;
 		const garden = loadTestGarden();
 		const seed = await garden.seed('fetch-test');
 		const actual = await seed.grow();
-		const golden = `Mocked result: {
-	"resource": "https://raw.githubusercontent.com/jkomoros/prompt-garden/main/seeds/example-basic.json",
-	"method": "POST",
-	"body": ""
-}`;
-		assert.deepStrictEqual(actual, golden);
+		const golden = {
+			'mock': true,
+			'format': 'json',
+			'resource': 'https://raw.githubusercontent.com/jkomoros/prompt-garden/main/seeds/example-basic.json',
+			'method': 'POST',
+			'body': ''
+		};
+		assert.deepStrictEqual(actual,golden);
 	});
 
 });