feat(lib): add move workflows for specifying ids directly

[Maed223]

Description

Adds a alternative workflow for performing resource moves by specifying resource ids directly.

The original workflow for resource moves didn't have (as of writing this) any bugs per say, yet some of the tradeoffs made in it's design made certain use cases quite difficult. As such, I made resource instance functions where the id to move to/from can be directly specified. Provides a better experience compared to using escape hatches, while avoiding potentially unhelpful abstraction in the targeting system.

In particular we saw in migrating the repository manager to use our new id generation that using the target system was incredibly cumbersome. In response to this use case, I've created an Aspect that will automatically perform the resource moves between the old id generation and the new for ease of upgrading past 0.17.

Resource Instance Function Additions

moveToId(id: string)

Moves the resource it is called upon to the resource corresponding to id

new S3Bucket(this, "test-bucket-moved", {
  bucket: "test-move-bucket-move-to-id",
}).moveToId("aws_s3_bucket.test-bucket-moved-to");

new S3Bucket(this, "test-bucket-moved-to", {
  bucket: "test-move-bucket-move-to-id",
});

moveFromId(id: string)

Move the resource corresponding to id to the resource it is called upon. Note that the resource being moved from must be marked as moved using the instance function .hasMoved().

new S3Bucket(this, "test-bucket-moved-from", {
  bucket: "test-move-bucket-move-from-id",
}).hasMoved();
new S3Bucket(this, "test-bucket", {
  bucket: "test-move-bucket-move-from-id",
}).moveFromId("aws_s3_bucket.test-bucket-moved-from");

Id Migration Aspect

/**
 * For migrating past 0.17 where id generation changed
 */
export class MigrateIdsAspect implements IAspect {
  visit(node: IConstruct) {
    // eslint-disable-next-line no-instanceof/no-instanceof
    if (node instanceof TerraformResource) {
      const oldId = allocateLogicalIdOldVersion(node);
      node.moveFromId(`${node.terraformResourceType}.${oldId}`);
    }
  }
}

Added an Aspect (MigrateIdsAspect) to the lib that migrates ids from prev 0.17 to post 0.17 when the feature flag was removed. Uses the old logic for Id generation to resolve the original resource address and calls moveFromId with that old address.

Should solve our issue in the repository manager quite nicely as well as any users in the same situation of upgrading their CDKTF version.

A screenshot of the new Aspect in action

[Maed223]

Still need to shout out the new MigrateIdsAspect somewhere. Figure the 0.17 upgrade guide would be the logical place, but to me it doesn't seem to be the most visible place. Curious to hear opinions on this 😁

[DanielMSchmidt]

@Maed223 I think the upgrade guide is the best place for that 👍

[ansgarm]

Nice work! Looks good to me 🚀
Got a few cleanup items / docs improvements, but would've been an approve otherwise ✅

[DanielMSchmidt]

The only "blocking" one is my question in the refactoring examples :)

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.