[pkgsite] internal: conditionally return documentation in GetUnit
0 views
Skip to first unread message
Ethan Lee (Gerrit)
Mar 18, 2026, 2:46:26 PM (yesterday) Mar 18
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Ethan Lee has uploaded the change for review![]( "Open in Gerrit")
Commit message
internal: conditionally return documentation in GetUnit
- Large documentations blobs should avoid being returned unless
explicitly requested. Add a WithoutDocsSource to enable retrieval of
unit information without the large documentation source information.
- This does not functionally change existing GetUnit callsites.
Change-Id: Ie983b7eaeb61bb92f2716ae64a3d1e1ea738dbe2
Change diff
diff --git a/internal/api/api.go b/internal/api/api.go
index bbc7c81..81dd24a 100644
--- a/internal/api/api.go
+++ b/internal/api/api.go
@@ -76,6 +76,9 @@
if params.Imports {
fs |= internal.WithImports
}
+ if params.Doc == "" {
+ fs |= internal.WithoutDocsSource
+ }
bc := internal.BuildContext{GOOS: params.GOOS, GOARCH: params.GOARCH}
var unit *internal.Unit
diff --git a/internal/postgres/unit.go b/internal/postgres/unit.go
index 2ead329..180ddd6 100644
--- a/internal/postgres/unit.go
+++ b/internal/postgres/unit.go
@@ -235,7 +235,7 @@
u := &internal.Unit{UnitMeta: *um}
if fields&internal.WithMain != 0 {
- u, err = db.getUnitWithAllFields(ctx, um, bc)
+ u, err = db.getUnitWithAllFields(ctx, um, fields, bc)
if err != nil {
return nil, err
}
@@ -413,7 +413,7 @@
return packages, nil
}
-func (db *DB) getUnitWithAllFields(ctx context.Context, um *internal.UnitMeta, bc internal.BuildContext) (_ *internal.Unit, err error) {
+func (db *DB) getUnitWithAllFields(ctx context.Context, um *internal.UnitMeta, fields internal.FieldSet, bc internal.BuildContext) (_ *internal.Unit, err error) {
defer derrors.WrapStack(&err, "getUnitWithAllFields(ctx, %q, %q, %q)", um.Path, um.ModulePath, um.Version)
defer stats.Elapsed(ctx, "getUnitWithAllFields")()
@@ -470,13 +470,17 @@
break
}
}
- // Get README, documentation and import counts.
- query := `
+ docSelect := "CAST(NULL AS bytea),"
+ if fields&internal.WithoutDocsSource == 0 {
+ docSelect = "d.source,"
+ }
+
+ query := fmt.Sprintf(`
SELECT
r.file_path,
r.contents,
d.synopsis,
- d.source,
+ %s
COALESCE((
SELECT COUNT(unit_id)
FROM imports
@@ -493,7 +497,7 @@
FROM units u
LEFT JOIN readmes r
ON r.unit_id = u.id
-
+
LEFT JOIN (
SELECT synopsis, source, goos, goarch, unit_id
FROM documentation d
@@ -501,7 +505,7 @@
) d
ON d.unit_id = u.id
WHERE u.id = $2
- `
+ `, docSelect)
var (
r internal.Readme
u internal.Unit
diff --git a/internal/postgres/unit_test.go b/internal/postgres/unit_test.go
index e8dc304..7f0db2b 100644
--- a/internal/postgres/unit_test.go
+++ b/internal/postgres/unit_test.go
@@ -672,7 +672,11 @@
cleanFields := func(u *internal.Unit, fields internal.FieldSet) {
// Add/remove fields based on the FieldSet specified.
if fields&internal.WithMain != 0 {
- u.Documentation = []*internal.Documentation{sample.Doc}
+ if fields&internal.WithoutDocsSource == 0 {
+ u.Documentation = []*internal.Documentation{sample.Doc}
+ } else {
+ u.Documentation = []*internal.Documentation{{GOOS: "all", GOARCH: "all", Synopsis: sample.Doc.Synopsis}}
+ }
u.BuildContexts = []internal.BuildContext{internal.BuildContextAll}
u.Readme = readme
u.NumImports = len(sample.Imports())
@@ -707,6 +711,11 @@
want: unit("a.com/m/dir/p", "a.com/m", "v1.2.3", "", readme, []string{}),
},
{
+ name: "WithMain|WithoutDocsSource",
+ fields: internal.WithMain | internal.WithoutDocsSource,
+ want: unit("a.com/m/dir/p", "a.com/m", "v1.2.3", "", readme, []string{}),
+ },
+ {
name: "WithImports",
fields: internal.WithImports,
want: unitNoLicenses("a.com/m/dir/p", "a.com/m", "v1.2.3", "", nil, []string{}),
diff --git a/internal/testing/fakedatasource/fakedatasource.go b/internal/testing/fakedatasource/fakedatasource.go
index 1f69519..0ccb01d 100644
--- a/internal/testing/fakedatasource/fakedatasource.go
+++ b/internal/testing/fakedatasource/fakedatasource.go
@@ -139,8 +139,18 @@
// Since we cache the module and its units, we have to copy this unit before we modify it.
// It can be a shallow copy, since we're only modifying the Unit.Documentation field.
u2 := *u
- if d := matchingDoc(u.Documentation, bc); d != nil {
- u2.Documentation = []*internal.Documentation{d}
+ if fields&internal.WithoutDocsSource == 0 {
+ if d := matchingDoc(u.Documentation, bc); d != nil {
+ u2.Documentation = []*internal.Documentation{d}
+ } else {
+ u2.Documentation = nil
+ }
+ } else if fields&internal.WithMain != 0 {
+ if d := matchingDoc(u.Documentation, bc); d != nil {
+ u2.Documentation = []*internal.Documentation{{GOOS: d.GOOS, GOARCH: d.GOARCH, Synopsis: d.Synopsis}}
+ } else {
+ u2.Documentation = nil
+ }
} else {
u2.Documentation = nil
}
diff --git a/internal/unit.go b/internal/unit.go
index 0a6b3cc..b75db89 100644
--- a/internal/unit.go
+++ b/internal/unit.go
@@ -113,4 +113,5 @@
WithMain FieldSet = 1 << iota
WithImports
WithLicenses
+ WithoutDocsSource
)
Change information
Files:
- M internal/api/api.go
- M internal/postgres/unit.go
- M internal/postgres/unit_test.go
- M internal/testing/fakedatasource/fakedatasource.go
- M internal/unit.go
Change size: S
Delta: 5 files changed, 37 insertions(+), 10 deletions(-)
Related details
Attention set is empty
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
kokoro (Gerrit)
Mar 18, 2026, 3:00:15 PM (yesterday) Mar 18
to Ethan Lee, goph...@pubsubhelper.golang.org, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
kokoro voted kokoro-CI-1![]( "Open in Gerrit")
Kokoro presubmit build finished with status: FAILURE
Logs at: https://source.cloud.google.com/results/invocations/f2c6f61b-84b4-46aa-bf5b-5d7163969ce5
| kokoro-CI | -1 |
Related details
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Jonathan Amsterdam (Gerrit)
Mar 18, 2026, 3:12:48 PM (yesterday) Mar 18
to Ethan Lee, goph...@pubsubhelper.golang.org, kokoro, Go LUCI, golang-co...@googlegroups.com
Attention needed from Ethan Lee
Jonathan Amsterdam added 2 comments![]( "Open in Gerrit")
File internal/postgres/unit.go
File internal/unit.go
Line 116, Patchset 1 (Latest):
WithoutDocsSourceJonathan Amsterdam . unresolved
Could we reverse the sense of this (WithDocsSource, or maybe just WithDoc) and add it in the normal code path? I think that would be clearer.
Related details
Attention is currently required from:
- Ethan Lee
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
Mar 18, 2026, 4:26:41 PM (yesterday) Mar 18
to goph...@pubsubhelper.golang.org, kokoro, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Jonathan Amsterdam
Ethan Lee added 1 comment![]( "Open in Gerrit")
File internal/unit.go
Line 116, Patchset 1 (Latest):
WithoutDocsSourceJonathan Amsterdam . unresolved
Could we reverse the sense of this (WithDocsSource, or maybe just WithDoc) and add it in the normal code path? I think that would be clearer.
Ethan Lee
Sure, but I just didn't want to potentially disrupt existing call sites. I can reverse it if you'd prefer.
Related details
Attention is currently required from:
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
11:06 AM (11 hours ago) 11:06 AM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
Ethan Lee uploaded new patchset![]( "Open in Gerrit")
Ethan Lee uploaded patch set #2 to this change.
Following approvals got outdated and were removed:
- TryBots-Pass: LUCI-TryBot-Result+1 by Go LUCI
- kokoro-CI-Passes: kokoro-CI-1 by kokoro
Related details
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
11:09 AM (11 hours ago) 11:09 AM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
Ethan Lee uploaded new patchset![]( "Open in Gerrit")
Ethan Lee uploaded patch set #3 to this change.
Related details
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
kokoro (Gerrit)
11:15 AM (11 hours ago) 11:15 AM
to Ethan Lee, goph...@pubsubhelper.golang.org, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
kokoro voted kokoro-CI-1![]( "Open in Gerrit")
Kokoro presubmit build finished with status: FAILURE
Related details
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
kokoro (Gerrit)
11:21 AM (11 hours ago) 11:21 AM
to Ethan Lee, goph...@pubsubhelper.golang.org, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
kokoro voted kokoro-CI-1![]( "Open in Gerrit")
Kokoro presubmit build finished with status: FAILURE
Related details
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
11:49 AM (10 hours ago) 11:49 AM
to goph...@pubsubhelper.golang.org, kokoro, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Jonathan Amsterdam
Ethan Lee added 1 comment![]( "Open in Gerrit")
File internal/unit.go
Ethan LeeCould we reverse the sense of this (WithDocsSource, or maybe just WithDoc) and add it in the normal code path? I think that would be clearer.
Sure, but I just didn't want to potentially disrupt existing call sites. I can reverse it if you'd prefer.
Attention is currently required from:
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
11:49 AM (10 hours ago) 11:49 AM
to goph...@pubsubhelper.golang.org, kokoro, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Jonathan Amsterdam
Ethan Lee added 1 comment![]( "Open in Gerrit")
File internal/postgres/unit.go
Related details
Attention is currently required from:
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
11:49 AM (10 hours ago) 11:49 AM
to goph...@pubsubhelper.golang.org, kokoro, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Jonathan Amsterdam
Ethan Lee voted and added 1 comment![]( "Open in Gerrit")
Votes added by Ethan Lee
| Commit-Queue | +1 |
1 comment
Patchset-level comments
kokoro (Gerrit)
11:59 AM (10 hours ago) 11:59 AM
to Ethan Lee, goph...@pubsubhelper.golang.org, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
Message from kokoro![]( "Open in Gerrit")
Kokoro presubmit build finished with status: FAILURE
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
1:13 PM (9 hours ago) 1:13 PM
to goph...@pubsubhelper.golang.org, kokoro, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Jonathan Amsterdam
Ethan Lee voted and added 1 comment![]( "Open in Gerrit")
Votes added by Ethan Lee
| Auto-Submit | +1 |
| Commit-Queue | +1 |
Ethan Lee . resolved
kokoro rerun
Attention is currently required from:
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
kokoro (Gerrit)
1:22 PM (9 hours ago) 1:22 PM
to Ethan Lee, goph...@pubsubhelper.golang.org, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
kokoro voted kokoro-CI-1![]( "Open in Gerrit")
Kokoro presubmit build finished with status: FAILURE
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Ethan Lee (Gerrit)
4:04 PM (6 hours ago) 4:04 PM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
Ethan Lee uploaded new patchset![]( "Open in Gerrit")
Ethan Lee uploaded patch set #5 to this change.
Following approvals got outdated and were removed:
- TryBots-Pass: LUCI-TryBot-Result+1 by Go LUCI
- kokoro-CI-Passes: kokoro-CI-1 by kokoro
Related details
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
kokoro (Gerrit)
4:30 PM (6 hours ago) 4:30 PM
to Ethan Lee, goph...@pubsubhelper.golang.org, Go LUCI, Jonathan Amsterdam, golang-co...@googlegroups.com
Attention needed from Ethan Lee and Jonathan Amsterdam
kokoro voted kokoro-CI+1![]( "Open in Gerrit")
Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/7ddab432-ec44-4ba4-be4e-ebe4b0da6495
| kokoro-CI | +1 |
Related details
Attention is currently required from:
- Ethan Lee
- Jonathan Amsterdam
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
kokoro-CI-Passes
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Reply all
Reply to author
Forward
0 new messages