Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
11 changes: 11 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ Version 1.8.14

To be released.

### @fedify/testing

- Fixed JSR publishing hanging indefinitely at the *processing* stage.
Removed all dependencies on *@opentelemetry/api* package to avoid type
graph analysis issues in JSR when the package is used alongside
`ResourceDescriptor` from *@fedify/fedify/webfinger*. The `tracerProvider`
fields now use `any` type instead of `TracerProvider`. [[#468], [#470]]

[#468]: https://github.com/fedify-dev/fedify/issues/468
[#470]: https://github.com/fedify-dev/fedify/pull/470

### @fedify/cli

- Fixed `fedify` command failing on Windows with `PermissionDenied` error
Expand Down
3 changes: 0 additions & 3 deletions packages/testing/deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
"exports": {
".": "./src/mod.ts"
},
"imports": {
"@opentelemetry/api": "npm:@opentelemetry/api@^1.9.0"
},
"exclude": [
"dist",
"node_modules",
Expand Down
3 changes: 0 additions & 3 deletions packages/testing/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@
"peerDependencies": {
"@fedify/fedify": "workspace:^"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0"
},
"devDependencies": {
"@js-temporal/polyfill": "catalog:",
"@std/assert": "catalog:",
Expand Down
64 changes: 16 additions & 48 deletions packages/testing/src/context.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
import type {
Context,
Federation,
InboxContext,
RequestContext,
} from "@fedify/fedify/federation";
// deno-lint-ignore-file no-explicit-any
import type { Context, Federation } from "@fedify/fedify/federation";
import { RouterError } from "@fedify/fedify/federation";
import {
lookupObject as globalLookupObject,
traverseCollection as globalTraverseCollection,
} from "@fedify/fedify/vocab";
import { lookupWebFinger as globalLookupWebFinger } from "@fedify/fedify/webfinger";
import { trace } from "@opentelemetry/api";
import { mockDocumentLoader } from "./docloader.ts";

// Create a no-op tracer provider.
// We use `any` type instead of importing TracerProvider from @opentelemetry/api
// to avoid type graph analysis issues in JSR. When @opentelemetry/api types are
// imported alongside ResourceDescriptor from @fedify/fedify/webfinger, JSR's type
// analyzer hangs indefinitely during the "processing" stage.
// See: https://github.com/fedify-dev/fedify/issues/468
const noopTracerProvider: any = {
getTracer: () => ({
startActiveSpan: () => undefined as any,
startSpan: () => undefined as any,
}),
};
Comment thread
dahlia marked this conversation as resolved.

// NOTE: Copied from @fedify/fedify/testing/context.ts

export function createContext<TContextData>(
Expand Down Expand Up @@ -64,7 +72,7 @@ export function createContext<TContextData>(
hostname: url.hostname,
documentLoader: documentLoader ?? mockDocumentLoader,
contextLoader: contextLoader ?? mockDocumentLoader,
tracerProvider: tracerProvider ?? trace.getTracerProvider(),
tracerProvider: tracerProvider ?? noopTracerProvider,
clone: clone ?? ((data) => createContext({ ...values, data })),
getNodeInfoUri: getNodeInfoUri ?? throwRouteError,
getActorUri: getActorUri ?? throwRouteError,
Expand Down Expand Up @@ -114,43 +122,3 @@ export function createContext<TContextData>(
}),
};
}

export function createRequestContext<TContextData>(
args: Partial<RequestContext<TContextData>> & {
url: URL;
data: TContextData;
federation: Federation<TContextData>;
},
): RequestContext<TContextData> {
return {
...createContext(args),
clone: args.clone ?? ((data) => createRequestContext({ ...args, data })),
request: args.request ?? new Request(args.url),
url: args.url,
getActor: args.getActor ?? (() => Promise.resolve(null)),
getObject: args.getObject ?? (() => Promise.resolve(null)),
getSignedKey: args.getSignedKey ?? (() => Promise.resolve(null)),
getSignedKeyOwner: args.getSignedKeyOwner ?? (() => Promise.resolve(null)),
sendActivity: args.sendActivity ?? ((_params) => {
throw new Error("Not implemented");
}),
};
}

export function createInboxContext<TContextData>(
args: Partial<InboxContext<TContextData>> & {
url?: URL;
data: TContextData;
recipient?: string | null;
federation: Federation<TContextData>;
},
): InboxContext<TContextData> {
return {
...createContext(args),
clone: args.clone ?? ((data) => createInboxContext({ ...args, data })),
recipient: args.recipient ?? null,
forwardActivity: args.forwardActivity ?? ((_params) => {
throw new Error("Not implemented");
}),
};
}
79 changes: 73 additions & 6 deletions packages/testing/src/mock.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,23 @@ import type {
TraverseCollectionOptions,
} from "@fedify/fedify/vocab";
import type { ResourceDescriptor } from "@fedify/fedify/webfinger";
import { trace, type TracerProvider } from "@opentelemetry/api";
import { createInboxContext, createRequestContext } from "./context.ts";
import { createContext } from "./context.ts";

// Re-export createContext for public API
export { createContext };
Comment thread
dahlia marked this conversation as resolved.

// Create a no-op tracer provider.
// We use `any` type instead of importing TracerProvider from @opentelemetry/api
// to avoid type graph analysis issues in JSR. When @opentelemetry/api types are
// imported alongside ResourceDescriptor from @fedify/fedify/webfinger, JSR's type
// analyzer hangs indefinitely during the "processing" stage.
// See: https://github.com/fedify-dev/fedify/issues/468
const noopTracerProvider: any = {
getTracer: () => ({
startActiveSpan: () => undefined as any,
startSpan: () => undefined as any,
}),
};
Comment thread
dahlia marked this conversation as resolved.

/**
* Helper function to expand URI templates with values.
Expand All @@ -54,6 +69,58 @@ function expandUriTemplate(
});
}

/**
* Creates a RequestContext for testing purposes.
* @param args Partial RequestContext properties
* @returns A RequestContext instance
* @since 1.8.0
*/
export function createRequestContext<TContextData>(
args: Partial<RequestContext<TContextData>> & {
url: URL;
data: TContextData;
federation: Federation<TContextData>;
},
): RequestContext<TContextData> {
return {
...createContext(args),
clone: args.clone ?? ((data) => createRequestContext({ ...args, data })),
request: args.request ?? new Request(args.url),
url: args.url,
getActor: args.getActor ?? (() => Promise.resolve(null)),
getObject: args.getObject ?? (() => Promise.resolve(null)),
getSignedKey: args.getSignedKey ?? (() => Promise.resolve(null)),
getSignedKeyOwner: args.getSignedKeyOwner ?? (() => Promise.resolve(null)),
sendActivity: args.sendActivity ?? ((_params) => {
throw new Error("Not implemented");
}),
};
}

/**
* Creates an InboxContext for testing purposes.
* @param args Partial InboxContext properties
* @returns An InboxContext instance
* @since 1.8.0
*/
export function createInboxContext<TContextData>(
args: Partial<InboxContext<TContextData>> & {
url?: URL;
data: TContextData;
recipient?: string | null;
federation: Federation<TContextData>;
},
): InboxContext<TContextData> {
return {
...createContext(args),
clone: args.clone ?? ((data) => createInboxContext({ ...args, data })),
recipient: args.recipient ?? null,
forwardActivity: args.forwardActivity ?? ((_params) => {
throw new Error("Not implemented");
}),
};
}

/**
* Represents a sent activity with metadata about how it was sent.
* @since 1.8.0
Expand Down Expand Up @@ -176,7 +243,7 @@ export class MockFederation<TContextData> implements Federation<TContextData> {
private options: {
contextData?: TContextData;
origin?: string;
tracerProvider?: TracerProvider;
tracerProvider?: any;
} = {},
) {
this.contextData = options.contextData;
Expand Down Expand Up @@ -628,7 +695,7 @@ export class MockContext<TContextData> implements Context<TContextData> {
readonly federation: Federation<TContextData>;
readonly documentLoader: DocumentLoader;
readonly contextLoader: DocumentLoader;
readonly tracerProvider: TracerProvider;
readonly tracerProvider: any;

private sentActivities: Array<{
sender: any;
Expand All @@ -643,7 +710,7 @@ export class MockContext<TContextData> implements Context<TContextData> {
federation: Federation<TContextData>;
documentLoader?: DocumentLoader;
contextLoader?: DocumentLoader;
tracerProvider?: TracerProvider;
tracerProvider?: any;
},
) {
const url = options.url ?? new URL("https://example.com");
Expand All @@ -660,7 +727,7 @@ export class MockContext<TContextData> implements Context<TContextData> {
documentUrl: url,
}));
this.contextLoader = options.contextLoader ?? this.documentLoader;
this.tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
this.tracerProvider = options.tracerProvider ?? noopTracerProvider;
}

clone(data: TContextData): Context<TContextData> {
Expand Down
9 changes: 3 additions & 6 deletions packages/testing/src/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@
* @module
*/

export { MockContext, MockFederation } from "./mock.ts";
export {
createContext,
createInboxContext,
createRequestContext,
} from "./context.ts";
export type { SentActivity } from "./mock.ts";
export { MockContext, MockFederation } from "./mock.ts";
export { mockDocumentLoader } from "./docloader.ts";
export { createContext } from "./context.ts";
Comment thread
dahlia marked this conversation as resolved.
Outdated
1 change: 0 additions & 1 deletion packages/testing/tsdown.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,5 @@ export default defineConfig({
"@fedify/fedify/runtime",
"@fedify/fedify/vocab",
"@fedify/fedify/webfinger",
"@opentelemetry/api",
],
});
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading