scriptoriumadmin/skillhub
1
0
Fork 0
mirror of https://github.com/iflytek/skillhub.git synced 2026-11-14 09:01:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

fix(publish): preserve package documentation fallback in preview

Browse source 
Signed-off-by: XiaoSeS <87064762+XiaoSeS@users.noreply.github.com>
This commit is contained in:
XiaoSeS 2026-11-05 11:19:24 +08:00
parent db2be92e0b
commit 7e5f867e0c
4 changed files with 56 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
server/skillhub-app/src/main/java/com/iflytek/skillhub/service/SkillPackagePreviewService.java
View file

@ -32,7 +32,7 @@ public class SkillPackagePreviewService {
SkillMetadata metadata = parser.parse(new String(skillMd.content(), StandardCharsets.UTF_8));
SkillExamplesSummary examples = SkillExamplesSummary.recognize(entries);
return new SkillPackagePreviewResponse(metadata.name(), metadata.displayName(), metadata.description(),
metadata.shortDescription(), metadata.overview(), metadata.version(),
metadata.shortDescription(), metadata.packageOverview(), metadata.version(),
examples.status(), examples.count());
}
}

33
server/skillhub-app/src/test/java/com/iflytek/skillhub/service/SkillPackagePreviewServiceTest.java
View file

@ -42,6 +42,39 @@ class SkillPackagePreviewServiceTest {
assertThat(serialized).contains("\"version\":null");
}
@Test
void missingOverviewStaysNullSoTheClientCanResolvePackageDocumentation() throws Exception {
var files = new java.util.ArrayList<>(entries(""));
byte[] readme = "# User-facing README".getBytes(StandardCharsets.UTF_8);
files.add(new PackageEntry("README.md", readme, readme.length, "text/markdown"));
var response = service.preview(files);
assertThat(response.overview()).isNull();
assertThat(response.description()).isEqualTo("Summary");
assertThat(response.shortDescription()).isEqualTo("Summary");
assertThat(response.examplesCount()).isZero();
assertThat(new com.fasterxml.jackson.databind.ObjectMapper().writeValueAsString(response))
.contains("\"overview\":null");
assertThat(files.get(0).content()).containsExactly(entries("").get(0).content());
assertThat(files.get(1).content()).containsExactly(readme);
}
@Test
void explicitPackageOverviewIsReturnedWithoutUsingTheSkillBody() {
var response = service.preview(entries("metadata:\n overview: ' Package overview '\n"));
assertThat(response.overview()).isEqualTo("Package overview");
}
@Test
void blankPackageOverviewDoesNotBecomeTheSkillBody() {
for (String metadata : List.of("metadata: {}\n", "metadata:\n overview: null\n",
"metadata:\n overview: ' '\n")) {
assertThat(service.preview(entries(metadata)).overview()).isNull();
}
}
@Test
void examplesRecognitionIsNonBlockingAndOmitsInvalidCount() throws Exception {
assertThat(service.preview(entries("")).examplesCount()).isZero();

7
server/skillhub-domain/src/main/java/com/iflytek/skillhub/domain/skill/metadata/SkillMetadata.java
View file

@ -57,10 +57,15 @@ public record SkillMetadata(
}
public String overview() {
String packageOverview = nestedText(frontmatter, "overview", null);
String packageOverview = packageOverview();
return overviewOverride != null ? overviewOverride : (packageOverview != null ? packageOverview : body);
}
/** Explicit package presentation only; documentation fallback is resolved by the reader. */
public String packageOverview() {
return nestedText(frontmatter, "overview", null);
}
private static String nestedText(Map<String, Object> values, String key, String fallback) {
if (values != null && values.get("metadata") instanceof Map<?, ?> metadata
&& metadata.get(key) instanceof String text && !text.strip().isEmpty()) {

16
server/skillhub-domain/src/test/java/com/iflytek/skillhub/domain/skill/metadata/SkillMetadataParserTest.java
View file

@ -11,6 +11,22 @@ class SkillMetadataParserTest {
private final SkillMetadataParser parser = new SkillMetadataParser();
@Test
void packageOverviewDoesNotIncludeOverridesOrBodyFallback() {
SkillMetadata declared = parser.parse("---\nname: my-skill\ndescription: Original\nmetadata:\n overview: ' Package overview '\n---\nBody");
assertEquals("Package overview", declared.packageOverview());
assertEquals("Package overview", declared.withPresentation(null, "Web overview", null).packageOverview());
for (Map<String, Object> frontmatter : java.util.List.of(Map.<String, Object>of(),
Map.<String, Object>of("metadata", Map.of("overview", " ")),
Map.<String, Object>of("metadata", Map.of("overview", 123)),
Map.<String, Object>of("metadata", "legacy"))) {
SkillMetadata metadata = new SkillMetadata("my-skill", "Summary", "1.0.0", "Body", frontmatter);
assertNull(metadata.packageOverview());
assertEquals("Body", metadata.overview());
}
assertNull(new SkillMetadata("my-skill", "Summary", "1.0.0", "Body", null).packageOverview());
}
@Test
void presentationOverridesAndPackageDefaultsRemainDistinct() {
SkillMetadata source = parser.parse("---\nname: my-skill\ndescription: Original\nmetadata:\n short-description: Package short\n overview: Package overview\n---\nBody");