Skip to content

Fix Google Discovery SDK typed boundaries #648

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

Closed
RhysSullivan wants to merge 1 commit into from
+243 −239
Closed

Fix Google Discovery SDK typed boundaries #648

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
111 changes: 44 additions & 67 deletions packages/plugins/google-discovery/src/sdk/binding-store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,9 @@
// survive adapter serialization.
// ---------------------------------------------------------------------------

import { Effect, Schema } from "effect";
import { Effect, Option, Schema } from "effect";

import {
defineSchema,
type StorageDeps,
type StorageFailure,
} from "@executor-js/sdk/core";
import { defineSchema, type StorageDeps, type StorageFailure } from "@executor-js/sdk/core";

import {
GoogleDiscoveryMethodBinding,
Expand Down Expand Up @@ -136,14 +132,12 @@ const decodeBinding = Schema.decodeUnknownSync(GoogleDiscoveryMethodBinding);

const toJsonRecord = (value: unknown): Record<string, unknown> => value as Record<string, unknown>;

const decodeJsonString = Schema.decodeUnknownOption(Schema.fromJsonString(Schema.Unknown));

const decodeJson = (value: unknown): unknown => {
if (value === null || value === undefined) return value;
if (typeof value !== "string") return value;
try {
return JSON.parse(value);
} catch {
return value;
}
return Option.getOrElse(decodeJsonString(value), () => value);
};

// --- auth column packing/unpacking ------------------------------------------
Expand Down Expand Up @@ -239,12 +233,11 @@ const rowsToValueMap = (
): Record<string, GoogleDiscoveryCredentialValue> => {
const out: Record<string, GoogleDiscoveryCredentialValue> = {};
for (const row of rows) {
const name = row.name as string;
if (typeof row.name !== "string") continue;
const name = row.name;
if (row.kind === "secret" && typeof row.secret_id === "string") {
const prefix = row.secret_prefix as string | undefined | null;
out[name] = prefix
? { secretId: row.secret_id, prefix }
: { secretId: row.secret_id };
out[name] = prefix ? { secretId: row.secret_id, prefix } : { secretId: row.secret_id };
} else if (row.kind === "text" && typeof row.text_value === "string") {
out[name] = row.text_value;
}
Expand Down Expand Up @@ -277,7 +270,10 @@ export interface GoogleDiscoveryStore {
toolId: string,
scope: string,
) => Effect.Effect<
{ readonly namespace: string; readonly binding: GoogleDiscoveryMethodBinding } | null,
{
readonly namespace: string;
readonly binding: GoogleDiscoveryMethodBinding;
} | null,
StorageFailure
>;
readonly putBinding: (
Expand Down Expand Up @@ -320,9 +316,7 @@ export interface GoogleDiscoveryStore {

/** Source rows whose oauth2 auth columns reference the given secret id.
* `slot` distinguishes client_id vs client_secret. */
readonly findSourcesBySecret: (
secretId: string,
) => Effect.Effect<
readonly findSourcesBySecret: (secretId: string) => Effect.Effect<
readonly {
readonly namespace: string;
readonly scope_id: string;
Expand All @@ -333,9 +327,7 @@ export interface GoogleDiscoveryStore {
>;

/** Source rows whose oauth2 auth points at the given connection id. */
readonly findSourcesByConnection: (
connectionId: string,
) => Effect.Effect<
readonly findSourcesByConnection: (connectionId: string) => Effect.Effect<
readonly {
readonly namespace: string;
readonly scope_id: string;
Expand Down Expand Up @@ -382,7 +374,7 @@ export const makeGoogleDiscoveryStore = (
});
if (!row) return null;
const decoded = decodeBinding(decodeJson(row.binding));
return { namespace: row.source_id as string, binding: decoded };
return { namespace: row.source_id, binding: decoded };
}),

putBinding: (toolId, sourceId, scope, binding) =>
Expand Down Expand Up @@ -420,7 +412,7 @@ export const makeGoogleDiscoveryStore = (
{ field: "scope_id", value: scope },
],
});
const ids = rows.map((r) => r.id as string);
const ids = rows.map((r) => r.id);
yield* db.deleteMany({
model: "google_discovery_binding",
where: [
Expand All @@ -442,7 +434,7 @@ export const makeGoogleDiscoveryStore = (
});
const out = new Map<string, GoogleDiscoveryMethodBinding>();
for (const row of rows) {
out.set(row.id as string, decodeBinding(decodeJson(row.binding)));
out.set(row.id, decodeBinding(decodeJson(row.binding)));
}
return out;
}),
Expand Down Expand Up @@ -477,11 +469,7 @@ export const makeGoogleDiscoveryStore = (
},
forceAllowId: true,
});
yield* writeCredentialRows(
source.namespace,
source.scope,
source.config.credentials,
);
yield* writeCredentialRows(source.namespace, source.scope, source.config.credentials);
}),

updateSourceMeta: (sourceId, scope, update) =>
Expand All @@ -502,7 +490,7 @@ export const makeGoogleDiscoveryStore = (
{ field: "scope_id", value: scope },
],
update: {
name: update.name ?? (row.name as string),
name: update.name ?? row.name,
updated_at: new Date(),
...authToColumns(auth),
},
Expand Down Expand Up @@ -532,9 +520,9 @@ export const makeGoogleDiscoveryStore = (
});
if (!row) return null;
return {
namespace: row.id as string,
scope: row.scope_id as string,
name: row.name as string,
namespace: row.id,
scope: row.scope_id,
name: row.name,
config: yield* hydrateStoredSourceData(row, sourceId, scope),
};
}),
Expand All @@ -558,15 +546,11 @@ export const makeGoogleDiscoveryStore = (
[
db.findMany({
model: "google_discovery_source",
where: [
{ field: "auth_client_id_secret_id", value: secretId },
],
where: [{ field: "auth_client_id_secret_id", value: secretId }],
}),
db.findMany({
model: "google_discovery_source",
where: [
{ field: "auth_client_secret_secret_id", value: secretId },
],
where: [{ field: "auth_client_secret_secret_id", value: secretId }],
}),
],
{ concurrency: "unbounded" },
Expand All @@ -579,17 +563,17 @@ export const makeGoogleDiscoveryStore = (
}[] = [];
for (const r of byClientId) {
out.push({
namespace: r.id as string,
scope_id: r.scope_id as string,
name: r.name as string,
namespace: r.id,
scope_id: r.scope_id,
name: r.name,
slot: "auth.oauth2.client_id",
});
}
for (const r of byClientSecret) {
out.push({
namespace: r.id as string,
scope_id: r.scope_id as string,
name: r.name as string,
namespace: r.id,
scope_id: r.scope_id,
name: r.name,
slot: "auth.oauth2.client_secret",
});
}
Expand All @@ -605,9 +589,9 @@ export const makeGoogleDiscoveryStore = (
.pipe(
Effect.map((rows) =>
rows.map((r) => ({
namespace: r.id as string,
scope_id: r.scope_id as string,
name: r.name as string,
namespace: r.id,
scope_id: r.scope_id,
name: r.name,
slot: "auth.oauth2.connection",
})),
),
Expand All @@ -631,15 +615,15 @@ export const makeGoogleDiscoveryStore = (
return [
...headers.map((r) => ({
kind: "credential_header" as const,
source_id: r.source_id as string,
scope_id: r.scope_id as string,
name: r.name as string,
source_id: r.source_id,
scope_id: r.scope_id,
name: r.name,
})),
...params.map((r) => ({
kind: "credential_query_param" as const,
source_id: r.source_id as string,
scope_id: r.scope_id as string,
name: r.name as string,
source_id: r.source_id,
scope_id: r.scope_id,
name: r.name,
})),
];
}),
Expand All @@ -651,8 +635,8 @@ export const makeGoogleDiscoveryStore = (
const requested = new Set(keys);
const out = new Map<string, string>();
for (const r of rows) {
const key = `${r.scope_id as string}:${r.id as string}`;
if (requested.has(key)) out.set(key, r.name as string);
const key = `${r.scope_id}:${r.id}`;
if (requested.has(key)) out.set(key, r.name);
}
return out;
}),
Expand Down Expand Up @@ -698,11 +682,7 @@ export const makeGoogleDiscoveryStore = (
forceAllowId: true,
});
}
const paramRows = valueMapToRows(
sourceId,
scope,
credentials.queryParams,
);
const paramRows = valueMapToRows(sourceId, scope, credentials.queryParams);
if (paramRows.length > 0) {
yield* db.createMany({
model: "google_discovery_source_credential_query_param",
Expand Down Expand Up @@ -737,8 +717,7 @@ export const makeGoogleDiscoveryStore = (
const headers = rowsToValueMap(headerRows);
const queryParams = rowsToValueMap(paramRows);
const credentials =
Object.keys(headers).length === 0 &&
Object.keys(queryParams).length === 0
Object.keys(headers).length === 0 && Object.keys(queryParams).length === 0
? undefined
: {
...(Object.keys(headers).length > 0 ? { headers } : {}),
Expand All @@ -757,9 +736,7 @@ export const makeGoogleDiscoveryStore = (
// Strip auth/credentials from the encoded source-data shape. Those
// moved to columns and child tables; the remaining structural fields
// live in the `config` JSON.
const stripExtractedFields = (
encoded: Record<string, unknown>,
): Record<string, unknown> => {
const stripExtractedFields = (encoded: Record<string, unknown>): Record<string, unknown> => {
const { auth, credentials, ...rest } = encoded;
void auth;
void credentials;
Expand Down
74 changes: 44 additions & 30 deletions packages/plugins/google-discovery/src/sdk/invoke.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Effect, Layer, Option } from "effect";
import { Effect, Layer, Option, Schema } from "effect";
import { FetchHttpClient, HttpClient, HttpClientRequest } from "effect/unstable/http";

import type { PluginCtx, StorageFailure } from "@executor-js/sdk/core";
Expand All @@ -13,6 +13,16 @@ import {

const SAFE_METHODS = new Set(["get", "head", "options"]);

const UnknownErrorMessage = Schema.Struct({ message: Schema.String });
const decodeUnknownErrorMessage = Schema.decodeUnknownOption(UnknownErrorMessage);

const errorMessageFromUnknown = (cause: unknown): string => {
const decoded = decodeUnknownErrorMessage(cause);
if (Option.isSome(decoded)) return decoded.value.message;
// oxlint-disable-next-line executor/no-unknown-error-message -- boundary: preserves existing fallback text for HTTP client errors
return String(cause);
};

export const annotationsForOperation = (
method: string,
pathTemplate: string,
Expand Down Expand Up @@ -46,19 +56,27 @@ const replacePathParameters = (input: {
pathTemplate: string;
args: Record<string, unknown>;
parameters: readonly GoogleDiscoveryParameter[];
}): string =>
input.pathTemplate.replaceAll(/\{([^}]+)\}/g, (_, name: string) => {
const parameter = input.parameters.find(
(entry) => entry.location === "path" && entry.name === name,
);
const values = stringValuesFromParameter(input.args[name], false);
if (values.length === 0) {
if (parameter?.required) {
throw new Error(`Missing required path parameter: ${name}`);
}): Effect.Effect<string, GoogleDiscoveryInvocationError> =>
Effect.gen(function* () {
let failure: GoogleDiscoveryInvocationError | undefined;
const resolved = input.pathTemplate.replaceAll(/\{([^}]+)\}/g, (_, name: string) => {
const parameter = input.parameters.find(
(entry) => entry.location === "path" && entry.name === name,
);
const values = stringValuesFromParameter(input.args[name], false);
if (values.length === 0) {
if (parameter?.required) {
failure = new GoogleDiscoveryInvocationError({
message: `Missing required path parameter: ${name}`,
statusCode: Option.none(),
});
}
return "";
}
return "";
}
return encodeURIComponent(values[0]!);
return encodeURIComponent(values[0]!);
});
if (failure) return yield* failure;
return resolved;
});

const resolveBaseUrl = (source: GoogleDiscoveryStoredSourceData): string =>
Expand Down Expand Up @@ -87,7 +105,7 @@ const performRequest = Effect.fn("GoogleDiscovery.invoke")(function* (input: {
}) {
const client = yield* HttpClient.HttpClient;

const resolvedPath = replacePathParameters({
const resolvedPath = yield* replacePathParameters({
pathTemplate: input.pathTemplate,
args: input.args,
parameters: input.parameters,
Expand Down Expand Up @@ -138,7 +156,7 @@ const performRequest = Effect.fn("GoogleDiscovery.invoke")(function* (input: {
Effect.mapError(
(err) =>
new GoogleDiscoveryInvocationError({
message: `HTTP request failed: ${err.message}`,
message: `HTTP request failed: ${errorMessageFromUnknown(err)}`,
statusCode: Option.none(),
cause: err,
}),
Expand All @@ -147,9 +165,9 @@ const performRequest = Effect.fn("GoogleDiscovery.invoke")(function* (input: {

const contentType = response.headers["content-type"] ?? null;
const mapBodyError = Effect.mapError(
(err: { readonly message?: string }) =>
(err: unknown) =>
new GoogleDiscoveryInvocationError({
message: `Failed to read response body: ${err.message ?? String(err)}`,
message: `Failed to read response body: ${errorMessageFromUnknown(err)}`,
statusCode: Option.some(response.status),
cause: err,
}),
Expand Down Expand Up @@ -191,21 +209,17 @@ export const invokeGoogleDiscoveryTool = (input: {
Effect.gen(function* () {
const entry = yield* input.ctx.storage.getBinding(input.toolId, input.toolScope);
if (!entry) {
return yield* Effect.fail(
new GoogleDiscoveryInvocationError({
message: `No Google Discovery operation found for tool "${input.toolId}"`,
statusCode: Option.none(),
}),
);
return yield* new GoogleDiscoveryInvocationError({
message: `No Google Discovery operation found for tool "${input.toolId}"`,
statusCode: Option.none(),
});
}
const stored = yield* input.ctx.storage.getSource(entry.namespace, input.toolScope);
if (!stored) {
return yield* Effect.fail(
new GoogleDiscoveryInvocationError({
message: `No Google Discovery source found for "${entry.namespace}"`,
statusCode: Option.none(),
}),
);
return yield* new GoogleDiscoveryInvocationError({
message: `No Google Discovery source found for "${entry.namespace}"`,
statusCode: Option.none(),
});
}
const source = stored.config;

Expand All @@ -215,7 +229,7 @@ export const invokeGoogleDiscoveryTool = (input: {
Effect.mapError(
(err) =>
new GoogleDiscoveryOAuthError({
message: "message" in err ? (err as { message: string }).message : String(err),
message: errorMessageFromUnknown(err),
}),
),
)}`
Expand Down
Loading
Loading