Skip to content

The Unified and Autonomous Development Platform

feat(npm): display dist-tags on package version pages

Robin Shenfeb536b30ccd
diff --git a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmData.java b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmData.java
index 980811105a..d563507902 100644
--- a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmData.java
+++ b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmData.java
@@ -1,8 +1,13 @@
package io.onedev.server.plugin.pack.npm;
import java.io.Serializable;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
import java.util.Set;
+import org.jspecify.annotations.Nullable;
+
public class NpmData implements Serializable {
private static final long serialVersionUID = 1L;
@@ -12,6 +17,9 @@ public class NpmData implements Serializable {
private final byte[] metadata;
private final Set<String> distTags;
+
+ // Null for packages serialized before tag update dates were recorded.
+ private Map<String, Date> distTagUpdateDates;
private final String fileName;
@@ -38,6 +46,24 @@ public class NpmData implements Serializable {
return distTags;
}
+ @Nullable
+ public Date getDistTagUpdateDate(String tag) {
+ return distTagUpdateDates != null ? distTagUpdateDates.get(tag) : null;
+ }
+
+ public void setDistTag(String tag, Date updateDate) {
+ distTags.add(tag);
+ if (distTagUpdateDates == null)
+ distTagUpdateDates = new HashMap<>();
+ distTagUpdateDates.put(tag, updateDate);
+ }
+
+ public void removeDistTag(String tag) {
+ distTags.remove(tag);
+ if (distTagUpdateDates != null)
+ distTagUpdateDates.remove(tag);
+ }
+
public String getFileName() {
return fileName;
}
diff --git a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackHandler.java b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackHandler.java
index 0ee179a308..78ed41104f 100644
--- a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackHandler.java
+++ b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackHandler.java
@@ -111,7 +111,7 @@ public class NpmPackHandler implements PackHandler {
private String getLockName(Long projectId, String name) {
return "update-pack:" + projectId + ":" + TYPE + ":" + name;
}
-
+
private ObjectNode readJson(byte[] jsonBytes) {
try {
return (ObjectNode) objectMapper.readTree(jsonBytes);
@@ -201,8 +201,7 @@ public class NpmPackHandler implements PackHandler {
var project = projectService.load(projectId);
var pack = packService.findByNameAndVersion(project, TYPE, packageName, version);
if (pack != null) {
- var packData = (NpmData) pack.getData();
- packData.getDistTags().add(tag);
+ ((NpmData) pack.getData()).setDistTag(tag, new Date());
} else {
throw new ClientException(SC_NOT_FOUND);
}
@@ -213,7 +212,7 @@ public class NpmPackHandler implements PackHandler {
var project = projectService.load(projectId);
for (var pack: packService.queryByName(project, TYPE, packageName, null)) {
var packData = (NpmData) pack.getData();
- packData.getDistTags().remove(tag);
+ packData.removeDistTag(tag);
}
});
response.setStatus(SC_OK);
@@ -450,6 +449,8 @@ public class NpmPackHandler implements PackHandler {
var sha256Hash = packBlobService.load(packBlobId).getSha256Hash();
pack.setData(new NpmData(packageMetadataBytes, versionMetadataBytes, distTagsOfVersion, fileName, sha256Hash));
packService.createOrUpdate(pack, newArrayList(packBlobService.load(packBlobId)), true);
+ for (var tag : distTagsOfVersion)
+ ((NpmData) pack.getData()).setDistTag(tag, pack.getPublishDate());
response.setStatus(SC_CREATED);
}
}
diff --git a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.html b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.html
index 7bb1380c65..8895f04208 100644
--- a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.html
+++ b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.html
@@ -1,4 +1,22 @@
<wicket:panel>
+ <div wicket:id="distTagsSection">
+ <div class="table table-responsive mb-5">
+ <table class="table table-bordered border-top">
+ <thead>
+ <tr>
+ <th><wicket:t>Tag</wicket:t></th>
+ <th><wicket:t>Last Updated</wicket:t></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr wicket:id="distTags">
+ <td class="text-break" wicket:id="tag"></td>
+ <td wicket:id="updated"></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="font-size-lg font-weight-bolder mb-3"><wicket:t>Run below commands to install this package</wicket:t></div>
<div class="code mb-5">
<div wicket:id="registryConfig" class="text-break font-size-sm mt-2"></div>
@@ -15,4 +33,4 @@
<div wicket:id="readme"></div>
</div>
</wicket:enclosure>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>
diff --git a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.java b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.java
index 42cf108a5b..0bf6362285 100644
--- a/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.java
+++ b/server-plugin/server-plugin-pack-npm/src/main/java/io/onedev/server/plugin/pack/npm/NpmPackPanel.java
@@ -7,16 +7,23 @@ import io.onedev.server.security.permission.ProjectPermission;
import io.onedev.server.security.permission.ReadPack;
import io.onedev.server.service.SettingService;
import io.onedev.server.model.Pack;
+import io.onedev.server.util.DateUtils;
import io.onedev.server.web.component.codesnippet.CodeSnippetPanel;
import io.onedev.server.web.component.markdown.MarkdownViewer;
+import org.apache.wicket.AttributeModifier;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
+import org.apache.wicket.markup.html.list.ListItem;
+import org.apache.wicket.markup.html.list.ListView;
import org.apache.wicket.markup.html.panel.GenericPanel;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.LoadableDetachableModel;
import org.apache.wicket.model.Model;
import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Collections;
import static io.onedev.server.web.translation.Translation._T;
import static org.apache.commons.lang3.StringUtils.substringAfter;
@@ -31,6 +38,36 @@ public class NpmPackPanel extends GenericPanel<Pack> {
@Override
protected void onInitialize() {
super.onInitialize();
+ var tagsModel = new LoadableDetachableModel<List<String>>() {
+ @Override
+ protected List<String> load() {
+ var tags = new ArrayList<>(((NpmData) getPack().getData()).getDistTags());
+ Collections.sort(tags);
+ return tags;
+ }
+ };
+ var distTagsSection = new WebMarkupContainer("distTagsSection") {
+ @Override
+ protected void onConfigure() {
+ super.onConfigure();
+ setVisible(!((NpmData) getPack().getData()).getDistTags().isEmpty());
+ }
+ };
+ add(distTagsSection);
+ distTagsSection.add(new ListView<String>("distTags", tagsModel) {
+ @Override
+ protected void populateItem(ListItem<String> item) {
+ var tag = item.getModelObject();
+ item.add(new Label("tag", tag));
+ var updateDate = ((NpmData) getPack().getData()).getDistTagUpdateDate(tag);
+ if (updateDate != null) {
+ item.add(new Label("updated", DateUtils.formatAge(updateDate))
+ .add(AttributeModifier.replace("data-tippy-content", DateUtils.formatDateTime(updateDate))));
+ } else {
+ item.add(new Label("updated", _T("Unknown")));
+ }
+ }
+ });
var registryUrl = getServerUrl() + "/" + getPack().getProject().getPath() + "/~" + NpmPackHandler.HANDLER_ID + "/";
if (getPack().getName().contains("/")) {
var scope = substringBefore(getPack().getName(), "/");