fix: compatiblity mode for v0 tagging behavior

.projenrc.ts

@@ -107,6 +107,9 @@ new TextFile(project, 'sonar-project.properties', {
     'sonar.sources=./src',
     'sonar.tests=./test',
     'sonar.test.inclusions=**/*.test.*',
+    'sonar.issue.ignore.multicriteria=e1',
+    'sonar.issue.ignore.multicriteria.e1.ruleKey=typescript:S1874',
+    'sonar.issue.ignore.multicriteria.e1.resourceKey=src/smartstack/tags/*.ts',
   ],
 });
 

README.md

@@ -210,3 +210,21 @@ Generally speaking you would be most interested in the following:
 - AccountContext (AC)
 - EnvironmentContext (EC)
 - Name / UrlName / PathName
+
+## Migration
+
+### v0 to v1
+
+#### Tagging behavior
+
+Due to a bug in `v0`, the `Contact` and `Organization` tags were NOT applied as they should have. This means that by default, upgrading from v0→v1 introduces CloudFormation diff. Basically adding the `Contact` and `Organization` tags to all resources. This should be safe operation, but we allow disabling it via a feature flag (note that `Contact` and `Organization` tags will most likely be enforced in future `v2`).
+
+```diff
+// cdk.json
+{
+  "context": {
+    // existing context keys
++   "@alma-cdk/project:compatibility:v0:tags": true
+  },
+}
+```

src/smartstack/tags/checks.test.ts

@@ -0,0 +1,34 @@
+import { useCompatibilityV0Tags, useLegacyTags } from './checks';
+import { TestableResource } from './test-helpers/TestableResource';
+
+describe('useLegacyTags', () => {
+  test('returns false if the context key is not set', () => {
+    const scope = new TestableResource();
+    expect(useLegacyTags(scope)).toBe(false);
+  });
+
+  test('returns true if the context key is set', () => {
+    const scope = new TestableResource({
+      context: {
+        '@alma-cdk/project:legacyTags': true,
+      },
+    });
+    expect(useLegacyTags(scope)).toBe(true);
+  });
+});
+
+describe('useCompatibilityV0Tags', () => {
+  test('returns false if the context key is not set', () => {
+    const scope = new TestableResource();
+    expect(useCompatibilityV0Tags(scope)).toBe(false);
+  });
+
+  test('returns true if the context key is set', () => {
+    const scope = new TestableResource({
+      context: {
+        '@alma-cdk/project:compatibility:v0:tags': true,
+      },
+    });
+    expect(useCompatibilityV0Tags(scope)).toBe(true);
+  });
+});

src/smartstack/tags/checks.ts

@@ -10,7 +10,26 @@ export function hasEnvironment(values: Values): boolean {
   return isNonEmptyString(values.environmentType);
 }
 
+/**
+ * Enforces usage of https://github.com/almamedia/alma-cdk-jsii-tag-and-name
+ * (for AWS CDK v1) compatible tagging behavior.
+ *
+ * @deprecated This behavior is not encouraged and will be removed in v2. Additionally according to GitHub search, this is not used anymore.
+ */
 export function useLegacyTags(scope: Construct): boolean {
   const contextKey = '@alma-cdk/project:legacyTags';
   return scope.node.tryGetContext(contextKey) === true;
 }
+
+/**
+ * Compatibility flag for v0 tagging behavior.
+ * Due to a bug in v0, the `Contact` and `Organization` tags were NOT applied as they should have.
+ * This flag can be used to enforce behavior that matches v0 implementation:
+ * I.e. `Contact` and `Organization` tags are NOT applied.
+ *
+ * @deprecated This behavior is not encouraged and will be removed in v2.
+ */
+export function useCompatibilityV0Tags(scope: Construct): boolean {
+  const contextKey = '@alma-cdk/project:compatibility:v0:tags';
+  return scope.node.tryGetContext(contextKey) === true;
+}