Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(servicecatalog): ProductStackHistory changes last product version ID #24561

Open
konokenj opened this issue Mar 10, 2023 · 5 comments · May be fixed by #32248
Open

(servicecatalog): ProductStackHistory changes last product version ID #24561

konokenj opened this issue Mar 10, 2023 · 5 comments · May be fixed by #32248
Labels
@aws-cdk/aws-servicecatalog Related to AWS Service Catalog bug This issue is a bug. effort/medium Medium work item – several days of effort p2

Comments

@konokenj
Copy link
Contributor

Describe the bug

ProductStackHistory is expected to keep older product versions as-is for consistency. But currently, the ID of last deployed product version changes by adding new version.
This becomes a blocker for users of Account Factory Customization (AFC) in AWS Control Tower because users may lost product version id that is used by AFC blueprint.

Expected Behavior

Product version IDs should be immutable when adding a new version with currentVersionLocked: true.

Current Behavior

The ID of last deployed product version changes by adding new version.

Reproduction Steps

Deploy v1

import { App, Stack } from 'aws-cdk-lib';
import { CloudFormationProduct, ProductStack, ProductStackHistory } from 'aws-cdk-lib/aws-servicecatalog';
import { Construct } from 'constructs';
import { Queue } from 'aws-cdk-lib/aws-sqs';

const app = new App();
const stack = new Stack(app, "ServiceCatalog")

class MyProduct extends ProductStack {
  constructor(scope: Construct, id: string) {
    super(scope, id);
    new Queue(this, "SCQueue1")
  }
}

const productStackHistory = new ProductStackHistory(stack, 'ProductStackHistory', {
  productStack: new MyProduct(stack, 'MyProduct'),
  currentVersionName: 'v1',
  currentVersionLocked: true,
});

new CloudFormationProduct(stack, 'Product', {
  productName: 'MyProduct',
  owner: 'Platform team at Example Company',
  productVersions: [
    productStackHistory.currentVersion(),
  ],
});

image

Deploy v2 with no changes in ProductStack

@@ -15,7 +15,7 @@ class MyProduct extends ProductStack {

 const productStackHistory = new ProductStackHistory(stack, 'ProductStackHistor>
   productStack: new MyProduct(stack, 'MyProduct'),
-  currentVersionName: 'v1',
+  currentVersionName: 'v2',
   currentVersionLocked: true,
 });

@@ -23,7 +23,7 @@ new CloudFormationProduct(stack, 'Product', {
   productName: 'MyProduct',
   owner: 'Platform team at Example Company',
   productVersions: [
-    // productStackHistory.versionFromSnapshot("v1"),
+    productStackHistory.versionFromSnapshot("v1"),
     productStackHistory.currentVersion(),
   ],
 });

cdk diff

ScreenShot 2023-03-10 16 59 22

Result of deployment

ScreenShot 2023-03-10 17 05 25

Deploy v3 with changes in ProductStack

@@ -9,13 +9,13 @@ const stack = new Stack(app, "ServiceCatalog")
 class MyProduct extends ProductStack {
   constructor(scope: Construct, id: string) {
     super(scope, id);
-    new Queue(this, "SCQueue1")
+    new Queue(this, "SCQueue3")
   }
 }

 const productStackHistory = new ProductStackHistory(stack, 'ProductStackHistor>
   productStack: new MyProduct(stack, 'MyProduct'),
-  currentVersionName: 'v2',
+  currentVersionName: 'v3',
   currentVersionLocked: true,
 });

@@ -24,6 +24,7 @@ new CloudFormationProduct(stack, 'Product', {
   owner: 'Platform team at Example Company',
   productVersions: [
     productStackHistory.versionFromSnapshot("v1"),
+    productStackHistory.versionFromSnapshot("v2"),
     productStackHistory.currentVersion(),
   ],
 });

cdk diff

ScreenShot 2023-03-10 17 09 06

Result of deployment

ScreenShot 2023-03-10 17 10 58

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.68.0 (build 25fda51)

Framework Version

2.68.0

Node.js Version

v18.13.0

OS

macOS Monterey 12.6.3

Language

Typescript

Language Version

4.9.5

Other information

No response
@konokenj konokenj added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Mar 10, 2023
@github-actions github-actions bot added the @aws-cdk/aws-servicecatalog Related to AWS Service Catalog label Mar 10, 2023
@pahud
Copy link
Contributor

pahud commented Mar 10, 2023

Awesome details!!! Thank you Kenji san! Are you interested to submit your PR for this?

@pahud pahud added response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. effort/medium Medium work item – several days of effort p2 and removed needs-triage This issue or PR still needs to be triaged. labels Mar 10, 2023
@konokenj
Copy link
Contributor Author

Yes, but I haven't come up with a good solution yet.
I think we have to keep S3 object path of the asset and product version name that once deployed. Or we have to use snapshot file that written to disk also in currentVersion(). Further investigation is needed.
Please let me know if you have a good idea.

@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Mar 10, 2023
@wanjacki
Copy link
Contributor

Hey @konokenj we (Service Catalog) will add an item to our backlog to investigate and hopefully fix this!

@HFR1994
Copy link

HFR1994 commented Apr 25, 2024

Any updates?

1001R pushed a commit to 1001R/aws-cdk that referenced this issue Nov 22, 2024
Bugfix for issue aws#24561
fe543ea
This was referenced Nov 22, 2024
Closed
Open
@1001R
Copy link

1001R commented Nov 22, 2024 •
edited
Loading

I've run into the same issue and may have identified the cause: the way the asset hash for the generated product template differs between the current version (product stack synthesized in memory and hashed) and snapshot versions (using FileSystem.fingerprint on the template written to disk). The moment you add a new version, for latest version will be created as a snapshot version, the asset hash changes (although it's essentially the same template), which in turn results in a different template URL.

I submitted a PR to fix this, but as this is my first contribution I've haven't been able to update the integration tests. Maybe someone could help me with this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-servicecatalog Related to AWS Service Catalog bug This issue is a bug. effort/medium Medium work item – several days of effort p2
Projects
None yet
Milestone
No milestone
5 participants
@pahud @1001R @HFR1994 @wanjacki @konokenj