Unverified Commit 98e4478e authored by Hong Minhee's avatar Hong Minhee
Browse files

Fix totalItems for collections with base-url param 

- Fix incorrect totalItems in OrderedCollection when base-url parameter
  is provided
- Update Collection-Synchronization header spec link to permanent URL
- Add warning for one-shot dispatcher recommendation for followers collection
parent f365c16f

CHANGES.md

+4 −0
Original line number Diff line number Diff line
@@ -8,6 +8,10 @@ Version 1.0.22 


To be released.



 -  Fixed a bug where the `totalItems` property of `OrderedCollection`

    objects returned by followers collection dispatcher had been an incorrect

    value if a `base-url` parameter was provided.





Version 1.0.21

--------------

src/federation/collection.ts

+2 −2
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ export interface PageItems<TItem> { 
/**

 * Calculates the [partial follower collection digest][1].

 *

 * [1]: https://codeberg.org/fediverse/fep/src/branch/main/fep/8fcf/fep-8fcf.md#partial-follower-collection-digest

 * [1]: https://w3id.org/fep/8fcf#partial-follower-collection-digest

 * @param uris The URIs to calculate the digest.  Duplicate URIs are ignored.

 * @returns The digest.

 */
@@ -40,7 +40,7 @@ export async function digest( 
/**

 * Builds [`Collection-Synchronization`][1] header content.

 *

 * [1]: https://codeberg.org/fediverse/fep/src/branch/main/fep/8fcf/fep-8fcf.md#the-collection-synchronization-http-header

 * [1]: https://w3id.org/fep/8fcf#the-collection-synchronization-http-header

 *

 * @param collectionId The sender's followers collection URI.

 * @param actorIds The actor URIs to digest.

src/federation/handler.ts

+5 −2
Original line number Diff line number Diff line
@@ -222,7 +222,9 @@ export async function handleCollection< 
      context,

      identifier,

    );

    const totalItems = await collectionCallbacks.counter?.(context, identifier);

    const totalItems = filter == null

      ? await collectionCallbacks.counter?.(context, identifier)

      : undefined;

    if (firstCursor == null) {

      const page = await collectionCallbacks.dispatcher(

        context,
@@ -329,7 +331,8 @@ function filterCollectionItems<TItem extends Object | Link | Recipient | URL>( 
        getLogger(["fedify", "federation", "collection"]).warn(

          `The ${collectionName} collection apparently does not implement ` +

            "filtering.  This may result in a large response payload.  " +

            "Please consider implementing filtering for the collection.",

            "Please consider implementing filtering for the collection.  " +

            "See also: https://fedify.dev/manual/collections#filtering-by-server",

        );

        logged = true;

      }

src/federation/middleware.ts

+9 −0
Original line number Diff line number Diff line
@@ -2585,6 +2585,15 @@ export class ContextImpl<TContextData> implements Context<TContextData> { 
      this,

      identifier,

    );

    if (cursor != null) {

      getLogger(["fedify", "federation", "outbox"]).warn(

        "Since the followers collection dispatcher returned null for no " +

          "cursor (i.e., one-shot dispatcher), the pagination is used to fetch " +

          '"followers".  However, it is recommended to implement the one-shot ' +

          "dispatcher for better performance.",

        { identifier },

      );

    }

    while (cursor != null) {

      const result = await this.federation.followersCallbacks.dispatcher(

        this,