Skip to content
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

feat : Show dependencies dependents count #342 #857

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

feat : Show dependencies dependents count #342 #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
768ca30
feat: add dependency and dependent counts to PackageNav across multip…
BorisLord Nov 22, 2024
28d63f8
feat: add dependencyCount and dependentCount to Package interface
BorisLord Nov 22, 2024
eed5404
feat: fake data in packageData function
BorisLord Nov 22, 2024
ea10445
feat: display dependency and dependent counts in PackageNav component
BorisLord Nov 22, 2024
986067e
feat: add dependency count to ApiPackage and calculate in get_handler
BorisLord Dec 4, 2024
275b3ad
refactor: remove hardcoded counts
BorisLord Dec 4, 2024
41091fc
feat: add count_package_dependents method
BorisLord Dec 4, 2024
63f2831
feat: add dependent_count to ApiPackage and calculate in get_handler
BorisLord Dec 4, 2024
092885e
refactor: removing transaction handling
BorisLord Dec 4, 2024
c64752a
refactor: useless conversion type
BorisLord Dec 5, 2024
4af1266
Merge branch 'main' into show-dependencies-dependents-count-#342
BorisLord Dec 5, 2024
a2761ab
Merge branch 'jsr-io:main' into show-dependencies-dependents-count-#342
BorisLord Jan 15, 2025
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
32 changes: 30 additions & 2 deletions api/src/api/package.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Copyright 2024 the JSR authors. All rights reserved. MIT license.
use std::borrow::Cow;
use std::collections::HashSet;
use std::io;
use std::sync::atomic::AtomicU64;
use std::sync::atomic::Ordering;
Expand Down Expand Up @@ -49,6 +50,7 @@ use crate::iam::ReqIamExt;
use crate::ids::PackageName;
use crate::ids::PackagePath;
use crate::ids::ScopeName;
use crate::ids::Version;
use crate::metadata::PackageMetadata;
use crate::npm::generate_npm_version_manifest;
use crate::orama::OramaClient;
Expand Down Expand Up @@ -302,12 +304,38 @@ pub async fn get_handler(req: Request<Body>) -> ApiResult<ApiPackage> {
Span::current().record("package", field::display(&package));

let db = req.data::<Database>().unwrap();
let package = db
let res_package = db
.get_package(&scope, &package)
.await?
.ok_or(ApiError::PackageNotFound)?;

Ok(ApiPackage::from(package))
let mut api_package = ApiPackage::from(res_package);

if let Some(latest_v) = &api_package.latest_version {
let latest_version = Version::new(latest_v).unwrap();

let deps = db
.list_package_version_dependencies(&scope, &package, &latest_version)
.await?;

api_package.dependency_count = {
let mut unique_deps = HashSet::new();
deps
.iter()
.filter(|dep| unique_deps.insert(&dep.dependency_name))
.count() as u64
};
Comment on lines +317 to +327
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe convert this to a database COUNT as well, especially since this is an active hotpath and recomputing this constantly seems a bit unecessary

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok i'll do it.

}

let dependent_count = db
.count_package_dependents(
crate::db::DependencyKind::Jsr,
&format!("@{}/{}", scope, package),
)
.await?;
api_package.dependent_count = dependent_count as u64;

Ok(api_package)
}

#[instrument(
Expand Down
4 changes: 4 additions & 0 deletions api/src/api/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,8 @@ pub struct ApiPackage {
pub updated_at: DateTime<Utc>,
pub created_at: DateTime<Utc>,
pub version_count: u64,
pub dependency_count: u64,
pub dependent_count: u64,
pub score: Option<u32>,
pub latest_version: Option<String>,
pub when_featured: Option<DateTime<Utc>>,
Expand All @@ -459,6 +461,8 @@ impl From<PackageWithGitHubRepoAndMeta> for ApiPackage {
updated_at: package.updated_at,
created_at: package.created_at,
version_count: package.version_count as u64,
dependency_count: 0,
dependent_count: 0,
score: package
.latest_version
.as_ref()
Expand Down
19 changes: 19 additions & 0 deletions api/src/db/database.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2858,6 +2858,25 @@ impl Database {
Ok((total_unique_package_dependents as usize, dependents))
}

#[instrument(name = "Database::count_package_dependents", skip(self), err)]
pub async fn count_package_dependents(
&self,
kind: DependencyKind,
name: &str,
) -> Result<usize> {
let total_unique_package_dependents = sqlx::query!(
r#"SELECT COUNT(DISTINCT (package_scope, package_name)) FROM package_version_dependencies
WHERE dependency_kind = $1 AND dependency_name = $2;"#,
kind as _,
name,
)
.map(|r| r.count.unwrap())
.fetch_one(&self.pool)
.await?;

Ok(total_unique_package_dependents as usize)
}

#[instrument(name = "Database::check_bad_word", skip(self), err)]
pub async fn check_is_bad_word(&self, word: &str) -> Result<bool> {
let res = sqlx::query!("SELECT * FROM bad_words WHERE word = $1", word)
Expand Down
10 changes: 10 additions & 0 deletions frontend/routes/package/(_components)/PackageNav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ interface PackageNavProps {
currentTab: Tab;
params: Params;
versionCount: number;
dependencyCount: number;
dependentCount: number;
iam: ScopeIAM;
latestVersion: string | null;
}
Expand All @@ -32,6 +34,8 @@ export function PackageNav({
params,
iam,
versionCount,
dependencyCount,
dependentCount,
latestVersion,
}: PackageNavProps) {
const base = `/@${params.scope}/${params.package}`;
Expand Down Expand Up @@ -74,6 +78,9 @@ export function PackageNav({
active={currentTab === "Dependencies"}
>
Dependencies
<span class="chip tabular-nums border-1 border-white bg-jsr-cyan-100 ml-2 flex items-center justify-center">
{dependencyCount}
</span>
</NavItem>
)}
{versionCount > 0 && (
Expand All @@ -82,6 +89,9 @@ export function PackageNav({
active={currentTab === "Dependents"}
>
Dependents
<span class="chip tabular-nums border-1 border-white bg-jsr-cyan-100 ml-2 flex items-center justify-center">
{dependentCount}
</span>
</NavItem>
)}
{versionCount > 0 && (
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/all_symbols.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ export default define.page<typeof handler>(function AllSymbols(
<PackageNav
currentTab="Docs"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/dependencies.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ export default define.page<typeof handler>(function Deps(
<PackageNav
currentTab="Dependencies"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/dependents.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export default define.page<typeof handler>(function Dep(
<PackageNav
currentTab="Dependents"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/doc/[file].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ export default define.page<typeof handler>(function File({
<PackageNav
currentTab="Docs"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/doc/[symbol].tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ export default define.page<typeof handler>(function Symbol(
<PackageNav
currentTab="Docs"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ export default define.page<typeof handler>(function PackagePage(
<PackageNav
currentTab="Index"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/publish.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ export default define.page<typeof handler>(function PackagePage({
<PackageNav
currentTab="Publish"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={data.iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/score.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ export default define.page<typeof handler>(function Score(
<PackageNav
currentTab="Score"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/settings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ export default define.page<typeof handler>(function Settings({ data, params }) {
<PackageNav
currentTab="Settings"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={data.iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/source.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ export default define.page<typeof handler>(function PackagePage(
<PackageNav
currentTab="Files"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={params as unknown as Params}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/package/versions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ export default define.page<typeof handler>(function Versions({
params={params as unknown as Params}
iam={iam}
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
latestVersion={data.package.latestVersion}
/>

Expand Down
2 changes: 2 additions & 0 deletions frontend/routes/status.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ export default define.page<typeof handler>(function PackageListPage({
<PackageNav
currentTab="Versions"
versionCount={data.package.versionCount}
dependencyCount={data.package.dependencyCount}
dependentCount={data.package.dependentCount}
iam={iam}
params={{ scope: data.package.scope, package: data.package.name }}
latestVersion={data.package.latestVersion}
Expand Down
2 changes: 2 additions & 0 deletions frontend/utils/api_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ export interface Package {
updatedAt: string;
createdAt: string;
versionCount: number;
dependencyCount: number;
dependentCount: number;
score: number | null;
latestVersion: string | null;
whenFeatured: string | null;
Expand Down
1 change: 1 addition & 0 deletions frontend/utils/data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export async function packageData(
? state.api.get<ScopeMember>(path`/user/member/${scope}`)
: Promise.resolve(null),
]);

if (!pkgResp.ok) {
if (pkgResp.code === "scopeNotFound") return null;
if (pkgResp.code === "packageNotFound") return null;
Expand Down