Remove deprecated 3.x APIs in core-common #7572
Conversation
This reverts commit 76974ed. Revert BackgroundMapSettings Removal
|
There are also deprecated objects in rpc, such as HttpServerRequest and HttpServerResponse with the note, "The RPC system will be significantly refactored (or replaced) in the future.". These objects are used throughout the rest of the files. Are these objects we wish to no longer export, or make private? |
My strong opinion is to leave RPC to a separate PR. It seems unlikely that most of the deprecated stuff will actually be removable in the 5.0 timeline. |
Alright, I'll leave it out for now and create a new issue to track it separately. |
…ike/remove-deprecated-corecommon
This reverts commit a5de240. Revert RpcInterface Removal
| } | ||
|
|
||
| /** @deprecated in 3.x. Use [CreateRenderMaterialArgs]($frontend). */ | ||
| export class Params { |
There was a problem hiding this comment.
These params are also still in use, I'm going to try swapping them out for CreateRenderMaterialArgs
There was a problem hiding this comment.
RenderTexture.Params is being using in multiple places in core\frontend
I was able to change one of the files, ParseImdlDoucment.ts, but I'm not sure if its implemented correctly as there is some logic around parsing colors.
@aruniverse @ben-polinsky Who would be best to talk to for more info on how to proceed.
There was a problem hiding this comment.
@pmconne will be your best starting point
There was a problem hiding this comment.
Looks like some of the core-frontend usage is being cleaned up in #7591.
Bear in mind that removing deprecated APIs just means making them unavailable to consumers of the public API. While generally we'll want to delete the APIs entirely, if it's too complicated to clean up our internal usage of a particular one, we can instead move it to /src/internal, and export it from cross-package.ts if it's used in other packages within itwinjs-core.
This reverts commit 1a9a2c8. Revert BackendTypes Removal
|
Separate Issue for RPC: https://github.com/iTwin/itwinjs-backlog/issues/1374 |
…ike/remove-deprecated-corecommon
MichaelSwigerAtBentley
requested review from
a team,
calebmshafer,
wgoehrig and
ben-polinsky
as code owners
There was a problem hiding this comment.
here's a guide you can use as reference for the internal apis:
https://www.itwinjs.org/learning/guidelines/release-tags-guidelines/#internal-apis
There was a problem hiding this comment.
we should move this file into core/common/src/internal
| /** @deprecated in 3.x. Use [CreateRenderMaterialArgs]($frontend). */ | ||
| /** Params for use in old CreateMaterial functions. Use [CreateRenderMaterialArgs]($frontend) instead. | ||
| * @internal | ||
| */ | ||
| export class Params { |
There was a problem hiding this comment.
grep for RenderMaterial. in the repo. you'll see RenderMaterial.Params is still used in few places
the namespace here looks useless now that the only thing exposed is marked internal, wonder if we deprecate the namespace or just mark it as internal too, or honestly remove it entirely and move the Params class into core/common/src/internal
| * @deprecated in 3.x. use RenderSystem.createTexture and CreateTextureArgs. | ||
| * @public | ||
| * Use RenderSystem.createTexture and CreateTextureArgs. | ||
| * @internal |
There was a problem hiding this comment.
same comments here as in RenderMaterial.ts
Removes deprecated APIs from core-common package
Note: This PR does not remove RPC methods deprecated in 3.6 or update the RPC interface. Deferring those changes for a larger scale RPC PR.
Files not edited in favor of a later RPC specific PR:
BackendTypes.ts
RpcConstants.ts
OpenAPI.ts
WebAppRpcProtocol.ts