add-ideas/govoplan-core
1
0
Fork 0
Code Issues 45 Pull Requests Actions Packages Projects Releases Wiki Activity

[Debt] Centralize repeated WebUI API client request helpers #249

New Issue
Closed
opened 2026-07-13 17:21:07 +02:00 by zemion · 1 comment
zemion commented 2026-07-13 17:21:07 +02:00
Owner
Copy Link

Created from add-ideas/govoplan#3 after triaging /mnt/DATA/git/govoplan/audit-reports/govoplan-full-20260711-1857/jscpd/jscpd-report.json.

Evidence

jscpd reports repeated TypeScript API-client code in core WebUI, especially:

  • webui/src/api/mail.ts: lines 171-216 and 338-392
  • webui/src/api/mail.ts: lines 108-142 and 198-232
  • webui/src/api/admin.ts: lines 44-73 and webui/src/api/privacyRetention.ts: lines 2-31

The repeated code is request/response plumbing, query construction, and typed fetch handling. This makes endpoint changes easy to update inconsistently.

Desired Shape

Introduce or extend shared core WebUI API helpers for common query string construction, empty-result handling, and typed fetch wrappers. Keep module-specific API semantics in the owning API files.

Acceptance Criteria

  • Common request/query/list plumbing is centralized in a stable core WebUI helper.
  • admin, mail, and privacyRetention API wrappers retain their public TypeScript function signatures unless deliberately migrated.
  • npm run test:module-capabilities and relevant WebUI build/test commands pass.
  • jscpd no longer reports the listed API helper clones.
Created from add-ideas/govoplan#3 after triaging `/mnt/DATA/git/govoplan/audit-reports/govoplan-full-20260711-1857/jscpd/jscpd-report.json`. ## Evidence jscpd reports repeated TypeScript API-client code in core WebUI, especially: - `webui/src/api/mail.ts`: lines 171-216 and 338-392 - `webui/src/api/mail.ts`: lines 108-142 and 198-232 - `webui/src/api/admin.ts`: lines 44-73 and `webui/src/api/privacyRetention.ts`: lines 2-31 The repeated code is request/response plumbing, query construction, and typed fetch handling. This makes endpoint changes easy to update inconsistently. ## Desired Shape Introduce or extend shared core WebUI API helpers for common query string construction, empty-result handling, and typed fetch wrappers. Keep module-specific API semantics in the owning API files. ## Acceptance Criteria - Common request/query/list plumbing is centralized in a stable core WebUI helper. - `admin`, `mail`, and `privacyRetention` API wrappers retain their public TypeScript function signatures unless deliberately migrated. - `npm run test:module-capabilities` and relevant WebUI build/test commands pass. - jscpd no longer reports the listed API helper clones.
zemion commented 2026-07-13 18:19:51 +02:00
Author
Owner
Copy Link

Codex State: done

Summary

  • Added shared core WebUI helpers for query serialization, path construction, typed list unwrapping, and POST/POST+JSON requests.
  • Moved shared admin overview/permission/tenant WebUI API contracts into core and re-exported them from admin/access without changing caller-facing names.
  • Moved shared mail profile/policy/test/mock mailbox DTO contracts into core and made mail/campaign re-export them while keeping endpoint behavior in the owning modules.
  • Updated privacy retention, admin/access admin, mail, and campaign API wrappers to use the shared helpers/contracts.

Changed Files

  • webui/src/api/client.ts
  • webui/src/api/adminCommon.ts
  • webui/src/api/mailContracts.ts
  • webui/src/api/privacyRetention.ts
  • webui/src/index.ts
  • webui/src/types.ts
  • ../govoplan-admin/webui/src/api/admin.ts
  • ../govoplan-access/webui/src/api/admin.ts
  • ../govoplan-mail/webui/src/api/client.ts
  • ../govoplan-mail/webui/src/api/mail.ts
  • ../govoplan-campaign/webui/src/api/client.ts
  • ../govoplan-campaign/webui/src/api/mail.ts

Verification

  • npm run test:module-capabilities
  • npm run build
  • npx --yes jscpd --absolute --min-tokens 80 ... touched API/catalog files: Found 0 clones
  • git diff --check in core/access/admin/mail/campaign
## Codex State: done ### Summary - Added shared core WebUI helpers for query serialization, path construction, typed list unwrapping, and POST/POST+JSON requests. - Moved shared admin overview/permission/tenant WebUI API contracts into core and re-exported them from admin/access without changing caller-facing names. - Moved shared mail profile/policy/test/mock mailbox DTO contracts into core and made mail/campaign re-export them while keeping endpoint behavior in the owning modules. - Updated privacy retention, admin/access admin, mail, and campaign API wrappers to use the shared helpers/contracts. ### Changed Files - `webui/src/api/client.ts` - `webui/src/api/adminCommon.ts` - `webui/src/api/mailContracts.ts` - `webui/src/api/privacyRetention.ts` - `webui/src/index.ts` - `webui/src/types.ts` - `../govoplan-admin/webui/src/api/admin.ts` - `../govoplan-access/webui/src/api/admin.ts` - `../govoplan-mail/webui/src/api/client.ts` - `../govoplan-mail/webui/src/api/mail.ts` - `../govoplan-campaign/webui/src/api/client.ts` - `../govoplan-campaign/webui/src/api/mail.ts` ### Verification - `npm run test:module-capabilities` - `npm run build` - `npx --yes jscpd --absolute --min-tokens 80 ... touched API/catalog files: Found 0 clones` - `git diff --check in core/access/admin/mail/campaign`
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area/api
HTTP API contracts, routers, schemas, or API smoke behavior.
area/auth
Authentication, sessions, access bootstrap, or login behavior.
area/db
Database sessions, models, transactions, or persistence primitives.
area/deployment
Deployment, release, operations, or runtime packaging.
area/devex
Local developer workflow, scripts, tests, tooling, or release helpers.
area/docs
Durable documentation and project guidance.
area/governance
Governance policy, audit, privacy, retention, or compliance behavior.
area/marketing
Public website, product messaging, publication copy, or legal page content.
area/migrations
Alembic migrations, schema bootstrap, or persistence evolution.
area/module-system
Module discovery, manifests, capabilities, routing, or optional integrations.
area/rbac
Permissions, roles, delegation, or authorization policy.
area/release
Versioning, release locks, tags, packaging, or dependency pins.
area/security
Security posture, static analysis, supply-chain hardening, or vulnerability remediation.
area/tenancy
Tenant boundaries, provisioning, or tenant-scoped data behavior.
area/webui
Shared WebUI shell, frontend components, routing, or frontend tests.
audit/complexity
Complexity finding from Radon, Xenon, or equivalent maintainability scans.
audit/duplication
Duplicated-code finding from jscpd or equivalent similarity scans.
audit/false-positive
Audit finding reviewed as a narrow false positive or acceptable risk.
audit/needs-design
Audit finding that needs an architectural or product decision before implementation.
audit/quick-fix
Audit finding that appears narrow and directly fixable.
audit/structural
Audit finding that needs design, refactoring, or behavior review.
codex/needs-human
Needs an explicit human decision before Codex should implement.
codex/ready
Suitable for Codex to pick up with the existing issue context.
module/access
GovOPlaN access, identity, authentication, RBAC, and administration behavior.
module/addresses
GovOPlaN Addresses module behavior or integration.
module/admin
GovOPlaN Admin module behavior or integration.
module/appointments
GovOPlaN Appointments module behavior or integration.
module/approvals
GovOPlaN Approvals module behavior or integration.
module/assets
GovOPlaN Assets module behavior or integration.
module/audit
GovOPlaN Audit module behavior or integration.
module/booking
GovOPlaN Booking module behavior or integration.
module/calendar
GovOPlaN Calendar module behavior or integration.
module/campaign
GovOPlaN campaign module behavior or integration.
module/cases
GovOPlaN Cases module behavior or integration.
module/certificates
GovOPlaN Certificates module behavior or integration.
module/committee
GovOPlaN Committee module behavior or integration.
module/connectors
GovOPlaN Connectors module behavior or integration.
module/consultation
GovOPlaN Consultation module behavior or integration.
module/contracts
GovOPlaN Contracts module behavior or integration.
module/core
GovOPlaN core runner, shared primitives, shell, or extension points.
module/dist-lists
GovOPlaN Distribution Lists module behavior or integration.
module/dms
GovOPlaN Dms module behavior or integration.
module/docs
GovOPlaN documentation layer behavior or integration.
module/erp
GovOPlaN Erp module behavior or integration.
module/evaluation
GovOPlaN Evaluation module behavior or integration.
module/facilities
GovOPlaN Facilities module behavior or integration.
module/files
GovOPlaN files module behavior or integration.
module/fit-connect
GovOPlaN Fit Connect module behavior or integration.
module/forms
GovOPlaN Forms module behavior or integration.
module/forms-runtime
GovOPlaN Forms Runtime module behavior or integration.
module/grants
GovOPlaN Grants module behavior or integration.
module/helpdesk
GovOPlaN Helpdesk module behavior or integration.
module/identity
GovOPlaN Identity module behavior or integration.
module/identity-trust
GovOPlaN Identity Trust module behavior or integration.
module/idm
GovOPlaN Idm module behavior or integration.
module/inspections
GovOPlaN Inspections module behavior or integration.
module/issue-reporting
GovOPlaN Issue Reporting module behavior or integration.
module/learning
GovOPlaN Learning module behavior or integration.
module/ledger
GovOPlaN Ledger module behavior or integration.
module/mail
GovOPlaN mail module behavior or integration.
module/notifications
GovOPlaN Notifications module behavior or integration.
module/ops
GovOPlaN Ops module behavior or integration.
module/organizations
GovOPlaN Organizations module behavior or integration.
module/payments
GovOPlaN Payments module behavior or integration.
module/permits
GovOPlaN Permits module behavior or integration.
module/policy
GovOPlaN Policy module behavior or integration.
module/poll
GovOPlaN Poll module behavior or integration.
module/portal
GovOPlaN Portal module behavior or integration.
module/postbox
GovOPlaN Postbox module behavior or integration.
module/procurement
GovOPlaN Procurement module behavior or integration.
module/records
GovOPlaN Records module behavior or integration.
module/reporting
GovOPlaN Reporting module behavior or integration.
module/resources
GovOPlaN Resources module behavior or integration.
module/risk-compliance
GovOPlaN Risk Compliance module behavior or integration.
module/scheduling
GovOPlaN Scheduling module behavior or integration.
module/search
GovOPlaN Search module behavior or integration.
module/tasks
GovOPlaN Tasks module behavior or integration.
module/templates
GovOPlaN Templates module behavior or integration.
module/tenancy
GovOPlaN Tenancy module behavior or integration.
module/transparency
GovOPlaN Transparency module behavior or integration.
module/web
GovOPlaN public website, product page, or publication content.
module/workflow
GovOPlaN Workflow module behavior or integration.
module/xoev
GovOPlaN Xoev module behavior or integration.
module/xrechnung
GovOPlaN Xrechnung module behavior or integration.
module/xta-osci
GovOPlaN Xta Osci module behavior or integration.
priority
p0
Immediate stop-the-line priority.
priority
p1
High priority for the next focused work window.
priority
p2
Normal planned priority.
priority
p3
Low priority or opportunistic cleanup.
source/backlog-import
Imported from markdown backlog, roadmap, plan, or TODO files.
source/module-roadmap
Created from GovOPlaN module and integration roadmap planning.
source/security-audit
Created from a structured security or code-quality audit report.
source/todo-scan
Imported from inline TODO/FIXME/HACK markers by the Gitea TODO importer.
status
blocked
Cannot progress without a decision, dependency, credential, or external change.
status
in-progress
Currently being worked.
status
needs-info
Needs clarifying input before implementation can proceed safely.
status
ready
Ready for implementation.
status
triage
Needs review, ownership, priority, or acceptance criteria.
type
bug
A reproducible defect, regression, or incorrect behavior.
type
debt
Cleanup, refactoring, risk reduction, or deferred engineering work.
type
docs
Documentation, process, or developer workflow work.
type
feature
New user-visible behavior or platform capability.
type
task
Implementation, maintenance, migration, or operational work.
type
user-story
End-to-end user journey or real-world process story used to steer product slices.
No Label
area/webui
audit/duplication
codex/ready
module/admin
module/core
module/mail
priority
p3
source/security-audit
status
ready
type
debt
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
zemion
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: add-ideas/govoplan-core#249
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?