Conversation
|
Warning Flaky specs
🤖 Ask Copilot to investigateCopy the prompt below into a new comment on this PR to delegate the investigation to GitHub Copilot. It will look into the flakiness and open a separate pull request with you as reviewer. |
Turns off no-explicit-any and the no-unsafe-* rules for specs and the test helpers that are kept out of the production bundle. Test doubles and expectation helpers routinely work with loosely typed values, and the typing effort under OP-20341 targets application code only. The two no-unsafe exemptions that lived in the vitest spec block move into the new block, which covers the helper files as well. Removes the inline disables in specs and test setup that the exemption makes redundant. https://community.openproject.org/wp/OP-20342
Removes the api.v3 Result, Collection and Duration interfaces, the Factory global and the op.QueryParams namespace. Nothing references them, and most declared their members as any. https://community.openproject.org/wp/OP-20342
Declares the tablesorter call and its language defaults, and the metadata plugin slot the reporting page clears, instead of any. The reporting controller no longer needs its inline disables for them. https://community.openproject.org/wp/OP-20342
Adds a HookSignatures map for the hooks the core registers and calls, so register and call check callback parameters and return typed results instead of any. Arbitrary hook names still fall back to an open signature, because plugins register and call hooks by name. The fallback excludes the known names, so a mismatched callback or argument for a known hook fails to compile; the spec pins that down. The bulk context menu actions are now declared as WorkPackageAction, which the typed hook result exposed as narrower than its use. https://community.openproject.org/wp/OP-20342
Types the dynamic component output maps with ng-dynamic-component's EventHandler, which is what ndcDynamicOutputs accepts, and the checksum callback as a plain thunk. The unconstrained Function type accepted any callable and let calls through unchecked. https://community.openproject.org/wp/OP-20342
Deletes WorkPackageResource#updateLinkedResources. It has no callers and calls an undeclared wpCacheService, so it only compiled because of the resource's `any` index signature. https://community.openproject.org/wp/OP-20344
Makes HalLink#$fetch and #$callable generic and gives CallableHalLink its call signature and a HalLink-typed $link, so link functions no longer rely on the global `Function.$link?:any` augmentation, which is removed. HalResource#$links is now a map of CallableHalLink and #$embedded a map of unknown values. Resource-specific link interfaces declare their action links as CallableHalLink<T> instead of `Promise<any>` methods, and are intersected with the base maps on `$links`/`$embedded` so the resource interfaces they are merged into keep the `any` index signature until it is flipped separately. WorkPackageResourceEmbedded drops its `HalResource|any` unions and the link interface no longer inherits the embedded attributes. The unused QueryFilterResource embedded declaration is removed. Callers that relied on the untyped maps get boundary casts. https://community.openproject.org/wp/OP-20344
Types HalResource#$source as HalSource and accepts an unknown source in the constructor and $initialize, which already unwrap a HalResource passed in place of a raw source. The initializer callback takes a HalResource, $copy and $plain drop their `any`, and lazy() becomes generic over the value it defines. initializeHalProperties now reads the source through typed views of `_links` and `_embedded` and passes the target maps to setupProperty directly instead of looking them up by a computed `$`-name, removing the builder's `any` casts. Runtime behaviour is unchanged. Callers and specs that relied on the untyped source get boundary casts. https://community.openproject.org/wp/OP-20344
Types ResourceChangeset#schema and WorkPackageChangeset#schema as ISchemaProxy, which is what both getters return. FormResource#schema stays the embedded form schema and gets its own FormSchemaResource type, a SchemaResource whose attributes are field schemas, and its commit link becomes a CallableHalLink. IFieldSchema is now derived from IOPFieldSchema instead of duplicating it with `any`-typed allowedValues and options. Fields that load allowed values through the link cast it at the boundary. SchemaProxy dispatches its proxied methods by name through proxyMethod, which keeps them bound to the handler and still honours subclass overrides, instead of wrapping unbound method references in a Function proxy. The payload helper checks own schema keys with Object.hasOwn. https://community.openproject.org/wp/OP-20344
Declares attributes and link callables that callers already read through the `any` index signature: FormResource#payload, #commit and #configureForm, QueryResource#star, #unstar, #icalUrl and #updatedAt, TimeEntryResource#hours, WorkPackageCollectionResource#customFields and #createWorkPackage, and WorkPackageResource#configureForm and #bcfViewpoints. WorkPackageResource#description becomes Formattable and RelationResource#type a string. Class and interface declaration merges are replaced by member declarations on the class (with `implements` for the exported shape), which emit no code under useDefineForClassFields: false. Resource state getters cast through unknown instead of `any`. Callers whose values are now typed get boundary casts. https://community.openproject.org/wp/OP-20344
Types the request data, created sources and registered classes in HalResourceService, the HTTP client options and interceptor, and ErrorResource's errors and details. HalResourceNotificationService takes ErrorResource where it reads error attributes and treats raw responses as unknown. HalError#resource is nullable, so the two callers passing it to showError assert it at the boundary, as the service already assumed. HTTPClientParamMap keeps its `any` values: query and BCF callers pass untyped objects as request params. https://community.openproject.org/wp/OP-20344
Types the remaining `any` members of the query filter, filter schema, schema dependency and grid resources, lets attachable resources read the now typed addAttachment link directly, and casts the two schema and parent reads that go through the resource index signature. https://community.openproject.org/wp/OP-20344
Removes type assertions, eslint-disable directives and imports that the typed HAL links, sources, schemas and resource attributes made unnecessary, and marks the two now typed $load() calls whose promises were already discarded with `void`. https://community.openproject.org/wp/OP-20344
Declares the base link map as holding a callable link, an array of links, or nothing, since the builder resolves array-valued HAL links to arrays and resources only carry the links the API sent. The self link is always present, as the builder creates one when missing. Call sites that read a link they have already checked, or that the resource always carries, cast it at the point of use. https://community.openproject.org/wp/OP-20344
Casts the resource attributes that display and edit fields read by name at the point of use, keeping today's values. These reads compiled only because HalResource declared an any index signature, which the next commit removes. https://community.openproject.org/wp/OP-20349
Casts work package attributes and raw links that views and services read without a declared type, keeping today's behaviour, ahead of the HalResource index signature becoming unknown. https://community.openproject.org/wp/OP-20349
Casts undeclared resource attributes read in grids, context menus, modals, search, BCF, the team planner and the costs and GitLab plugin modules, keeping today's behaviour, ahead of the HalResource index signature becoming unknown. https://community.openproject.org/wp/OP-20349
Casts the resource attribute a spec reads by name, since specs are typechecked even though they are exempt from the typing lint rules. https://community.openproject.org/wp/OP-20349
Declares the HalResource index signature as unknown instead of any. The any signature let every undeclared attribute read skip type checking, which a code comment had tracked as a source of bugs since 2019 (#31462). Reads of undeclared attributes now need a declaration or a cast, as the preceding commits add. The payload helper picks the current schema with ?? instead of ||; the value is a schema resource or nullish, so the result is unchanged. https://community.openproject.org/wp/OP-20349
Declares a ChangesetPayload interface for the plain HAL payload that ResourceChangeset builds and posts to the form and update links, and types minimalPayload, applyChanges and buildPayloadFromChanges with it. The WorkPackageChangeset override follows the new signature. Types getLinkedValue input as unknown and casts at the collection boundary, keeping the existing forEach/elements detection. Replaces redundant unknown unions and the proxy identifier any cast. https://community.openproject.org/wp/OP-20345
Types Field.resource as HalResource instead of any, and the value accessors and parseValue of Field and EditFieldComponent as unknown, now that HalResource attributes are unknown. The edit field types cast attribute reads at the boundary to the shapes they already assumed (formattables, HAL resource arrays, date and duration strings), so behaviour is unchanged. The hours formatter accepts unknown because its template passes the untyped value. Removes eslint-disable directives and type assertions that the typed resource made unnecessary, and types the select autocompleter registry with component classes. https://community.openproject.org/wp/OP-20345
Types field class registration with a FieldClass constructor type and casts once to the registry type where the static fieldType is set. Declares IDisplayFieldType with the (name, context) constructor that DisplayFieldService actually calls; the previous signature was masked by the any[] fallback. Declares DisplayFieldContextOptions for the options display fields read, types the edit field handler submit callbacks, and derives ResourceChangesetClass from the ResourceChangeset constructor as the hook service already does. https://community.openproject.org/wp/OP-20345
Types the render options of display fields as the schema option record, the values passed to the resources display field helpers as unknown[], and casts hierarchy item labels at the template literal boundary. Removes eslint-disable directives that the typed display context and value made unused. https://community.openproject.org/wp/OP-20345
ac71ea0 to
2705f0a
Compare
02f30cc to
17815ec
Compare
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
No unresolved review issues were identified, and all approval assessments are positive.
Review effort: Lite
Findings: None
What changed in this PR
Updates the frontend fields framework with stricter TypeScript typings while preserving behavior.
Changes:
- Adds typed field, resource, registry, handler, and changeset contracts.
- Replaces unsafe
anyusage with field-specific types and casts. - Aligns display-field and autocompleter registrations with actual usage.
| File | Description |
|---|---|
frontend/src/app/shared/components/fields/field.service.ts |
Types field constructors and registrations. |
frontend/src/app/shared/components/fields/field.base.ts |
Types resources and field values. |
frontend/src/app/shared/components/fields/edit/services/hal-resource-editing.service.ts |
Types changeset constructors. |
frontend/src/app/shared/components/fields/edit/field-types/versions-edit-field.component.ts |
Removes obsolete option cast. |
frontend/src/app/shared/components/fields/edit/field-types/user-edit-field.component.ts |
Removes obsolete lint suppression. |
frontend/src/app/shared/components/fields/edit/field-types/select-edit-field/select-edit-field.component.ts |
Types select values and targets. |
frontend/src/app/shared/components/fields/edit/field-types/select-edit-field/select-autocompleter-register.service.ts |
Types registered component classes. |
frontend/src/app/shared/components/fields/edit/field-types/project-edit-field.component.ts |
Uses typed resource identity. |
frontend/src/app/shared/components/fields/edit/field-types/progress-popover-edit-field.component.ts |
Types progress resource values. |
frontend/src/app/shared/components/fields/edit/field-types/plain-formattable-edit-field.component.ts |
Types formattable values. |
frontend/src/app/shared/components/fields/edit/field-types/multi-select-edit-field.component.ts |
Types options and selected values. |
frontend/src/app/shared/components/fields/edit/field-types/hours-duration-edit-field.component.ts |
Types formatter input. |
frontend/src/app/shared/components/fields/edit/field-types/formattable-edit-field/formattable-edit-field.component.ts |
Types editor context and values. |
frontend/src/app/shared/components/fields/edit/field-types/days-duration-edit-field.component.ts |
Types duration input. |
frontend/src/app/shared/components/fields/edit/field-types/date-picker-edit-field.component.ts |
Removes obsolete suppressions. |
frontend/src/app/shared/components/fields/edit/field-types/date-edit-field/date-edit-field.component.ts |
Types formatted date values. |
frontend/src/app/shared/components/fields/edit/editing-portal/edit-field-handler.ts |
Types submission handler results. |
frontend/src/app/shared/components/fields/edit/edit-field.component.ts |
Types field values and parsing. |
frontend/src/app/shared/components/fields/display/field-types/work-display-field.module.ts |
Removes obsolete lint suppression. |
frontend/src/app/shared/components/fields/display/field-types/resources-display-field.module.ts |
Types rendered resource values. |
frontend/src/app/shared/components/fields/display/field-types/render-hierarchy-item.ts |
Types hierarchy display values. |
frontend/src/app/shared/components/fields/display/field-types/formattable-display-field.module.ts |
Types rendering options. |
frontend/src/app/shared/components/fields/display/field-types/date-display-field.module.ts |
Removes obsolete lint suppression. |
frontend/src/app/shared/components/fields/display/display-field.service.ts |
Types display contexts and constructors. |
frontend/src/app/shared/components/fields/display/display-field.module.ts |
Types render options. |
frontend/src/app/shared/components/fields/changeset/resource-changeset.ts |
Adds typed payload handling. |
frontend/src/app/shared/components/fields/changeset/changeset.ts |
Clarifies unknown value returns. |
frontend/src/app/features/work-packages/components/wp-edit/work-package-changeset.ts |
Applies the shared payload type. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Warning Flaky specs
🤖 Ask Copilot to investigateCopy the prompt below into a new comment on this PR to delegate the investigation to GitHub Copilot. It will look into the flakiness and open a separate pull request with you as reviewer. |
2705f0a to
cdd9389
Compare
Ticket
https://community.openproject.org/wp/OP-20345
What are you trying to accomplish?
Part of OP-20341: removes ESLint typing violations from the display and edit fields framework, without changing behaviour.
ChangesetPayloadinterface.Field#resourceasHalResource; field values areunknownand each field type casts to the shape it already assumed.shared/components/fieldsgoes from 107 typing violations to 0; application-code typing violations drop from 531 to 418.What approach did you choose and why?
Values stay
unknownat the framework level and are cast where each concrete field consumes them, so no runtime narrowing was added. Two expressions changed form with identical output: a?.id as stringbecame?.id ?? nullbefore a formatter that maps both to'', and|| ''became?? ''after a formatter that returnsstring|null.Typing exposed two declarations that did not match their use: the display field constructor signature now matches how
DisplayFieldServiceinstantiates fields, and the select autocompleter registry stores component classes rather than strings.WorkPackageChangeset#applyChangesadopts the new payload type.Templates were checked with
ngcin addition totsc.Stacked on #25661, which makes the
HalResourceindex signatureunknown.AI involvement
Directed – I specified the requirements and AI implemented most of it; I validated via testing rather than a full line-by-line review.
Merge checklist
Browser JavaScript diff (7 files, type-only changes omitted)
Each changed browser file (TypeScript and templates, excluding specs, test helpers and declaration files) is transpiled on its own with
frontend/tsconfig.json, before and after; this is the emitted JavaScript that differs.