[s3-assets] some fields in AssetOptions are deprecated, but is that intended?

[acomagu]

The exclude and follow fields in AssetOptions interface were marked deprecated, because of #7708. But the pull doesn't seem to have the intension to deprecate them. If not, they should be fixed.

---

This is a 📕 documentation issue

[iliapolo]

@acomagu These properties are deprecated in favor of using the core library:

aws-cdk/packages/@aws-cdk/core/lib/fs/options.ts

Lines 33 to 49 in 938f326

	/**
	* Obtains applied when copying directories into the staging location.
	*/
	export interface CopyOptions {
	/**
	* A strategy for how to handle symlinks.
	*
	* @default SymlinkFollowMode.NEVER
	*/
	readonly follow?: SymlinkFollowMode;
	/**
	* Glob patterns to exclude from the copy.
	*
	* @default - nothing is excluded
	*/
	readonly exclude?: string[];

This is intended, as CopyOptions from the assets module (which AssetOptions in s3-assets extend from) will be removed in future major versions.

[github-actions]

This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

[acomagu]

@iliapolo Sorry for late reply.

So now AssetOptions should extend CopyOptions from core module, shouldn't it? The documentation says the exclude field is deprecated, but the field WON'T be removed from AssetOptions because it still exists in the core module one, right?

[acomagu]

From user perspective, they think that they should not use exclude field any more because it's marked as deprecated. But actually no plan to remove the field from AssetOptions and we don't need to worry about using it.

[iliapolo]

@acomagu Yeah I see it can be confusing. I'll make the deprecation notice a little clearer. Thanks!

[danielsharvey]

Should this be re-opened? The deprecation notice remains confusing...

[eladb]

I believe @skinny85 spent some time on this, right?

[mjwbenton]

Is there a plan for migrating other packages (e.g. aws-s3-deployment) that use aws-s3-assets right now to core? I don't think I can find an issue related to it.

Isn't it possible to make that step without it being a breaking change, and therefore side step the issue with the confusing deprecation notices?

[skinny85]

Here's the summary of the situation, and how we will change it:

1. Currently, the AssetOptions interface from the @aws-cdk/aws-s3-assets module extends the deprecated CopyOptions interface from the deprecated module @aws-cdk/assets.
2. We will add a new, non-deprecated interface FileCopyOptions to @aws-cdk/core. The above mentioned AssetOptions interface will now extend both CopyOptions and FileCopyOptions. This is done in PR chore: add new interfaces for Assets #13356.
3. In V2, we will automatically strip all deprecated features from our code. Which means the old CopyOptions will be removed, and only the new FileCopyOptions will remain, thus getting rid of the confusing deprecations.

Hope this clears this up!

Thanks,
Adam

[mjwbenton]

Gotcha, thanks for the explanation.

[github-actions]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.