Add package resource file sizes to PackageRevision interface

[JamesMcDermott]

Description

• What changed:
  • PackageRevision type - added a prrSizeBytes field to PackageRevisionStatus in both v1alpha1 (existing) and v1alpha2 (in-progress CRD migration) APIs
  • On getting/listing PackageRevisions, the total resources size is included in the status field of the returned API object
• Why it's needed:
  • Provides visibility into the total file size of a package revision's resources, so users can understand storage usage before actually pulling/downloading the package revision resources.
• How it works:
  • New resources_size INTEGER column to the package_revisions database table
    • Wiring in SQL queries (read, write, update) to include the new resources_size column
    • SQL upgrade/downgrade scripts to add-and-populate or remove column on version change across boundary of this PR
      • needs to repopulate column on upgrade to cover case where package revisions are already present
        • resource file contents will be cached, but resources_size will be 0
        • sync will not pick up this discrepancy without intervention
  • When a draft is closed, the sizes of all individual resource file strings are summed and stored in resources_size
  • When package revisions are retrieved, the stored size is returned in the prrSizeBytes status field

---

Related Issue(s)

• Closes Expose package resource file sizes in PackageRevision interface #913

---

Type of Change

• Bug fix
• New feature
• Enhancement
• Refactor
• Documentation
• Tests
• Other: ________

---

Checklist

• Code follows project style guidelines
• Self-reviewed changes
• Tests added/updated
• Documentation added/updated
• All tests and gating checks pass

---

AI Disclosure

• I have used AI in the creation of this PR.

Examples:

• Amazon Q to:
  • provide SQL in upgrade scripts to calculate and populate resources_size column on upgrade
  • identify locations in documentation to update
    • actual updates written by hand
  • generate initial seed of this PR description by filling out PULL_REQUEST_TEMPLATE.md

[netlify]

✅ Deploy Preview for porch ready!

Name	Link
🔨 Latest commit	2c701d9
🔍 Latest deploy log	https://app.netlify.com/projects/porch/deploys/6a035d179c05790008c9b54b
😎 Deploy Preview	https://deploy-preview-954--porch.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[nagygergo]

Issue that it fixes is incorrect.

[JamesMcDermott]

Issue that it fixes is incorrect.

Corrected - good spot, thanks.

[efiacor]

Looks good overall.
I think we need to add some size checks for clone and edit e2e flows.
Maybe using assert.Greater() to avoid having to calculate the exact sizes.

[JamesMcDermott]

Looks good overall. I think we need to add some size checks for clone and edit e2e flows. Maybe using assert.Greater() to avoid having to calculate the exact sizes.

Thanks - I've added the checks in the clone, edit and upgrade tests - the edit one also has a resources-update flow, so good call - it let me do a before/after comparison.

Not sure assert.Greater() would have any value given the adjustment I put in to avoid having exact sizes hardcoded in the tests...

[liamfallon]

@JamesMcDermott please mark any closed off comments (especially the CoPilot ones) as resolved if they are resolved.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

Pull request overview

Adds a new prrSizeBytes status field on PackageRevision to expose the total size (bytes) of a package revision’s resource contents, with DB schema + migrations to persist/backfill the value and E2E/docs updates to validate and document the new field.

Changes:

• Add PrrSizeBytes to PackageRevisionStatus across API versions (v1alpha1 + v1alpha2), including conversion + OpenAPI + CRD schema.
• Persist and read the value via DB cache (resources_size column) and populate it during sync/close-draft flows.
• Update E2E tests and documentation to surface and validate the new status field.

Reviewed changes

Copilot reviewed 25 out of 27 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
test/e2e/suiteutils/suite.go	Adds DB-cache detection flag and (problematic) import path changes.
test/e2e/api/rpkg_lifecycle_test.go	Validates revision and adds package resource size validation.
test/e2e/api/rpkg_init_test.go	Adds helper to validate PrrSizeBytes and updates imports.
test/e2e/api/rpkg_edit_test.go	Adds assertions around size changes when resources are updated.
test/e2e/api/rpkg_clone_test.go	Adds size validation after clone/upgrade flows.
test/e2e/api/repository_test.go	Adds size validation during list checks and updates imports.
pkg/cache/dbcache/dbreposync.go	Computes and stores resources size during external repo sync caching.
pkg/cache/dbcache/dbrepository.go	Computes resources size on draft close before persisting.
pkg/cache/dbcache/dbpackagerevisionsql.go	Wires resources_size into SELECT/INSERT/UPDATE SQL and scanning.
pkg/cache/dbcache/dbpackagerevision.go	Exposes DB-cached size via PackageRevisionStatus.PrrSizeBytes.
docs/content/en/docs/7_cli_api/api-ref.md	Documents the new prrSizeBytes status field.
docs/content/en/docs/5_architecture_and_components/package-cache/db-cache.md	Documents DB-cache behavior including resource size summing on close.
docs/content/en/docs/4_tutorials_and_how-tos/working_with_package_revisions/inspecting-packages.md	Minor formatting adjustment near output explanation.
docs/content/en/docs/2_concepts/package-revisions.md	Fixes YAML indentation and updates repo branch example.
deployments/porch/3-porch-postgres-bundle.yaml	Adds resources_size column to packaged Postgres schema.
controllers/packagevariants/pkg/controllers/packagevariant/packagevariant_controller-with-workspacename_test.go	Updates copyright header year.
api/sql/porch-db.sql	Adds resources_size column to base schema.
api/sql/porch-db-1.6.0-1.5.9.sql	Adds downgrade script to drop resources_size.
api/sql/porch-db-1.5.9-1.6.0.sql	Adds upgrade script to add/backfill resources_size.
api/sql/porch-db-1.5.9-1.5.10.sql	Adds upgrade script to add/backfill resources_size.
api/sql/porch-db-1.5.10-1.5.9.sql	Adds downgrade script to drop resources_size.
api/porch/v1alpha2/porch.kpt.dev_packagerevisions.yaml	Updates CRD schema docs and adds prrSizeBytes.
api/porch/v1alpha2/packagerevision_types.go	Adds PrrSizeBytes to v1alpha2 status type.
api/porch/v1alpha1/zz_generated.conversion.go	Wires PrrSizeBytes through generated conversions.
api/porch/v1alpha1/types.go	Adds PrrSizeBytes to v1alpha1 status type and fixes comments.
api/porch/types.go	Adds PrrSizeBytes to internal API status type and fixes comments.
api/generated/openapi/zz_generated.openapi.go	Updates generated OpenAPI schema to include prrSizeBytes.

Files not reviewed (1)

• api/porch/v1alpha1/zz_generated.conversion.go: Language not supported

[Copilot]

Pull request overview

Copilot reviewed 25 out of 27 changed files in this pull request and generated 6 comments.

Files not reviewed (1)

• api/porch/v1alpha1/zz_generated.conversion.go: Language not supported

Comments suppressed due to low confidence (1)

test/e2e/suiteutils/suite.go:167

• The body of checkIfUsingDBCache wraps a trivial expression in an immediately-invoked anonymous function. This can be simplified to a direct assignment: t.UsingDBCache = os.Getenv("DB_CACHE") != "". The IIFE adds no value and obscures the logic.

func (t *TestSuite) checkIfUsingDBCache() {
	t.UsingDBCache = func() bool {
		return os.Getenv("DB_CACHE") != ""
	}()
}

[Copilot]

Pull request overview

Copilot reviewed 25 out of 27 changed files in this pull request and generated no new comments.

Files not reviewed (1)

• api/porch/v1alpha1/zz_generated.conversion.go: Language not supported

[Copilot]

Pull request overview

Copilot reviewed 26 out of 28 changed files in this pull request and generated 2 comments.

Files not reviewed (1)

• api/porch/v1alpha1/zz_generated.conversion.go: Language not supported