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? |
core/common/src/BackendTypes.ts
Outdated
| */ | ||
|
|
||
| /** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */ | ||
| export type BackendReadable = Readable; |
There was a problem hiding this comment.
Also, for these deprecated types, in files like RpcMarchaling.ts, should I replace them with their node:stream counterpart?
There was a problem hiding this comment.
I think you should revert these changes and keep this coupled with the rpc changes in a separate pr that @GytisCepk and @paulius-valiunas will lead efforts on
There was a problem hiding this comment.
Sounds good. Ill document what hasn't been removed yet in the PR description
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
This reverts commit 3d1e450. Revert Node:stream change
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