metacpan · haarg · Apr 30, 2024 · Apr 30, 2024 · Apr 30, 2024
diff --git a/docs/API-docs.md b/docs/API-docs.md
@@ -27,13 +27,13 @@ Part of being polite is letting us know who you are and how to reach you.  This
 Available fields can be found by accessing the corresponding `_mapping` endpoint.
 
 
-* [/author/_mapping](https://fastapi.metacpan.org/v1/author/_mapping) - [explore](https://explorer.metacpan.org/?url=/author/_mapping)
-* [/distribution/_mapping](https://fastapi.metacpan.org/v1/distribution/_mapping) - [explore](https://explorer.metacpan.org/?url=/distribution/_mapping)
-* [/favorite/_mapping](https://fastapi.metacpan.org/v1/favorite/_mapping) - [explore](https://explorer.metacpan.org/?url=/favorite/_mapping)
-* [/file/_mapping](https://fastapi.metacpan.org/v1/file/_mapping) - [explore](https://explorer.metacpan.org/?url=/file/_mapping)
-* [/module/_mapping](https://fastapi.metacpan.org/v1/module/_mapping) - [explore](https://explorer.metacpan.org/?url=/module/_mapping)
-* [/rating/_mapping](https://fastapi.metacpan.org/v1/rating/_mapping) - [explore](https://explorer.metacpan.org/?url=/rating/_mapping)
-* [/release/_mapping](https://fastapi.metacpan.org/v1/release/_mapping) - [explore](https://explorer.metacpan.org/?url=/release/_mapping)
+* [`/author/_mapping`](https://fastapi.metacpan.org/v1/author/_mapping) - [explore](https://explorer.metacpan.org/?url=/author/_mapping)
+* [`/distribution/_mapping`](https://fastapi.metacpan.org/v1/distribution/_mapping) - [explore](https://explorer.metacpan.org/?url=/distribution/_mapping)
+* [`/favorite/_mapping`](https://fastapi.metacpan.org/v1/favorite/_mapping) - [explore](https://explorer.metacpan.org/?url=/favorite/_mapping)
+* [`/file/_mapping`](https://fastapi.metacpan.org/v1/file/_mapping) - [explore](https://explorer.metacpan.org/?url=/file/_mapping)
+* [`/module/_mapping`](https://fastapi.metacpan.org/v1/module/_mapping) - [explore](https://explorer.metacpan.org/?url=/module/_mapping)
+* [`/rating/_mapping`](https://fastapi.metacpan.org/v1/rating/_mapping) - [explore](https://explorer.metacpan.org/?url=/rating/_mapping)
+* [`/release/_mapping`](https://fastapi.metacpan.org/v1/release/_mapping) - [explore](https://explorer.metacpan.org/?url=/release/_mapping)
 
 
 ## Field documentation
@@ -44,42 +44,12 @@ Fields are documented in the API codebase: https://github.com/metacpan/metacpan-
 
 Performing a search without any constraints is an easy way to get sample data
 
-* [/author/_search](https://fastapi.metacpan.org/v1/author/_search)
-* [/distribution/_search](https://fastapi.metacpan.org/v1/distribution/_search)
-* [/favorite/_search](https://fastapi.metacpan.org/v1/favorite/_search)
-* [/file/_search](https://fastapi.metacpan.org/v1/file/_search)
-* [/rating/_search](https://fastapi.metacpan.org/v1/rating/_search)
-* [/release/_search](https://fastapi.metacpan.org/v1/release/_search)
-
-## Joins
-
-ElasticSearch itself doesn't support joining data across multiple types. The API server can, however, handle a `join` query parameter if the underlying type was set up accordingly. Browse https://github.com/metacpan/metacpan-api/blob/master/lib/MetaCPAN/Server/Controller/ to see all join conditions. Here are some examples.
-
-Joins on documents:
-
-* [/author/PERLER?join=favorite](https://fastapi.metacpan.org/v1/author/PERLER?join=favorite)
-* [/author/PERLER?join=favorite&join=release](https://fastapi.metacpan.org/v1/author/PERLER?join=favorite&join=release)
-* [/release/Moose?join=author](https://fastapi.metacpan.org/v1/release/Moose?join=author)
-* [/module/Moose?join=release](https://fastapi.metacpan.org/v1/module/Moose?join=release)
-
-Joins on search results is work in progress.
-
-Restricting the joined results can be done by using the [boolean "should"](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/query-dsl-bool-query.html) occurrence type:
-
-```sh
-curl -XPOST https://fastapi.metacpan.org/v1/author/PERLER?join=release -d '
-{
-    "query": {
-        "bool": {
-            "should": [{
-                "term": {
-                    "release.status": "latest"
-                }
-            }]
-        }
-    }
-}'
-```
+* [`/author/_search`](https://fastapi.metacpan.org/v1/author/_search)
+* [`/distribution/_search`](https://fastapi.metacpan.org/v1/distribution/_search)
+* [`/favorite/_search`](https://fastapi.metacpan.org/v1/favorite/_search)
+* [`/file/_search`](https://fastapi.metacpan.org/v1/file/_search)
+* [`/rating/_search`](https://fastapi.metacpan.org/v1/rating/_search)
+* [`/release/_search`](https://fastapi.metacpan.org/v1/release/_search)
 
 ## JSONP
 
@@ -101,33 +71,33 @@ The `/download_url` endpoint exists specifically for the `cpanm` client.  It tak
 
 Obviously anyone can use this endpoint, but we'll only consider changes to this endpoint after considering how `cpanm` might be affected.
 
-* [https://fastapi.metacpan.org/v1/download_url/HTTP::Tiny](https://fastapi.metacpan.org/v1/download_url/HTTP::Tiny)
-* [https://fastapi.metacpan.org/v1/download_url/Moose?version===0.01](https://fastapi.metacpan.org/v1/download_url/Moose?version===0.01)
-* [https://fastapi.metacpan.org/v1/download_url/Moose?version=!=0.01](https://fastapi.metacpan.org/v1/download_url/Moose?version=!=0.01)
-* [https://fastapi.metacpan.org/v1/download_url/Moose?version=<=0.02](https://fastapi.metacpan.org/v1/download_url/Moose?version=<=0.02)
-* [https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.24](https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.24)
-* [https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27&dev=1](https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27&dev=1)
-* [https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.26&dev=1](https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.26&dev=1)
+* [`https://fastapi.metacpan.org/v1/download_url/HTTP::Tiny`](https://fastapi.metacpan.org/v1/download_url/HTTP::Tiny)
+* [`https://fastapi.metacpan.org/v1/download_url/Moose?version===0.01`](https://fastapi.metacpan.org/v1/download_url/Moose?version===0.01)
+* [`https://fastapi.metacpan.org/v1/download_url/Moose?version=!=0.01`](https://fastapi.metacpan.org/v1/download_url/Moose?version=!=0.01)
+* [`https://fastapi.metacpan.org/v1/download_url/Moose?version=<=0.02`](https://fastapi.metacpan.org/v1/download_url/Moose?version=<=0.02)
+* [`https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.24`](https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.24)
+* [`https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27&dev=1`](https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27&dev=1)
+* [`https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.26&dev=1`](https://fastapi.metacpan.org/v1/download_url/Try::Tiny?version=>0.21,<0.27,!=0.26&dev=1)
 
 ### `/release/{distribution}`
 
 ### `/release/{author}/{release}`
 
-The `/release` endpoint accepts either the name of a `distribution` (e.g. [/release/Moose](https://fastapi.metacpan.org/v1/release/Moose)), which returns the most recent release of the distribution. Or provide the full path which consists of its `author` and the name of the `release` (e.g. [/release/DOY/Moose-2.0001](https://fastapi.metacpan.org/v1/release/DOY/Moose-2.0001)).
+The `/release` endpoint accepts either the name of a `distribution` (e.g. [`/release/Moose`](https://fastapi.metacpan.org/v1/release/Moose)), which returns the most recent release of the distribution. Or provide the full path which consists of its `author` and the name of the `release` (e.g. [`/release/DOY/Moose-2.0001`](https://fastapi.metacpan.org/v1/release/DOY/Moose-2.0001)).
 
 ### `/author/{author}`
 
-`author` refers to the pauseid of the author. It must be uppercased (e.g. [/author/DOY](https://fastapi.metacpan.org/v1/author/DOY)).
+`author` refers to the pauseid of the author. It must be uppercased (e.g. [`/author/DOY`](https://fastapi.metacpan.org/v1/author/DOY)).
 
 ### `/module/{module}`
 
-Returns the corresponding `file` of the latest version of the `module`. Considering that Moose-2.0001 is the latest release, the result of [/module/Moose](https://fastapi.metacpan.org/v1/module/Moose) is the same as [/file/DOY/Moose-2.0001/lib/Moose.pm](https://fastapi.metacpan.org/v1/file/DOY/Moose-2.0001/lib/Moose.pm).
+Returns the corresponding `file` of the latest version of the `module`. Considering that Moose-2.0001 is the latest release, the result of [`/module/Moose`](https://fastapi.metacpan.org/v1/module/Moose) is the same as [`/file/DOY/Moose-2.0001/lib/Moose.pm`](https://fastapi.metacpan.org/v1/file/DOY/Moose-2.0001/lib/Moose.pm).
 
 ### `/pod/{module}`
 
 ### `/pod/{author}/{release}/{path}`
 
-Returns the POD of the given module. You can change the output format by either passing a `content-type` query parameter (e.g. [/pod/Moose?content-type=text/plain](https://fastapi.metacpan.org/v1/pod/Moose?content-type=text/plain) or by adding an `Accept` header to the HTTP request. Valid content types are:
+Returns the POD of the given module. You can change the output format by either passing a `content-type` query parameter (e.g. [`/pod/Moose?content-type=text/plain`](https://fastapi.metacpan.org/v1/pod/Moose?content-type=text/plain) or by adding an `Accept` header to the HTTP request. Valid content types are:
 
 * text/html (default)
 * text/plain
@@ -143,11 +113,11 @@ Returns the full source of the latest, authorized version of the given
 
 Names of latest releases by OALDERS:
 
-https://fastapi.metacpan.org/v1/release/_search?q=author:OALDERS%20AND%20status:latest&fields=name,status&size=100
+[`https://fastapi.metacpan.org/v1/release/_search?q=author:OALDERS%20AND%20status:latest&fields=name,status&size=100`](https://fastapi.metacpan.org/v1/release/_search?q=author:OALDERS%20AND%20status:latest&fields=name,status&size=100)
 
 5,000 CPAN Authors:
 
-[https://fastapi.metacpan.org/v1/author/_search?q=*&size=5000](https://fastapi.metacpan.org/author/_search?q=*)
+[`https://fastapi.metacpan.org/v1/author/_search?q=*&size=5000`](https://fastapi.metacpan.org/author/_search?q=*)
 
 All CPAN Authors Who Have Provided Twitter IDs:
 
@@ -159,11 +129,11 @@ https://fastapi.metacpan.org/v1/author/_search?q=updated:*&sort=updated:desc
 
 First 100 distributions which SZABGAB has given a ++:
 
- https://fastapi.metacpan.org/v1/favorite/_search?q=user:sWuxlxYeQBKoCQe1f-FQ_Q&size=100&fields=distribution
+https://fastapi.metacpan.org/v1/favorite/_search?q=user:sWuxlxYeQBKoCQe1f-FQ_Q&size=100&fields=distribution
 
 The 100 most recent releases ( similar to https://metacpan.org/recent )
 
- https://fastapi.metacpan.org/v1/release/_search?q=status:latest&fields=name,status,date&sort=date:desc&size=100
+https://fastapi.metacpan.org/v1/release/_search?q=status:latest&fields=name,status,date&sort=date:desc&size=100
 
 Number of ++'es that DOY's dists have received:
 

diff --git a/lib/MetaCPAN/Server/Controller.pm b/lib/MetaCPAN/Server/Controller.pm
@@ -26,14 +26,6 @@ has type => (
     default => sub { shift->action_namespace },
 );
 
-has relationships => (
-    is      => 'ro',
-    isa     => HashRef,
-    default => sub { {} },
-    traits  => ['Hash'],
-    handles => { has_relationships => 'count' },
-);
-
 my $MAX_SIZE = 5000;
 
 # apply "filters" like \&model but for fabricated data
@@ -128,90 +120,6 @@ sub search : Path('_search') : ActionClass('~Deserialize') {
     } or do { $self->internal_error( $c, $@ ) };
 }
 
-sub join : ActionClass('~Deserialize') {
-    my ( $self, $c ) = @_;
-    my $joins     = $self->relationships;
-    my @req_joins = $c->req->param('join');
-    my $is_get    = ref $c->stash->{hits} ? 0 : 1;
-    my $query
-        = $c->req->params->{q}
-        ? { query => { query_string => { query => $c->req->params->{q} } } }
-        : $c->req->data ? $c->req->data
-        :                 { query => { match_all => {} } };
-    $c->detach(
-        '/not_allowed',
-        [
-            'unknown join type, valid values are '
-                . Moose::Util::english_list( keys %$joins )
-        ]
-    ) if ( scalar grep { !$joins->{$_} } @req_joins );
-
-    while ( my ( $join, $config ) = each %$joins ) {
-        my $has_many = ref $config->{type};
-        my ($type)   = $has_many ? @{ $config->{type} } : $config->{type};
-        my $cself    = $config->{self} || $join;
-        next unless ( grep { $_ eq $join } @req_joins );
-        my $data
-            = $is_get
-            ? [ $c->stash ]
-            : [
-            map {
-                $_->{_source}
-                    || single_valued_arrayref_to_scalar( $_->{fields} )
-            } @{ $c->stash->{hits}->{hits} }
-            ];
-        my @ids = List::AllUtils::uniq grep {defined}
-            map { ref $cself eq 'CODE' ? $cself->($_) : $_->{$cself} } @$data;
-        my $filter   = { terms => { $config->{foreign} => [@ids] } };
-        my $filtered = {%$query};    # don't work on $query
-        $filtered->{filter}
-            = $query->{filter}
-            ? { and => [ $filter, $query->{filter} ] }
-            : $filter;
-        my $foreign = eval {
-            $c->model("CPAN::$type")->query( $filtered->{query} )
-                ->filter( $filtered->{filter} )->size(1000)->raw->all;
-        } or do { $self->internal_error( $c, $@ ) };
-        $c->detach(
-            "/not_allowed",
-            [
-                'The number of joined documents exceeded the allowed number of 1000 documents by '
-                    . ( $foreign->{hits}->{total} - 1000 )
-                    . '. Please reduce the number of documents or apply additional filters.'
-            ]
-        ) if ( $foreign->{hits}->{total} > 1000 );
-        $c->stash->{took} += $foreign->{took} unless ($is_get);
-
-        if ($has_many) {
-            my $many;
-            for ( @{ $foreign->{hits}->{hits} } ) {
-                my $list = $many->{ $_->{_source}->{ $config->{foreign} } }
-                    ||= [];
-                push( @$list, $_ );
-            }
-            $foreign = $many;
-        }
-        else {
-            $foreign = { map { $_->{_source}->{ $config->{foreign} } => $_ }
-                    @{ $foreign->{hits}->{hits} } };
-        }
-        for (@$data) {
-            my $key = ref $cself eq 'CODE' ? $cself->($_) : $_->{$cself};
-            next unless ($key);
-            my $result = $foreign->{$key};
-            $_->{$join}
-                = $has_many
-                ? {
-                hits => {
-                    hits  => $result,
-                    total => scalar @{ $result || [] }
-                }
-                }
-                : $result;
-        }
-    }
-}
-
 sub not_found : Private {
     my ( $self, $c ) = @_;
     $c->cdn_never_cache(1);
@@ -238,57 +146,8 @@ sub internal_error {
 
 sub end : Private {
     my ( $self, $c ) = @_;
-    $c->forward('join')
-        if ( $self->has_relationships && $c->req->param('join') );
     $c->forward('/end');
 }
 
 __PACKAGE__->meta->make_immutable;
 1;
-
-__END__
-
-=head1 ATTRIBUTES
-
-=head2 relationships
-
- MetaCPAN::Server::Controller::Author->config(
-     relationships => {
-         release => {
-             type    => ['Release'],
-             self    => 'pauseid',
-             foreign => 'author',
-         }
-     }
- );
-
-Contains a HashRef of relationships with other controllers.
-If C<type> is an ArrayRef, the relationship is considered a
-I<has many> relationship.
-
-Unless a C<self> exists, the name of the relationship is used
-as key to join on. C<self> can also be a CodeRef, if the foreign
-key is build from several local keys. In this case, again the name of
-the relationship is used as key in the result.
-
-C<foreign> refers to the foreign key on the C<type> controller the data
-is joined with.
-
-=head1 ACTIONS
-
-=head2 join
-
-This action is called if the controller has L</relationships> defined
-and if one or more C<join> query parameters are defined. It then
-does a I<left join> based on the information provided by
-L</relationships>.
-
-This works both for GET requests, where only one document is requested
-and search requests, where a number of documents is returned.
-It also passes through search data (either the C<q> query string or
-the request body).
-
-B<The number of documents that can be joined is limited to 1000 per
-relationship for now.>
-
-=cut
diff --git a/lib/MetaCPAN/Server/Controller/Author.pm b/lib/MetaCPAN/Server/Controller/Author.pm
@@ -10,21 +10,6 @@ BEGIN { extends 'MetaCPAN::Server::Controller' }
 
 with 'MetaCPAN::Server::Role::JSONP';
 
-__PACKAGE__->config(
-    relationships => {
-        release => {
-            type    => ['Release'],
-            self    => 'pauseid',
-            foreign => 'author',
-        },
-        favorite => {
-            type    => ['Favorite'],
-            self    => 'user',
-            foreign => 'user',
-        }
-    }
-);
-
 # https://fastapi.metacpan.org/v1/author/LLAP
 sub get : Path('') : Args(1) {
     my ( $self, $c, $id ) = @_;

diff --git a/lib/MetaCPAN/Server/Controller/Changes.pm b/lib/MetaCPAN/Server/Controller/Changes.pm
@@ -12,8 +12,6 @@ BEGIN { extends 'MetaCPAN::Server::Controller' }
 
 with 'MetaCPAN::Server::Role::JSONP';
 
-# TODO: __PACKAGE__->config(relationships => ?)
-
 has '+type' => ( default => 'file' );
 
 sub index : Chained('/') : PathPart('changes') : CaptureArgs(0) {

diff --git a/lib/MetaCPAN/Server/Controller/File.pm b/lib/MetaCPAN/Server/Controller/File.pm
@@ -11,23 +11,6 @@ BEGIN { extends 'MetaCPAN::Server::Controller' }
 
 with 'MetaCPAN::Server::Role::JSONP';
 
-__PACKAGE__->config(
-    relationships => {
-        author => {
-            type    => 'Author',
-            foreign => 'pauseid',
-        },
-        release => {
-            type => 'Release',
-            self => sub {
-                ElasticSearchX::Model::Util::digest( $_[0]->{author},
-                    $_[0]->{release} );
-            },
-            foreign => 'id',
-        }
-    }
-);
-
 sub find : Path('') {
     my ( $self, $c, $author, $release, @path ) = @_;
 

diff --git a/lib/MetaCPAN/Server/Controller/Release.pm b/lib/MetaCPAN/Server/Controller/Release.pm
@@ -10,15 +10,6 @@ BEGIN { extends 'MetaCPAN::Server::Controller' }
 
 with 'MetaCPAN::Server::Role::JSONP';
 
-__PACKAGE__->config(
-    relationships => {
-        author => {
-            type    => 'Author',
-            foreign => 'pauseid',
-        }
-    }
-);
-
 sub find : Path('') : Args(1) {
     my ( $self, $c, $name ) = @_;
     my $file = $self->model($c)->find($name);