add ESModel Catalyst model class

haarg · haarg · commit 6b3ab977e1d0 · 2024-10-26T05:14:03.000+02:00
Replaces the CPAN and User model classes. Removes magic namespace
creation. Just returns the model object. Everything is trivially
accessible from there.
diff --git a/lib/MetaCPAN/Server/Controller.pm b/lib/MetaCPAN/Server/Controller.pm
@@ -41,7 +41,7 @@ sub apply_request_filter {
 
 sub model {
     my ( $self, $c ) = @_;
-    my $model = $c->model('CPAN')->type( $self->type );
+    my $model = $c->model('ESModel')->doc( $self->type );
     $model = $model->fields( [ map { split(/,/) } $c->req->param('fields') ] )
         if $c->req->param('fields');
     if ( my ($size) = $c->req->param('size') ) {
@@ -55,7 +55,7 @@ sub model {
 
 sub mapping : Path('_mapping') Args(0) {
     my ( $self, $c ) = @_;
-    $c->stash( $c->model('CPAN')
+    $c->stash( $c->model('ESModel')
             ->es->indices->get_mapping( es_doc_path( $self->type ) ) );
 }
 
diff --git a/lib/MetaCPAN/Server/Controller/Activity.pm b/lib/MetaCPAN/Server/Controller/Activity.pm
@@ -13,7 +13,7 @@ sub get : Path('') : Args(0) {
     my ( $self, $c ) = @_;
 
     $c->stash_or_detach(
-        $c->model('CPAN::Release')->activity( $c->req->params ) );
+        $c->model('ESModel')->doc('release')->activity( $c->req->params ) );
 }
 
 __PACKAGE__->meta->make_immutable;
diff --git a/lib/MetaCPAN/Server/Controller/Author.pm b/lib/MetaCPAN/Server/Controller/Author.pm
@@ -16,7 +16,7 @@ sub get : Path('') : Args(1) {
     $c->cdn_max_age('1y');
     my $file = $self->model($c)->raw->get($id);
     $c->stash_or_detach(
-        $c->model('CPAN::Release')->author_status( $id, $file ) );
+        $c->model('ESModel')->doc('release')->author_status( $id, $file ) );
 }
 
 # /author/search?q=QUERY
diff --git a/lib/MetaCPAN/Server/Controller/Changes.pm b/lib/MetaCPAN/Server/Controller/Changes.pm
@@ -25,7 +25,8 @@ sub get : Chained('index') : PathPart('') : Args(2) {
     $c->cdn_max_age('1y');
 
     my $file
-        = $c->model('CPAN::File')->find_changes_files( $author, $release );
+        = $c->model('ESModel')->doc('file')
+        ->find_changes_files( $author, $release );
     $file or $c->detach( '/not_found', [] );
 
     my $source = $c->model('Source')->path( @$file{qw(author release path)} )
@@ -52,7 +53,7 @@ sub get : Chained('index') : PathPart('') : Args(2) {
 
 sub find : Chained('index') : PathPart('') : Args(1) {
     my ( $self, $c, $name ) = @_;
-    my $release = eval { $c->model('CPAN::Release')->find($name); }
+    my $release = eval { $c->model('ESModel')->doc('release')->find($name); }
         or $c->detach( '/not_found', [] );
 
     $c->forward( 'get', [ @$release{qw( author name )} ] );
@@ -76,7 +77,8 @@ sub by_releases : Path('by_releases') : Args(0) {
         return;
     }
 
-    my $ret = $c->model('CPAN::Release')->by_author_and_names( \@releases );
+    my $ret = $c->model('ESModel')->doc('release')
+        ->by_author_and_names( \@releases );
 
     my @changes;
     for my $release ( @{ $ret->{releases} } ) {
diff --git a/lib/MetaCPAN/Server/Controller/Diff.pm b/lib/MetaCPAN/Server/Controller/Diff.pm
@@ -33,8 +33,8 @@ sub release : Chained('index') : PathPart('release') : Args(1) {
 
     my ( $latest, $previous );
     try {
-        $latest   = $c->model('CPAN::Release')->find($name);
-        $previous = $c->model('CPAN::Release')->predecessor($name);
+        $latest   = $c->model('ESModel')->doc('release')->find($name);
+        $previous = $c->model('ESModel')->doc('release')->predecessor($name);
     }
     catch {
         $c->detach('/not_found');
@@ -55,7 +55,7 @@ sub file : Chained('index') : PathPart('file') : Args(2) {
         = map { [ @$_{qw(author release path)} ] }
         map {
         my $file = $_;
-        try { $c->model('CPAN::File')->raw->get($file)->{_source}; }
+        try { $c->model('ESModel')->doc('file')->raw->get($file)->{_source}; }
             or $c->detach('/not_found');
         } ( $source, $target );
 
diff --git a/lib/MetaCPAN/Server/Controller/Login.pm b/lib/MetaCPAN/Server/Controller/Login.pm
@@ -37,7 +37,7 @@ sub index : Path Args(0) {
 
 sub update_user {
     my ( $self, $c, $type, $id, $data ) = @_;
-    my $model = $c->model('User::Account');
+    my $model = $c->model('ESModel')->doc('account');
     my $user  = $model->find( { name => $type, key => $id } );
     unless ($user) {
         $user = $model->get( $c->user->id )
diff --git a/lib/MetaCPAN/Server/Controller/Login/PAUSE.pm b/lib/MetaCPAN/Server/Controller/Login/PAUSE.pm
@@ -37,7 +37,7 @@ sub index : Path Args(0) {
     elsif ( ( $id = $c->req->parameters->{id} )
         && $c->req->parameters->{id} =~ /[a-zA-Z]+/ )
     {
-        my $author = $c->model('CPAN::Author')->get( uc($id) );
+        my $author = $c->model('ESModel')->doc('author')->get( uc($id) );
         $c->controller('OAuth2')->redirect( $c, error => "author_not_found" )
             unless ($author);
 
diff --git a/lib/MetaCPAN/Server/Controller/OAuth2.pm b/lib/MetaCPAN/Server/Controller/OAuth2.pm
@@ -78,7 +78,7 @@ sub access_token : Local {
     $self->bad_request( $c,
         invalid_request => 'code query parameter is required' )
         unless ($code);
-    my $user = $c->model('User::Account')->find_code($code);
+    my $user = $c->model('ESModel')->doc('account')->find_code($code);
     $self->bad_request( $c, access_denied => 'the code is invalid' )
         unless ($user);
 
diff --git a/lib/MetaCPAN/Server/Controller/Package.pm b/lib/MetaCPAN/Server/Controller/Package.pm
@@ -11,7 +11,7 @@ with 'MetaCPAN::Server::Role::JSONP';
 sub modules : Path('modules') : Args(1) {
     my ( $self, $c, $dist ) = @_;
 
-    my $last = $c->model('CPAN::Release')->find($dist);
+    my $last = $c->model('ESModel')->doc('release')->find($dist);
     $c->detach( '/not_found', ["Cannot find last release for $dist"] )
         unless $last;
     $c->stash_or_detach(
diff --git a/lib/MetaCPAN/Server/Controller/Pod.pm b/lib/MetaCPAN/Server/Controller/Pod.pm
@@ -36,14 +36,14 @@ sub find : Path('') {
 
 sub get : Path('') : Args(1) {
     my ( $self, $c, $module ) = @_;
-    $module = $c->model('CPAN::File')->find_pod($module)
+    $module = $c->model('ESModel')->doc('file')->find_pod($module)
         or $c->detach( '/not_found', [] );
     $c->forward( 'find', [ map { $module->$_ } qw(author release path) ] );
 }
 
 sub find_dist_links {
     my ( $self, $c, $author, $release, $permalinks ) = @_;
-    my @modules = $c->model('CPAN::File')
+    my @modules = $c->model('ESModel')->doc('file')
         ->documented_modules( { name => $release, author => $author } );
 
     my $links = {};
diff --git a/lib/MetaCPAN/Server/Controller/Release.pm b/lib/MetaCPAN/Server/Controller/Release.pm
@@ -103,14 +103,14 @@ sub top_uploaders : Path('top_uploaders') : Args() {
 sub interesting_files : Path('interesting_files') : Args(2) {
     my ( $self, $c, $author, $release ) = @_;
     my $categories = $c->read_param( 'category', 1 );
-    $c->stash_or_detach( $c->model('CPAN::File')
+    $c->stash_or_detach( $c->model('ESModel')->doc('file')
             ->interesting_files( $author, $release, $categories ) );
 }
 
 sub files_by_category : Path('files_by_category') : Args(2) {
     my ( $self, $c, $author, $release ) = @_;
     my $categories = $c->read_param( 'category', 1 );
-    $c->stash_or_detach( $c->model('CPAN::File')
+    $c->stash_or_detach( $c->model('ESModel')->doc('file')
             ->files_by_category( $author, $release, $categories ) );
 }
 
diff --git a/lib/MetaCPAN/Server/Controller/ReverseDependencies.pm b/lib/MetaCPAN/Server/Controller/ReverseDependencies.pm
@@ -14,7 +14,7 @@ with 'MetaCPAN::Server::Role::JSONP';
 sub dist : Path('dist') : Args(1) {
     my ( $self, $c, $dist ) = @_;
     $c->stash_or_detach(
-        $c->model('CPAN::Release')->reverse_dependencies(
+        $c->model('ESModel')->doc('release')->reverse_dependencies(
             $dist, @{ $c->req->params }{qw< page page_size size sort >}
         )
     );
@@ -23,7 +23,7 @@ sub dist : Path('dist') : Args(1) {
 sub module : Path('module') : Args(1) {
     my ( $self, $c, $module ) = @_;
     $c->stash_or_detach(
-        $c->model('CPAN::Release')->requires(
+        $c->model('ESModel')->doc('release')->requires(
             $module, @{ $c->req->params }{qw< page page_size sort >}
         )
     );
diff --git a/lib/MetaCPAN/Server/Controller/Scroll.pm b/lib/MetaCPAN/Server/Controller/Scroll.pm
@@ -55,7 +55,7 @@ sub index : Path('/_search/scroll') : Args {
     }
 
     my $res = eval {
-        $c->model('CPAN')->es->scroll( {
+        $c->model('ESModel')->es->scroll( {
             scroll_id => $scroll_id,
             scroll    => $c->req->params->{scroll},
         } );
diff --git a/lib/MetaCPAN/Server/Controller/Source.pm b/lib/MetaCPAN/Server/Controller/Source.pm
@@ -63,7 +63,7 @@ sub module : Chained('index') : PathPart('') : Args(1) {
 
     $c->cdn_never_cache(1);
 
-    $module = $c->model('CPAN::File')->find($module)
+    $module = $c->model('ESModel')->doc('file')->find($module)
         or $c->detach( '/not_found', [] );
     $c->forward( 'get', [ map { $module->$_ } qw(author release path) ] );
 }
diff --git a/lib/MetaCPAN/Server/Controller/User.pm b/lib/MetaCPAN/Server/Controller/User.pm
@@ -24,7 +24,9 @@ sub auto : Private {
     $c->cdn_never_cache(1);
 
     if ( my $token = $c->req->params->{access_token} ) {
-        if ( my $user = $c->model('User::Account')->find_token($token) ) {
+        if ( my $user
+            = $c->model('ESModel')->doc('account')->find_token($token) )
+        {
             $c->authenticate( { user => $user } );
             Log::Log4perl::MDC->put( user => $user->id );
         }
@@ -73,7 +75,8 @@ sub profile : Local : ActionClass('REST') {
         $self->status_not_found( $c, message => 'Profile doesn\'t exist' );
         $c->detach;
     }
-    my $profile = $c->model('CPAN::Author')->raw->get( $pause->key );
+    my $profile
+        = $c->model('ESModel')->doc('author')->raw->get( $pause->key );
     $c->stash->{profile} = $profile->{_source};
 }
 
@@ -95,15 +98,17 @@ sub profile_PUT {
         donation city region country
         location extra perlmongers);
     $profile->{updated} = DateTime->now->iso8601;
-    my @errors = $c->model('CPAN::Author')->new_document->validate($profile);
+    my @errors = $c->model('ESModel')->doc('author')
+        ->new_document->validate($profile);
 
     if (@errors) {
         $self->status_bad_request( $c, message => 'Validation failed' );
         $c->stash->{rest}->{errors} = \@errors;
     }
     else {
         $profile
-            = $c->model('CPAN::Author')->put( $profile, { refresh => true } );
+            = $c->model('ESModel')->doc('author')
+            ->put( $profile, { refresh => true } );
         $self->status_created(
             $c,
             location => $c->uri_for( '/author/' . $profile->{pauseid} ),
diff --git a/lib/MetaCPAN/Server/Controller/User/Favorite.pm b/lib/MetaCPAN/Server/Controller/User/Favorite.pm
@@ -27,7 +27,7 @@ sub index_POST {
     my ( $self, $c ) = @_;
     my $pause    = $c->stash->{pause};
     my $data     = $c->req->data;
-    my $favorite = $c->model('CPAN::Favorite')->put(
+    my $favorite = $c->model('ESModel')->doc('favorite')->put(
         {
             user         => $c->user->id,
             author       => $data->{author},
@@ -48,7 +48,7 @@ sub index_POST {
 
 sub index_DELETE {
     my ( $self, $c, $distribution ) = @_;
-    my $favorite = $c->model('CPAN::Favorite')
+    my $favorite = $c->model('ESModel')->doc('favorite')
         ->get( { user => $c->user->id, distribution => $distribution } );
     if ($favorite) {
         $favorite->delete( { refresh => true } );
diff --git a/lib/MetaCPAN/Server/Model/CPAN.pm b/lib/MetaCPAN/Server/Model/CPAN.pm
diff --git a/lib/MetaCPAN/Server/Model/ESModel.pm b/lib/MetaCPAN/Server/Model/ESModel.pm
@@ -0,0 +1,27 @@
+package MetaCPAN::Server::Model::ESModel;
+
+use Moose;
+
+use MetaCPAN::Model          ();
+use MetaCPAN::Server::Config ();
+use MetaCPAN::ESConfig       qw( es_config );
+
+extends 'Catalyst::Model';
+
+has _esx_model => (
+    is      => 'ro',
+    lazy    => 1,
+    handles => ['es'],
+    default => sub {
+        MetaCPAN::Model->new(
+            es => MetaCPAN::Server::Config::config()->{elasticsearch_servers}
+        );
+    },
+);
+
+sub ACCEPT_CONTEXT {
+    my ( $self, $c ) = @_;
+    return $self->_esx_model;
+}
+
+1;
diff --git a/lib/MetaCPAN/Server/Model/Search.pm b/lib/MetaCPAN/Server/Model/Search.pm
@@ -6,18 +6,29 @@ use warnings;
 use Moose;
 use MetaCPAN::Query::Search ();
 
-extends 'MetaCPAN::Server::Model::CPAN';
+extends 'Catalyst::Model';
+
+has es => (
+    is     => 'ro',
+    writer => '_set_es',
+);
 
 has search => (
     is      => 'ro',
     isa     => 'MetaCPAN::Query::Search',
     lazy    => 1,
-    handles => [qw( search_for_first_result search_web )],
     default => sub {
         my $self = shift;
-        return MetaCPAN::Query::Search->new( es => $self->es, );
+        return MetaCPAN::Query::Search->new( es => $self->es );
     },
 );
 
-1;
+sub ACCEPT_CONTEXT {
+    my ( $self, $c ) = @_;
+    if ( !$self->es ) {
+        $self->_set_es( $c->model('ESModel')->es );
+    }
+    return $self->search;
+}
 
+1;
diff --git a/lib/MetaCPAN/Server/Model/User.pm b/lib/MetaCPAN/Server/Model/User.pm
diff --git a/lib/MetaCPAN/Server/User.pm b/lib/MetaCPAN/Server/User.pm
@@ -23,7 +23,7 @@ sub for_session {
 
 sub from_session {
     my ( $self, $c, $id ) = @_;
-    my $user = $c->model('User::Account')->get($id);
+    my $user = $c->model('ESModel')->doc('account')->get($id);
     $self->_set_obj($user) if ($user);
     return $user ? $self : undef;
 }
diff --git a/t/lib/MetaCPAN/TestServer.pm b/t/lib/MetaCPAN/TestServer.pm
@@ -256,7 +256,7 @@ sub index_favorite {
 sub prepare_user_test_data {
     my $self = shift;
     ok(
-        my $user = MetaCPAN::Server->model('User::Account')->put( {
+        my $user = MetaCPAN::Server->model('ESModel')->doc('account')->put( {
             access_token => [ { client => 'testing', token => 'testing' } ]
         } ),
         'prepare user'
@@ -266,7 +266,7 @@ sub prepare_user_test_data {
     ok( $user->put( { refresh => true } ), 'put user' );
 
     ok(
-        MetaCPAN::Server->model('User::Account')->put(
+        MetaCPAN::Server->model('ESModel')->doc('account')->put(
             { access_token => [ { client => 'testing', token => 'bot' } ] },
             { refresh      => true }
         ),
diff --git a/t/model/release/reverse_dependencies.t b/t/model/release/reverse_dependencies.t

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ sub get : Path('') : Args(0) {`
`13`	`13`	`my ( $self, $c ) = @_;`
`14`	`14`
`15`	`15`	`$c->stash_or_detach(`
`16`		`- $c->model('CPAN::Release')->activity( $c->req->params ) );`
	`16`	`+ $c->model('ESModel')->doc('release')->activity( $c->req->params ) );`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`__PACKAGE__->meta->make_immutable;`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ sub get : Path('') : Args(1) {`
`16`	`16`	`$c->cdn_max_age('1y');`
`17`	`17`	`my $file = $self->model($c)->raw->get($id);`
`18`	`18`	`$c->stash_or_detach(`
`19`		`- $c->model('CPAN::Release')->author_status( $id, $file ) );`
	`19`	`+ $c->model('ESModel')->doc('release')->author_status( $id, $file ) );`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`# /author/search?q=QUERY`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ sub index : Path Args(0) {`
`37`	`37`	`elsif ( ( $id = $c->req->parameters->{id} )`
`38`	`38`	`&& $c->req->parameters->{id} =~ /[a-zA-Z]+/ )`
`39`	`39`	`{`
`40`		`- my $author = $c->model('CPAN::Author')->get( uc($id) );`
	`40`	`+ my $author = $c->model('ESModel')->doc('author')->get( uc($id) );`
`41`	`41`	`$c->controller('OAuth2')->redirect( $c, error => "author_not_found" )`
`42`	`42`	`unless ($author);`
`43`	`43`