Skip to content

Release Info refactor #1946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 19, 2017
Merged

Release Info refactor #1946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ac10719
add internal_error endpoint
haarg Jul 11, 2017
b8c55da
handle Content-Encoding in API requests
haarg Jul 11, 2017
5827234
properly strip W3C dates from note in changes parser
haarg Jul 11, 2017
b1b8515
remote extraneous </p> in not_found template
haarg Jul 11, 2017
b66734b
move multiple author get into separate method
haarg Jul 5, 2017
7b5da34
move release info collection into ReleaseInfo model
haarg Jul 7, 2017
a6b81fa
move changelog issue linking to controller
haarg Jul 11, 2017
342faa8
model method to directly return relevant changelog entries
haarg Jul 11, 2017
bf2234a
Merge branch 'master' into haarg/release-info-refactor
mickeyn Jul 19, 2017
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
169 changes: 86 additions & 83 deletions lib/MetaCPAN/Web/Controller/Pod.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,24 @@ use namespace::autoclean;

BEGIN { extends 'MetaCPAN::Web::Controller' }

with qw(
MetaCPAN::Web::Role::ReleaseInfo
);

# /pod/$name
sub find : Path : Args(1) {
my ( $self, $c, @path ) = @_;

$c->browser_max_age('1h');

# TODO: Pass size param so we can disambiguate?
$c->stash->{pod_file} = $c->model('API::Module')->find(@path)->get;
my $pod_file = $c->stash->{pod_file}
= $c->model('API::Module')->find(@path)->get;

$c->detach('/not_found')
if !$pod_file->{name};

my $release_info
= $c->model('ReleaseInfo')
->get( $pod_file->{author}, $pod_file->{release} )
->else( sub { Future->done( {} ) } );
$c->stash( $release_info->get );

# TODO: Disambiguate if there's more than once match. #176

Expand All @@ -41,8 +47,17 @@ sub release : Local : Args {
$c->detach();
}

$c->stash->{pod_file} = $c->model('API::Module')->get(@path)->get;
$c->stash->{permalinks} = 1;
my $release_data = $c->model('ReleaseInfo')->get( @path[ 0, 1 ] )
->else( sub { Future->done( {} ) } );
my $pod_file = $c->model('API::Module')->get(@path);
$c->stash(
{
pod_file => $pod_file->get,
%{ $release_data->get },
permalinks => 1,
}
);

$c->forward( 'view', [@path] );
}

Expand All @@ -57,15 +72,18 @@ sub distribution : Local : Args {

# Get latest "author/release" of dist so we can use it to find the file.
# TODO: Pass size param so we can disambiguate?
my $release = try {
$c->model('API::Release')->find($dist)->get->{release};
my $release_data = try {
$c->model('ReleaseInfo')->find($dist)->get;
} or $c->detach('/not_found');

# TODO: Disambiguate if there's more than once match. #176
unshift @path, @{ $release_data->{release} }{qw( author name )};

unshift @path, @$release{qw( author name )};

$c->stash->{pod_file} = $c->model('API::Module')->get(@path)->get;
$c->stash(
{
%$release_data,
pod_file => $c->model('API::Module')->get(@path)->get,
}
);

$c->forward( 'view', [@path] );
}
Expand All @@ -81,43 +99,75 @@ sub view : Private {
$c->detach;
}

my ( $documentation, $pod, $documented_module )
my ( $documentation, $assoc_pod, $documented_module )
= map { $_->{name}, $_->{associated_pod}, $_ }
grep { @path > 1 || $path[0] eq $_->{name} }
grep {
!$data->{documentation}
|| $data->{documentation} eq $_->{name}
}
grep { $_->{associated_pod} } @{ $data->{module} || [] };

$data->{documentation} = $documentation if $documentation;
if ( $pod && $pod ne "$data->{author}/$data->{release}/$data->{path}" ) {

if ( $assoc_pod
&& $assoc_pod ne "$data->{author}/$data->{release}/$data->{path}" )
{
$data->{pod_path}
= $pod =~ s{^\Q$data->{author}/$data->{release}/}{}r;
= $assoc_pod =~ s{^\Q$data->{author}/$data->{release}/}{}r;
}

$c->detach('/not_found') unless ( $data->{name} );

my $pod_path = '/pod/' . ( $pod || join( q{/}, @path ) );
my $pod_path = '/pod/' . ( $assoc_pod || join( q{/}, @path ) );

my $reqs = $self->api_requests(
$c,
my $pod = $c->model('API')->request(
$pod_path,
undef,
{
pod => $c->model('API')->request(
$pod_path,
undef,
{
show_errors => 1,
( $permalinks ? ( permalinks => 1 ) : () ),
url_prefix => '/pod/',
}
),
release => $c->model('API::Release')
->get( @{$data}{qw(author release)} ),
},
$data,
show_errors => 1,
( $permalinks ? ( permalinks => 1 ) : () ),
url_prefix => '/pod/',
}
)->get;
$self->stash_api_results( $c, $reqs, $data );
$self->add_favorites_data( $data, $reqs->{favorites}, $data );

my $pod_html = $self->filter_html( $pod->{raw}, $data );

my $release = $c->stash->{release};

#<<<
my $canonical = ( $documented_module
&& $documented_module->{authorized}
&& $documented_module->{indexed}
) ? "/pod/$documentation"
: join(q{/}, q{}, qw( pod distribution ), $release->{distribution},
# Strip $author/$release from front of path.
@path[ 2 .. $#path ]
);
#>>>

# Store at fastly for a year - as we will purge!
$c->cdn_max_age('1y');
$c->add_dist_key( $release->{distribution} );
$c->add_author_key( $release->{author} );

$c->stash(
{
template => 'pod.html',
module => $data,
pod => $pod_html,
canonical => $canonical,
documented_module => $documented_module,
}
);

unless ( $pod->{raw} ) {
$c->stash( pod_error => $pod->{message}, );
}
}

sub filter_html {
my ( $self, $html, $data ) = @_;

my $hr = HTML::Restrict->new(
uri_schemes =>
Expand Down Expand Up @@ -188,7 +238,7 @@ sub view : Private {
$base .= "$data->{author}/$data->{release}/";
}
else {
$base .= $pod
$base .= $data->{associated_pod}
|| "$data->{author}/$data->{release}/$data->{path}";
}
$val = URI->new_abs( $val, $base )->as_string;
Expand All @@ -200,54 +250,7 @@ sub view : Private {
return $tag;
},
);

my $release = $reqs->{release}{release};

#<<<
my $canonical = ( $documented_module
&& $documented_module->{authorized}
&& $documented_module->{indexed}
) ? "/pod/$documentation"
: join(q{/}, q{}, qw( pod distribution ), $release->{distribution},
# Strip $author/$release from front of path.
@path[ 2 .. $#path ]
);
#>>>

my $dist = $release->{distribution};

# Store at fastly for a year - as we will purge!
$c->cdn_max_age('1y');
$c->add_dist_key($dist);
$c->add_author_key( $release->{author} );

$c->stash( $c->model('API::Favorite')->find_plussers($dist)->get );

$c->stash(
$c->model(
'ReleaseInfo',
{
author => $reqs->{author},
distribution => $reqs->{distribution},
release => $release,
}
)->summary_hash
);

$c->stash(
{
module => $data,
pod => $hr->process( $reqs->{pod}->{raw} ),
release => $release,
template => 'pod.html',
canonical => $canonical,
documented_module => $documented_module,
}
);

unless ( $reqs->{pod}->{raw} ) {
$c->stash( pod_error => $reqs->{pod}->{message}, );
}
$hr->process($html);
}

__PACKAGE__->meta->make_immutable;
Expand Down
3 changes: 2 additions & 1 deletion lib/MetaCPAN/Web/Controller/Recent/TopUploaders.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ sub topuploaders : Private {
my $data = $c->model('API::Release')->topuploaders($range)->get;

my $authors
= $c->model('API::Author')->get( keys %{ $data->{counts} } )->get;
= $c->model('API::Author')->get_multiple( keys %{ $data->{counts} } )
->get;

$c->stash(
{
Expand Down
Loading