Skip to content

Commit 5944bad

Browse files
juliusmarmingecodex
andcommitted
Redact managed relay endpoint mismatches
Co-authored-by: codex <[email protected]>
1 parent 55ec0fa commit 5944bad

2 files changed

Lines changed: 117 additions & 4 deletions

File tree

‎packages/client-runtime/src/relay/managedRelayState.test.ts‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import {
1919
createManagedRelaySession,
2020
managedRelayAccountChanges,
2121
ManagedRelaySessionUnavailableError,
22+
ManagedRelayStatusEndpointMismatchError,
2223
ManagedRelayStatusEnvironmentMismatchError,
2324
ManagedRelayTokenReadError,
2425
ManagedRelayTokenUnavailableError,
@@ -114,6 +115,65 @@ function clerkToken(expiresAtSeconds: number): string {
114115
describe("createManagedRelayQueryManager", () => {
115116
afterEach(resetRegistry);
116117

118+
it("redacts endpoint mismatch secrets while retaining correlation fields", () => {
119+
const expectedHttpBaseUrl =
120+
"https://expected-user:[email protected]/private/catalog?token=expected-secret#expected-fragment";
121+
const expectedWsBaseUrl =
122+
"wss://expected-user:[email protected]/private/socket?token=expected-secret#expected-fragment";
123+
const actualHttpBaseUrl =
124+
"https://actual-user:[email protected]/private/catalog?token=actual-secret#actual-fragment";
125+
const actualWsBaseUrl =
126+
"wss://actual-user:[email protected]/private/socket?token=actual-secret#actual-fragment";
127+
128+
const error = ManagedRelayStatusEndpointMismatchError.fromEndpoints({
129+
environmentId: environment.environmentId,
130+
expectedEndpoint: {
131+
providerKind: "cloudflare_tunnel",
132+
httpBaseUrl: expectedHttpBaseUrl,
133+
wsBaseUrl: expectedWsBaseUrl,
134+
},
135+
actualEndpoint: {
136+
providerKind: "cloudflare_tunnel",
137+
httpBaseUrl: actualHttpBaseUrl,
138+
wsBaseUrl: actualWsBaseUrl,
139+
},
140+
});
141+
142+
expect(error).toMatchObject({
143+
expectedProviderKind: "cloudflare_tunnel",
144+
expectedHttpBaseUrlInputLength: expectedHttpBaseUrl.length,
145+
expectedHttpBaseUrlProtocol: "https:",
146+
expectedHttpBaseUrlHostname: "expected.example.test",
147+
expectedWsBaseUrlInputLength: expectedWsBaseUrl.length,
148+
expectedWsBaseUrlProtocol: "wss:",
149+
expectedWsBaseUrlHostname: "expected.example.test",
150+
actualProviderKind: "cloudflare_tunnel",
151+
actualHttpBaseUrlInputLength: actualHttpBaseUrl.length,
152+
actualHttpBaseUrlProtocol: "https:",
153+
actualHttpBaseUrlHostname: "actual.example.test",
154+
actualWsBaseUrlInputLength: actualWsBaseUrl.length,
155+
actualWsBaseUrlProtocol: "wss:",
156+
actualWsBaseUrlHostname: "actual.example.test",
157+
});
158+
expect(error).not.toHaveProperty("expectedEndpoint");
159+
expect(error).not.toHaveProperty("actualEndpoint");
160+
const exposedText = `${Object.values(error).join(" ")} ${error.message}`;
161+
for (const secret of [
162+
"expected-user",
163+
"expected-password",
164+
"/private/catalog",
165+
"/private/socket",
166+
"expected-secret",
167+
"expected-fragment",
168+
"actual-user",
169+
"actual-password",
170+
"actual-secret",
171+
"actual-fragment",
172+
]) {
173+
expect(exposedText).not.toContain(secret);
174+
}
175+
});
176+
117177
it.effect("waits for the current cloud session before reading its token", () =>
118178
Effect.gen(function* () {
119179
const tokenFiber = yield* waitForManagedRelayClerkToken(registry).pipe(Effect.forkChild);

‎packages/client-runtime/src/relay/managedRelayState.ts‎

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ import { EnvironmentId } from "@t3tools/contracts";
66
import {
77
RelayEnvironmentConnectScope,
88
RelayEnvironmentStatusScope,
9-
RelayManagedEndpoint,
9+
RelayManagedEndpointProviderKind,
1010
} from "@t3tools/contracts/relay";
1111
import { decodeRelayJwt } from "@t3tools/shared/relayJwt";
12+
import { getUrlDiagnostics } from "@t3tools/shared/urlDiagnostics";
1213
import * as Cause from "effect/Cause";
1314
import * as Clock from "effect/Clock";
1415
import * as Effect from "effect/Effect";
@@ -110,10 +111,62 @@ export class ManagedRelayStatusEndpointMismatchError extends Schema.TaggedErrorC
110111
"ManagedRelayStatusEndpointMismatchError",
111112
{
112113
environmentId: EnvironmentId,
113-
expectedEndpoint: RelayManagedEndpoint,
114-
actualEndpoint: RelayManagedEndpoint,
114+
expectedProviderKind: RelayManagedEndpointProviderKind,
115+
expectedHttpBaseUrlInputLength: Schema.Number,
116+
expectedHttpBaseUrlProtocol: Schema.optionalKey(Schema.String),
117+
expectedHttpBaseUrlHostname: Schema.optionalKey(Schema.String),
118+
expectedWsBaseUrlInputLength: Schema.Number,
119+
expectedWsBaseUrlProtocol: Schema.optionalKey(Schema.String),
120+
expectedWsBaseUrlHostname: Schema.optionalKey(Schema.String),
121+
actualProviderKind: RelayManagedEndpointProviderKind,
122+
actualHttpBaseUrlInputLength: Schema.Number,
123+
actualHttpBaseUrlProtocol: Schema.optionalKey(Schema.String),
124+
actualHttpBaseUrlHostname: Schema.optionalKey(Schema.String),
125+
actualWsBaseUrlInputLength: Schema.Number,
126+
actualWsBaseUrlProtocol: Schema.optionalKey(Schema.String),
127+
actualWsBaseUrlHostname: Schema.optionalKey(Schema.String),
115128
},
116129
) {
130+
static fromEndpoints(input: {
131+
readonly environmentId: EnvironmentId;
132+
readonly expectedEndpoint: RelayClientEnvironmentRecord["endpoint"];
133+
readonly actualEndpoint: RelayClientEnvironmentRecord["endpoint"];
134+
}): ManagedRelayStatusEndpointMismatchError {
135+
const expectedHttp = getUrlDiagnostics(input.expectedEndpoint.httpBaseUrl);
136+
const expectedWs = getUrlDiagnostics(input.expectedEndpoint.wsBaseUrl);
137+
const actualHttp = getUrlDiagnostics(input.actualEndpoint.httpBaseUrl);
138+
const actualWs = getUrlDiagnostics(input.actualEndpoint.wsBaseUrl);
139+
return new ManagedRelayStatusEndpointMismatchError({
140+
environmentId: input.environmentId,
141+
expectedProviderKind: input.expectedEndpoint.providerKind,
142+
expectedHttpBaseUrlInputLength: expectedHttp.inputLength,
143+
...(expectedHttp.protocol === undefined
144+
? {}
145+
: { expectedHttpBaseUrlProtocol: expectedHttp.protocol }),
146+
...(expectedHttp.hostname === undefined
147+
? {}
148+
: { expectedHttpBaseUrlHostname: expectedHttp.hostname }),
149+
expectedWsBaseUrlInputLength: expectedWs.inputLength,
150+
...(expectedWs.protocol === undefined
151+
? {}
152+
: { expectedWsBaseUrlProtocol: expectedWs.protocol }),
153+
...(expectedWs.hostname === undefined
154+
? {}
155+
: { expectedWsBaseUrlHostname: expectedWs.hostname }),
156+
actualProviderKind: input.actualEndpoint.providerKind,
157+
actualHttpBaseUrlInputLength: actualHttp.inputLength,
158+
...(actualHttp.protocol === undefined
159+
? {}
160+
: { actualHttpBaseUrlProtocol: actualHttp.protocol }),
161+
...(actualHttp.hostname === undefined
162+
? {}
163+
: { actualHttpBaseUrlHostname: actualHttp.hostname }),
164+
actualWsBaseUrlInputLength: actualWs.inputLength,
165+
...(actualWs.protocol === undefined ? {} : { actualWsBaseUrlProtocol: actualWs.protocol }),
166+
...(actualWs.hostname === undefined ? {} : { actualWsBaseUrlHostname: actualWs.hostname }),
167+
});
168+
}
169+
117170
override get message(): string {
118171
return `Relay returned a different endpoint for environment ${this.environmentId}.`;
119172
}
@@ -349,7 +402,7 @@ function validateEnvironmentStatus(
349402
}
350403
if (!endpointMatches(status.endpoint, environment.endpoint)) {
351404
return Effect.fail(
352-
new ManagedRelayStatusEndpointMismatchError({
405+
ManagedRelayStatusEndpointMismatchError.fromEndpoints({
353406
environmentId: environment.environmentId,
354407
expectedEndpoint: environment.endpoint,
355408
actualEndpoint: status.endpoint,

0 commit comments

Comments
 (0)